MQTT Switch


The mqtt switch platform lets you control your MQTT enabled switches.

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 switch will receive an instant state update after subscription, and will start with the 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 the device (message from state_topic).

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

To enable this switch in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: mqtt
    command_topic: "home/bedroom/switch1/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 stringRequired

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(Optional)

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

device map(Optional)

Information about the device this switch is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set.

connections list(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.

icon icon(Optional)

Icon for the switch.

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 Switch)

The name to use when displaying this switch.

optimistic boolean(Optional)

Flag that defines if switch works in optimistic mode.

Default:

true if no state_topic defined, else false.

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.

payload_off string(Optional, default: OFF)

The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic.

payload_on string(Optional, default: ON)

The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic.

qos integer(Optional, default: 0)

The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.

retain boolean(Optional, default: false)

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

state_off string(Optional)

The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off.

Default:

payload_off if defined, else OFF

state_on string(Optional)

The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on.

Default:

payload_on if defined, else ON

state_topic string(Optional)

The MQTT topic subscribed to receive state updates.

unique_id string(Optional)

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

value_template string(Optional)

Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.

Make sure that your topic matches exactly. some-topic/ and some-topic are different topics.

Examples

In this section, you will find some real-life examples of how to use this sensor.

Full configuration

The example below shows a full configuration for a switch.

# Example configuration.yaml entry
switch:
  - platform: mqtt
    unique_id: bedroom_switch
    name: "Bedroom Switch"
    state_topic: "home/bedroom/switch1"
    command_topic: "home/bedroom/switch1/set"
    availability:
      - topic: "home/bedroom/switch1/available"
    payload_on: "ON"
    payload_off: "OFF"
    state_on: "ON"
    state_off: "OFF"
    optimistic: false
    qos: 0
    retain: true

For a check, you can use the command line tools mosquitto_pub shipped with mosquitto to send MQTT messages. This allows you to operate your switch manually:

mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m "ON"

Set the state of a device with ESPEasy

Assuming that you have flashed your ESP8266 unit with ESPEasy. Under “Config” is a name (“Unit Name:”) set for your device (here it’s “bathroom”). A configuration for a “Controller” for MQTT with the protocol “OpenHAB MQTT” is present and the entries (“Controller Subscribe:” and “Controller Publish:”) are adjusted to match your needs. In this example, the topics are prefixed with “home”. There is no further configuration needed as the GPIOs can be controlled with MQTT directly.

Manually you can set pin 13 to high with mosquitto_pub or another MQTT tool:

mosquitto_pub -h 127.0.0.1 -t home/bathroom/gpio/13 -m "1"

The configuration will look like the example below:

# Example configuration.yaml entry
switch:
  - platform: mqtt
    name: bathroom
    state_topic: "home/bathroom/gpio/13"
    command_topic: "home/bathroom/gpio/13"
    payload_on: "1"
    payload_off: "0"