jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

e-integrations: Restart HA after adding the integration to the configuration.yaml (#32635)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-08 23:30:27 +02:00 committed by GitHub
parent 9ce44b739d
commit 53733d8a36
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 190 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/ebox.markdown
View File

@ -9,13 +9,17 @@ ha_domain: ebox
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant.
## Configuration
To use your EBox sensor in your installation, add the following to your `configuration.yaml` file:
To use your EBox 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

6
source/_integrations/ebusd.markdown
View File

@ -9,13 +9,17 @@ ha_domain: ebusd
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Integration between the [ebusd](https://github.com/john30/ebusd/) daemon (used for communication with the eBUS heating systems), and Home Assistant. The ebusd integrations uses the sensor integration.
## Configuration
Enable the sensor by adding the following to your `configuration.yaml` file:
Enable the sensor by adding the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/ecoal_boiler.markdown
View File

@ -10,13 +10,17 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
The `ecoal_boiler` {% term integration %} is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal).
## Configuration
To use your eCoal pumps or sensors in your installation, add the following to your `configuration.yaml` file:
To use your eCoal pumps or sensors 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

13
source/_integrations/ecobee.markdown
View File

@ -64,7 +64,8 @@ Your new application will now appear on the left. Upon clicking on the applicati
## Manual configuration
If you prefer to set up the integration in [`configuration.yaml`](/docs/configuration/), add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel):
If you prefer to set up the integration in your {% term "`configuration.yaml`" %} file, add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel).
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -190,7 +191,7 @@ Delete a vacation on the selected ecobee thermostat.
Resumes the standard active schedule of presets. This cancels any manual temperature settings or selected preset. This will not cancel vacation events, use `delete_vacation`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of climate devices to control. Omit to target all ecobee thermostats. |
| `resume_all` | no | `true` will resume the standard schedule. `false` will only cancel the latest active event, which is not used often. |
@ -199,7 +200,7 @@ Resumes the standard active schedule of presets. This cancels any manual tempera
Sets the minimum amount of time that the fan will run per hour.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Omit to target all ecobee thermostats. |
| `fan_min_on_time` | no | integer (e.g., 5) |
@ -208,7 +209,7 @@ Sets the minimum amount of time that the fan will run per hour.
Enable/disable automatic daylight savings time.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------ |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set daylight savings time mode. Omit to target all ecobee thermostats. |
| `dst_enabled` | no | true or false |
@ -217,7 +218,7 @@ Enable/disable automatic daylight savings time.
Enable/disable Alexa mic (only for ecobee 4).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| ---------------------- | -------- | -------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set the mic mode. Omit to target all ecobee thermostats. |
| `mic_enabled` | no | true or false |
@ -226,7 +227,7 @@ Enable/disable Alexa mic (only for ecobee 4).
Enable/disable Smart Home/Away and Follow Me modes.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set occupancy modes. Omit to target all ecobee thermostats. |
| `auto_away` | yes | true or false |
| `follow_me` | yes | true or false |

12
source/_integrations/eddystone_temperature.markdown
View File

@ -9,14 +9,17 @@ ha_domain: eddystone_temperature
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature).
All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](https://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google.
The `eddystone_temperature` sensor {% term integration %} reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature).
All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this {% term integration %}. For example [Gimbal](https://store.gimbal.com/collections/beacons/), [Estimote](https://estimote.com/) or [kontakt.io](https://kontakt.io/). For more manufacturers see [this overview](https://developers.google.com/beacons/eddystone#beacon_manufacturers) by Google.
## Requirements
As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed:
As this {% term integration %} uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed:
```bash
sudo apt-get install libbluetooth-dev
@ -29,7 +32,8 @@ sudo apt-get install libcap2-bin
sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))
```
To use your Eddystone beacon in your installation, add the following to your `configuration.yaml` file:
To use your Eddystone beacon 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

8
source/_integrations/edimax.markdown
View File

@ -9,11 +9,15 @@ ha_domain: edimax
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This `edimax` switch platform allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
This `edimax` switch {% term integration %} allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
To use your Edimax switch in your installation, add the following to your `configuration.yaml` file:
To use your Edimax switch 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

6
source/_integrations/egardia.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Egardia** {% term integration %} enables the ability to control an [Egardia](https://egardia.com/)/[Woonveilig](https://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically.
@ -22,7 +25,8 @@ You will need to know the IP of your alarm panel on your local network. Test if
## Basic configuration
To enable the {% term integration %} with your alarm panel, add the following lines to your `configuration.yaml` file:
To enable the {% term integration %} with your alarm panel, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/eliqonline.markdown
View File

@ -9,11 +9,15 @@ ha_domain: eliqonline
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Integrate your [ELIQ Online](https://eliq.io/) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account.
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

77
source/_integrations/elkm1.markdown
View File

@ -27,6 +27,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation.
@ -91,12 +94,12 @@ If you are using the features below then these respective global options
should be enabled:
| Option # | Option Name | Description |
| ---------------------- | -------- | ----------- |
| 36 | Transmit Zone Changes | If you are using Zones this allows Home Assistant to track the status of the Zones.
| 37 | Transmit Output Changes | If you are using Outputs this allows Home Assistant to track the status of the Outputs.
| 38 | Transmit Automation Task Changes | If you are using ElkM1 Tasks this allows Home Assistant to track the status of the Tasks.
| 39 | Transmit Light Changes | If you are using ElkM1 Lights this allows Home Assistant to track the status of the lights.
| 40 | Transmit Keypad Changes | Oddly, this option tracks keypad changes and alarm status. If you are wishing to track keypresses on ElkM1 keypad or if you are wishing to track the armed, disarmed, and alarm state of the ElkM1 then this option should be set.
| -------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 36 | Transmit Zone Changes | If you are using Zones this allows Home Assistant to track the status of the Zones. |
| 37 | Transmit Output Changes | If you are using Outputs this allows Home Assistant to track the status of the Outputs. |
| 38 | Transmit Automation Task Changes | If you are using ElkM1 Tasks this allows Home Assistant to track the status of the Tasks. |
| 39 | Transmit Light Changes | If you are using ElkM1 Lights this allows Home Assistant to track the status of the lights. |
| 40 | Transmit Keypad Changes | Oddly, this option tracks keypad changes and alarm status. If you are wishing to track keypresses on ElkM1 keypad or if you are wishing to track the armed, disarmed, and alarm state of the ElkM1 then this option should be set. |
## System Trouble Status
@ -463,9 +466,9 @@ Arms the ElkM1 area in "home instant", "night instant", or "vacation" modes
respectively.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 area which to arm.
| `code` | no | Alarm code to arm the system (4 or 6 digits).
| ---------------------- | -------- | --------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to arm. |
| `code` | no | Alarm code to arm the system (4 or 6 digits). |
### Services `elkm1.alarm_bypass` and `elkm1.alarm_clear_bypass`
@ -473,22 +476,22 @@ For all zones associated with the specified alarm panel these services respectiv
bypass or clear the bypass the zones.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 area which to bypass or clear bypass.
| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits).
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to bypass or clear bypass. |
| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits). |
### Service `elkm1.alarm_display_message`
Display text on an area's keypads.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 area which to display the message.
| `clear` | yes | 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2
| `beep` | yes | 0=no beep, 1=beep; default 0
| `timeout` | yes | Time to display message, 0=forever, max 65535, default 0
| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank.
| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank.
| ---------------------- | -------- | ------------------------------------------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to display the message. |
| `clear` | yes | 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2 |
| `beep` | yes | 0=no beep, 1=beep; default 0 |
| `timeout` | yes | Time to display message, 0=forever, max 65535, default 0 |
| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
### Service `elkm1.sensor_counter_refresh`
@ -497,17 +500,17 @@ panel does not automatically send a new value under certain
conditions. This service retrieves the current counter value.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 counter to refresh.
| ---------------------- | -------- | ------------------------- |
| `entity_id` | yes | ElkM1 counter to refresh. |
### Service `elkm1.sensor_counter_set`
Set counter to value.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 counter to refresh.
| `value` | no | Value to set the counter to Can be 0-65536.
| ---------------------- | -------- | ------------------------------------------- |
| `entity_id` | yes | ElkM1 counter to refresh. |
| `value` | no | Value to set the counter to Can be 0-65536. |
### Service `elkm1.sensor_zone_bypass`
@ -515,9 +518,9 @@ Bypass a zone. Note that the only mechanism ElkM1 offers to clear the bypass
is to clear all the bypassed zones in a given alarm panel (area).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 zone which to bypass.
| `code` | no | Alarm code to bypass the zone (4 or 6 digits).
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | yes | ElkM1 zone which to bypass. |
| `code` | no | Alarm code to bypass the zone (4 or 6 digits). |
### Service `elkm1.sensor_zone_trigger`
@ -525,34 +528,34 @@ Cause a zone on the panel to trigger. This command creates a virtual momentary
open condition on the zone as if the EOL hardwired loop had been physically opened.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 zone which to trigger.
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | yes | ElkM1 zone which to trigger. |
### Service `elkm1.set_time`
Set the time on the panel. Uses the current time on the instance of Home Assistant.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `prefix` | yes | Prefix to identify panel when multiple panels configured.
| ---------------------- | -------- | --------------------------------------------------------- |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_phrase`
Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `phrase` | no | Phrase to speak.
| `prefix` | yes | Prefix to identify panel when multiple panels configured.
| ---------------------- | -------- | --------------------------------------------------------- |
| `phrase` | no | Phrase to speak. |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_word`
Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documentation.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `word` | no | Word to speak.
| `prefix` | yes | Prefix to identify panel when multiple panels configured.
| ---------------------- | -------- | --------------------------------------------------------- |
| `word` | no | Word to speak. |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
## Debugging
Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).

