mqtt switch platform lets you control your MQTT enabled switches.
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
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
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
# Example configuration.yaml entry switch: - platform: mqtt command_topic: "home/bedroom/switch1/set"
(string)(Optional)The MQTT topic to publish commands to change the switch state.
(string)(Optional)The name to use when displaying this switch.
Default value: MQTT Switch
(icon)(Optional)Icon for the switch.
(string)(Optional)The MQTT topic subscribed to receive state updates.
(string)(Optional)The payload that represents the on state.
payload_onif defined, else ON
(string)(Optional)The payload that represents the off state.
payload_offif defined, else OFF
(string)(Optional)The MQTT topic subscribed to receive availability (online/offline) updates.
(string)(Optional)The payload that represents enabled state.
Default value: ON
(string)(Optional)The payload that represents disabled state.
Default value: OFF
(string)(Optional)The payload that represents the available state.
Default value: online
(string)(Optional)The payload that represents the unavailable state.
Default value: offline
(boolean)(Optional)Flag that defines if switch works in optimistic mode.
(integer)(Optional)The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
Default value: 0
(boolean)(Optional)If the published message should have the retain flag on or not.
Default value: false
(string)(Optional)Defines a template to extract a value from the payload.
(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.
(list | string)(Optional)A list of IDs that uniquely identify the device. For example a serial number.
(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"]].
(string)(Optional)The manufacturer of the device.
(string)(Optional)The model of the device.
(string)(Optional)The name of the device.
(string)(Optional)The firmware version of the device.
Make sure that your topic matches exactly.
some-topic are different topics.
In this section, you will find some real-life examples of how to use this sensor.
The example below shows a full configuration for a switch.
# Example configuration.yaml entry switch: - platform: mqtt 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"
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"