Skip to content

Commit eb8dc08

Browse files
fabafffabaff
committed
Add missing variable descriptions
1 parent cee5825 commit eb8dc08

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

‎source/_components/fan.mqtt.markdown

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,27 @@ fan:
3232
3333
Configuration variables:
3434
35-
- **name** (*Optional*): The name of the lock. Default is 'MQTT Lock'.
35+
- **command_topic** (*Required*): The MQTT topic to publish commands to change the fan state.
3636
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
37-
- **command_topic** (*Required*): The MQTT topic to publish commands to change the lock state.
37+
- **name** (*Optional*): The name of the fan. Default is 'MQTT Fan'.
3838
- **payload_on** (*Optional*): The payload that represents the running state. Default is "ON".
3939
- **payload_off** (*Optional*): The payload that represents the stop state. Default is "OFF".
4040
- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no state topic defined, else `false`.
4141
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
4242
- **retain** (*Optional*): If the published message should have the retain flag on or not.
43-
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
43+
- **state_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the state.
44+
- **speed_state_topic** (*Optional*): The MQTT topic subscribed to receive speed updates.
45+
- **speed_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan speed.
46+
- **speed_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the speed.
47+
- **oscillation_state_topic** (*Optional*): The MQTT topic subscribed to receive oscillation updates.
48+
- **oscillation_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan oscillation.
49+
- **oscillation_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the oscillation.
50+
- **payload_oscillation_on** (*Optional*): The payload that represents the oscillation state. Default is "ON".
51+
- **payload_oscillation_off** (*Optional*): The payload that represents the oscillation state. Default is "OFF".
52+
- **payload_low_speed** (*Optional*): The payload that represents the low speed state. Default is "low".
53+
- **payload_medium_speed** (*Optional*): The payload that represents the low speed state. Default is "med".
54+
- **payload_high_speed** (*Optional*): The payload that represents the low speed state. Default is "high".
55+
- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `med`, and `high`.
4456

4557
<p class='note warning'>
4658
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.

0 commit comments

Comments
 (0)