diff --git a/source/_integrations/acmeda.markdown b/source/_integrations/acmeda.markdown index d787f59ac66..79cc391e0a3 100644 --- a/source/_integrations/acmeda.markdown +++ b/source/_integrations/acmeda.markdown @@ -17,18 +17,17 @@ ha_platforms: The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rolelase Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition. -### Supported devices +## Supported devices - Automate Pulse Hub v1 - {% include integrations/config_flow.md %} -### Multiple hubs +## Multiple hubs Multiple hubs work transparently with discovery, so you don't have to do anything special to set them up. -### Caveats +## Caveats If the IP address for the hub changes, you will need to re-register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your hub so that it always has the same IP address. diff --git a/source/_integrations/adax.markdown b/source/_integrations/adax.markdown index 9f325672b96..6e8a9ed2b2c 100644 --- a/source/_integrations/adax.markdown +++ b/source/_integrations/adax.markdown @@ -22,5 +22,4 @@ You'll need the Account ID (which can be found in the Adax Wifi app, pressing 'A 3. Select “Add Credential” 4. Give some name to the created credential and copy the generated password. - {% include integrations/config_flow.md %} diff --git a/source/_integrations/agent_dvr.markdown b/source/_integrations/agent_dvr.markdown index 6b9acc5f522..ba5c39a4f6f 100644 --- a/source/_integrations/agent_dvr.markdown +++ b/source/_integrations/agent_dvr.markdown @@ -38,7 +38,7 @@ Available services: `start_recording`, `stop_recording`, `turn_on`, `turn_off`, `toggle`, `enable_motion_detection`,`disable_motion_detection` -#### Service `enable_alerts`/`disable_alerts` +### Service `enable_alerts`/`disable_alerts` These services enable or disable the device's alert events within Agent DVR. @@ -46,7 +46,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### Service `start_recording`/`stop_recording` +### Service `start_recording`/`stop_recording` These services start or stop the device recording. @@ -54,7 +54,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### Service `turn_on`/`turn_off`/`toggle` +### Service `turn_on`/`turn_off`/`toggle` These services turn on, off or toggle the device enabled state within Agent DVR @@ -62,9 +62,9 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. - ## IFrame - - Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to https://www.ispyconnect.com/app/ + +- Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to

