MQTT Fan


The mqtt fan platform let you control your MQTT enabled fans.

In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with RETAIN flag, the MQTT fan will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the fan will be false.

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.yml entry
fan:
  - platform: mqtt
    command_topic: "bedroom_fan/on/set"

Configuration variables:

  • command_topic (Required): The MQTT topic to publish commands to change the fan state.
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • name (Optional): The name of the fan. Default is ‘MQTT Fan’.
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • payload_on (Optional): The payload that represents the running state. Default is “ON”.
  • payload_off (Optional): The payload that represents the stop state. Default is “OFF”.
  • state_value_template (Optional): Defines a template to extract a value from the state.
  • qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
  • optimistic (Optional): Flag that defines if lock works in optimistic mode. Default is true if no state topic defined, else false.
  • retain (Optional): If the published message should have the retain flag on or not.
  • oscillation_state_topic (Optional): The MQTT topic subscribed to receive oscillation state updates.
  • oscillation_command_topic (Optional): The MQTT topic to publish commands to change the oscillation state.
  • payload_oscillation_on (Optional): The payload that represents the oscillation on state. Default is “oscillate_on”.
  • payload_oscillation_off (Optional): The payload that presents the oscillation off state. Default is “oscillate_off”.
  • oscillation_value_template (Optional): Defines a template to extract a value from the oscillation.
  • speed_state_topic (Optional): The MQTT topic subscribed to receive speed state updates.
  • speed_command_topic (Optional): The MQTT topic to publish commands to change speed state.
  • payload_low_speed (Optional): The payload that represents the fan’s low speed.
  • payload_medium_speed (Optional): The payload that represents the fan’s medium speed.
  • payload_high_speed (Optional): The payload that represents the fan’s high speed.
  • speed_value_template (Optional): Defines a template to extract a value from the speed payload.
  • speeds array (Optional): Valid entries for the list are off, low, med, and high.

Make sure that your topic is an exact match. 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.yml 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:
      - low
      - medium
      - high