mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 04:16:48 +00:00
Merge branch 'current' into next
This commit is contained in:
commit
f44ec4c702
@ -160,9 +160,6 @@ Supported abbreviations:
|
||||
'osc_cmd_t': 'oscillation_command_topic',
|
||||
'osc_stat_t': 'oscillation_state_topic',
|
||||
'osc_val_tpl': 'oscillation_value_template',
|
||||
'pct_cmd_t': 'percentage_command_topic',
|
||||
'pct_stat_t': 'percentage_state_topic',
|
||||
'pct_val_tpl': 'percentage_value_template',
|
||||
'pl': 'payload',
|
||||
'pl_arm_away': 'payload_arm_away',
|
||||
'pl_arm_home': 'payload_arm_home',
|
||||
@ -199,10 +196,6 @@ Supported abbreviations:
|
||||
'pow_cmd_t': 'power_command_topic',
|
||||
'pow_stat_t': 'power_state_topic',
|
||||
'pow_stat_tpl': 'power_state_template',
|
||||
'pr_mode_cmd_t': 'preset_mode_command_topic',
|
||||
'pr_mode_stat_t': 'preset_mode_state_topic',
|
||||
'pr_mode_val_tpl': 'preset_mode_value_template',
|
||||
'pr_modes': 'preset_modes',
|
||||
'r_tpl': 'red_template',
|
||||
'ret': 'retain',
|
||||
'rgb_cmd_tpl': 'rgb_command_template',
|
||||
@ -218,8 +211,6 @@ Supported abbreviations:
|
||||
'pos_tpl': 'position_template',
|
||||
'spd_cmd_t': 'speed_command_topic',
|
||||
'spd_stat_t': 'speed_state_topic',
|
||||
'spd_rng_min': 'speed_range_min',
|
||||
'spd_rng_max': 'speed_range_max',
|
||||
'spd_val_tpl': 'speed_value_template',
|
||||
'spds': 'speeds',
|
||||
'src_type': 'source_type',
|
||||
|
@ -132,6 +132,21 @@ payload_available:
|
||||
required: false
|
||||
type: string
|
||||
default: online
|
||||
payload_high_speed:
|
||||
description: The payload that represents the fan's high speed.
|
||||
required: false
|
||||
type: string
|
||||
default: high
|
||||
payload_low_speed:
|
||||
description: The payload that represents the fan's low speed.
|
||||
required: false
|
||||
type: string
|
||||
default: low
|
||||
payload_medium_speed:
|
||||
description: The payload that represents the fan's medium speed.
|
||||
required: false
|
||||
type: string
|
||||
default: medium
|
||||
payload_not_available:
|
||||
description: The payload that represents the unavailable state.
|
||||
required: false
|
||||
@ -157,35 +172,6 @@ payload_oscillation_on:
|
||||
required: false
|
||||
type: string
|
||||
default: oscillate_on
|
||||
percentage_command_topic:
|
||||
description: The MQTT topic to publish commands to change the fan speed state based on a percentage.
|
||||
required: false
|
||||
type: string
|
||||
percentage_state_topic:
|
||||
description: The MQTT topic subscribed to receive fan speed based on percentage.
|
||||
required: false
|
||||
type: string
|
||||
percentage_value_template:
|
||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from fan percentage speed.
|
||||
required: false
|
||||
type: string
|
||||
preset_mode_command_topic:
|
||||
description: The MQTT topic to publish commands to change the preset mode.
|
||||
required: false
|
||||
type: string
|
||||
preset_mode_state_topic:
|
||||
description: The MQTT topic to publish commands to change the preset mode.
|
||||
required: false
|
||||
type: string
|
||||
preset_mode_value_template:
|
||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the preset_mode payload.
|
||||
required: false
|
||||
type: string
|
||||
preset_modes:
|
||||
description: List of preset modes this fan is capable of running at. Common examples include `auto`, `smart`, `whoosh`, `eco` and `breeze`.
|
||||
required: false
|
||||
type: [list]
|
||||
default: []
|
||||
qos:
|
||||
description: The maximum QoS level of the state topic.
|
||||
required: false
|
||||
@ -196,16 +182,22 @@ retain:
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
speed_range_min:
|
||||
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - 1 represents 0%).
|
||||
speed_command_topic:
|
||||
description: The MQTT topic to publish commands to change speed state.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
speed_range_max:
|
||||
description: The maximum of numeric output range (representing 100%).
|
||||
type: string
|
||||
speed_state_topic:
|
||||
description: The MQTT topic subscribed to receive speed state updates.
|
||||
required: false
|
||||
type: integer
|
||||
default: 100
|
||||
type: string
|
||||
speed_value_template:
|
||||
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the speed payload."
|
||||
required: false
|
||||
type: string
|
||||
speeds:
|
||||
description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium` and `high`."
|
||||
required: false
|
||||
type: [string, list]
|
||||
state_topic:
|
||||
description: The MQTT topic subscribed to receive state updates.
|
||||
required: false
|
||||
@ -232,10 +224,10 @@ In this section you find some real-life examples of how to use this fan.
|
||||
|
||||
### 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.
|
||||
|
||||
```yaml
|
||||
# Example using percentage based speeds with preset modes configuration.yaml
|
||||
# Example configuration.yaml entry
|
||||
fan:
|
||||
- platform: mqtt
|
||||
name: "Bedroom Fan"
|
||||
@ -243,21 +235,19 @@ fan:
|
||||
command_topic: "bedroom_fan/on/set"
|
||||
oscillation_state_topic: "bedroom_fan/oscillation/state"
|
||||
oscillation_command_topic: "bedroom_fan/oscillation/set"
|
||||
percentage_state_topic: "bedroom_fan/speed/percentage_state"
|
||||
percentage_command_topic: "bedroom_fan/speed/percentage"
|
||||
preset_mode_state_topic: "bedroom_fan/speed/preset_mode_state"
|
||||
preset_mode_command_topic: "bedroom_fan/speed/preset_mode"
|
||||
preset_modes:
|
||||
- "auto"
|
||||
- "smart"
|
||||
- "whoosh"
|
||||
- "eco"
|
||||
- "breeze"
|
||||
speed_state_topic: "bedroom_fan/speed/state"
|
||||
speed_command_topic: "bedroom_fan/speed/set"
|
||||
qos: 0
|
||||
payload_on: "true"
|
||||
payload_off: "false"
|
||||
payload_oscillation_on: "true"
|
||||
payload_oscillation_off: "false"
|
||||
speed_range_min: 1
|
||||
speed_range_max: 100
|
||||
payload_low_speed: "low"
|
||||
payload_medium_speed: "medium"
|
||||
payload_high_speed: "high"
|
||||
speeds:
|
||||
- "off"
|
||||
- low
|
||||
- medium
|
||||
- high
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user