mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 09:46:59 +00:00
d and e integrations: apply sentence-style capitalization (#29901)
* d and e integrations: apply sentence-style capitalization - add references to glossary terms * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> * Apply suggestions from code review Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * Fix typo --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
c0ffeeca7
GitHub
parent
530204bb23
commit
4bb544e615
@ -2,9 +2,9 @@
|
||||
title: Dacia
|
||||
description: Connect and control your Dacia devices using the Renault integration
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Car
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
- Select
|
||||
- Sensor
|
||||
ha_domain: dacia
|
||||
|
||||
@ -25,7 +25,7 @@ ha_integration_type: integration
|
||||
Daikin has removed their local API in newer products. They offer a cloud API accessible only under NDA, which is incompatible with open source. This affects units fitted with the BRP069C4x wifi adapter. Units listed under Supported Hardware below continue to have access to local control. Additionally the older but commonly available BRP072A42 adapter can be fitted to most if not all newer units for access to local control.
|
||||
</p>
|
||||
|
||||
The `daikin` integration integrates Daikin air conditioning systems into Home Assistant.
|
||||
The **Daikin** {% term integration %} integrates Daikin air conditioning systems into Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
@ -143,7 +143,7 @@ Zones with the name `-` will be ignored, just as the AirBase application is work
|
||||
|
||||
Additionally the Daikin Streamer (air purifier) function can be toggled on supported devices using a switch. Note that it isn't currently possible to reliably detect whether a specific device has streamer support, so the switch may appear in the UI even if the functionality isn't actually supported.
|
||||
|
||||
## Region Changing
|
||||
## Region changing
|
||||
|
||||
The European and United States controllers (Most likely the Australian controllers too) have an HTTP API endpoint that allows you to change the controllers region so that other regional apps can be used. (Sometimes these controllers get exported to regions that can not download the app for the controllers region.)
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Danfoss Air
|
||||
description: How to integrate Danfoss Air HRV in Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
- Switch
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit.
|
||||
The **Danfoss Air** {% term integration %} allows you to access information from your Danfoss Air HRV unit.
|
||||
|
||||
*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the integration will not work while you have the HRV PC-Tool open.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ ha_domain: datadog
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
|
||||
The **Datadog** {% term integration %} sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
|
||||
|
||||
Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc.
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ ha_codeowners:
|
||||
ha_integration_type: entity
|
||||
---
|
||||
|
||||
The date integration is built for the controlling and monitoring of dates on devices.
|
||||
The **Date** {% term integration %} is built for the controlling and monitoring of dates on devices.
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
||||
@ -19,13 +19,13 @@ If you are looking for a way to create a similar entity, please take a look at t
|
||||
|
||||
## Services
|
||||
|
||||
### date services
|
||||
### Date services
|
||||
|
||||
Available services: `date.set_value`
|
||||
Available {% term services %}: `date.set_value`
|
||||
|
||||
### Service `date.set_value`
|
||||
|
||||
Set a new value for the date entity.
|
||||
Set a new value for the date {% term entity %}.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
|
||||
@ -11,7 +11,7 @@ ha_codeowners:
|
||||
ha_integration_type: entity
|
||||
---
|
||||
|
||||
The Date/Time integration is built for the controlling and monitoring of timestamps on devices.
|
||||
The **Date/Time** {% term integration %} is built for the controlling and monitoring of timestamps on devices.
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
||||
@ -21,11 +21,11 @@ If you are looking for a way to create a Date/Time entity, please take a look at
|
||||
|
||||
### datetime services
|
||||
|
||||
Available services: `datetime.set_value`
|
||||
Available {% term services %}: `datetime.set_value`
|
||||
|
||||
### Service `datetime.set_value`
|
||||
|
||||
Set a new value for the datetime entity.
|
||||
Set a new value for the datetime {% term entity %}.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: DD-WRT
|
||||
description: Instructions on how to integrate DD-WRT based routers into Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: pre 0.7
|
||||
ha_domain: ddwrt
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Remote Python Debugger
|
||||
description: Remote Python Debugger (debugpy) for Visual Studio Code
|
||||
title: Remote Python debugger
|
||||
description: Remote Python debugger (debugpy) for Visual Studio Code
|
||||
ha_category:
|
||||
- Utility
|
||||
ha_release: 0.112
|
||||
@ -12,7 +12,7 @@ ha_iot_class: Local Push
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
The remote Python debugger integration allows you to use the Visual Studio Code
|
||||
The **Remote Python debugger** {% term integration %} allows you to use the Visual Studio Code
|
||||
Python debug tooling with a remote Home Assistant instance.
|
||||
|
||||
It uses Microsoft's `debugpy` library which is the successor of `ptvsd`, and
|
||||
@ -69,7 +69,7 @@ Home Assistant instance, which is very unsafe.
|
||||
If the Home Assistant instance is behind your firewall with only the http(s) port
|
||||
exposed, then this is safe from outside connections.
|
||||
|
||||
## Performance and Memory Use
|
||||
## Performance and memory use
|
||||
|
||||
Using the debugger (even when not attached), increases memory usage and
|
||||
decreases performance. It is not recommended to configure the debugger on a
|
||||
|
||||
@ -3,7 +3,7 @@ title: deCONZ
|
||||
description: Instructions on how to setup ConBee/RaspBee devices with deCONZ from dresden elektronik within Home Assistant.
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Cover
|
||||
- Fan
|
||||
- Hub
|
||||
@ -45,8 +45,8 @@ ha_integration_type: hub
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Alarm Control Panel](#alarm-control-panel)
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Alarm control panel](#alarm-control-panel)
|
||||
- [Binary sensor](#binary-sensor)
|
||||
- [Climate](#climate)
|
||||
- [Cover](#cover)
|
||||
- [Light](#light)
|
||||
@ -67,7 +67,7 @@ See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
Running a stand-alone instance of deCONZ (non add-on installation) requires a pairing between the deCONZ gateway and Home Assistant. To allow Home Assistant to connect with deCONZ go to the Phoscon **UI click Settings -> Gateway -> Advanced** and press the "Authenticate app" button. This same information is also shown during the config flow of the deCONZ integration.
|
||||
Running a stand-alone instance of deCONZ (non add-on installation) requires a pairing between the deCONZ gateway and Home Assistant. To allow Home Assistant to connect with deCONZ go to the Phoscon UI select **Settings** > **Gateway** > **Advanced** and select the **Authenticate app** button. This same information is also shown during the config flow of the deCONZ integration.
|
||||
|
||||
## Debugging integration
|
||||
|
||||
@ -87,7 +87,7 @@ If you are having issues and want to report a problem, always start with making
|
||||
|
||||
### No state updates
|
||||
|
||||
If the state of entities are only reflected in Home Assistant when the integration is loaded (during restart, reload, setup) you probably have an issue with the WebSocket configuration where your deCONZ instance is running. The deCONZ integration uses the WebSocket port provided by the deCONZ REST API. If you're running the deCONZ Docker container make sure that it properly configures the WebSocket port so deCONZ can report what port is exposed outside of the containerized environment. Also, make sure to review firewall rules that might block communication over certain ports.
|
||||
If the state of {% term entities %} are only reflected in Home Assistant when the {% term integration %} is loaded (during restart, reload, setup) you probably have an issue with the WebSocket configuration where your deCONZ instance is running. The deCONZ integration uses the WebSocket port provided by the deCONZ REST API. If you're running the deCONZ Docker container make sure that it properly configures the WebSocket port so deCONZ can report what port is exposed outside of the containerized environment. Also, make sure to review firewall rules that might block communication over certain ports.
|
||||
|
||||
## Device services
|
||||
|
||||
@ -125,13 +125,13 @@ Either `entity` or `field` must be provided. If both are present, `field` will b
|
||||
|
||||
Refresh with devices added to deCONZ after Home Assistants latest restart.
|
||||
|
||||
Note: deCONZ automatically signals Home Assistant when new sensors are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
|
||||
Note: deCONZ automatically signals Home Assistant when new {% term sensors %} are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
|
||||
|
||||
### Service `deconz.remove_orphaned_entries`
|
||||
|
||||
Remove entries from entity and device registry which are no longer provided by deCONZ.
|
||||
Remove entries from {% term entity %} and device registry which are no longer provided by deCONZ.
|
||||
|
||||
Note: it is recommended to use this service after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
|
||||
Note: it is recommended to use this {% term service %} after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
|
||||
|
||||
## Remote control devices
|
||||
|
||||
@ -312,14 +312,14 @@ automation:
|
||||
|
||||
The `entity_id` name will be `platform.device_name`, where `device_name` is defined in deCONZ.
|
||||
|
||||
### Alarm Control Panel
|
||||
### Alarm control panel
|
||||
|
||||
The entity of a physical keypad. Can be in 4 different modes (`arm_away`, `arm_home`, `arm_night` or `disarmed`). Changing the state will do an audible notification from the keypad.
|
||||
|
||||
The Device also exposes a new event type `deconz_alarm_event` which reflects signals not supported within the Alarm Control Panel platform.
|
||||
The Device also exposes a new event type `deconz_alarm_event` which reflects signals not supported within the alarm control panel platform.
|
||||
The Payload consists of an event (`emergency`, `fire`, `invalid_code` or `panic`).
|
||||
|
||||
### Binary Sensor
|
||||
### Binary sensor
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
@ -362,7 +362,7 @@ The `entity_id` name will be `scene.group_scene_name`, where `group` is which gr
|
||||
|
||||
The following sensor types are supported:
|
||||
|
||||
- Air Quality sensor
|
||||
- Air quality sensor
|
||||
- Battery sensor
|
||||
- Consumption sensor
|
||||
- Daylight
|
||||
|
||||
@ -11,7 +11,7 @@ ha_codeowners:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
|
||||
This {% term integration %} is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
|
||||
|
||||
- [Automation](/integrations/automation/) (`automation`)
|
||||
- [Assist pipeline](/integrations/assist_pipeline/) (`assist_pipeline`)
|
||||
@ -20,7 +20,7 @@ This integration is a meta-component and configures a default set of integration
|
||||
- [Configuration](/integrations/config/) (`config`)
|
||||
- [Conversation](/integrations/conversation/) (`conversation`)
|
||||
- [Counter](/integrations/counter/) (`counter`)
|
||||
- [DHCP Discovery](/integrations/dhcp/) (`dhcp`)
|
||||
- [DHCP discovery](/integrations/dhcp/) (`dhcp`)
|
||||
- [Energy](/integrations/energy/) (`energy`)
|
||||
- [Frontend](/integrations/frontend/) (`frontend`)
|
||||
- [Hardware](/integrations/hardware/) (`hardware`)
|
||||
@ -37,8 +37,8 @@ This integration is a meta-component and configures a default set of integration
|
||||
- [Logbook](/integrations/logbook/) (`logbook`)
|
||||
- [Logger](/integrations/logger/) (`logger`)
|
||||
- [Map](/integrations/map/) (`map`)
|
||||
- [Media Source](/integrations/media_source/) (`media_source`)
|
||||
- [Mobile App Support](/integrations/mobile_app/) (`mobile_app`)
|
||||
- [Media source](/integrations/media_source/) (`media_source`)
|
||||
- [Mobile app support](/integrations/mobile_app/) (`mobile_app`)
|
||||
- [My Home Assistant](/integrations/my/) (`my`)
|
||||
- [Network](/integrations/network/) (`network`)
|
||||
- [Person](/integrations/person/) (`person`)
|
||||
@ -48,7 +48,7 @@ This integration is a meta-component and configures a default set of integration
|
||||
- [Simple Service Discovery Protocol (SSDP)](/integrations/ssdp/) (`ssdp`)
|
||||
- [Stream](/integrations/stream/) (`stream`)
|
||||
- [Sun](/integrations/sun/) (`sun`)
|
||||
- [System Health](/integrations/system_health/) (`system_health`)
|
||||
- [System health](/integrations/system_health/) (`system_health`)
|
||||
- [Tag](/integrations/tag/) (`tag`)
|
||||
- [Timer](/integrations/timer/) (`timer`)
|
||||
- [USB](/integrations/usb/) (`usb`)
|
||||
|
||||
@ -50,7 +50,7 @@ The `demo` platform allows you to use integrations which are providing a demo of
|
||||
|
||||
Available demo platforms:
|
||||
|
||||
- [Air Quality](/integrations/air_quality/) (`air_quality`)
|
||||
- [Air quality](/integrations/air_quality/) (`air_quality`)
|
||||
- [Alarm control panel](/integrations/alarm_control_panel/) (`alarm_control_panel`)
|
||||
- [Binary sensor](/integrations/binary_sensor/) (`binary_sensor`)
|
||||
- [Button](/integrations/button/) (`button`)
|
||||
@ -58,15 +58,15 @@ Available demo platforms:
|
||||
- [Camera](/integrations/camera/) (`camera`)
|
||||
- [Climate](/integrations/climate/) (`climate`)
|
||||
- [Cover](/integrations/cover/) (`cover`)
|
||||
- [Device Tracker](/integrations/device_tracker/) (`device_tracker`)
|
||||
- [Device tracker](/integrations/device_tracker/) (`device_tracker`)
|
||||
- [Fan](/integrations/fan/) (`fan`)
|
||||
- [Geolocation](/integrations/geo_location/) (`geo_location`)
|
||||
- [Humidifier](/integrations/humidifier/) (`humidifier`)
|
||||
- [Image Processing](/integrations/image_processing/) (`image_processing`)
|
||||
- [Image processing](/integrations/image_processing/) (`image_processing`)
|
||||
- [Light](/integrations/light/) (`light`)
|
||||
- [Lock](/integrations/lock/) (`lock`)
|
||||
- [Mailbox](/integrations/mailbox/) (`mailbox`)
|
||||
- [Media Player](/integrations/media_player/) (`media_player`)
|
||||
- [Media player](/integrations/media_player/) (`media_player`)
|
||||
- [Notification](/integrations/notify/) (`notify`)
|
||||
- [Number](/integrations/number/) (`number`)
|
||||
- [Remote](/integrations/remote/) (`remote`)
|
||||
@ -78,7 +78,7 @@ Available demo platforms:
|
||||
- [Text-to-speech](/integrations/tts/) (`tts`)
|
||||
- [Update](/integrations/update/) (`update`)
|
||||
- [Vacuum](/integrations/vacuum/) (`vacuum`)
|
||||
- [Water Heater](/integrations/water_heater/) (`water_heater`)
|
||||
- [Water heater](/integrations/water_heater/) (`water_heater`)
|
||||
- [Weather](/integrations/weather/) (`weather`)
|
||||
|
||||
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Denon Network Receivers
|
||||
description: Instructions on how to integrate Denon Network Receivers into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.7.2
|
||||
ha_domain: denon
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Denon AVR Network Receivers
|
||||
description: Instructions on how to integrate Denon AVR Network Receivers into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.7.2
|
||||
ha_domain: denonavr
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
---
|
||||
title: Presence-based Lights
|
||||
title: Presence-based lights
|
||||
description: Instructions on how to automate your lights with Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Light
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_iot_class: Calculated
|
||||
ha_release: pre 0.7
|
||||
ha_quality_scale: internal
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Device Tracker
|
||||
title: Device tracker
|
||||
description: Instructions on how to setup device tracking within Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: device_tracker
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
---
|
||||
title: "MQTT Device Tracker"
|
||||
title: "MQTT device tracker"
|
||||
description: "Instructions on how to use MQTT to track devices in Home Assistant."
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_iot_class: Configurable
|
||||
ha_release: 0.7.3
|
||||
ha_domain: mqtt
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
---
|
||||
title: "Xiaomi Router"
|
||||
title: "Xiaomi router"
|
||||
description: "Instructions on how to integrate Xiaomi routers into Home Assistant."
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_release: 0.36
|
||||
ha_domain: xiaomi
|
||||
---
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
---
|
||||
title: "MQTT Device Trigger"
|
||||
title: "MQTT Device trigger"
|
||||
description: "Instructions on how to integrate MQTT device triggers within Home Assistant."
|
||||
ha_category:
|
||||
- Device Automation
|
||||
- Device automation
|
||||
ha_release: 0.106
|
||||
ha_iot_class: Configurable
|
||||
ha_domain: mqtt
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: devolo Home Control
|
||||
description: Instructions on how to integrate devolo Home Control with Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Light
|
||||
|
||||
@ -2,10 +2,10 @@
|
||||
title: devolo Home Network
|
||||
description: Instructions on how to integrate devolo Home Network devices with Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Image
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
- Sensor
|
||||
- Switch
|
||||
- Update
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: DHCP Discovery
|
||||
title: DHCP discovery
|
||||
description: Discover integrations on the network using DHCP protocol.
|
||||
ha_category:
|
||||
- Network
|
||||
@ -12,11 +12,11 @@ ha_codeowners:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The `dhcp` "DHCP Discovery" integration will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel.
|
||||
The **DHCP discovery** {% term integration %} will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel.
|
||||
|
||||
## Configuration
|
||||
|
||||
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||
This {% term integration %} is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -11,14 +11,14 @@ ha_codeowners:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The diagnostics integration provides a way to download diagnostic data from
|
||||
a device or integration, that can be shared in issue reports. Sharing
|
||||
The diagnostics {% term integration %} provides a way to download diagnostic data from
|
||||
a {% term device %} or {% term integration %}, that can be shared in issue reports. Sharing
|
||||
diagnostics data when reporting an issue allows developers to diagnose
|
||||
and fix your reported problem quicker.
|
||||
|
||||
<p class='img'>
|
||||
<img class="no-shadow" src='/images/blog/2022-02/diagnostics.png' alt='Screenshot showing the Download Diagnostics button on a Sonos device page'>
|
||||
Screenshot of the Download Diagnostics button on the device page
|
||||
Screenshot of the download diagnostics button on the device page
|
||||
</p>
|
||||
|
||||
Diagnostics data is provided by an integration, and can be downloaded
|
||||
|
||||
@ -10,7 +10,7 @@ ha_domain: dialogflow
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `dialogflow` integration is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
||||
The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
|
||||
|
||||
To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Digital Loggers
|
||||
description: Connect and control your Digital Loggers devices using the Belkin WeMo integration
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Fan
|
||||
- Hub
|
||||
- Light
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: Digital Ocean
|
||||
description: Instructions on how to integrate the Digital Ocean within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Switch
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_release: '0.30'
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
@ -16,11 +16,11 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
|
||||
The **Digital Ocean** {% term integration %} allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](/integrations/digital_ocean/#binary-sensor)
|
||||
- [Binary sensor](/integrations/digital_ocean/#binary-sensor)
|
||||
- [Switch](/integrations/digital_ocean/#switch)
|
||||
|
||||
## Setup
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: DirecTV
|
||||
description: Instructions on how to integrate DirecTV receivers into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
- Remote
|
||||
ha_release: 0.25
|
||||
ha_iot_class: Local Polling
|
||||
@ -22,7 +22,7 @@ The DirecTV platform allows you to control a [DirecTV](https://www.directv.com)
|
||||
|
||||
For proper integration with Home Assistant, your DirecTV device settings should allow "External Access".
|
||||
|
||||
This is done via series of settings found via "Menu > Settings & Help > Settings > Whole Home > External Device":
|
||||
This is done via series of settings found via **Menu** > **Settings & Help** > **Settings** > **Whole Home** > **External Device**:
|
||||
|
||||
- External Access: Allow
|
||||
- Current Program: Allow
|
||||
@ -34,7 +34,7 @@ This is done via series of settings found via "Menu > Settings & Help > Settings
|
||||
|
||||
### Media control services
|
||||
|
||||
Available services: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
|
||||
Available {% term services %}: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
|
||||
|
||||
#### Service `media_player.play_media`
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ This channel or a user ID has to be used as the target when calling the notifica
|
||||
|
||||
When adding the Discord integration you will be asked for an API Key. Enter the hidden **Token** of your bot to link your Discord integration to the bot you created and allow Home Assistant to send messages as that bot.
|
||||
|
||||
## Discord Service Data
|
||||
## Discord service data
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
The `discovergy` integration allows users to integrate their [Discovergy](https://discovergy.com/) smart meters into Home Assistant.
|
||||
The **Discovergy** {% term integration %} allows users to integrate their [Discovergy](https://discovergy.com/) smart meters into Home Assistant.
|
||||
The integration is using the [official REST API](https://api.discovergy.com/docs/#/) by Discovergy.
|
||||
|
||||
The integration supports the following meters within Home Assistant:
|
||||
@ -26,17 +26,17 @@ The integration supports the following meters within Home Assistant:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
For this integration, you need a Discovergy smart meter, a [Discovergy account](https://my.discovergy.com/) and your credentials.
|
||||
For this {% term integration %}, you need a Discovergy smart meter, a [Discovergy account](https://my.discovergy.com/) and your credentials.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Electricity meter
|
||||
|
||||
Sensor entities are being added for current active power usage and the all-time total consumption.
|
||||
Sensor {% term entities %} are being added for current active power usage and the all-time total consumption.
|
||||
By default, the sensors for phase-specific current active power usage are disabled.
|
||||
|
||||
In case you have a combined meter for consumption and production, the all-time total production is added as well.
|
||||
|
||||
## Gas meter
|
||||
|
||||
A Sensor entity is being added for total gas consumption.
|
||||
A Sensor {% term entity %} is being added for total gas consumption.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Dlib Face Detect
|
||||
description: Instructions on how to integrate Dlib Face Detect into Home Assistant.
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.44
|
||||
ha_domain: dlib_face_detect
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Dlib Face Identify
|
||||
description: Instructions on how to integrate Dlib Face Identify into Home Assistant.
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.44
|
||||
ha_domain: dlib_face_identify
|
||||
|
||||
@ -15,7 +15,7 @@ ha_codeowners:
|
||||
ha_integration_type: device
|
||||
---
|
||||
|
||||
The D-Link Wi-Fi Smart Plugs integration allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-home).
|
||||
The **D-Link Wi-Fi Smart Plugs** {% term integration %} allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-home).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -26,4 +26,4 @@ Supported devices (tested):
|
||||
|
||||
Password: The default password is the PIN included on the configuration card or on the back of the unit.
|
||||
|
||||
Use the legacy protocol in case the integration does not work. This enables limited support for legacy firmware protocols (Tested with v1.24, v1.26). Data such as power consumption will not be available. The temperature will also show a freezing level.
|
||||
Use the legacy protocol in case the D-Link Wi-Fi Smart Plugs does not work. This enables limited support for legacy firmware protocols (Tested with v1.24, v1.26). Data such as power consumption will not be available. The temperature will also show a freezing level.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: DLNA Digital Media Renderer
|
||||
description: Instructions on how to integrate a DLNA DMR device into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: 0.76
|
||||
ha_iot_class: Local Push
|
||||
ha_config_flow: true
|
||||
@ -16,7 +16,7 @@ ha_ssdp: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
|
||||
The **DLNA Digital Media Renderer** {% term integration %} allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
|
||||
|
||||
Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)).
|
||||
|
||||
@ -24,7 +24,7 @@ Please note that some devices, such as Samsung TVs, are rather picky about the s
|
||||
|
||||
## Options
|
||||
|
||||
Options for DLNA DMR devices can be set going to **Settings** -> **Devices & Services** -> **DLNA Digital Media Renderer** -> **Configuration**.
|
||||
Options for DLNA DMR devices can be set going to **Settings** > **Devices & Services** > **DLNA Digital Media Renderer** > **Configuration**.
|
||||
|
||||
{% configuration_basic %}
|
||||
Event listener port:
|
||||
@ -59,4 +59,4 @@ Most DLNA DMR devices can play media from local HTTP servers. For best results,
|
||||
|
||||
### Media sources
|
||||
|
||||
The DLNA Digital Media Renderer integration can browse any configured [Media Source](/integrations/media_source/). Displayed media will be filtered based on the capabilities of the DLNA DMR device.
|
||||
The DLNA Digital Media Renderer integration can browse any configured [media source](/integrations/media_source/). Displayed media will be filtered based on the capabilities of the DLNA DMR device.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: DLNA Digital Media Server
|
||||
description: Instructions on how to access media stored on a DLNA DMS device with Home Assistant.
|
||||
ha_category:
|
||||
- Media Source
|
||||
- Media source
|
||||
ha_release: 2022.3
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
|
||||
@ -14,9 +14,9 @@ ha_codeowners:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The DNS IP integration will expose an IP address, fetched via DNS resolution (every 2 minutes), as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
|
||||
The **DNS IP** {% term integration %} will expose an IP address, fetched via DNS resolution (every 2 minutes), as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
|
||||
|
||||
1. When you enable the integration with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
|
||||
1. When you enable the {% term integration %} with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
|
||||
2. If you specify a `hostname`, a regular DNS lookup will be performed, providing you the IP the hostname resolves to.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -9,17 +9,17 @@ ha_domain: dominos
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
|
||||
The **Dominos Pizza** {% term integration %} allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
|
||||
|
||||
At present, this integration only supports ordering within Canada and the US.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable the integration, you need to set up your customer information and define some orders.
|
||||
To enable the {% term integration %}, you need to set up your customer information and define some orders.
|
||||
|
||||
Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/craigjmidwinter/hass-dominos-panel) to see the available product codes in a separate panel in your install.
|
||||
|
||||
Currently, there is no support in this integration for toppings, coupons or order tracking.
|
||||
Currently, there is no support in this integration for toppings, coupons, or order tracking.
|
||||
|
||||
```yaml
|
||||
dominos:
|
||||
@ -35,7 +35,7 @@ dominos:
|
||||
- P12IPAZA
|
||||
```
|
||||
|
||||
Now you can use the Dominos service to order pizza within your automations:
|
||||
Now you can use the Dominos {% term service %} to order pizza within your automations:
|
||||
|
||||
```yaml
|
||||
- service: dominos.order
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: DOODS - Dedicated Open Object Detection Service
|
||||
description: Detect and recognize objects with DOODS.
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.100'
|
||||
ha_domain: doods
|
||||
|
||||
@ -20,7 +20,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `doorbird` implementation allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
|
||||
The **DoorBird** {% term integration %} allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
@ -54,7 +54,8 @@ See [Automation Example](#automation-example) section below for details on how t
|
||||
Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.
|
||||
</div>
|
||||
|
||||
### Clearing Registered Events
|
||||
### Clearing registered events
|
||||
|
||||
Events can be cleared from DoorBird devices by visiting a special URL.
|
||||
|
||||
Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `
|
||||
@ -64,7 +65,7 @@ Please note that clearing device events will require configuration steps above t
|
||||
<br><br>
|
||||
If DoorBird was setup using UI prompts, a token can be discovered through DoorBird App by clicking settings (cog icon) -> Administration-> LOGIN (using your App Administration details). Under the "FAVORITES" section, choose "HTTP(S) Calls". This displays all events and the associated HTTP URL. In that URL field, you will be able to see the token that was auto-generated by Home Assistant.
|
||||
|
||||
### Event Data
|
||||
### Event data
|
||||
|
||||
Each event will include live image and video URLs for the DoorBird device that triggered the event. These URLs can be found on the event data and are helpful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.
|
||||
|
||||
@ -98,7 +99,7 @@ On the desired event, you should be able to specify blocks of time for when you
|
||||
|
||||
Note: Remember to complete the schedule assignment steps above for each event type you registered. If you are configuring HTTP Call(s) schedules for registered RFID tags, please note that you will have to enable/configure the schedule for each RFID tag.
|
||||
|
||||
## Automation Example
|
||||
## Automation example
|
||||
|
||||
The example automation below shows how to turn on a light when somebody presses the DoorBird call button:
|
||||
|
||||
@ -119,7 +120,6 @@ You can also create automation actions based on the DoorBird RFID scanner being
|
||||
|
||||
The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
|
||||
|
||||
|
||||
## Button
|
||||
|
||||
The `doorbird` button platform allows you to power connected relays and trigger the low-light/dark Infra-Red (IR) array on your [DoorBird](https://www.doorbird.com/) video doorbell device.
|
||||
|
||||
@ -4,7 +4,7 @@ description: How to integrate Dovado within Home Assistant.
|
||||
ha_category:
|
||||
- Notifications
|
||||
- Sensor
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_release: 0.87
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: dovado
|
||||
|
||||
@ -43,7 +43,7 @@ This will download the file from the given URL.
|
||||
| `filename` | yes | Determine the filename. |
|
||||
| `overwrite` | yes | Whether to overwrite the file or not, defaults to `false`. |
|
||||
|
||||
### Download Status Events
|
||||
### Download status events
|
||||
|
||||
When a download finished successfully, Home Assistant will emit a `downloader_download_completed` event to the event bus which you can use to write automations against.
|
||||
In case download failed another event `downloader_download_failed` is emitted to indicate that the download did not complete successfully.
|
||||
@ -55,7 +55,7 @@ Along with the event the following payload parameters are available:
|
||||
| `url` | The `url` that was requested.|
|
||||
| `filename` | The `name` of the file that was being downloaded.|
|
||||
|
||||
#### Example Automation:
|
||||
#### Example automation:
|
||||
|
||||
```yaml
|
||||
- alias: "Download Failed Notification"
|
||||
|
||||
@ -34,7 +34,7 @@ To use this DSMR Reader sensor integration, you need to have a DSMR Reader insta
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Configuring the Energy Dashboard
|
||||
## Configuring the energy dashboard
|
||||
|
||||
It is most advisable to not use the "total" and "daily" sources. The regular "reading" sensors provide the most stable source of data for Home Assistant to use. These MQTT values are part of the "Telegram: Split topic" MQTT values within DSMR Reader, so make sure to enable them.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Dune HD
|
||||
description: Instructions on how to integrate Dune HD media players into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.34
|
||||
ha_domain: dunehd
|
||||
@ -12,7 +12,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `Dune HD` integration allows you to control a [Dune HD media player](https://dune-hd.com/eng/products/full_hd_media_players) from Home Assistant. Support is based on the official [IP protocol](https://dune-hd.com/support/ip_control/dune_ip_control_overview.txt) published by Dune.
|
||||
The **Dune HD** {% term integration %} allows you to control a [Dune HD media player](https://dune-hd.com/eng/products/full_hd_media_players) from Home Assistant. Support is based on the official [IP protocol](https://dune-hd.com/support/ip_control/dune_ip_control_overview.txt) published by Dune.
|
||||
|
||||
Devices with firmware 110127_2105_beta or above are supported. Some functions may depend on the version of the protocol (volume / mute control is only available with version 2 onwards).
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: silver
|
||||
---
|
||||
|
||||
The Duotecno integration can be used to control [Duotecno](https://www.duotecno.be/) nodes in Home Assistant.
|
||||
The **Duotecno** {% term integration %} can be used to control [Duotecno](https://www.duotecno.be/) nodes in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Deutscher Wetterdienst Weather Warnings integration uses the [Deutscher Wetterdienst (DWD)](https://www.dwd.de) as a source for current and advance weather warnings. The configured sensor checks for data every 15 minutes.
|
||||
The **Deutscher Wetterdienst Weather Warnings** {% term integration %} uses the [Deutscher Wetterdienst (DWD)](https://www.dwd.de) as a source for current and advance weather warnings. The configured sensor checks for data every 15 minutes.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ Since Philips Dynalite has virtually no auto-discover capabilities, once it is a
|
||||
|
||||
There are global setup parameters and advanced parameters that should normally be left as is. The most important part is defining the areas. Each area normally corresponds to a room or function. They have to be added manually via the UI and match the setup of the existing dynalite installation.
|
||||
|
||||
## Initial Configuration and Discovery
|
||||
## Initial configuration and discovery
|
||||
|
||||
Maybe the most difficult thing about a Dynalite system is finding out the areas and channel mapping. If you have them or have access to the Dynalite software and your configuration files, this could be easy,
|
||||
but in the likely case that your system was installed by an integrator, you will have to discover them on your own.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: eSterownik eCoal.pl Boiler
|
||||
description: Instructions on how to integrate eSterownik.pl eCoal.pl controller into Home Assistant.
|
||||
ha_category:
|
||||
- Water Heater
|
||||
- Water heater
|
||||
ha_release: 0.87
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: ecoal_boiler
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: ecobee
|
||||
description: Instructions for how to integrate ecobee thermostats and sensors within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Humidifier
|
||||
- Notifications
|
||||
@ -30,7 +30,7 @@ ha_homekit: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||
The **ecobee** {% term integration %} lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||
|
||||
## Preliminary steps
|
||||
|
||||
|
||||
@ -2,10 +2,10 @@
|
||||
title: Rheem EcoNet Products
|
||||
description: Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
- Water Heater
|
||||
- Water heater
|
||||
ha_release: 0.61
|
||||
ha_iot_class: Cloud Push
|
||||
ha_domain: econet
|
||||
@ -21,7 +21,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The EcoNet integration is consuming the information provided by a [EcoNet enabled Rheem water heater or thermostat](https://www.rheem.com/econet).
|
||||
The **EcoNet** {% term integration %} is consuming the information provided by a [EcoNet enabled Rheem water heater or thermostat](https://www.rheem.com/econet).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -29,14 +29,14 @@ The EcoNet integration is consuming the information provided by a [EcoNet enable
|
||||
|
||||
EcoNet devices may be represented by one or more platforms.
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Binary sensor](#binary-sensor)
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
- [Water Heater](#water-heater)
|
||||
- [Water heater](#water-heater)
|
||||
|
||||
### Binary sensor
|
||||
|
||||
The EcoNet Binary Sensor platform lets you view binary states of sensors associated with your EcoNet thermostat or water heater. For example, if the device is currently running.
|
||||
The EcoNet Binary sensor platform lets you view binary states of sensors associated with your EcoNet thermostat or water heater. For example, if the device is currently running.
|
||||
|
||||
### Climate
|
||||
|
||||
@ -48,4 +48,4 @@ The EcoNet Sensor platform lets you view sensors associated with your EcoNet the
|
||||
|
||||
### Water heater
|
||||
|
||||
The EcoNet Water Heater platform lets you control your EcoNet water heater. Water Heaters do not report the current water temperature.
|
||||
The EcoNet water heater platform lets you control your EcoNet water heater. Water heaters do not report the current water temperature.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Ecowitt
|
||||
description: Instructions on how to integrate Ecowitt Weather Station within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_release: 2022.9
|
||||
ha_iot_class: Local Push
|
||||
|
||||
@ -3,7 +3,7 @@ title: Egardia
|
||||
description: Instructions on how to setup Egardia / Woonveilig within Home Assistant.
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Hub
|
||||
ha_release: 0.65
|
||||
ha_iot_class: Local Polling
|
||||
@ -16,13 +16,13 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `egardia` platform 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.
|
||||
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.
|
||||
|
||||
You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in using your Egardia/Woonveilig account.
|
||||
|
||||
## Basic configuration
|
||||
|
||||
To enable the 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 `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions to setup the Elk-M1 controller.
|
||||
ha_release: 0.81
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Hub
|
||||
- Light
|
||||
@ -36,7 +36,7 @@ The Elk-M1 controller is manufactured by [Elk Products](https://www.elkproducts.
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Alarm** - An ElkM1 area (also known as partition) is represented as an `alarm_control_panel`.
|
||||
- **Binary Sensor** - ElkM1 zones that have 4 states (i.e.: are not analog zones) are represented as `binary_sensor` entities. `Normal` is `off` and any of the other values is `on`.
|
||||
- **Binary sensor** - ElkM1 zones that have 4 states (i.e.: are not analog zones) are represented as `binary_sensor` entities. `Normal` is `off` and any of the other values is `on`.
|
||||
- **Climate** - An ElkM1 thermostat is represented as a `climate` entity.
|
||||
- **Light** - An ElkM1 light (which can be X10, Insteon, UPB) is represented as a `light`.
|
||||
- **Scene** - ElkM1 tasks are represented as `scene` entities.
|
||||
@ -46,13 +46,13 @@ There is currently support for the following device types within Home Assistant:
|
||||
The implementation follows the Elk Products ElkM1 "ASCII Protocol & Interface
|
||||
Specification, Revision 1.84" document. This document can be found on the Internet.
|
||||
|
||||
## ElkM1 Configuration and Version
|
||||
## ElkM1 configuration and version
|
||||
|
||||
In order for the ElkM1 integration to work to its fullest with Home Assistant the
|
||||
ElkM1 panel must be configured correctly. This section describes the configuration
|
||||
required on the ElkM1 panel.
|
||||
|
||||
### ElkM1 Version
|
||||
### ElkM1 version
|
||||
|
||||
ElkM1 should be running:
|
||||
|
||||
@ -63,7 +63,7 @@ Force arm away and stay are available in 5.3.0 or higher.
|
||||
|
||||
Many features will work with lower versions of the ElkM1. Check the "ElkM1 RS232 Protocol" manual for details.
|
||||
|
||||
### ELK-M1XEP Version
|
||||
### ELK-M1XEP version
|
||||
|
||||
The ELK-M1XEP is the Ethernet controller board for the ElkM1. If connecting the integration
|
||||
in secure mode the version of the ELK-M1XEP determines which secure protocol is supported.
|
||||
@ -440,7 +440,7 @@ The `event_data` contains the following:
|
||||
|
||||
## Services
|
||||
|
||||
Besides the standard Home Assistant services for Alarm Control Panel, Climate, Light, Scene, Sensor,
|
||||
Besides the standard Home Assistant services for Alarm control panel, Climate, Light, Scene, Sensor,
|
||||
and Switch the ElkM1 integration offers these additional services:
|
||||
|
||||
- `elkm1.alarm_arm_home_instant`
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Emby
|
||||
description: Instructions on how to integrate Emby into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: 0.32
|
||||
ha_iot_class: Local Push
|
||||
ha_codeowners:
|
||||
@ -13,7 +13,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `emby` platform allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant.
|
||||
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:
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Enigma2 (OpenWebif)
|
||||
description: Instructions on how to integrate an Enigma2 based box running OpenWebif into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: '0.90'
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: EnOcean
|
||||
description: Connect EnOcean devices to Home Assistant
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Hub
|
||||
- Light
|
||||
- Sensor
|
||||
@ -27,7 +27,7 @@ The EnOcean integration adds support for some of these devices. You will need a
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor) - Wall switches
|
||||
- [Binary sensor](#binary-sensor) - Wall switches
|
||||
- [Sensor](#sensor) - Power meters, temperature sensors, humidity sensors and window handles
|
||||
- [Light](#light) - Dimmers
|
||||
- [Switch](#switch)
|
||||
|
||||
@ -52,15 +52,15 @@ For newer models running firmware 7 and greater, you will need your Enlighten cl
|
||||
|
||||
For models running firmware 5 and older, use `installer` for the username. No password is required. The integration will automatically detect the `installer` password.
|
||||
|
||||
## Enpower Load Shedding Relays
|
||||
## Enpower load shedding relays
|
||||
|
||||
The Enphase Enpower has 4 load shedding relays that can be used to control non-essential loads in your home. These have two main modes of operation:
|
||||
|
||||
### Standard
|
||||
When the mode entity is set to standard, you can simply set the state of the relay to be powered or not powered for each mode of operation: on grid, off grid, and on generator.
|
||||
|
||||
### Battery Level
|
||||
### Battery level
|
||||
When the relay mode is set to battery level, the relays will turn on and off based on the remaining battery level of your Encharge batteries. Two number entities are available to control the cutoff and restore levels for the relays. When the battery level drops below the cutoff level, the relays will turn off. When the battery level rises above the restore level, the relays will turn back on.
|
||||
|
||||
## Polling Interval
|
||||
## Polling interval
|
||||
The default polling interval is 60 seconds. To customize the polling interval, refer to [defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval). Specify the envoy device as a target of the service using the `+ choose device` button. Updating the envoy will also update the related devices like the inverters; there is no need to split them into separate entities or add all inverter devices. When using multiple Envoys, add them as targets or create separate custom polling intervals as needed.
|
||||
|
||||
@ -20,7 +20,7 @@ ha_config_flow: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Environment Canada integration provides meteorological data for Canadian locations from [Environment and Climate Change Canada](https://weather.gc.ca/index_e.html).
|
||||
The **Environment Canada** {% term integration %} provides meteorological data for Canadian locations from [Environment and Climate Change Canada](https://weather.gc.ca/index_e.html).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -45,7 +45,7 @@ The integration will create the entities listed below. Some of the entities are
|
||||
|
||||
### Sensors
|
||||
|
||||
#### Conditions and Forecasts
|
||||
#### Conditions and forecasts
|
||||
|
||||
- Current condition
|
||||
- Forecast summary
|
||||
@ -55,7 +55,7 @@ The integration will create the entities listed below. Some of the entities are
|
||||
- Humidity
|
||||
- Visibility
|
||||
- UV index
|
||||
- Air Quality (AQHI)
|
||||
- Air quality (AQHI)
|
||||
|
||||
#### Temperature
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: Envisalink
|
||||
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_release: 0.23
|
||||
ha_iot_class: Local Push
|
||||
@ -18,15 +18,15 @@ ha_codeowners:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `envisalink` 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.
|
||||
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.
|
||||
|
||||
Please visit the [eyezon website](https://www.eyezon.com/) for further information about the evl3 and evl4 boards.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.)
|
||||
- Binary sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.)
|
||||
- Sensor: Emulates an alphanumeric keypad attached to the alarm panel
|
||||
- Alarm Control Panel: Reports on partition status, and can be used to arm/disarm the system
|
||||
- Alarm control panel: Reports on partition status, and can be used to arm/disarm the system
|
||||
|
||||
This is a fully event-based integration. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
|
||||
|
||||
@ -112,7 +112,7 @@ panic_type:
|
||||
default: Police
|
||||
type: string
|
||||
zones:
|
||||
description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. Zone numbers correspond to the zone numbers configured on your alarm system and must be in the range of 1 to 64. For each zone, at least a name must be given. For more information about the visual representation of a zone, take a look at the [Binary Sensor](/integrations/binary_sensor/#device-class) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
|
||||
description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. Zone numbers correspond to the zone numbers configured on your alarm system and must be in the range of 1 to 64. For each zone, at least a name must be given. For more information about the visual representation of a zone, take a look at the [binary sensor](/integrations/binary_sensor/#device-class) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
|
||||
required: false
|
||||
type: integer
|
||||
keys:
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Epson
|
||||
description: Instructions on how to integrate Epson projector into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: 0.72
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: epson
|
||||
@ -14,8 +14,8 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `epson` platform allows you to control a Epson projector from Home Assistant.
|
||||
**Device has to be turned on during initial configuration.**
|
||||
The **Epson** {% term integration %} allows you to control a Epson projector from Home Assistant.
|
||||
**The device has to be turned on during initial configuration.**
|
||||
When you want to add a device for the first time, turn it on before following the integration steps.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate a Honeywell Evohome/TCC system wit
|
||||
ha_category:
|
||||
- Climate
|
||||
- Hub
|
||||
- Water Heater
|
||||
- Water heater
|
||||
ha_release: '0.80'
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_codeowners:
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `evohome` integration links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
|
||||
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:
|
||||
|
||||
- the Honeywell Evohome CH/DHW system, and
|
||||
- the Honeywell Mobile Access Kit with a Round Thermostat
|
||||
@ -61,7 +61,7 @@ scan_interval:
|
||||
|
||||
This is an IoT cloud-polling integration and the recommended minimum `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by the vendor. There is little value in shorter intervals, as this integration will automatically force a refresh shortly after any configuration changes.
|
||||
|
||||
## Locations and Zones
|
||||
## Locations and zones
|
||||
|
||||
TCC systems are implemented as a _location_, which consist of 1-12 _zones_ and, optionally, a DHW controller:
|
||||
|
||||
@ -88,7 +88,7 @@ Note that TCC devices may well measure temperatures with very high precision, bu
|
||||
|
||||
Therefore, depending upon the above, Home Assistant will display/record current temperatures with a precision of either 0.5 °C or 0.1 °C (it's highest supported precision).
|
||||
|
||||
## System modes, Zone overrides and Inheritance
|
||||
## System modes, zone overrides and inheritance
|
||||
|
||||
TCC locations can support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all systems support all modes.
|
||||
|
||||
@ -181,7 +181,7 @@ The `duration` can be up to 24 hours, after which the zone mode will revert to s
|
||||
|
||||
This service call is used to set a zone, as identified by its `entity_id`, to **FollowSchedule**.
|
||||
|
||||
## Useful Jinja Templates
|
||||
## Useful Jinja templates
|
||||
|
||||
The actual operating mode of Evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Your cameras will now show under integration options as "discovered devices". Pl
|
||||
|
||||
You can also change the camera options should you need to access a high or low res stream. Generally, though it will just work without any modification to options.
|
||||
|
||||
### Integration Entity Options
|
||||
### Integration entity options
|
||||
|
||||
`Request Timeout (seconds)`:
|
||||
|
||||
@ -130,15 +130,15 @@ To enable/disable motion detection, use the Home Assistant built in services.
|
||||
| -----------------------| ----------- |
|
||||
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
|
||||
|
||||
### Alarm Control Panel Entity
|
||||
### Alarm control panel entity
|
||||
|
||||
The Alarm Control Panel entity in the EZVIZ platform allows users to manage and control the armed status of all their EZVIZ devices. With this entity, users can choose between three options: **Arm Away**, **Arm Sleep**, and **Disarm**.
|
||||
The Alarm control panel entity in the EZVIZ platform allows users to manage and control the armed status of all their EZVIZ devices. With this entity, users can choose between three options: **Arm Away**, **Arm Sleep**, and **Disarm**.
|
||||
|
||||
### OTA update
|
||||
|
||||
Trigger device OTA firmware update process for latest stable version.
|
||||
|
||||
### Motion Detection Sensitivity
|
||||
### Motion detection sensitivity
|
||||
|
||||
The motion detection sensitivity can be adjusted using the "Detection sensitivity" Number entity. It's important to note that this entity fetches information from the device and will not update if your battery-powered camera is in sleep mode, as this measure is implemented to preserve battery life and prevent excessive drainage.
|
||||
|
||||
@ -159,7 +159,7 @@ If your camera supports motion detection warning sounds, you can use this entity
|
||||
|
||||
A light entity will be added to cameras + light combos. You can turn it on/off and set the brightness.
|
||||
|
||||
### Image Entity
|
||||
### Image entity
|
||||
|
||||
The image entity represents the last detected event from a camera and visually represents the event within Home Assistant.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user