MQTT Switch Support

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 switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.

When a state topic is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from device (message from state_topic).

Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect switch operation.

1
2
3
4
5
6
7
8
9

# Example configuration.yml entr
switch:
  platform: mqtt
  name: "Bedroom Switch"
  state_topic: "home/bedroom/switch1"
  command_topic: "home/bedroom/switch1/set"
  payload_on: "ON"
  payload_off: "OFF"
  optimistic: false

command_topic: The MQTT topic to publish commands to change the switch state. Required

name: The name of the switch. Default is ‘MQTT Switch’. Optional

state_topic: The MQTT topic subscribed to receive state updates. Optional

payload_on: The payload that represents enabled state. Default is “ON”. Optional

payload_off: The payload that represents disabled state. Default is “OFF”. Optional

optimistic: Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false. Optional