10
source/_integrations/elv.markdown
View File

@ -11,13 +11,17 @@ ha_domain: elv
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `pca` switch platform allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex).
The `pca` switch {% term integration %} allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex).
## Configuration
To use your PCA 301 switch or socket in your installation, add the following to your `configuration.yaml` file:
To use your PCA 301 switch or socket 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
@ -25,7 +29,7 @@ elv:
device: SERIAL_PORT
```
This platform will add all PCA 301 switches which are in range. You can read the total used energy in kWh and the current power in Watt.
This {% term integration %} will add all PCA 301 switches which are in range. You can read the total used energy in kWh and the current power in Watt.
{% configuration %}
device:

6
source/_integrations/emby.markdown
View File

@ -11,11 +11,15 @@ ha_domain: emby
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Emby** {% term integration %} allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant.
To add Emby to your installation, add the following to your `configuration.yaml` file:
To add Emby 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

10
source/_integrations/emoncms.markdown
View File

@ -11,11 +11,15 @@ ha_codeowners:
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `emoncms` sensor platform creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org).
The `emoncms` sensor {% term integration %} creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org).
To enable this sensor, add the following lines to your `configuration.yaml`, it will list all feeds as a sensor:
To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file. It will list all feeds as a sensor.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry using cloud based Emoncms
@ -28,7 +32,7 @@ sensor:
As of Feb 2020, the integration will discover all sensors from Emoncms and will use the unit of measurement specified in the Feed from Emoncms, in preference to the one set in the configuration. Tested with [Emoncms](https://github.com/emoncms/emoncms) V10.1.13 - `unit` was added to the API around version V9.9.1.
To write information from Home Assistant to Emoncms, you can use the [`emoncms_history`](/integrations/emoncms_history) integration.
To write information from Home Assistant to Emoncms, you can use the [`emoncms_history`](/integrations/emoncms_history) {% term integration %}.
## Configuration variables

8
source/_integrations/emoncms_history.markdown
View File

@ -7,11 +7,15 @@ ha_iot_class: Local Polling
ha_release: 0.31
ha_domain: emoncms_history
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `emoncms_history` integration makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
The `emoncms_history` {% term integration %} makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file:
To use the `emoncms_history` {% 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

8
source/_integrations/emulated_hue.markdown
View File

@ -11,6 +11,9 @@ ha_integration_type: integration
ha_codeowners:
- '@bdraco'
- '@Tho85'
related:
- docs: /docs/configuration/
title: Configuration file
---
<div class='note warning'>
@ -19,7 +22,7 @@ Be aware that `emulated_hue` doesn't work for new users of **Google Home** with
</div>
The `emulated_hue` integration provides a virtual [Philips Hue](https://www.philips-hue.com) bridge, written entirely in software that allows services that work with the Hue API to interact with Home Assistant
The `emulated_hue` {% term integration %} provides a virtual [Philips Hue](https://www.philips-hue.com) bridge, written entirely in software that allows services that work with the Hue API to interact with Home Assistant
entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes.
The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.
@ -53,7 +56,8 @@ Logitech Harmony remotes cannot connect to this emulator via Android and iOS mob
### Configuration
To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file:
To enable the emulated Hue bridge, add one of the following configs to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Google Home example configuration.yaml entry

8
source/_integrations/emulated_kasa.markdown
View File

@ -10,9 +10,12 @@ ha_codeowners:
ha_domain: emulated_kasa
ha_quality_scale: internal
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Emulated Kasa integration emulates a TP-Link Kasa smart plug and announces the power usage of configured devices to any that might request it on the local network.
The Emulated Kasa {% term integration %} emulates a TP-Link Kasa smart plug and announces the power usage of configured devices to any that might request it on the local network.
For example, the [Sense Energy Monitor](/integrations/sense) can use this to identify power usage.
@ -28,7 +31,8 @@ The provided power unit must be the current power usage in Watts. Values of `kW
## Configuration
This integration requires the entities exposed to be listed in your `configuration.yaml` file:
This {% term integration %} requires the entities exposed to be listed in your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

10
source/_integrations/emulated_roku.markdown
View File

