--- title: "MQTT Fan" description: "Instructions on how to integrate MQTT fans into Home Assistant." ha_category: - Fan ha_release: 0.27 ha_iot_class: Configurable ha_domain: 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 `unknown`. A MQTT device can reset the current state to `unknown` using a `None` payload. 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`). The initial state is set to `False` / `off` in optimistic mode. 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 {% term "`configuration.yaml`" %} file. {% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry mqtt: - fan: 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 value_template: description: "Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." required: false type: template availability_mode: description: When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid entries are `all`, `any`, and `latest`. If set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online. If set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online. If set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability. required: false type: string default: latest availability_template: description: "Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." required: false type: template 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_template: description: Defines a [template](/docs/configuration/templating/#using-command-templates-with-mqtt) to generate the payload to send to `command_topic`. required: false type: template 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](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device." required: false type: map keys: configuration_url: description: 'A link to the webpage that can manage the configuration of this device. Can be either an `http://`, `https://` or an internal `homeassistant://` URL.' required: false type: string 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 hw_version: description: The hardware version of the device. required: false type: string 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 model_id: description: The model identifier of the device. required: false type: string name: description: The name of the device. required: false type: string serial_number: description: "The serial number of the device." required: false type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' 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 enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false type: boolean default: true encoding: description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload. required: false type: string default: "utf-8" entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string entity_picture: description: "Picture URL for the entity." required: false type: string icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false type: icon json_attributes_template: description: "Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) 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](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. required: false type: string name: description: The name of the fan. Can be set to `null` if only the device name is relevant. required: false type: string default: MQTT Fan object_id: description: Used instead of `name` for automatic generation of `entity_id` required: false type: string optimistic: description: Flag that defines if fan works in optimistic mode required: false type: boolean default: "`true` if no state topic defined, else `false`." direction_command_template: description: Defines a [template](/docs/configuration/templating/#using-command-templates-with-mqtt) to generate the payload to send to `direction_command_topic`. required: false type: template direction_command_topic: description: The MQTT topic to publish commands to change the direction state. required: false type: string direction_state_topic: description: The MQTT topic subscribed to receive direction state updates. required: false type: string direction_value_template: description: "Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract a value from the direction." required: false type: template oscillation_command_template: description: Defines a [template](/docs/configuration/templating/#using-command-templates-with-mqtt) to generate the payload to send to `oscillation_command_topic`. required: false type: template 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](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract a value from the oscillation." required: false type: template 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 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 payload_reset_percentage: description: A special payload that resets the `percentage` state attribute to `unknown` when received at the `percentage_state_topic`. required: false type: string default: '"None"' payload_reset_preset_mode: description: A special payload that resets the `preset_mode` state attribute to `unknown` when received at the `preset_mode_state_topic`. required: false type: string default: '"None"' percentage_command_template: description: Defines a [template](/docs/configuration/templating/#using-command-templates-with-mqtt) to generate the payload to send to `percentage_command_topic`. required: false type: template 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/#using-value-templates-with-mqtt) to extract the `percentage` value from the payload received on `percentage_state_topic`. required: false type: template platform: description: Must be `fan`. Only allowed and required in [MQTT auto discovery device messages](/integrations/mqtt/#device-discovery-payload). required: true type: string preset_mode_command_template: description: Defines a [template](/docs/configuration/templating/#using-command-templates-with-mqtt) to generate the payload to send to `preset_mode_command_topic`. required: false type: template 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 subscribed to receive fan speed based on presets. required: false type: string preset_mode_value_template: description: Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the `preset_mode` value from the payload received on `preset_mode_state_topic`. required: false type: template 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 to be used when receiving and publishing messages. 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_range_max: description: The maximum of numeric output range (representing 100 %). The number of speeds within the `speed_range` / `100` will determine the `percentage_step`. required: false type: integer default: 100 speed_range_min: description: The minimum of numeric output range (`off` not included, so `speed_range_min` - `1` represents 0 %). The number of speeds within the speed_range / 100 will determine the `percentage_step`. required: false type: integer default: 1 state_topic: description: The MQTT topic subscribed to receive state updates. A "None" payload resets to an `unknown` state. An empty payload is ignored. By default, valid state payloads are `OFF` and `ON`. The accepted payloads can be overridden with the `payload_off` and `payload_on` config options. required: false type: string state_value_template: description: "Defines a [template](/docs/configuration/templating/#using-value-templates-with-mqtt) to extract a value from the state." required: false type: template 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 when used with device-based discovery. required: false type: string {% endconfiguration %} {% important %} Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics. {% endimportant %} ## 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 using percentage and preset modes. There are 10 speeds within the speed range, so `percentage_step` = 100 / 10 steps = 10.0 %. ```yaml # Example using percentage based speeds with preset modes configuration.yaml mqtt: - fan: name: "Bedroom Fan" state_topic: "bedroom_fan/on/state" command_topic: "bedroom_fan/on/set" direction_state_topic: "bedroom_fan/direction/state" direction_command_topic: "bedroom_fan/direction/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/preset/preset_mode_state" preset_mode_command_topic: "bedroom_fan/preset/preset_mode" preset_modes: - "auto" - "smart" - "whoosh" - "eco" - "breeze" qos: 0 payload_on: "true" payload_off: "false" payload_oscillation_on: "true" payload_oscillation_off: "false" speed_range_min: 1 speed_range_max: 10 ``` ### Configuration using command templates This example demonstrates how to use command templates with JSON output. {% raw %} ```yaml # Example configuration.yaml with command templates mqtt: - fan: name: "Bedroom Fan" command_topic: "bedroom_fan/on/set" command_template: "{ state: '{{ value }}'}" direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}" direction_value_template: "{{ iif(value == 'fwd', 'forward', 'reverse') }}" oscillation_command_topic: "bedroom_fan/oscillation/set" oscillation_command_template: "{ oscillation: '{{ value }}'}" percentage_command_topic: "bedroom_fan/speed/percentage" percentage_command_template: "{ percentage: '{{ value }}'}" preset_mode_command_topic: "bedroom_fan/preset/preset_mode" preset_mode_command_template: "{ preset_mode: '{{ value }}'}" preset_modes: - "auto" - "smart" - "whoosh" - "eco" - "breeze" ``` {% endraw %} This example shows how to configure a fan that doesn't use `forward` and `backward` as directions. {% raw %} ```yaml # Example configuration.yaml with direction templates mqtt: - fan: name: "Bedroom Fan" direction_command_template: "{{ iif(value == 'forward', 'fwd', 'rev') }}" direction_value_template: "{{ iif(value == 'fwd', 'forward', 'reverse') }}" ``` {% endraw %}