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

availability list (Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_available string (Optional, default: online)

The payload that represents the available state.

payload_not_available string (Optional, default: offline)

The payload that represents the unavailable state.

topic string Required

An MQTT topic subscribed to receive availability (online/offline) updates.

availability_topic string (Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

command_topic string Required

The MQTT topic to publish commands to change the fan state.

device map (Optional)

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.

connections list | map (Optional)

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"]].

identifiers string | list (Optional)

A list of IDs that uniquely identify the device. For example a serial number.

manufacturer string (Optional)

The manufacturer of the device.

model string (Optional)

The model of the device.

name string (Optional)

The name of the device.

sw_version string (Optional)

The firmware version of the device.

via_device string (Optional)

Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.

json_attributes_template template (Optional)

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.

json_attributes_topic string (Optional)

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.

name string (Optional, default: MQTT Fan)

The name of the fan.

optimistic boolean (Optional)

Flag that defines if lock works in optimistic mode

Default:

true if no state topic defined, else false.

oscillation_command_topic string (Optional)

The MQTT topic to publish commands to change the oscillation state.

oscillation_state_topic string (Optional)

The MQTT topic subscribed to receive oscillation state updates.

oscillation_value_template string (Optional)

Defines a template to extract a value from the oscillation.

payload_available string (Optional, default: online)

The payload that represents the available state.

payload_high_speed string (Optional, default: high)

The payload that represents the fan’s high speed.

payload_low_speed string (Optional, default: low)

The payload that represents the fan’s low speed.

payload_medium_speed string (Optional, default: medium)

The payload that represents the fan’s medium speed.

payload_not_available string (Optional, default: offline)

The payload that represents the unavailable state.

payload_off string (Optional, default: OFF)

The payload that represents the stop state.

payload_on string (Optional, default: ON)

The payload that represents the running state.

payload_oscillation_off string (Optional, default: oscillate_off)

The payload that represents the oscillation off state.

payload_oscillation_on string (Optional, default: oscillate_on)

The payload that represents the oscillation on state.

qos integer (Optional, default: 0)

The maximum QoS level of the state topic.

retain boolean (Optional, default: true)

If the published message should have the retain flag on or not.

speed_command_topic string (Optional)

The MQTT topic to publish commands to change speed state.

speed_state_topic string (Optional)

The MQTT topic subscribed to receive speed state updates.

speed_value_template string (Optional)

Defines a template to extract a value from the speed payload.

speeds string | list (Optional)

List of speeds this fan is capable of running at. Valid entries are off, low, medium and high.

state_topic string (Optional)

The MQTT topic subscribed to receive state updates.

state_value_template string (Optional)

Defines a template to extract a value from the state.

unique_id string (Optional)

An ID that uniquely identifies this fan. If two fans have the same unique ID, Home Assistant will raise an exception.

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