diff --git a/source/_integrations/manual.markdown b/source/_integrations/manual.markdown index 391339a8d81..eae9dbc2fec 100644 --- a/source/_integrations/manual.markdown +++ b/source/_integrations/manual.markdown @@ -10,13 +10,17 @@ ha_iot_class: Calculated ha_platforms: - alarm_control_panel ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `manual` alarm control panel platform enables you to create an alarm system in Home Assistant. +The `manual` alarm control panel {% term integration %} enables you to create an alarm system in Home Assistant. ## Configuration -To enable this, add the following lines to your `configuration.yaml` file: +To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/manual_mqtt.markdown b/source/_integrations/manual_mqtt.markdown index daebb429e3a..f64d45304bc 100644 --- a/source/_integrations/manual_mqtt.markdown +++ b/source/_integrations/manual_mqtt.markdown @@ -9,13 +9,16 @@ ha_iot_class: Local Push ha_platforms: - alarm_control_panel ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `mqtt` platform extends the [manual alarm](/integrations/manual) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant. +The `mqtt` {% term integration %} extends the [manual alarm](/integrations/manual) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant. It's essentially the opposite of the [MQTT Alarm Panel](/integrations/alarm_control_panel.mqtt/) which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device. -The integration will accept the following commands from your Alarm Panel via the `command_topic`: +The {% term integration %} will accept the following commands from your Alarm Panel via the `command_topic`: - `DISARM` - `ARM_HOME` @@ -37,7 +40,8 @@ When the state of the manual alarm changes, Home Assistant will publish one of t ## Configuration -To use your panel in your installation, add the following to your `configuration.yaml` file: +To use your panel in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/marytts.markdown b/source/_integrations/marytts.markdown index 920741c9571..609f2bd2a88 100644 --- a/source/_integrations/marytts.markdown +++ b/source/_integrations/marytts.markdown @@ -9,13 +9,17 @@ ha_domain: marytts ha_platforms: - tts ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) text-to-speech engine to read a text with natural sounding voices. +The `marytts` text-to-speech {% term integration %} uses [MaryTTS](http://mary.dfki.de/) text-to-speech engine to read a text with natural sounding voices. ## Configuration -To enable text-to-speech with MaryTTS, add the following lines to your `configuration.yaml`: +To enable text-to-speech with MaryTTS, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/mastodon.markdown b/source/_integrations/mastodon.markdown index b3c2937daf7..d0a79ef1966 100644 --- a/source/_integrations/mastodon.markdown +++ b/source/_integrations/mastodon.markdown @@ -11,6 +11,9 @@ ha_iot_class: Cloud Push ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver notifications from Home Assistant. @@ -22,7 +25,8 @@ If you want to grant only required accesses, uncheck all checkboxes then check o ### Configuration -To add Mastodon to your installation, add the following to your `configuration.yaml` file: +To add Mastodon to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown index 48cfb641a39..278fe2491fe 100644 --- a/source/_integrations/matrix.markdown +++ b/source/_integrations/matrix.markdown @@ -12,9 +12,12 @@ ha_platforms: ha_integration_type: integration ha_codeowners: - '@PaarthShah' +related: + - docs: /docs/configuration/ + title: Configuration file --- -This integration allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. +This {% term integration %} allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. There is currently support for the following device types within Home Assistant: @@ -22,6 +25,9 @@ There is currently support for the following device types within Home Assistant: ## Configuration +To enable the Matrix {% term integration %}, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry matrix: diff --git a/source/_integrations/maxcube.markdown b/source/_integrations/maxcube.markdown index 7628a1d6753..75f4b7b4daf 100644 --- a/source/_integrations/maxcube.markdown +++ b/source/_integrations/maxcube.markdown @@ -11,6 +11,9 @@ ha_platforms: - binary_sensor - climate ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- [eQ-3 MAX!](https://www.eq-3.com/products/homematic/detail/max-cube-lan-gateway.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported integrations available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. @@ -34,7 +37,8 @@ Supported Devices: ### One gateway -A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required: +A `maxcube` section must be present in the {% term "`configuration.yaml`" %} file and contain the following options as required: +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/media_extractor.markdown b/source/_integrations/media_extractor.markdown index 877144db959..b6a2c9d253b 100644 --- a/source/_integrations/media_extractor.markdown +++ b/source/_integrations/media_extractor.markdown @@ -10,15 +10,19 @@ ha_domain: media_extractor ha_integration_type: integration ha_codeowners: - '@joostlek' +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly. +The `media_extractor` {% term integration %} gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.
Media extractor doesn't transcode streams, it just tries to find a stream that matches the requested query.
-To use the media extractor service in your installation, add the following to your `configuration.yaml` file: +To use the media extractor service in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry @@ -81,10 +85,10 @@ This will download the file from the given URL. There is also a service that will directly return the URL in the response of the service. -| Service data attribute | Optional | Description | -|-----------------------| -------- |-----------------------------------------------------------------------------------------------------------| -| `url` | no | The URL of the media to extract. | -| `format_query` | yes | The query that will be used to select the right media. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------ | +| `url` | no | The URL of the media to extract. | +| `format_query` | yes | The query that will be used to select the right media. | ### Cookies diff --git a/source/_integrations/mediaroom.markdown b/source/_integrations/mediaroom.markdown index eb619086176..7f8350be106 100644 --- a/source/_integrations/mediaroom.markdown +++ b/source/_integrations/mediaroom.markdown @@ -11,11 +11,15 @@ ha_domain: mediaroom ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `mediaroom` integration allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. +The `mediaroom` {% term integration %} allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. -To add a Mediaroom STB to your installation, add the following to your `configuration.yaml` file: +To add a Mediaroom STB to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/melissa.markdown b/source/_integrations/melissa.markdown index 70f8178452d..e700e5fd810 100644 --- a/source/_integrations/melissa.markdown +++ b/source/_integrations/melissa.markdown @@ -12,9 +12,12 @@ ha_domain: melissa ha_platforms: - climate ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `melissa` integration is the main integration to connect to a [Melissa Climate](https://seemelissa.com/) A/C control. +The `melissa` {% term integration %} is the main integration to connect to a [Melissa Climate](https://seemelissa.com/) A/C control. There is currently support for the following device types within Home Assistant: @@ -24,7 +27,8 @@ The climate platform will be automatically configured if Melissa integration is ## Configuration -To set the Melissa integration up, add the following information to your `configuration.yaml` file: +To set the Melissa {% term integration %} up, add the following information to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/meraki.markdown b/source/_integrations/meraki.markdown index 33c82c4891e..1617eb1aaf2 100644 --- a/source/_integrations/meraki.markdown +++ b/source/_integrations/meraki.markdown @@ -9,6 +9,9 @@ ha_domain: meraki ha_platforms: - device_tracker ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network. @@ -26,7 +29,8 @@ Use your Meraki AP as device tracker. Note that Meraki will see all devices, not ## Configuration -After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file: +After you configure access to the Meraki CMX API, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/message_bird.markdown b/source/_integrations/message_bird.markdown index d20a448105a..ddc9668314d 100644 --- a/source/_integrations/message_bird.markdown +++ b/source/_integrations/message_bird.markdown @@ -9,9 +9,12 @@ ha_domain: message_bird ha_platforms: - notify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. +The `MessageBird` notification {% term integration %} sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. ## Setup @@ -19,7 +22,8 @@ Go to [MessageBird](https://www.messagebird.com/) to retrieve your API key. ## Configuration -To enable MessageBird notifications in your installation, add the following to your `configuration.yaml` file: +To enable MessageBird notifications in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/mfi.markdown b/source/_integrations/mfi.markdown index 88bd59bd175..f1083aa5c8b 100644 --- a/source/_integrations/mfi.markdown +++ b/source/_integrations/mfi.markdown @@ -12,6 +12,9 @@ ha_platforms: - sensor - switch ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- There is currently support for the following device types within Home Assistant: @@ -21,9 +24,10 @@ There is currently support for the following device types within Home Assistant: ## Sensor -The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). +The `mfi` sensor {% term integration %} to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). -To add this platform to your installation, add the following to your `configuration.yaml` file: +To add this {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/microsoft.markdown b/source/_integrations/microsoft.markdown index 886fd07f78b..e8ac566daf2 100644 --- a/source/_integrations/microsoft.markdown +++ b/source/_integrations/microsoft.markdown @@ -9,13 +9,17 @@ ha_domain: microsoft ha_platforms: - tts ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `microsoft` text-to-speech platform uses the [TTS engine of the Microsoft Speech Service](https://learn.microsoft.com/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices). +The `microsoft` text-to-speech {% term integration %} uses the [TTS engine of the Microsoft Speech Service](https://learn.microsoft.com/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices). ## Configuration -To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`: +To enable text-to-speech with Microsoft, add the following lines to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown index b2bd4ea5ef2..a41fb8d96e1 100644 --- a/source/_integrations/microsoft_face.markdown +++ b/source/_integrations/microsoft_face.markdown @@ -9,7 +9,7 @@ ha_domain: microsoft_face ha_integration_type: integration --- -The `microsoft_face` integration platform is the main integration for Microsoft +The `microsoft_face` integration {% term integration %} is the main integration for Microsoft Azure Cognitive service [Face](https://azure.microsoft.com/products/cognitive-services/vision-services). All data are stored in your own private instance in the Azure cloud. @@ -26,7 +26,7 @@ Please note that all keys on cognitive services must be recreated every 90 days. ## Configuration -To enable the Microsoft Face integration, +To enable the Microsoft Face {% term integration %}, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/microsoft_face_detect.markdown b/source/_integrations/microsoft_face_detect.markdown index 0e2132c1fbe..eccd546a6df 100644 --- a/source/_integrations/microsoft_face_detect.markdown +++ b/source/_integrations/microsoft_face_detect.markdown @@ -7,9 +7,12 @@ ha_iot_class: Cloud Push ha_release: 0.38 ha_domain: microsoft_face_detect ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `microsoft_face_detect` image processing platform allows you to use the +The `microsoft_face_detect` image processing {% term integration %} allows you to use the [Microsoft Face Identify](https://azure.microsoft.com/products/cognitive-services/) API through Home Assistant. This platform enables you to detect face on camera and fire an event with attributes. @@ -28,6 +31,9 @@ The free version of the Microsoft Face identify API limits the number of request ### Configuration +To enable the integration, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry image_processing: diff --git a/source/_integrations/microsoft_face_identify.markdown b/source/_integrations/microsoft_face_identify.markdown index 12fe03f3e0d..87cfb45fbe7 100644 --- a/source/_integrations/microsoft_face_identify.markdown +++ b/source/_integrations/microsoft_face_identify.markdown @@ -7,9 +7,12 @@ ha_iot_class: Cloud Push ha_release: 0.37 ha_domain: microsoft_face_identify ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `microsoft_face_identify` image processing platform lets you use +The `microsoft_face_identify` image processing {% term integration %} lets you use [Microsoft Face identify](https://azure.microsoft.com/products/cognitive-services/) API through Home Assistant. This platform allow you do identify persons on camera and fire an event with attributes. @@ -28,6 +31,9 @@ The free version of the Microsoft Face identify API limits the number of request ### Configuration +To enable this integration, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} + ```yaml # Example configuration.yaml entry image_processing: