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-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into rc

Browse Source
This commit is contained in:
Franck Nijhof 2022-08-25 00:31:02 +02:00
commit 6b18ce8e03
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
29 changed files with 266 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.github/workflows/add_prs_to_project.yml vendored Normal file
View File

@ -0,0 +1,24 @@
name: Add new PRs to project
on:
pull_request_target:
types:
- opened
jobs:
add-to-project:
name: Add new PR to project
runs-on: ubuntu-latest
steps:
- name: Generate app token
id: token
# Pinned to a specific version of the action for security reasons
uses: tibdex/github-app-token@f717b5ecd4534d3c4df4ce9b5c1c2214f0f7cd06 # v1.6.0
with:
app_id: ${{ secrets.PROJECTS_APP_ID }}
private_key: ${{ secrets.PROJECTS_APP_PEM }}
- name: Add to Project
uses: actions/add-to-project@v0.3.0
with:
project-url: https://github.com/orgs/home-assistant/projects/10
github-token: ${{ steps.token.outputs.token }}

6
Gemfile.lock
View File

@ -1,8 +1,8 @@
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
addressable (2.8.0) addressable (2.8.1)
public_suffix (>= 2.0.2, < 5.0) public_suffix (>= 2.0.2, < 6.0)
chunky_png (1.4.0) chunky_png (1.4.0)
colorator (1.1.0) colorator (1.1.0)
commonmarker (0.23.5) commonmarker (0.23.5)
@ -77,7 +77,7 @@ GEM
racc (~> 1.4) racc (~> 1.4)
pathutil (0.16.2) pathutil (0.16.2)
forwardable-extended (~> 2.6) forwardable-extended (~> 2.6)
public_suffix (4.0.7) public_suffix (5.0.0)
racc (1.6.0) racc (1.6.0)
rack (2.2.4) rack (2.2.4)
rack-protection (2.2.2) rack-protection (2.2.2)

4
source/_docs/configuration/templating.markdown
View File

@ -857,7 +857,7 @@ With given payload:
Template {% raw %}```{{ value_json.temperature | round(1) }}```{% endraw %} renders to `21.9`. Template {% raw %}```{{ value_json.temperature | round(1) }}```{% endraw %} renders to `21.9`.
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template. Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used as variables in the template. The `this` attribute refers to the [entity state](/docs/configuration/state_object) of the MQTT item.
</div> </div>
@ -877,7 +877,7 @@ With given value `21.9` template {% raw %}```{"temperature": {{ value }} }```{%
} }
``` ```
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template. Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used as variables in the template. The `this` attribute refers to the [entity state](/docs/configuration/state_object) of the MQTT item.
</div> </div>

10
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -78,7 +78,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -87,7 +87,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -114,7 +114,7 @@ code_trigger_required:
type: boolean type: boolean
default: true default: true
command_template: command_template:
description: "The [template](/docs/configuration/templating/#processing-incoming-data) used for the command payload. Available variables: `action` and `code`." description: "The [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) used for the command payload. Available variables: `action` and `code`."
required: false required: false
type: string type: string
default: action default: action
@ -183,7 +183,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -263,7 +263,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

8
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -70,7 +70,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -79,7 +79,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -160,7 +160,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -214,7 +214,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) that returns a string to be compared to `payload_on`/`payload_off` or an empty string, in which case the MQTT message will be removed. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads (i.e no pre-processing of original message is required)." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) that returns a string to be compared to `payload_on`/`payload_off` or an empty string, in which case the MQTT message will be removed. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads (i.e no pre-processing of original message is required)."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}

19
source/_integrations/bluetooth.markdown
View File

@ -87,6 +87,25 @@ The following methods are known to work to add multiple adapters:
Integrations that have followed the [Best practices for library authors](https://developers.home-assistant.io/docs/network_discovery?_highlight=bluetooth#best-practices-for-library-authors) will automatically connect via the adapter with the best signal and failover to an active adapter if one becomes unavailable. Integrations that have followed the [Best practices for library authors](https://developers.home-assistant.io/docs/network_discovery?_highlight=bluetooth#best-practices-for-library-authors) will automatically connect via the adapter with the best signal and failover to an active adapter if one becomes unavailable.
## Remote adapters
The Bluetooth integration supports receiving advertisement data from external adapters for devices and sensors that do not need an active connection. The number of remote scanners is limited only by the performance of the host system.
The following remote adapters are supported:
- [ESPHome](https://esphome.io)
### ESPHome requirements
Devices with an ESP32 chip running ESPHome must enable the `bluetooth_proxy` component and be added to Home Assistant before advertisements are forwarded.
```yaml
esp32_ble_tracker:
bluetooth_proxy:
```
Many integrations require an active scan for discovery. By default, the [ESPHome tracker](https://esphome.io/components/esp32_ble_tracker.html) runs in active mode. Adding ESPHome remotes that have active scanning disabled may cause some integrations to malfunction.
## Troubleshooting ## Troubleshooting
### Integrations that require exclusive use of the Bluetooth Adapter ### Integrations that require exclusive use of the Bluetooth Adapter

8
source/_integrations/button.mqtt.markdown
View File

@ -59,7 +59,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -68,7 +68,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -76,7 +76,7 @@ availability_topic:
required: false required: false
type: string type: string
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -149,7 +149,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:

6
source/_integrations/camera.mqtt.markdown
View File

@ -69,7 +69,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -78,7 +78,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -151,7 +151,7 @@ image_encoding:
type: string type: string
default: None default: None
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:

10
source/_integrations/climate.mqtt.markdown
View File

@ -85,7 +85,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -94,7 +94,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -196,7 +196,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -271,7 +271,7 @@ precision:
type: float type: float
default: 0.1 for Celsius and 1.0 for Fahrenheit. default: 0.1 for Celsius and 1.0 for Fahrenheit.
preset_mode_command_template: preset_mode_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `preset_mode_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `preset_mode_command_topic`.
required: false required: false
type: template type: template
preset_mode_command_topic: preset_mode_command_topic:
@ -283,7 +283,7 @@ preset_mode_state_topic:
required: false required: false
type: string type: string
preset_mode_value_template: preset_mode_value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the `preset_mode` value from the payload received on `preset_mode_state_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the `preset_mode` value from the payload received on `preset_mode_state_topic`.
required: false required: false
type: string type: string
preset_modes: preset_modes:

6
source/_integrations/cover.mqtt.markdown
View File

@ -76,7 +76,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -85,7 +85,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -161,7 +161,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:

8
source/_integrations/device_tracker.mqtt.markdown
View File

@ -104,7 +104,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -113,7 +113,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -166,7 +166,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -219,7 +219,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) that returns a device tracker state." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) that returns a device tracker state."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

2
source/_integrations/device_trigger.mqtt.markdown
View File

@ -85,7 +85,7 @@ device:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

22
source/_integrations/fan.mqtt.markdown
View File

@ -67,7 +67,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -76,7 +76,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -84,7 +84,7 @@ availability_topic:
required: false required: false
type: string type: string
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -152,7 +152,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -174,7 +174,7 @@ optimistic:
type: boolean type: boolean
default: "`true` if no state topic defined, else `false`." default: "`true` if no state topic defined, else `false`."
oscillation_command_template: oscillation_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `oscillation_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `oscillation_command_topic`.
required: false required: false
type: template type: template
oscillation_command_topic: oscillation_command_topic:
@ -186,7 +186,7 @@ oscillation_state_topic:
required: false required: false
type: string type: string
oscillation_value_template: oscillation_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the oscillation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value from the oscillation."
required: false required: false
type: string type: string
payload_available: payload_available:
@ -230,7 +230,7 @@ payload_reset_preset_mode:
type: string type: string
default: 'None' default: 'None'
percentage_command_template: percentage_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `percentage_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `percentage_command_topic`.
required: false required: false
type: template type: template
percentage_command_topic: percentage_command_topic:
@ -242,11 +242,11 @@ percentage_state_topic:
required: false required: false
type: string type: string
percentage_value_template: percentage_value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the `percentage` value from the payload received on `percentage_state_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the `percentage` value from the payload received on `percentage_state_topic`.
required: false required: false
type: string type: string
preset_mode_command_template: preset_mode_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `preset_mode_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `preset_mode_command_topic`.
required: false required: false
type: template type: template
preset_mode_command_topic: preset_mode_command_topic:
@ -258,7 +258,7 @@ preset_mode_state_topic:
required: false required: false
type: string type: string
preset_mode_value_template: preset_mode_value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the `preset_mode` value from the payload received on `preset_mode_state_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the `preset_mode` value from the payload received on `preset_mode_state_topic`.
required: false required: false
type: string type: string
preset_modes: preset_modes:
@ -291,7 +291,7 @@ state_topic:
required: false required: false
type: string type: string
state_value_template: state_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value from the state."
required: false required: false
type: string type: string
unique_id: unique_id:

18
source/_integrations/humidifier.mqtt.markdown
View File

@ -69,7 +69,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -78,7 +78,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -86,7 +86,7 @@ availability_topic:
required: false required: false
type: string type: string
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -159,7 +159,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -221,7 +221,7 @@ payload_reset_mode:
type: string type: string
default: 'None' default: 'None'
target_humidity_command_template: target_humidity_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `target_humidity_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `target_humidity_command_topic`.
required: false required: false
type: template type: template
target_humidity_command_topic: target_humidity_command_topic:
@ -233,11 +233,11 @@ target_humidity_state_topic:
required: false required: false
type: string type: string
target_humidity_state_template: target_humidity_state_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value for the humidifier `target_humidity` state. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value for the humidifier `target_humidity` state.
required: false required: false
type: string type: string
mode_command_template: mode_command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `mode_command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `mode_command_topic`.
required: false required: false
type: template type: template
mode_command_topic: mode_command_topic:
@ -249,7 +249,7 @@ mode_state_topic:
required: false required: false
type: string type: string
mode_state_template: mode_state_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value for the humidifier `mode` state. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value for the humidifier `mode` state.
required: false required: false
type: string type: string
modes: modes:
@ -272,7 +272,7 @@ state_topic:
required: false required: false
type: string type: string
state_value_template: state_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value from the state."
required: false required: false
type: string type: string
unique_id: unique_id:

2
source/_integrations/lametric.markdown
View File

@ -2,6 +2,7 @@
title: LaMetric title: LaMetric
description: Instructions on how to integrate LaMetric TIME with Home Assistant. description: Instructions on how to integrate LaMetric TIME with Home Assistant.
ha_category: ha_category:
- Button
- Notifications - Notifications
- Number - Number
ha_iot_class: Local Polling ha_iot_class: Local Polling
@ -11,6 +12,7 @@ ha_codeowners:
- '@frenck' - '@frenck'
ha_domain: lametric ha_domain: lametric
ha_platforms: ha_platforms:
- button
- notify - notify
- number - number
ha_integration_type: integration ha_integration_type: integration

56
source/_integrations/light.mqtt.markdown
View File

@ -89,7 +89,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -98,7 +98,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -123,7 +123,7 @@ brightness_state_topic:
required: false required: false
type: string type: string
brightness_value_template: brightness_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the brightness value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the brightness value."
required: false required: false
type: string type: string
color_mode_state_topic: color_mode_state_topic:
@ -131,7 +131,7 @@ color_mode_state_topic:
required: false required: false
type: string type: string
color_mode_value_template: color_mode_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the color mode." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the color mode."
required: false required: false
type: string type: string
color_temp_command_template: color_temp_command_template:
@ -147,7 +147,7 @@ color_temp_state_topic:
required: false required: false
type: string type: string
color_temp_value_template: color_temp_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the color temperature value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the color temperature value."
required: false required: false
type: string type: string
command_topic: command_topic:
@ -227,7 +227,7 @@ effect_state_topic:
required: false required: false
type: string type: string
effect_value_template: effect_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the effect value."
required: false required: false
type: string type: string
hs_command_topic: hs_command_topic:
@ -242,7 +242,7 @@ hs_state_topic:
required: false required: false
type: string type: string
hs_value_template: hs_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the HS value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the HS value."
required: false required: false
type: string type: string
icon: icon:
@ -250,7 +250,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -326,7 +326,7 @@ rgb_state_topic:
required: false required: false
type: string type: string
rgb_value_template: rgb_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGB value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the RGB value."
required: false required: false
type: string type: string
rgbw_command_template: rgbw_command_template:
@ -342,7 +342,7 @@ rgbw_state_topic:
required: false required: false
type: string type: string
rgbw_value_template: rgbw_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGBW value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the RGBW value."
required: false required: false
type: string type: string
rgbww_command_template: rgbww_command_template:
@ -358,7 +358,7 @@ rgbww_state_topic:
required: false required: false
type: string type: string
rgbww_value_template: rgbww_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGBWW value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the RGBWW value."
required: false required: false
type: string type: string
schema: schema:
@ -371,7 +371,7 @@ state_topic:
required: false required: false
type: string type: string
state_value_template: state_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the state value. The template should match the payload `on` and `off` values, so if your light uses `power on` to turn on, your `state_value_template` string should return `power on` when the switch is on. For example if the message is just `on`, your `state_value_template` should be `power {{ value }}`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the state value. The template should match the payload `on` and `off` values, so if your light uses `power on` to turn on, your `state_value_template` string should return `power on` when the switch is on. For example if the message is just `on`, your `state_value_template` should be `power {{ value }}`."
required: false required: false
type: string type: string
unique_id: unique_id:
@ -396,7 +396,7 @@ xy_state_topic:
required: false required: false
type: string type: string
xy_value_template: xy_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the XY value."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}
@ -554,7 +554,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -563,7 +563,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -661,7 +661,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -918,7 +918,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -927,7 +927,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -935,23 +935,23 @@ availability_topic:
required: false required: false
type: string type: string
blue_template: blue_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract blue color from the state payload value. Expected result of the template is an integer from 0-255 range." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract blue color from the state payload value. Expected result of the template is an integer from 0-255 range."
required: false required: false
type: string type: string
brightness_template: brightness_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract brightness from the state payload value. Expected result of the template is an integer from 0-255 range." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract brightness from the state payload value. Expected result of the template is an integer from 0-255 range."
required: false required: false
type: string type: string
color_temp_template: color_temp_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract color temperature from the state payload value. Expected result of the template is an integer representing mired units." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract color temperature from the state payload value. Expected result of the template is an integer representing mired units."
required: false required: false
type: string type: string
command_off_template: command_off_template:
description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *off* state changes. Available variables: `state` and `transition`." description: "The [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) for *off* state changes. Available variables: `state` and `transition`."
required: true required: true
type: string type: string
command_on_template: command_on_template:
description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *on* state changes. Available variables: `state`, `brightness`, `color_temp`, `red`, `green`, `blue`, `flash`, `transition` and `effect`. Values `red`, `green`, `blue`, `brightness` are provided as integers from range 0-255. Value of `color_temp` is provided as integer representing mired units." description: "The [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) for *on* state changes. Available variables: `state`, `brightness`, `color_temp`, `red`, `green`, `blue`, `flash`, `transition` and `effect`. Values `red`, `green`, `blue`, `brightness` are provided as integers from range 0-255. Value of `color_temp` is provided as integer representing mired units."
required: true required: true
type: string type: string
command_topic: command_topic:
@ -1011,11 +1011,11 @@ effect_list:
required: false required: false
type: [string, list] type: [string, list]
effect_template: effect_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract effect from the state payload value." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract effect from the state payload value."
required: false required: false
type: string type: string
green_template: green_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract green color from the state payload value. Expected result of the template is an integer from 0-255 range." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract green color from the state payload value. Expected result of the template is an integer from 0-255 range."
required: false required: false
type: string type: string
icon: icon:
@ -1023,7 +1023,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -1068,7 +1068,7 @@ qos:
type: integer type: integer
default: 0 default: 0
red_template: red_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract red color from the state payload value. Expected result of the template is an integer from 0-255 range." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract red color from the state payload value. Expected result of the template is an integer from 0-255 range."
required: false required: false
type: string type: string
schema: schema:
@ -1077,7 +1077,7 @@ schema:
type: string type: string
default: default default: default
state_template: state_template:
description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract state from the state payload value." description: "[Template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract state from the state payload value."
required: false required: false
type: string type: string
state_topic: state_topic:

8
source/_integrations/lock.mqtt.markdown
View File

@ -69,7 +69,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -78,7 +78,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -150,7 +150,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -225,7 +225,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value from the payload."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}

6
source/_integrations/number.mqtt.markdown
View File

@ -69,7 +69,7 @@ availability_mode:
type: string type: string
default: latest default: latest
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -142,7 +142,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -205,7 +205,7 @@ unit_of_measurement:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

1
source/_integrations/nzbget.markdown
View File

@ -34,6 +34,7 @@ This component will create these sensors:
- `nzbget_post_processing_paused`: Whether post processing is paused. - `nzbget_post_processing_paused`: Whether post processing is paused.
- `nzbget_uptime`: NZBGet server uptime. - `nzbget_uptime`: NZBGet server uptime.
- `nzbget_size`: Amount of data downloaded since server start in MB. - `nzbget_size`: Amount of data downloaded since server start in MB.
- `nzbget_speed_limit`: Download queue speed limit in MB/s.
## Event Automation ## Event Automation

2
source/_integrations/qingping.markdown
View File

@ -28,4 +28,6 @@ The Qingping integration will automatically discover devices once the [Bluetooth
- [Air Monitor Lite](https://www.qingping.co/air-monitor-lite/overview) (CGDN1) - [Air Monitor Lite](https://www.qingping.co/air-monitor-lite/overview) (CGDN1)
- [Alarm Clock](https://www.qingping.co/bluetooth-alarm-clock/overview) (CGD1) - [Alarm Clock](https://www.qingping.co/bluetooth-alarm-clock/overview) (CGD1)
- [BT Clock Lite](https://www.qingping.co/bluetooth-clock/overview) (CGC1) - [BT Clock Lite](https://www.qingping.co/bluetooth-clock/overview) (CGC1)
- [Door/Window Sensor](https://www.qingping.co/door-window-sensor/overview) (CGH1)
- [LEE GUITARS Thermo-Hygrometer](https://www.qingping.co/lee-guitars-thermo-hygrometer/overview) (CGM1)
- [Motion & Ambient Light Sensor](https://www.qingping.co/motion-light-sensor/overview) (CGPR1) - [Motion & Ambient Light Sensor](https://www.qingping.co/motion-light-sensor/overview) (CGPR1)

24
source/_integrations/risco.markdown
View File

@ -5,7 +5,7 @@ ha_category:
- Alarm - Alarm
- Binary Sensor - Binary Sensor
ha_release: '0.115' ha_release: '0.115'
ha_iot_class: Cloud Polling ha_iot_class: Local Push
ha_config_flow: true ha_config_flow: true
ha_codeowners: ha_codeowners:
- '@OnFreund' - '@OnFreund'
@ -18,14 +18,17 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
This integration connects with Risco Alarms over [Risco Cloud](https://riscocloud.com/). This integration connects with Risco Alarms, in one of two ways:
## Risco Cloud (recommended)
The integration will connect with your alarm over [Risco Cloud](https://riscocloud.com/).
This is easiest to configure, and is widely supported, but is cloud based, and requires polling.
<div class='note'> <div class='note'>
As from January 2021, Risco have implemented charges for use of their Cloud Features. As of January 2021, Risco have implemented charges for use of their Cloud Features.
</div> </div>
{% include integrations/config_flow.md %}
<div class='note warning'> <div class='note warning'>
It is recommended to use a regular (non-owner) account with the Risco app/website, and use a different regular account with the integration. Risco has restrictions on concurrent uses by different users, especially if they have different permission levels. It is recommended to use a regular (non-owner) account with the Risco app/website, and use a different regular account with the integration. Risco has restrictions on concurrent uses by different users, especially if they have different permission levels.
</div> </div>
@ -35,6 +38,17 @@ has the event timestamp as the state, and other event information in attributes.
If you have multiple sites, only the first site will be used. If you have multiple sites, only the first site will be used.
## Local (advanced)
The integration will connect locally to your system.
No dependency on the cloud, and instantaneous updates, but is harder to set up.
You will need the master code to your system, and with older models,
you might need to either disconnect your system from the cloud, or set up a proxy that will allow you to connect both locally and via the cloud.
The local version of the integration does not support events, and the `arming` state.
{% include integrations/config_flow.md %}
## Options ## Options
You can configure additional behavior by clicking on **Options** in the relevant box in the Integration panel: You can configure additional behavior by clicking on **Options** in the relevant box in the Integration panel:

4
source/_integrations/scene.mqtt.markdown
View File

@ -61,7 +61,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -70,7 +70,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:

10
source/_integrations/select.mqtt.markdown
View File

@ -69,7 +69,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -82,11 +82,11 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate the payload to send to `command_topic`. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -154,7 +154,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -197,7 +197,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

10
source/_integrations/sensor.mqtt.markdown
View File

@ -61,7 +61,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -70,7 +70,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -153,7 +153,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -161,7 +161,7 @@ json_attributes_topic:
required: false required: false
type: string type: string
last_reset_value_template: last_reset_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the last_reset. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the last_reset. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes."
required: false required: false
type: string type: string
name: name:
@ -206,7 +206,7 @@ unit_of_measurement:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes. If the template throws an error, the current state will be used instead." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes. If the template throws an error, the current state will be used instead."
required: false required: false
type: template type: template
{% endconfiguration %} {% endconfiguration %}

12
source/_integrations/siren.mqtt.markdown
View File

@ -66,7 +66,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -75,7 +75,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -87,11 +87,11 @@ available_tones:
required: false required: false
type: list type: list
command_template: command_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate a custom payload to send to `command_topic`. The variable `value` will be assigned with the configured `payload_on` or `payload_off` setting. The siren turn on service parameters `tone`, `volume_level` or `duration` can be used as variables in the template. When operation in optimistic mode the corresponding state attributes will be set. Turn on parameters will be filtered if a device misses the support. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic`. The variable `value` will be assigned with the configured `payload_on` or `payload_off` setting. The siren turn on service parameters `tone`, `volume_level` or `duration` can be used as variables in the template. When operation in optimistic mode the corresponding state attributes will be set. Turn on parameters will be filtered if a device misses the support.
required: false required: false
type: template type: template
command_off_template: command_off_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to generate a custom payload to send to `command_topic` when the siren turn off service is called. By default `command_template` will be used as template for service turn off. The variable `value` will be assigned with the configured `payload_off` setting. description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic` when the siren turn off service is called. By default `command_template` will be used as template for service turn off. The variable `value` will be assigned with the configured `payload_off` setting.
required: false required: false
type: template type: template
command_topic: command_topic:
@ -160,7 +160,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -226,7 +226,7 @@ state_topic:
required: false required: false
type: string type: string
state_value_template: state_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's state from the `state_topic`. To determine the siren's state result of this template will be compared to `state_on` and `state_off`. Alternatively `value_template` can be used to render to a valid JSON payload." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's state from the `state_topic`. To determine the siren's state result of this template will be compared to `state_on` and `state_off`. Alternatively `value_template` can be used to render to a valid JSON payload."
required: false required: false
type: string type: string
support_duration: support_duration:

90
source/_integrations/sms.markdown
View File

@ -26,22 +26,94 @@ This integration provides the following platforms:
## Notifications ## Notifications
To configure the notification service, edit your `configuration.yaml` file: An SMS message can be sent by calling the `notify.sms`. It will send the message to all phone numbers specified in the `target` parameter.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
### Send message
```yaml ```yaml
notify: action:
- platform: sms service: notify.sms
name: sms_person1 data:
recipient: PHONE_NUMBER message: "This is a message for you!"
- platform: sms target: "+5068081-8181"
name: sms_person2
recipient: PHONE_NUMBER
``` ```
### Sending SMS using GSM alphabet
Some devices (receiving or sending) do not support Unicode (the default encoding). For these you can disable Unicode:
```yaml
action:
service: notify.sms
data:
message: "This is a message for you in ANSI"
target: "+5068081-8181"
data:
unicode: False
```
### Getting SMS messages
You can also receive SMS messages that are sent to the SIM card number in your device. You can also receive SMS messages that are sent to the SIM card number in your device.
Every time there is a message received, `event: sms.incoming_sms` is fired with date, phone number and text message. Every time there is a message received, `event: sms.incoming_sms` is fired with date, phone number and text message.
Sample automation that forward all SMS to `user1`:
To use notifications, please see the [getting started with automation page](/getting-started/automation/). #### Define a sensor in `configuration.yaml` to protect user phone number
```yaml
template:
- sensor:
- name: "User1 Phone Number"
state: !secret user1_phone_number
```
#### Define a script in `scripts.yaml` to use the sensor
{% raw %}
```yaml
notify_sms_user1:
alias: Notify via SMS to User1
fields:
message:
description: The message content
example: The light is on!
sequence:
- service: notify.sms
data:
message: "{{ message }}"
target: states(sensor.user1_phone_number)
mode: single
icon: mdi:chat-alert
```
{% endraw %}
#### Putting it all together in `automations.yaml`
{% raw %}
```yaml
- id: 'forward_sms'
alias: Forward SMS
description: ''
trigger:
- platform: event
event_type: sms.incoming_sms
condition: []
action:
- service: script.notify_sms_user1
data:
message: 'From: {{trigger.event.data.phone}}
{{trigger.event.data.text}}
'
mode: single
```
{% endraw %}
## Notes about the operating system
If the integration is used with the Home Assistant Operating System, then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required. If the integration is used with the Home Assistant Operating System, then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required.

8
source/_integrations/switch.mqtt.markdown
View File

@ -67,7 +67,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -76,7 +76,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -153,7 +153,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -223,7 +223,7 @@ unique_id:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's state from the `state_topic`. To determine the switches's state result of this template will be compared to `state_on` and `state_off`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's state from the `state_topic`. To determine the switches's state result of this template will be compared to `state_on` and `state_off`."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}

2
source/_integrations/tag.mqtt.markdown
View File

@ -21,7 +21,7 @@ topic:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) that returns a tag ID." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) that returns a tag ID."
required: false required: false
type: string type: string
device: device:

12
source/_integrations/vacuum.mqtt.markdown
View File

@ -70,7 +70,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -79,7 +79,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -162,7 +162,7 @@ icon:
required: false required: false
type: icon type: icon
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic:
@ -363,7 +363,7 @@ availability:
required: true required: true
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_mode: availability_mode:
@ -372,7 +372,7 @@ availability_mode:
type: string type: string
default: latest default: latest
availability_template: availability_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
required: false required: false
type: template type: template
availability_topic: availability_topic:
@ -434,7 +434,7 @@ fan_speed_list:
required: false required: false
type: [string, list] type: [string, list]
json_attributes_template: json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false required: false
type: template type: template
json_attributes_topic: json_attributes_topic: