MQTT Fan
The mqtt
fan platform lets you control your MQTT enabled fans.
Configuration
In an ideal scenario, the MQTT device will have a state_topic
to publish state changes. If these messages are published with a RETAIN
flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be false
/ off
.
When a state_topic
is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from state_topic
).
Optimistic mode can be forced even if a state_topic
is available. Try to enable it if you are experiencing incorrect fan operation.
To enable MQTT fans in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
fan:
- platform: mqtt
command_topic: "bedroom_fan/on/set"
Configuration Variables
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic
.
The payload that represents the available state.
The payload that represents the unavailable state.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability
.
Information about the device this fan is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id
is set.
A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]
. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]]
.
A list of IDs that uniquely identify the device. For example a serial number.
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic
. Usage example can be found in MQTT sensor documentation.
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
Flag that defines if lock works in optimistic mode
true
if no state topic defined, else false
.
The MQTT topic to publish commands to change the oscillation state.
The MQTT topic subscribed to receive oscillation state updates.
Defines a template to extract a value from the oscillation.
The payload that represents the available state.
The payload that represents the fan’s high speed.
The payload that represents the fan’s medium speed.
The payload that represents the unavailable state.
The payload that represents the oscillation off state.
The payload that represents the oscillation on state.
If the published message should have the retain flag on or not.
Defines a template to extract a value from the speed payload.
List of speeds this fan is capable of running at. Valid entries are off
, low
, medium
and high
.
Defines a template to extract a value from the state.
Make sure that your topics match exactly. some-topic/
and some-topic
are different topics.
Examples
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.
# Example configuration.yaml entry
fan:
- platform: mqtt
name: "Bedroom Fan"
state_topic: "bedroom_fan/on/state"
command_topic: "bedroom_fan/on/set"
oscillation_state_topic: "bedroom_fan/oscillation/state"
oscillation_command_topic: "bedroom_fan/oscillation/set"
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"
payload_low_speed: "low"
payload_medium_speed: "medium"
payload_high_speed: "high"
speeds:
- "off"
- low
- medium
- high