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-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT Fan docs - sorted config and small text corrections (#18454)

Browse Source 
* sorted config and small text corrections

* remove unneeded raw tags
This commit is contained in:
Jan Bouwhuis 2021-07-12 18:26:16 +02:00 committed by GitHub
parent 17f9f7ca3a
commit 8a44aee384
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -197,7 +197,7 @@ 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 a value from fan percentage speed. description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) 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:
@ -213,7 +213,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 a value from the preset_mode payload. 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`.
required: false required: false
type: string type: string
preset_modes: preset_modes:
@ -231,16 +231,16 @@ retain:
required: false required: false
type: boolean type: boolean
default: true default: true
speed_range_min:
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - 1 represents 0%). The number of speeds within the speed_range / 100 will determine the `percentage_step`.
required: false
type: integer
default: 1
speed_range_max: speed_range_max:
description: The maximum of numeric output range (representing 100%). The number of speeds within the speed_range / 100 will determine the `percentage_step`. description: The maximum of numeric output range (representing 100 %). The number of speeds within the `speed_range` / `100` will determine the `percentage_step`.
required: false required: false
type: integer type: integer
default: 100 default: 100
speed_range_min:
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - `1` represents 0 %). The number of speeds within the speed_range / 100 will determine the `percentage_step`.
required: false
type: integer
default: 1
state_topic: state_topic:
description: The MQTT topic subscribed to receive state updates. description: The MQTT topic subscribed to receive state updates.
required: false required: false
@ -298,13 +298,14 @@ fan:
speed_range_max: 10 speed_range_max: 10
``` ```
{% raw %} ### Configuration using command templates
This example demonstrates how to use command templates with JSON output. This example demonstrates how to use command templates with JSON output.
{% raw %}
```yaml ```yaml
# Example configuration.yaml # Example configuration.yaml with command templates
# Example using command templates
fan: fan:
- platform: mqtt - platform: mqtt
name: "Bedroom Fan" name: "Bedroom Fan"