home-assistant.io/source/_integrations/fan.mqtt.markdown

title	description	ha_category	ha_release	ha_iot_class	ha_domain
MQTT Fan	Instructions on how to integrate MQTT fans into Home Assistant.	Fan	0.27	Configurable	mqtt

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 %} availability: description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic. required: false type: list keys: payload_available: description: The payload that represents the available state. required: false type: string default: online payload_not_available: description: The payload that represents the unavailable state. required: false type: string default: offline topic: description: An MQTT topic subscribed to receive availability (online/offline) updates. required: true type: string availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability. required: false type: string command_topic: description: The MQTT topic to publish commands to change the fan state. required: true type: string device: description: "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." required: false type: map keys: connections: description: '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"]].' required: false type: [list, map] identifiers: description: A list of IDs that uniquely identify the device. For example a serial number. required: false type: [string, list] manufacturer: description: The manufacturer of the device. required: false type: string model: description: The model of the device. required: false type: string name: description: The name of the device. required: false type: string sw_version: description: The firmware version of the device. required: false type: string via_device: description: '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.' required: false type: string json_attributes_template: description: "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." required: false type: template json_attributes_topic: description: 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. required: false type: string name: description: The name of the fan. required: false type: string default: MQTT Fan optimistic: description: Flag that defines if lock works in optimistic mode required: false type: boolean default: "true if no state topic defined, else false." oscillation_command_topic: description: The MQTT topic to publish commands to change the oscillation state. required: false type: string oscillation_state_topic: description: The MQTT topic subscribed to receive oscillation state updates. required: false type: string oscillation_value_template: description: "Defines a template to extract a value from the oscillation." required: false type: string payload_available: description: The payload that represents the available state. 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 type: string default: offline payload_off: description: The payload that represents the stop state. required: false type: string default: "OFF" payload_on: description: The payload that represents the running state. required: false type: string default: "ON" payload_oscillation_off: description: The payload that represents the oscillation off state. required: false type: string default: oscillate_off payload_oscillation_on: description: The payload that represents the oscillation on state. required: false type: string default: oscillate_on qos: description: The maximum QoS level of the state topic. required: false type: integer default: 0 retain: description: If the published message should have the retain flag on or not. required: false type: boolean default: true speed_command_topic: description: The MQTT topic to publish commands to change speed state. required: false type: string speed_state_topic: description: The MQTT topic subscribed to receive speed state updates. required: false type: string speed_value_template: description: "Defines a template 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 type: string state_value_template: description: "Defines a template to extract a value from the state." required: false type: string unique_id: description: An ID that uniquely identifies this fan. If two fans have the same unique ID, Home Assistant will raise an exception. required: false type: string {% endconfiguration %}

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