diff --git a/source/_integrations/air_quality.markdown b/source/_integrations/air_quality.markdown index d47370ea19d..2474e450b40 100644 --- a/source/_integrations/air_quality.markdown +++ b/source/_integrations/air_quality.markdown @@ -6,9 +6,7 @@ ha_domain: air_quality ha_quality_scale: internal --- -The `air_quality` base platform allows other integrations to process information -about air quality and pollution details. It is used by integrations that provide -an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health). +The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health). The platforms cover the following levels (if they are available): diff --git a/source/_integrations/airthings.markdown b/source/_integrations/airthings.markdown index cf7da18d164..c6f34bd2f33 100644 --- a/source/_integrations/airthings.markdown +++ b/source/_integrations/airthings.markdown @@ -18,7 +18,6 @@ Integrates Airthings sensors into Home Assistant. [Airthings](https://www.airthings.com/) provide different sensors for measuring the air quality. The focus specially on Radon sensors. - Login [here](https://dashboard.airthings.com/integrations/api-integration) to find your credentials. {% include integrations/config_flow.md %} diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown index 06b652520cf..d205b439b6d 100644 --- a/source/_integrations/airvisual.markdown +++ b/source/_integrations/airvisual.markdown @@ -35,7 +35,7 @@ For example: ## Using an AirVisual Node/Pro Unit -The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba). +The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; [instructions here](https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba)). {% include integrations/config_flow.md %} @@ -45,9 +45,9 @@ In addition to using latitude and longitude, the AirVisual integration may be co For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the values to use in the UI would be: -* City: `Sao Paulo` -* State: `Sao Paulo` -* Country: `Brazil` +- City: `Sao Paulo` +- State: `Sao Paulo` +- Country: `Brazil` ## Sensor Types @@ -96,12 +96,12 @@ Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](http Node/Pro units will create a variety of sensors: -* Air Quality Index (AQI) -* Battery Level -* Carbon Dioxide (CO2) -* Humidity -* Particulate (<= 0.1 μm) (PM0.1) -* Particulate (<= 2.5 μm) (PM2.5) -* Particulate (<= 10 μm) (PM10) -* Temperature -* Volatile Organic Compounds (VOC) +- Air Quality Index (AQI) +- Battery Level +- Carbon Dioxide (CO2) +- Humidity +- Particulate (<= 0.1 μm) (PM0.1) +- Particulate (<= 2.5 μm) (PM2.5) +- Particulate (<= 10 μm) (PM10) +- Temperature +- Volatile Organic Compounds (VOC) diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index 903f8b46156..6973ff7a648 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -88,6 +88,7 @@ Next, you will need to set up the required IFTTT applets as listed below. This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered. For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those. + * **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system. * **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. * **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown index 32e8edcf9c1..db34c2eb4f0 100644 --- a/source/_integrations/alarmdecoder.markdown +++ b/source/_integrations/alarmdecoder.markdown @@ -191,7 +191,6 @@ The `chr(4)` and `chr(5)` sequences below are equivalent to pressing the Sta - | Mode | Key Sequence | | ------------------------------------------------------- | ------------------------------ | | `alarm_arm_home` | `chr(4)` + `chr(4)` + `chr(4)` | diff --git a/source/_integrations/alert.markdown b/source/_integrations/alert.markdown index 4a27181d0f4..fb017346fa1 100644 --- a/source/_integrations/alert.markdown +++ b/source/_integrations/alert.markdown @@ -243,7 +243,7 @@ alert: The resulting message could be `Plant Officeplant needs help (moisture low)`. -### Additional parameters for notifiers +### Additional parameters for notifiers Some notifiers support more parameters (e.g., to set text color or action buttons). These can be supplied via the `data` parameter: @@ -269,6 +269,7 @@ alert: notifiers: - frank_telegram ``` + This particular example relies on the `inline_keyboard` functionality of Telegram, where the user is presented with buttons to execute certain actions. diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 41baf3a8651..92a7d583216 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -101,7 +101,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo Next you need create a Lambda function. - Click `Services` in top navigation bar, expand the menu to display all AWS services, click `Lambda` under `Compute` section to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home) -- **IMPORTANT - Alexa Skills are only supported in certain AWS reigons** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported reigons for Alexa Skills otherwise this will not work! +- **IMPORTANT - Alexa Skills are only supported in certain AWS regions** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported regions for Alexa Skills otherwise this will not work! - **US East (N.Virginia)** region for English (US) or English (CA) skills - **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills - **US West (Oregon)** region for Japanese and English (AU) skills. @@ -163,6 +163,7 @@ After your Home Assistant has restarted, go back to `AWS Lambda Console`, you ar } } ``` + - Click `Create` in the bottom right hand corner. This test event is a `Discovery` directive, your Home Assistant instance will respond with a list of devices Alexa can interact with. This test data is lack of `token` in `payload.scope`, your Lambda function will read the `LONG_LIVED_ACCESS_TOKEN` from environment variable. @@ -796,7 +797,7 @@ The following table lists the possible friendly name synonyms available for a In ### Light -Control lights with _"turn on"_ and _"turn off"_ utterances, adjust brightness, color, and temperature. +Control lights with _"turn on"_ and _"turn off"_ utterances, adjust brightness, color, and temperature. - _"Alexa, turn on the bathroom light."_ - _"Alexa, turn off the patio light."_ @@ -938,11 +939,11 @@ Support _"turn on"_ and _"turn off"_ utterances. ### Timer -Start a timer with using the _"turn on"_ utterance. +Start a timer with using the _"turn on"_ utterance. - _"Alexa, turn on the laundry."_ -Cancel a timer using the _"turn off"_ utterance. +Cancel a timer using the _"turn off"_ utterance. - _"Alexa, turn off the laundry."_ diff --git a/source/_integrations/amberelectric.markdown b/source/_integrations/amberelectric.markdown index e4686310f3a..bc91f7cdb5c 100644 --- a/source/_integrations/amberelectric.markdown +++ b/source/_integrations/amberelectric.markdown @@ -23,7 +23,7 @@ Using this integration, customers can go a step further - setting up devices to To use this integration, you will need to generate an API key. -1. Login to your Amber account at: https://app.amber.com.au +1. Login to your Amber account at: 2. Click _Settings_ 3. Enable _Developer Mode_ 4. Click _Generate API Key_ diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index f9109d4da63..f37d3ac9145 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -278,8 +278,8 @@ When sending commands like UP, DOWN, HOME, etc. via ADB, the device can be slow | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of Android TV / Fire TV entities. -1. Call the `androidtv.learn_sendevent` service. -2. Within 8 seconds, hit a single button on your Android TV / Fire TV remote. +1. Call the `androidtv.learn_sendevent` service. +2. Within 8 seconds, hit a single button on your Android TV / Fire TV remote. 3. After 8 seconds, a persistent notification will appear that contains the equivalent command that can be sent via the `androidtv.adb_command` service. This command can also be found in the `adb_response` attribute of the media player in Home Assistant, and it will be logged at the INFO level. As an example, a service call in a [script](/docs/scripts) could be changed from this: @@ -306,7 +306,7 @@ to this: ### `androidtv.download` and `androidtv.upload` -You can use the `androidtv.download` service to download a file from your Android TV / Fire TV device to your Home Assistant instance. +You can use the `androidtv.download` service to download a file from your Android TV / Fire TV device to your Home Assistant instance. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -328,13 +328,13 @@ The Android TV integration works by polling the Android TV / Fire TV device at a The solution to this problem is the `state_detection_rules` configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are: -* `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'` - * If this is not a map, then this state will always be reported when this app is the current app - * If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above): +- `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'` + - If this is not a map, then this state will always be reported when this app is the current app + - If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above): 1. ``'media_session_state'`` 2. ``'audio_state'`` 3. ``'wake_lock_size'`` -* `'media_session_state'` = try to use the `media_session_state` property to determine the state -* `'audio_state'` = try to use the `audio_state` property to determine the state +- `'media_session_state'` = try to use the `media_session_state` property to determine the state +- `'audio_state'` = try to use the `audio_state` property to determine the state To determine what these rules should be, you can use the `androidtv.adb_command` service with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section. diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown index fbe3ca36a04..38e4b082863 100644 --- a/source/_integrations/anthemav.markdown +++ b/source/_integrations/anthemav.markdown @@ -19,10 +19,9 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp Support is provided through the Python [anthemav] module. Older, RS-232 serial-based units like the [D2v series](https://www.anthemav.com/products-archived/model=d2v/page=overview) use a different protocol entirely and are not currently supported. -[Anthem]: https://www.anthemav.com/ +[Anthem]: https://www.anthemav.com/ [anthemav]: https://github.com/nugget/python-anthemav - To use your Anthem A/V Receiver in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -50,9 +49,9 @@ name: ## Notes and Limitations -- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. -- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. -- Only Zone 1 is currently supported. +* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. +* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. +* Only Zone 1 is currently supported.

diff --git a/source/_integrations/apns.markdown b/source/_integrations/apns.markdown index 9d786f171d9..ba847c78c41 100644 --- a/source/_integrations/apns.markdown +++ b/source/_integrations/apns.markdown @@ -66,7 +66,7 @@ This service will send messages to a registered device. The following parameters - **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this ID matches a device in `known_devices.yaml` the device state will be tracked. - **data**: - * **badge**: The number to display as the badge of the app icon. - * **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. - * **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`. - * **content_available**: Provide this key with a value of 1 to indicate that new content is available. + - **badge**: The number to display as the badge of the app icon. + - **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. + - **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`. + - **content_available**: Provide this key with a value of 1 to indicate that new content is available. diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown index 4c475b85972..f2c6ba34636 100644 --- a/source/_integrations/apple_tv.markdown +++ b/source/_integrations/apple_tv.markdown @@ -25,6 +25,7 @@ There is currently support for the following entities within the Apple TV device - [Remote](#remote) {% include integrations/config_flow.md %} + ## Media Player The Apple TV media player platform will create a Media Player entity for each @@ -63,7 +64,7 @@ The following commands are currently available: | `num_repeats` | yes | Number of times to repeat the commands | | `delay_secs` | yes | Interval in seconds between one send and another
This is a `float` value e.g. 1, 1.2 etc. | -**Examples** +### Examples Create a script to invoke the Netflix application based on the application icon being in a fixed place on the home screen: