mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Introduce new yaml style and update examples (#28229)
* Introduce new yaml style and update examples * Apply suggestions from code review Thnx @frenck ! Co-authored-by: Franck Nijhof <frenck@frenck.nl> --------- Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
ba45d161bb
commit
35ade923d9
@ -34,8 +34,8 @@ To enable this platform, add the following lines to your `configuration.yaml`:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
alarm_control_panel:
|
- alarm_control_panel:
|
||||||
- state_topic: "home/alarm"
|
state_topic: "home/alarm"
|
||||||
command_topic: "home/alarm/set"
|
command_topic: "home/alarm/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -267,8 +267,8 @@ The example below shows a full configuration with local code validation.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example using text based code with local validation configuration.yaml
|
# Example using text based code with local validation configuration.yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
alarm_control_panel:
|
- alarm_control_panel:
|
||||||
- name: "Alarm Panel With Numeric Keypad"
|
name: "Alarm Panel With Numeric Keypad"
|
||||||
state_topic: "alarmdecoder/panel"
|
state_topic: "alarmdecoder/panel"
|
||||||
value_template: "{{value_json.state}}"
|
value_template: "{{value_json.state}}"
|
||||||
command_topic: "alarmdecoder/panel/set"
|
command_topic: "alarmdecoder/panel/set"
|
||||||
@ -286,8 +286,8 @@ The example below shows a full configuration with remote code validation and `co
|
|||||||
```yaml
|
```yaml
|
||||||
# Example using text code with remote validation configuration.yaml
|
# Example using text code with remote validation configuration.yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
alarm_control_panel:
|
- alarm_control_panel:
|
||||||
- name: "Alarm Panel With Text Code Dialog"
|
name: "Alarm Panel With Text Code Dialog"
|
||||||
state_topic: "alarmdecoder/panel"
|
state_topic: "alarmdecoder/panel"
|
||||||
value_template: "{{ value_json.state }}"
|
value_template: "{{ value_json.state }}"
|
||||||
command_topic: "alarmdecoder/panel/set"
|
command_topic: "alarmdecoder/panel/set"
|
||||||
@ -299,8 +299,8 @@ mqtt:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example using numeric code with remote validation configuration.yaml
|
# Example using numeric code with remote validation configuration.yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
alarm_control_panel:
|
- alarm_control_panel:
|
||||||
- name: "Alarm Panel With Numeric Keypad"
|
name: "Alarm Panel With Numeric Keypad"
|
||||||
state_topic: "alarmdecoder/panel"
|
state_topic: "alarmdecoder/panel"
|
||||||
value_template: "{{ value_json.state }}"
|
value_template: "{{ value_json.state }}"
|
||||||
command_topic: "alarmdecoder/panel/set"
|
command_topic: "alarmdecoder/panel/set"
|
||||||
|
@ -27,8 +27,8 @@ add the following to your `configuration.yaml` file:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
binary_sensor:
|
- binary_sensor:
|
||||||
- state_topic: "home-assistant/window/contact"
|
state_topic: "home-assistant/window/contact"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -230,8 +230,8 @@ The example below shows a full configuration for a binary sensor:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
binary_sensor:
|
- binary_sensor:
|
||||||
- name: "Window Contact Sensor"
|
name: "Window Contact Sensor"
|
||||||
state_topic: "home-assistant/window/contact"
|
state_topic: "home-assistant/window/contact"
|
||||||
payload_on: "ON"
|
payload_on: "ON"
|
||||||
availability:
|
availability:
|
||||||
@ -252,8 +252,8 @@ mqtt:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
binary_sensor:
|
- binary_sensor:
|
||||||
- state_topic: "lab_button/cmnd/POWER"
|
state_topic: "lab_button/cmnd/POWER"
|
||||||
value_template: "{%if is_state(entity_id,\"on\")-%}OFF{%-else-%}ON{%-endif%}"
|
value_template: "{%if is_state(entity_id,\"on\")-%}OFF{%-else-%}ON{%-endif%}"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -276,8 +276,8 @@ The configuration will look like the example below:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
binary_sensor:
|
- binary_sensor:
|
||||||
- name: Bathroom
|
name: Bathroom
|
||||||
state_topic: "home/bathroom/switch/button"
|
state_topic: "home/bathroom/switch/button"
|
||||||
payload_on: "1"
|
payload_on: "1"
|
||||||
payload_off: "0"
|
payload_off: "0"
|
||||||
|
@ -17,8 +17,8 @@ The `mqtt` button platform lets you send an MQTT message when the button is pres
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
button:
|
- button:
|
||||||
- command_topic: "home/bedroom/switch1/reboot"
|
command_topic: "home/bedroom/switch1/reboot"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -201,8 +201,8 @@ The example below shows a full configuration for a button.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
button:
|
- button:
|
||||||
- unique_id: bedroom_switch_reboot_btn
|
unique_id: bedroom_switch_reboot_btn
|
||||||
name: "Restart Bedroom Switch"
|
name: "Restart Bedroom Switch"
|
||||||
command_topic: "home/bedroom/switch1/commands"
|
command_topic: "home/bedroom/switch1/commands"
|
||||||
payload_press: "restart"
|
payload_press: "restart"
|
||||||
|
@ -21,8 +21,8 @@ To enable this camera in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
camera:
|
- camera:
|
||||||
- topic: zanzito/shared_locations/my-device
|
topic: zanzito/shared_locations/my-device
|
||||||
```
|
```
|
||||||
|
|
||||||
The sample configuration above can be tested by publishing an image to the topic from the console:
|
The sample configuration above can be tested by publishing an image to the topic from the console:
|
||||||
|
@ -19,8 +19,8 @@ To enable this climate platform in your installation, first add the following to
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
climate:
|
- climate:
|
||||||
- name: Study
|
name: Study
|
||||||
mode_command_topic: "study/ac/mode/set"
|
mode_command_topic: "study/ac/mode/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -431,8 +431,8 @@ Say you receive the operation mode `"auto"` via your `mode_state_topic`, but the
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
climate:
|
- climate:
|
||||||
- name: Study
|
name: Study
|
||||||
modes:
|
modes:
|
||||||
- "off"
|
- "off"
|
||||||
- "heat"
|
- "heat"
|
||||||
@ -457,8 +457,8 @@ A full configuration example looks like the one below.
|
|||||||
```yaml
|
```yaml
|
||||||
# Full example configuration.yaml entry
|
# Full example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
climate:
|
- climate:
|
||||||
- name: Study
|
name: Study
|
||||||
modes:
|
modes:
|
||||||
- "off"
|
- "off"
|
||||||
- "cool"
|
- "cool"
|
||||||
|
@ -34,8 +34,8 @@ To use your MQTT cover in your installation, add the following to your `configur
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -332,8 +332,8 @@ The example below shows a full configuration for a cover without tilt with state
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
availability:
|
availability:
|
||||||
@ -364,8 +364,8 @@ The example below shows a full configuration for a cover without tilt with posit
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
availability:
|
availability:
|
||||||
@ -395,8 +395,8 @@ The example below shows a full configuration for a cover with position, state &
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -436,8 +436,8 @@ The example below shows a full configuration for a cover using stopped state.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -470,8 +470,8 @@ Setting `payload_close` empty or to `null` disables the close command and will n
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- payload_open: "on"
|
payload_open: "on"
|
||||||
payload_close:
|
payload_close:
|
||||||
payload_stop: "on"
|
payload_stop: "on"
|
||||||
```
|
```
|
||||||
@ -505,8 +505,8 @@ The example below shows an example of how to correct the state of the blind depe
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
@ -549,8 +549,8 @@ Following variable might be used in `position_template`, `set_position_template`
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
cover:
|
- cover:
|
||||||
- name: "MQTT Cover"
|
name: "MQTT Cover"
|
||||||
command_topic: "home-assistant/cover/set"
|
command_topic: "home-assistant/cover/set"
|
||||||
state_topic: "home-assistant/cover/state"
|
state_topic: "home-assistant/cover/state"
|
||||||
position_topic: "home-assistant/cover/position"
|
position_topic: "home-assistant/cover/position"
|
||||||
|
@ -20,11 +20,12 @@ To use this device tracker in your installation, add the following to your `conf
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
device_tracker:
|
- device_tracker:
|
||||||
- name: "annetherese_n4"
|
name: "annetherese_n4"
|
||||||
state_topic: "location/annetherese"
|
state_topic: "location/annetherese"
|
||||||
- name: "paulus_oneplus"
|
- device_tracker:
|
||||||
state_topic: "location/paulus"
|
name: "paulus_oneplus"
|
||||||
|
state_topic: "location/paulus"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -253,8 +254,8 @@ The following example shows how to configure the same device tracker through con
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
device_tracker:
|
- device_tracker:
|
||||||
- name: "My Tracker"
|
name: "My Tracker"
|
||||||
state_topic: "a4567d663eaf/state"
|
state_topic: "a4567d663eaf/state"
|
||||||
payload_home: "home"
|
payload_home: "home"
|
||||||
payload_not_home: "not_home"
|
payload_not_home: "not_home"
|
||||||
|
@ -25,8 +25,8 @@ To enable MQTT fans in your installation, add the following to your `configurati
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
fan:
|
- fan:
|
||||||
- command_topic: "bedroom_fan/on/set"
|
command_topic: "bedroom_fan/on/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -321,8 +321,8 @@ There are 10 speeds within the speed range, so `percentage_step` = 100 / 10 ste
|
|||||||
```yaml
|
```yaml
|
||||||
# Example using percentage based speeds with preset modes configuration.yaml
|
# Example using percentage based speeds with preset modes configuration.yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
fan:
|
- fan:
|
||||||
- name: "Bedroom Fan"
|
name: "Bedroom Fan"
|
||||||
state_topic: "bedroom_fan/on/state"
|
state_topic: "bedroom_fan/on/state"
|
||||||
command_topic: "bedroom_fan/on/set"
|
command_topic: "bedroom_fan/on/set"
|
||||||
direction_state_topic: "bedroom_fan/direction/state"
|
direction_state_topic: "bedroom_fan/direction/state"
|
||||||
@ -358,8 +358,8 @@ This example demonstrates how to use command templates with JSON output.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml with command templates
|
# Example configuration.yaml with command templates
|
||||||
mqtt:
|
mqtt:
|
||||||
fan:
|
- fan:
|
||||||
- name: "Bedroom Fan"
|
name: "Bedroom Fan"
|
||||||
command_topic: "bedroom_fan/on/set"
|
command_topic: "bedroom_fan/on/set"
|
||||||
command_template: "{ state: '{{ value }}'}"
|
command_template: "{ state: '{{ value }}'}"
|
||||||
direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}"
|
direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}"
|
||||||
@ -387,8 +387,8 @@ This example shows how to configure a fan that doesn't use `forward` and `backwa
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml with direction templates
|
# Example configuration.yaml with direction templates
|
||||||
mqtt:
|
mqtt:
|
||||||
fan:
|
- fan:
|
||||||
- name: "Bedroom Fan"
|
name: "Bedroom Fan"
|
||||||
direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}"
|
direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}"
|
||||||
direction_value_template: "{{ iif(value == 'fwd', 'forward', 'reverse') }}"
|
direction_value_template: "{{ iif(value == 'fwd', 'forward', 'reverse') }}"
|
||||||
```
|
```
|
||||||
|
@ -25,8 +25,8 @@ To enable MQTT humidifiers in your installation, add the following to your `conf
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
humidifier:
|
- humidifier:
|
||||||
- command_topic: "bedroom_humidifier/on/set"
|
command_topic: "bedroom_humidifier/on/set"
|
||||||
target_humidity_command_topic: "bedroom_humidifier/humidity/set"
|
target_humidity_command_topic: "bedroom_humidifier/humidity/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -304,8 +304,8 @@ The example below shows a full configuration for a MQTT humidifier including mod
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml
|
# Example configuration.yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
humidifier:
|
- humidifier:
|
||||||
- name: "Bedroom humidifier"
|
name: "Bedroom humidifier"
|
||||||
device_class: "humidifier"
|
device_class: "humidifier"
|
||||||
state_topic: "bedroom_humidifier/on/state"
|
state_topic: "bedroom_humidifier/on/state"
|
||||||
action_topic: "bedroom_humidifier/action"
|
action_topic: "bedroom_humidifier/action"
|
||||||
|
@ -47,8 +47,8 @@ The state of MQTT lights with default schema and support for both color and colo
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- command_topic: "office/rgb1/light/switch"
|
command_topic: "office/rgb1/light/switch"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -419,8 +419,8 @@ To enable a light with brightness and RGB support in your installation, add the
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- name: "Office Light RGB"
|
name: "Office Light RGB"
|
||||||
state_topic: "office/rgb1/light/status"
|
state_topic: "office/rgb1/light/status"
|
||||||
command_topic: "office/rgb1/light/switch"
|
command_topic: "office/rgb1/light/switch"
|
||||||
brightness_state_topic: "office/rgb1/brightness/status"
|
brightness_state_topic: "office/rgb1/brightness/status"
|
||||||
@ -445,8 +445,8 @@ To enable a light with brightness (no RGB version) in your installation, add the
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- name: "Office light"
|
name: "Office light"
|
||||||
state_topic: "office/light/status"
|
state_topic: "office/light/status"
|
||||||
command_topic: "office/light/switch"
|
command_topic: "office/light/switch"
|
||||||
brightness_state_topic: 'office/light/brightness'
|
brightness_state_topic: 'office/light/brightness'
|
||||||
@ -464,8 +464,8 @@ To enable a light that sends only brightness topics to turn it on, add the follo
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- name: "Brightness light"
|
name: "Brightness light"
|
||||||
state_topic: "office/light/status"
|
state_topic: "office/light/status"
|
||||||
command_topic: "office/light/switch"
|
command_topic: "office/light/switch"
|
||||||
payload_off: "OFF"
|
payload_off: "OFF"
|
||||||
@ -519,8 +519,8 @@ Optimistic mode can be forced, even if state topic is available. Try enabling it
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
command_topic: "home/rgb1/set"
|
command_topic: "home/rgb1/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -748,8 +748,8 @@ To enable a light with brightness and RGB support in your installation, add the
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
name: mqtt_json_light_1
|
name: mqtt_json_light_1
|
||||||
state_topic: "home/rgb1"
|
state_topic: "home/rgb1"
|
||||||
command_topic: "home/rgb1/set"
|
command_topic: "home/rgb1/set"
|
||||||
@ -765,8 +765,8 @@ To enable a light with brightness (but no color support) in your installation, a
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
name: mqtt_json_light_1
|
name: mqtt_json_light_1
|
||||||
state_topic: "home/rgb1"
|
state_topic: "home/rgb1"
|
||||||
command_topic: "home/rgb1/set"
|
command_topic: "home/rgb1/set"
|
||||||
@ -782,8 +782,8 @@ To enable a light using a brightness scale other than 8bit the `brightness_scale
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
name: mqtt_json_light_1
|
name: mqtt_json_light_1
|
||||||
state_topic: "home/light"
|
state_topic: "home/light"
|
||||||
command_topic: "home/light/set"
|
command_topic: "home/light/set"
|
||||||
@ -808,8 +808,8 @@ To use a light with hue+saturation as the color model, set `supported_color_mode
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
name: mqtt_json_hs_light
|
name: mqtt_json_hs_light
|
||||||
state_topic: "home/light"
|
state_topic: "home/light"
|
||||||
command_topic: "home/light/set"
|
command_topic: "home/light/set"
|
||||||
@ -837,8 +837,8 @@ To enable a light with brightness, RGB support and a separate white channel (RGB
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: json
|
schema: json
|
||||||
name: mqtt_json_light_1
|
name: mqtt_json_light_1
|
||||||
state_topic: "home/rgbw1"
|
state_topic: "home/rgbw1"
|
||||||
command_topic: "home/rgbw1/set"
|
command_topic: "home/rgbw1/set"
|
||||||
@ -881,8 +881,8 @@ Optimistic mode can be forced, even if state topic is available. Try enabling it
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: template
|
schema: template
|
||||||
command_topic: "home/rgb1/set"
|
command_topic: "home/rgb1/set"
|
||||||
command_on_template: "on"
|
command_on_template: "on"
|
||||||
command_off_template: "off"
|
command_off_template: "off"
|
||||||
@ -1100,8 +1100,8 @@ For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g.,
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: template
|
schema: template
|
||||||
command_topic: "home/rgb1/set"
|
command_topic: "home/rgb1/set"
|
||||||
state_topic: "home/rgb1/status"
|
state_topic: "home/rgb1/status"
|
||||||
command_on_template: "on,{{ brightness|d }},{{ red|d }}-{{ green|d }}-{{ blue|d }},{{ hue|d }}-{{ sat|d }}"
|
command_on_template: "on,{{ brightness|d }},{{ red|d }}-{{ green|d }}-{{ blue|d }},{{ hue|d }}-{{ sat|d }}"
|
||||||
@ -1124,8 +1124,8 @@ For a JSON payload with the format `{"state": "on", "brightness": 255, "color":
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: template
|
schema: template
|
||||||
effect_list:
|
effect_list:
|
||||||
- rainbow
|
- rainbow
|
||||||
- colorloop
|
- colorloop
|
||||||
@ -1169,8 +1169,8 @@ Add the following to your `configuration.yaml` file:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
light:
|
- light:
|
||||||
- schema: template
|
schema: template
|
||||||
name: "Bulb-white"
|
name: "Bulb-white"
|
||||||
command_topic: "shellies/bulb/color/0/set"
|
command_topic: "shellies/bulb/color/0/set"
|
||||||
state_topic: "shellies/bulb/color/0/status"
|
state_topic: "shellies/bulb/color/0/status"
|
||||||
|
@ -28,8 +28,8 @@ To enable MQTT locks in your installation, add the following to your `configurat
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
lock:
|
- lock:
|
||||||
- command_topic: "home/frontdoor/set"
|
command_topic: "home/frontdoor/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -260,8 +260,8 @@ The example below shows a full configuration for a MQTT lock.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
lock:
|
- lock:
|
||||||
- name: Frontdoor
|
name: Frontdoor
|
||||||
state_topic: "home-assistant/frontdoor/state"
|
state_topic: "home-assistant/frontdoor/state"
|
||||||
code_format: "^\\d{4}$"
|
code_format: "^\\d{4}$"
|
||||||
command_topic: "home-assistant/frontdoor/set"
|
command_topic: "home-assistant/frontdoor/set"
|
||||||
|
@ -679,7 +679,36 @@ In the example above, the entity_id will be `sensor.my_super_device` instead of
|
|||||||
|
|
||||||
For most integrations, it is also possible to manually set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml).
|
For most integrations, it is also possible to manually set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml).
|
||||||
|
|
||||||
{% details "MQTT integrations that support setup via YAML" %}
|
MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt.
|
||||||
|
|
||||||
|
### YAML configuration listed per item
|
||||||
|
|
||||||
|
This method expects all items to be in a YAML list. Each item has a `{domain}` key and the item config is placed directly under the domain key. This method is considered as best practice. In all the examples we use this format.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
mqtt:
|
||||||
|
- {domain}:
|
||||||
|
name: ""
|
||||||
|
...
|
||||||
|
- {domain}:
|
||||||
|
name: ""
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### YAML configuration keyed and bundled by `{domain}`
|
||||||
|
|
||||||
|
All items are grouped per `{domain}` and where all configs are listed.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
mqtt:
|
||||||
|
{domain}:
|
||||||
|
- name: ""
|
||||||
|
...
|
||||||
|
- name: ""
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
{% details "MQTT components that support setup via YAML" %}
|
||||||
|
|
||||||
- [Alarm control panel](/integrations/alarm_control_panel.mqtt/)
|
- [Alarm control panel](/integrations/alarm_control_panel.mqtt/)
|
||||||
- [Binary sensor](/integrations/binary_sensor.mqtt/)
|
- [Binary sensor](/integrations/binary_sensor.mqtt/)
|
||||||
|
@ -19,8 +19,8 @@ To enable MQTT Number in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
number:
|
- number:
|
||||||
- command_topic: my-device/threshold
|
command_topic: my-device/threshold
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
|
@ -19,8 +19,8 @@ To enable a MQTT scene in your installation, add the following to your `configur
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
scene:
|
- scene:
|
||||||
- command_topic: zigbee2mqtt/living_room_group/set
|
command_topic: zigbee2mqtt/living_room_group/set
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -135,8 +135,8 @@ The example below shows a full configuration for a scene.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
scene:
|
- scene:
|
||||||
- unique_id: living_room_party_scene
|
unique_id: living_room_party_scene
|
||||||
name: "Living Room Party Scene"
|
name: "Living Room Party Scene"
|
||||||
command_topic: "home/living_room/party_scene/set"
|
command_topic: "home/living_room/party_scene/set"
|
||||||
availability:
|
availability:
|
||||||
@ -153,8 +153,8 @@ The example below shows a configuration using a JSON payload.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
scene:
|
- scene:
|
||||||
- name: Living Room Blue Scene
|
name: Living Room Blue Scene
|
||||||
unique_id: living_room_blue_scene
|
unique_id: living_room_blue_scene
|
||||||
command_topic: "home/living_room/set"
|
command_topic: "home/living_room/set"
|
||||||
payload_on: '{"activate_scene": "Blue Scene"}'
|
payload_on: '{"activate_scene": "Blue Scene"}'
|
||||||
|
@ -19,12 +19,12 @@ To enable MQTT Select in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
select:
|
- select:
|
||||||
- command_topic: topic
|
command_topic: topic
|
||||||
name: "Test Select"
|
name: "Test Select"
|
||||||
options:
|
options:
|
||||||
- "Option 1"
|
- "Option 1"
|
||||||
- "Option 2"
|
- "Option 2"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
|
@ -19,8 +19,8 @@ To use your MQTT sensor in your installation, add the following to your `configu
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- state_topic: "home/bedroom/temperature"
|
state_topic: "home/bedroom/temperature"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -220,8 +220,8 @@ Extra attributes will be displayed in the frontend and can also be extracted in
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "RSSI"
|
name: "RSSI"
|
||||||
state_topic: "home/sensor1/infojson"
|
state_topic: "home/sensor1/infojson"
|
||||||
unit_of_measurement: "dBm"
|
unit_of_measurement: "dBm"
|
||||||
value_template: "{{ value_json.RSSI }}"
|
value_template: "{{ value_json.RSSI }}"
|
||||||
@ -245,13 +245,14 @@ Extra attributes will be displayed in the frontend and can also be extracted in
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "Timer 1"
|
name: "Timer 1"
|
||||||
state_topic: "tele/sonoff/sensor"
|
state_topic: "tele/sonoff/sensor"
|
||||||
value_template: "{{ value_json.Timer1.Arm }}"
|
value_template: "{{ value_json.Timer1.Arm }}"
|
||||||
json_attributes_topic: "tele/sonoff/sensor"
|
json_attributes_topic: "tele/sonoff/sensor"
|
||||||
json_attributes_template: "{{ value_json.Timer1 | tojson }}"
|
json_attributes_template: "{{ value_json.Timer1 | tojson }}"
|
||||||
- name: "Timer 2"
|
- sensor:
|
||||||
|
name: "Timer 2"
|
||||||
state_topic: "tele/sonoff/sensor"
|
state_topic: "tele/sonoff/sensor"
|
||||||
value_template: "{{ value_json.Timer2.Arm }}"
|
value_template: "{{ value_json.Timer2.Arm }}"
|
||||||
json_attributes_topic: "tele/sonoff/sensor"
|
json_attributes_topic: "tele/sonoff/sensor"
|
||||||
@ -271,8 +272,8 @@ The example below shows how a simple filter, that calculates the value by adding
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "Temp 1"
|
name: "Temp 1"
|
||||||
state_topic: "sensor/temperature"
|
state_topic: "sensor/temperature"
|
||||||
value_template: |-
|
value_template: |-
|
||||||
{% if states(entity_id) == None %}
|
{% if states(entity_id) == None %}
|
||||||
@ -299,8 +300,8 @@ Thus the trick is extracting the battery level from the payload.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "Battery Tablet"
|
name: "Battery Tablet"
|
||||||
state_topic: "owntracks/tablet/tablet"
|
state_topic: "owntracks/tablet/tablet"
|
||||||
unit_of_measurement: "%"
|
unit_of_measurement: "%"
|
||||||
value_template: "{{ value_json.batt }}"
|
value_template: "{{ value_json.batt }}"
|
||||||
@ -327,13 +328,14 @@ Then use this configuration example to extract the data from the payload:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "Temperature"
|
name: "Temperature"
|
||||||
state_topic: "office/sensor1"
|
state_topic: "office/sensor1"
|
||||||
suggested_display_precision: 1
|
suggested_display_precision: 1
|
||||||
unit_of_measurement: "°C"
|
unit_of_measurement: "°C"
|
||||||
value_template: "{{ value_json.temperature }}"
|
value_template: "{{ value_json.temperature }}"
|
||||||
- name: "Humidity"
|
- sensor:
|
||||||
|
name: "Humidity"
|
||||||
state_topic: "office/sensor1"
|
state_topic: "office/sensor1"
|
||||||
unit_of_measurement: "%"
|
unit_of_measurement: "%"
|
||||||
value_template: "{{ value_json.humidity }}"
|
value_template: "{{ value_json.humidity }}"
|
||||||
@ -363,7 +365,7 @@ The configuration will look like the example below:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
sensor:
|
- sensor:
|
||||||
- name: "Brightness"
|
name: "Brightness"
|
||||||
state_topic: "home/bathroom/analog/brightness"
|
state_topic: "home/bathroom/analog/brightness"
|
||||||
```
|
```
|
||||||
|
@ -25,8 +25,8 @@ To enable this siren in your installation, add the following to your `configurat
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
siren:
|
- siren:
|
||||||
- command_topic: "home/bedroom/siren/set"
|
command_topic: "home/bedroom/siren/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -252,8 +252,8 @@ The example below shows a full configuration for a siren.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
siren:
|
- siren:
|
||||||
- unique_id: custom_siren
|
unique_id: custom_siren
|
||||||
name: "Intrusion siren"
|
name: "Intrusion siren"
|
||||||
state_topic: "home/alarm/siren1"
|
state_topic: "home/alarm/siren1"
|
||||||
command_topic: "home/alarm/siren1/set"
|
command_topic: "home/alarm/siren1/set"
|
||||||
@ -282,8 +282,8 @@ The example below shows a configuration for an On/Off type siren, which does not
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
siren:
|
- siren:
|
||||||
- unique_id: tasmota_siren
|
unique_id: tasmota_siren
|
||||||
name: "garage"
|
name: "garage"
|
||||||
state_topic: "stat/SIREN/RESULT"
|
state_topic: "stat/SIREN/RESULT"
|
||||||
command_topic: "cmnd/SIREN/POWER"
|
command_topic: "cmnd/SIREN/POWER"
|
||||||
|
@ -25,8 +25,8 @@ To enable this switch in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
switch:
|
- switch:
|
||||||
- command_topic: "home/bedroom/switch1/set"
|
command_topic: "home/bedroom/switch1/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -232,8 +232,8 @@ The example below shows a full configuration for a switch.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
switch:
|
- switch:
|
||||||
- unique_id: bedroom_switch
|
unique_id: bedroom_switch
|
||||||
name: "Bedroom Switch"
|
name: "Bedroom Switch"
|
||||||
state_topic: "home/bedroom/switch1"
|
state_topic: "home/bedroom/switch1"
|
||||||
command_topic: "home/bedroom/switch1/set"
|
command_topic: "home/bedroom/switch1/set"
|
||||||
@ -269,8 +269,8 @@ The configuration will look like the example below:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
switch:
|
- switch:
|
||||||
- name: bathroom
|
name: bathroom
|
||||||
state_topic: "home/bathroom/gpio/13"
|
state_topic: "home/bathroom/gpio/13"
|
||||||
command_topic: "home/bathroom/gpio/13"
|
command_topic: "home/bathroom/gpio/13"
|
||||||
payload_on: "1"
|
payload_on: "1"
|
||||||
|
@ -17,8 +17,8 @@ To enable MQTT text platform in your installation, add the following to your `co
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
text:
|
- text:
|
||||||
- command_topic: command-topic
|
command_topic: command-topic
|
||||||
```
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
@ -201,8 +201,8 @@ This is an example of a manual configured MQTT `text` item.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
text:
|
- text:
|
||||||
- name: "Remote LCD screen"
|
name: "Remote LCD screen"
|
||||||
icon: mdi:ab-testing
|
icon: mdi:ab-testing
|
||||||
mode: "text"
|
mode: "text"
|
||||||
command_topic: "txt/cmd"
|
command_topic: "txt/cmd"
|
||||||
|
@ -17,8 +17,8 @@ To enable MQTT Update in your installation, add the following to your `configura
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
update:
|
- update:
|
||||||
- state_topic: topic-installed
|
state_topic: topic-installed
|
||||||
latest_version_topic: topic-latest
|
latest_version_topic: topic-latest
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -216,8 +216,8 @@ This is an example of Update entity configuration for Shelly Gen1 device.
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
update:
|
- update:
|
||||||
- name: "Shelly Plug S Firmware Update"
|
name: "Shelly Plug S Firmware Update"
|
||||||
title: "Shelly Plug S Firmware"
|
title: "Shelly Plug S Firmware"
|
||||||
release_url: "https://shelly-api-docs.shelly.cloud/gen1/#changelog"
|
release_url: "https://shelly-api-docs.shelly.cloud/gen1/#changelog"
|
||||||
entity_picture: "https://brands.home-assistant.io/_/shelly/icon.png"
|
entity_picture: "https://brands.home-assistant.io/_/shelly/icon.png"
|
||||||
@ -256,8 +256,8 @@ For the above JSON payload, the `update` entity configuration should look like t
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
update:
|
- update:
|
||||||
- name: "Amazing Device Update"
|
name: "Amazing Device Update"
|
||||||
title: "Device Firmware"
|
title: "Device Firmware"
|
||||||
state_topic: "amazing-device/state-topic"
|
state_topic: "amazing-device/state-topic"
|
||||||
device_class: "firmware"
|
device_class: "firmware"
|
||||||
@ -287,8 +287,8 @@ For the above JSON payload, the `update` entity configuration should look like t
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
update:
|
update:
|
||||||
- name: "Amazing Device Update"
|
name: "Amazing Device Update"
|
||||||
title: "Device Firmware"
|
title: "Device Firmware"
|
||||||
state_topic: "amazing-device/state-topic"
|
state_topic: "amazing-device/state-topic"
|
||||||
value_template: "{{ {'installed_version': value_json.installed_ver, 'latest_version': value_json.new_ver } | to_json }}"
|
value_template: "{{ {'installed_version': value_json.installed_ver, 'latest_version': value_json.new_ver } | to_json }}"
|
||||||
|
@ -24,8 +24,8 @@ To add your MQTT vacuum to your installation, add the following to your `configu
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
vacuum:
|
- vacuum:
|
||||||
- command_topic: "vacuum/command"
|
command_topic: "vacuum/command"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Legacy Configuration
|
## Legacy Configuration
|
||||||
@ -247,8 +247,8 @@ unique_id:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
vacuum:
|
- vacuum:
|
||||||
- name: "MQTT Vacuum"
|
name: "MQTT Vacuum"
|
||||||
supported_features:
|
supported_features:
|
||||||
- turn_on
|
- turn_on
|
||||||
- turn_off
|
- turn_off
|
||||||
@ -520,8 +520,8 @@ unique_id:
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
vacuum:
|
- vacuum:
|
||||||
- name: "MQTT Vacuum"
|
name: "MQTT Vacuum"
|
||||||
schema: state
|
schema: state
|
||||||
supported_features:
|
supported_features:
|
||||||
- start
|
- start
|
||||||
|
@ -19,8 +19,8 @@ To enable this water heater platform in your installation, first add the followi
|
|||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
water_heater:
|
- water_heater:
|
||||||
- name: Boiler
|
name: Boiler
|
||||||
mode_command_topic: "basement/boiler/mode/set"
|
mode_command_topic: "basement/boiler/mode/set"
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -267,8 +267,8 @@ Say you receive the operation mode `"off"` via your `mode_state_topic`, but the
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mqtt:
|
mqtt:
|
||||||
water_heater:
|
- water_heater:
|
||||||
- name: Boiler
|
name: Boiler
|
||||||
modes:
|
modes:
|
||||||
- "off"
|
- "off"
|
||||||
- "eco"
|
- "eco"
|
||||||
@ -293,8 +293,8 @@ A full configuration example looks like the one below.
|
|||||||
```yaml
|
```yaml
|
||||||
# Full example configuration.yaml entry
|
# Full example configuration.yaml entry
|
||||||
mqtt:
|
mqtt:
|
||||||
water_heater:
|
- water_heater:
|
||||||
- name: Boiler
|
name: Boiler
|
||||||
modes:
|
modes:
|
||||||
- "off"
|
- "off"
|
||||||
- "eco"
|
- "eco"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user