mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-08 03:59:00 +00:00
56 lines
2.5 KiB
Markdown
56 lines
2.5 KiB
Markdown
---
|
|
layout: page
|
|
title: "MQTT Switch"
|
|
description: "Instructions how to integrate MQTT switches into Home Assistant."
|
|
date: 2015-08-30 23:38
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: mqtt.png
|
|
ha_category: Switch
|
|
ha_release: 0.7
|
|
ha_iot_class: depends
|
|
---
|
|
|
|
The `mqtt` switch platform let you control your MQTT enabled light.
|
|
|
|
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.
|
|
|
|
To enable this switch in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yml entry
|
|
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
|
|
qos: 0
|
|
retain: true
|
|
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
|
|
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
|
|
- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state.
|
|
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
|
|
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
|
|
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
|
|
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
|
|
- **retain** (*Optional*): If the published message should have the retain flag on or not.
|
|
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
|
|
|
<p class='note warning'>
|
|
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.
|
|
</p>
|