@ -8,9 +8,12 @@ ha_iot_class: Local Push
ha_config_flow: true
ha_domain: emulated_roku
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This integration integrates an emulated Roku API into Home Assistant,
The **Emulated Roku** {% term integration %} integrates an emulated Roku API into Home Assistant,
so remotes such as Harmony and Android apps can connect to it through Wi-Fi as if it were a Roku player.
Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations.
Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries.
@ -23,7 +26,7 @@ Windows is not supported because Home Assistant uses `ProactorEventLoop` which d
<div class='note warning'>
This integration opens an unauthenticated API on the host, allowing anything on the local network to access
This {% term integration %} opens an unauthenticated API on the host, allowing anything on the local network to access
your Home Assistant instance through the automations you create with emulated Roku as the trigger.
Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's IP or DNS name)
@ -33,7 +36,8 @@ Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip`
## Manual configuration
If you wish to configure advanced options, you can add the following entry in `configuration.yaml`.
If you wish to configure advanced options, you can add the following entry in your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/enocean.markdown
View File

@ -19,6 +19,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary.
@ -65,7 +68,8 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec
- F6-02-01 (Light and Blind Control - Application Style 2)
- F6-02-02 (Light and Blind Control - Application Style 1)
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

2
source/_integrations/entur_public_transport.markdown
View File

@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
The `entur_public_transport` sensor gives real-time departure information for the next departures from any bus stop, car ferry quay, train station, airport and person ferries quay in Norway.
The `entur_public_transport` {% term integration %} gives real-time departure information for the next departures from any bus stop, car ferry quay, train station, airport and person ferries quay in Norway.
For each stop place given in the configuration, a sensor will be mounted for that stop place. It will give remaining minutes until the nearest departure in the state, but also next departures in the attributes. Information about if the departure is monitored in real-time or is from scheduled times, and how many minutes there is in delays, are included as well.

12
source/_integrations/envisalink.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Envisalink** {% term integration %} will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4.
@ -30,7 +33,8 @@ This is a fully event-based integration. Any event sent by the Envisalink device
As of 0.29, the alarm_trigger service is supported. It is possible to fire off an envisalink-based alarm directly from Home Assistant. For example, a newer Z-Wave/Zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
An `envisalink` 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
@ -152,7 +156,7 @@ The zone status binary sensors have extra attributes representing additional
information about each zone.
| Name | Description |
| ---- | ----------- |
| `last_tripped_time` | Last time this zone was tripped.
| `zone` | Zone number. Can be used in combination with `alarm_keypress` service
| ------------------- | --------------------------------------------------------------------- |
| `last_tripped_time` | Last time this zone was tripped. |
| `zone` | Zone number. Can be used in combination with `alarm_keypress` service |
to issue commands relating to this zone.

6
source/_integrations/etherscan.markdown
View File

@ -9,11 +9,15 @@ ha_domain: etherscan
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `Etherscan` sensor platform displays Ether and ERC-20 token balances from [Etherscan.io](https://etherscan.io).
To add the Etherscan sensor to your installation, specify an Ethereum address to watch in the `configuration.yaml` file. You can also optionally provide a token name to retrieve and ERC-20 token balance. If no token is provided then the balance retrieved will be in ETH. You can also optionally provide the token contract address in case the token name is not found.
To add the Etherscan sensor to your installation, specify an Ethereum address to watch in the {% term "`configuration.yaml`" %} file. You can also optionally provide a token name to retrieve and ERC-20 token balance. If no token is provided then the balance retrieved will be in ETH. You can also optionally provide the token contract address in case the token name is not found.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/eufy.markdown
View File

@ -12,16 +12,20 @@ ha_platforms:
- light
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The EufyHome integration is the main integration to integrate [eufy](https://eufy.com/) devices sold under the EufyHome product line with Home Assistant.
The **EufyHome** {% term integration %} is the main integration to integrate [eufy](https://eufy.com/) devices sold under the EufyHome product line with Home Assistant.
There is currently support for the following device types within Home Assistant:
- Light
- Switch
Supported devices will be discovered after the EufyHome integration is configured:
Supported devices will be discovered after the EufyHome integration is added to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/everlights.markdown
View File

@ -9,13 +9,17 @@ ha_domain: everlights
ha_platforms:
- light
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box.
### Configuration details
To enable EverLights, add the following lines to your `configuration.yaml` file:
To enable EverLights, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/evohome.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- climate
- water_heater
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Evohome** {% term integration %} links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
@ -29,7 +32,8 @@ For your system to be compatible with this integration, then you must be able to
## Configuration
To set up this integration, add the following to your `configuration.yaml` file:
To set up this integration, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry