diff --git a/source/_integrations/oasa_telematics.markdown b/source/_integrations/oasa_telematics.markdown index 0df45cd7a4b..ed14ed07b56 100644 --- a/source/_integrations/oasa_telematics.markdown +++ b/source/_integrations/oasa_telematics.markdown @@ -10,13 +10,17 @@ ha_domain: oasa_telematics ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `oasa_telematics` sensor will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/). +The `oasa_telematics` {% term integration %} will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/). ## Configuration -Add a sensor to your `configuration.yaml` file as shown in the example: +Add the {% term integration %} to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/oem.markdown b/source/_integrations/oem.markdown index 30071180980..7fdb80b31b2 100644 --- a/source/_integrations/oem.markdown +++ b/source/_integrations/oem.markdown @@ -9,13 +9,17 @@ ha_domain: oem ha_platforms: - climate ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://web.archive.org/web/20220426080315/https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/) (archived page, no longer for sale). The underlying [library](https://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). +This {% term integration %} supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://web.archive.org/web/20220426080315/https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/) (archived page, no longer for sale). The underlying [library](https://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). This platform controls the setpoint of the thermostat in its "manual" mode. -To set it up, add the following information to your `configuration.yaml` file: +To set it 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/ohmconnect.markdown b/source/_integrations/ohmconnect.markdown index d0b711845e7..7c19ee1a973 100644 --- a/source/_integrations/ohmconnect.markdown +++ b/source/_integrations/ohmconnect.markdown @@ -11,9 +11,12 @@ ha_domain: ohmconnect ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID. +The `ohmconnect` {% term integration %} will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID. OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that. @@ -21,7 +24,8 @@ OhmConnect monitors real-time conditions on the electricity grid. When dirty and You can find your OhmConnect ID on the [OhmConnect API settings page](https://login.ohmconnect.com/api/v2/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. -To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file: +To enable the OhMConnect {% 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/ombi.markdown b/source/_integrations/ombi.markdown index d0e3014bb18..b3ad34c741d 100644 --- a/source/_integrations/ombi.markdown +++ b/source/_integrations/ombi.markdown @@ -11,13 +11,16 @@ ha_domain: ombi ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- The Ombi integration monitors data from your [Ombi](https://ombi.io) instance. ## Setup -This integration needs to authenticate to your Ombi instance with either a user `password` or an `api_key`. +This {% term integration %} needs to authenticate to your Ombi instance with either a user `password` or an `api_key`. To find your `api_key` open the Ombi web interface. Navigate to **Settings** and then to **Ombi**, you should then be able to see your `api_key`. @@ -25,7 +28,8 @@ If you want to use `password` authentication simply use the same `password` you ## Configuration -If you want to enable this sensor, add the following lines to your `configuration.yaml`: +If you want 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 @@ -91,23 +95,23 @@ Available services: `submit_movie_request`, `submit_music_request`, `submit_tv_r Searches and requests the closest matching movie. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ------------------------------------------------ | -| `name` | no | Search parameter. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------- | +| `name` | no | Search parameter. | #### Service `submit_music_request` Searches and requests the closest matching music album. -| Service data attribute | Optional | Description | -|------------------------|----------|--------------------------------------------------| -| `name` | no | Search parameter. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------- | +| `name` | no | Search parameter. | #### Service `submit_tv_request` Searches and requests the closest matching TV show. -| Service data attribute | Optional | Description | -|------------------------|----------|-----------------------------------------------------------------------------------------------| -| `name` | no | Search parameter. | -| `season` | yes | Which season(s) to request. Must be one of `first`, `latest` or `all`. Defaults to latest. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------------------------------ | +| `name` | no | Search parameter. | +| `season` | yes | Which season(s) to request. Must be one of `first`, `latest` or `all`. Defaults to latest. | diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown index c6613f9fba5..35e2f9e588c 100644 --- a/source/_integrations/onkyo.markdown +++ b/source/_integrations/onkyo.markdown @@ -9,15 +9,19 @@ ha_domain: onkyo ha_platforms: - media_player ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `onkyo` platform allows you to control a [Onkyo](https://www.onkyo.com), [Integra](http://www.integrahometheater.com) +The `onkyo` {% term integration %} allows you to control a [Onkyo](https://www.onkyo.com), [Integra](http://www.integrahometheater.com) and some recent [Pioneer](https://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this integration to work in your Hardware. ## Configuration -To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file: +To add an Onkyo or Pioneer receiver 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 @@ -105,10 +109,10 @@ unknown-model: master-volume = 191 Changes HDMI output of your receiver -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of a single `entity_id` that will change output. -| `hdmi_output` | no | The desired output code. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------- | +| `entity_id` | no | String or list of a single `entity_id` that will change output. | +| `hdmi_output` | no | The desired output code. | Accepted values are: 'no', 'analog', 'yes', 'out', 'out-sub', 'sub', 'hdbaset', 'both', 'up' diff --git a/source/_integrations/openalpr_cloud.markdown b/source/_integrations/openalpr_cloud.markdown index 0ee6bde7b8a..c0ea55d94e0 100644 --- a/source/_integrations/openalpr_cloud.markdown +++ b/source/_integrations/openalpr_cloud.markdown @@ -7,9 +7,12 @@ ha_iot_class: Cloud Push ha_release: 0.36 ha_domain: openalpr_cloud ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you +The [OpenALPR](https://www.openalpr.com/) {% term integration %} for Home Assistant allows you to process license plates from a camera. This allows you to open a garage door or trigger any other [automation](/integrations/automation/) based on a license plate. @@ -18,6 +21,9 @@ take a look at the [integration](/integrations/image_processing/) page. ### Configuration +To enable the OPENALPR {% term 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/openerz.markdown b/source/_integrations/openerz.markdown index df73a818750..b573774b85d 100644 --- a/source/_integrations/openerz.markdown +++ b/source/_integrations/openerz.markdown @@ -11,13 +11,17 @@ ha_codeowners: ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -This `openerz` sensor platform uses [OpenERZ](http://openerz.metaodi.ch/) API to access data from Entsorgung und Recycling Zürich (ERZ). It reports the next pickup date for the specified zip and waste type. +This `openerz` sensor {% term integration %} uses [OpenERZ](http://openerz.metaodi.ch/) API to access data from Entsorgung und Recycling Zürich (ERZ). It reports the next pickup date for the specified zip and waste type. ## Configuration -To enable this sensor in your installation, add the following to your `configuration.yaml` file: +To enable this {% term integration %} 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/openevse.markdown b/source/_integrations/openevse.markdown index 4d4e89e740d..20283d33203 100644 --- a/source/_integrations/openevse.markdown +++ b/source/_integrations/openevse.markdown @@ -9,13 +9,17 @@ ha_domain: openevse ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection. +This `openevse` sensor {% term integration %} pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection. ## Configuration -To enable this sensor in your installation, add the following to your `configuration.yaml` file: +To enable this sensor 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/openhardwaremonitor.markdown b/source/_integrations/openhardwaremonitor.markdown index 939770b1c45..a47fd7e4cdb 100644 --- a/source/_integrations/openhardwaremonitor.markdown +++ b/source/_integrations/openhardwaremonitor.markdown @@ -9,9 +9,12 @@ ha_domain: openhardwaremonitor ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `openhardwaremonitor` platform uses your [Open Hardware Monitor](https://openhardwaremonitor.org/) installation as a source for sensors that will display system information. +The `openhardwaremonitor` {% term integration %} uses your [Open Hardware Monitor](https://openhardwaremonitor.org/) installation as a source for sensors that will display system information. ## Setup @@ -37,7 +40,8 @@ sudo firewall-cmd --reload ## Configuration -To add Open Hardware Monitor to your installation, add the following to your `configuration.yaml` file: +To add Open Hardware Monitor 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/opensensemap.markdown b/source/_integrations/opensensemap.markdown index 338f1ef458d..21d1d5dddfa 100644 --- a/source/_integrations/opensensemap.markdown +++ b/source/_integrations/opensensemap.markdown @@ -9,9 +9,12 @@ ha_domain: opensensemap ha_platforms: - air_quality ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `opensensemap` air quality platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. +The `opensensemap` air quality {% term integration %} will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. ## Setup @@ -19,7 +22,8 @@ To get the ID of a station you need to select it on the [openSense map](https:// ## Manual configuration -To enable this platform, 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/opple.markdown b/source/_integrations/opple.markdown index 4de10b970b5..66c82a47b84 100644 --- a/source/_integrations/opple.markdown +++ b/source/_integrations/opple.markdown @@ -9,13 +9,17 @@ ha_domain: opple ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `opple` light platform allows you to control the state of your Opple smart light. +The `opple` light {% term integration %} allows you to control the state of your Opple smart light. The platform supports all Opple lights with Wi-Fi support or lights that can be controlled by the App. -To use your Opple light in your installation, add the following to your `configuration.yaml` file: +To use your Opple light 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/oru.markdown b/source/_integrations/oru.markdown index 15f4ce9f35f..ed60f03fa58 100644 --- a/source/_integrations/oru.markdown +++ b/source/_integrations/oru.markdown @@ -11,14 +11,18 @@ ha_domain: oru ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- [Orange and Rockland Utility](https://oru.com) is an energy provider in NY and NJ, USA. -The `oru` sensor platform fetches your current energy usage from your ORU smart meter. +The `oru` sensor {% term integration %} fetches your current energy usage from your ORU smart meter. ## Configuration -To add the `oru` sensor to your installation, add your `meter_number` to your `configuration.yaml` file: +To add the `oru` {% term integration %} to your installation, add your `meter_number` to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/osramlightify.markdown b/source/_integrations/osramlightify.markdown index 76c08c4c237..7ab3dfed980 100644 --- a/source/_integrations/osramlightify.markdown +++ b/source/_integrations/osramlightify.markdown @@ -9,9 +9,15 @@ ha_domain: osramlightify ha_platforms: - light ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `osramlightify` platform allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant. +The `osramlightify` {% term integration %} allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant. + +To enable the {% term integration %}, add it to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/otp.markdown b/source/_integrations/otp.markdown index dd720f74729..9954dedf775 100644 --- a/source/_integrations/otp.markdown +++ b/source/_integrations/otp.markdown @@ -11,13 +11,17 @@ ha_domain: otp ha_platforms: - sensor ha_integration_type: integration +related: + - docs: /docs/configuration/ + title: Configuration file --- -The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. +The `otp` {% term integration %} generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. ## Configuration -To enable the OTP sensor, add the following lines to your `configuration.yaml`: +To enable the OTP {% 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