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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve example and explain speed_range for mqtt fan (#17369)

Browse Source
This commit is contained in:
Jan Bouwhuis 2021-04-10 12:35:20 +02:00 committed by GitHub
parent c76a2f1287
commit d3df8f40f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -217,12 +217,12 @@ retain:
type: boolean type: boolean
default: true default: true
speed_range_min: speed_range_min:
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - 1 represents 0%). 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 required: false
type: integer type: integer
default: 1 default: 1
speed_range_max: speed_range_max:
description: The maximum of numeric output range (representing 100%). 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
@ -253,6 +253,7 @@ In this section you find some real-life examples of how to use this fan.
### Full configuration ### Full configuration
The example below shows a full configuration for a MQTT fan using percentage and preset modes. The example below shows a full configuration for a MQTT fan using percentage and preset modes.
There are 10 speeds within the speed range, so `percentage_step` = 100 / 10 steps = 10.0 %.
```yaml ```yaml
# Example using percentage based speeds with preset modes configuration.yaml # Example using percentage based speeds with preset modes configuration.yaml
@ -279,10 +280,10 @@ fan:
payload_oscillation_on: "true" payload_oscillation_on: "true"
payload_oscillation_off: "false" payload_oscillation_off: "false"
speed_range_min: 1 speed_range_min: 1
speed_range_max: 100 speed_range_max: 10
``` ```
{% raw %}} {% raw %}
This example demonstrates how to use command templates with JSON output. This example demonstrates how to use command templates with JSON output.

2
source/_integrations/fan.template.markdown
View File

@ -54,7 +54,7 @@ fan:
preset_modes: preset_modes:
- 'auto' - 'auto'
- 'smart' - 'smart'
- 'woosh' - 'whoosh'
``` ```
{% endraw %} {% endraw %}