7.0 KiB
| title | description | logo | ha_category | ha_release | ha_iot_class | |
|---|---|---|---|---|---|---|
| MQTT Switch | Instructions on how to integrate MQTT switches into Home Assistant. | mqtt.png |
|
0.7 | Configurable |
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 %}
command_topic:
description: The MQTT topic to publish commands to change the switch state.
required: false
type: string
name:
description: The name to use when displaying this switch.
required: false
type: string
default: MQTT Switch
icon:
description: Icon for the switch.
required: false
type: icon
state_topic:
description: The MQTT topic subscribed to receive state updates.
required: false
type: string
state_on:
description: The payload that represents the on state.
required: false
type: string
default: "payload_on if defined, else ON"
state_off:
description: The payload that represents the off state.
required: false
type: string
default: "payload_off if defined, else OFF"
availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates.
required: false
type: string
payload_on:
description: The payload that represents enabled state.
required: false
type: string
default: "ON"
payload_off:
description: The payload that represents disabled state.
required: false
type: string
default: "OFF"
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
optimistic:
description: Flag that defines if switch works in optimistic mode.
required: false
type: boolean
default: "true if no state_topic defined, else false."
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to 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: false
value_template:
description: "Defines a template to extract a value from the payload."
required: false
type: string
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 documentation.
required: false
type: string
json_attributes_template:
description: "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."
required: false
type: template
device:
description: "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."
required: false
type: map
keys:
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false
type: [string, list]
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
manufacturer:
description: The manufacturer of the device.
required: false
type: string
model:
description: The model of the device.
required: false
type: string
name:
description: The name of the device.
required: false
type: string
sw_version:
description: The firmware version of the device.
required: false
type: string
{% endconfiguration %}
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
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:
{% raw %}
# 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"
{% endraw %}