mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-08-19 06:09:45 +00:00
.themes
_deploy
architecture
assets
blog
contributing
font
getting-started
images
javascripts
plugins
sass
source
_components
alarm_control_panel.alarmdotcom.markdown
alarm_control_panel.envisalink.markdown
alarm_control_panel.manual.markdown
alarm_control_panel.markdown
alarm_control_panel.mqtt.markdown
alarm_control_panel.nx584.markdown
alarm_control_panel.simplisafe.markdown
alarm_control_panel.verisure.markdown
alexa.markdown
apcupsd.markdown
arduino.markdown
automation.markdown
binary_sensor.apcupsd.markdown
binary_sensor.arest.markdown
binary_sensor.bloomsky.markdown
binary_sensor.command_line.markdown
binary_sensor.ecobee.markdown
binary_sensor.enocean.markdown
binary_sensor.envisalink.markdown
binary_sensor.ffmpeg.markdown
binary_sensor.homematic.markdown
binary_sensor.http.markdown
binary_sensor.isy994.markdown
binary_sensor.knx.markdown
binary_sensor.markdown
binary_sensor.modbus.markdown
binary_sensor.mqtt.markdown
binary_sensor.mysensors.markdown
binary_sensor.nest.markdown
binary_sensor.nx584.markdown
binary_sensor.octoprint.markdown
binary_sensor.rest.markdown
binary_sensor.rpi_gpio.markdown
binary_sensor.sleepiq.markdown
binary_sensor.tcp.markdown
binary_sensor.template.markdown
binary_sensor.trend.markdown
binary_sensor.vera.markdown
binary_sensor.wink.markdown
binary_sensor.zigbee.markdown
binary_sensor.zwave.markdown
bloomsky.markdown
browser.markdown
camera.bloomsky.markdown
camera.ffmpeg.markdown
camera.foscam.markdown
camera.generic.markdown
camera.local_file.markdown
camera.markdown
camera.mjpeg.markdown
camera.netatmo.markdown
camera.rpi_camera.markdown
camera.uvc.markdown
climate.ecobee.markdown
climate.eq3btsmart.markdown
climate.generic_thermostat.markdown
climate.heatmiser.markdown
climate.homematic.markdown
climate.honeywell.markdown
climate.knx.markdown
climate.markdown
climate.mysensors.markdown
climate.nest.markdown
climate.proliphix.markdown
climate.radiotherm.markdown
climate.vera.markdown
climate.zwave.markdown
configurator.markdown
conversation.markdown
cover.command_line.markdown
cover.homematic.markdown
cover.isy994.markdown
cover.markdown
cover.mqtt.markdown
cover.rfxtrx.markdown
cover.rpi_gpio.markdown
cover.scsgate.markdown
cover.vera.markdown
cover.wink.markdown
cover.zwave.markdown
demo.markdown
device_sun_light_trigger.markdown
device_tracker.actiontec.markdown
device_tracker.aruba.markdown
device_tracker.asuswrt.markdown
device_tracker.automatic.markdown
device_tracker.bluetooth_le_tracker.markdown
device_tracker.bluetooth_tracker.markdown
device_tracker.bt_home_hub_5.markdown
device_tracker.ddwrt.markdown
device_tracker.fritz.markdown
device_tracker.icloud.markdown
device_tracker.locative.markdown
device_tracker.luci.markdown
device_tracker.markdown
device_tracker.mqtt.markdown
device_tracker.netgear.markdown
device_tracker.nmap_tracker.markdown
device_tracker.owntracks.markdown
device_tracker.snmp.markdown
device_tracker.thomson.markdown
device_tracker.tomato.markdown
device_tracker.tplink.markdown
device_tracker.ubus.markdown
device_tracker.unifi.markdown
discoverable.markdown
discovery.markdown
downloader.markdown
dweet.markdown
ecobee.markdown
emulated_hue.markdown
enocean.markdown
envisalink.markdown
fan.insteon_hub.markdown
fan.isy994.markdown
fan.markdown
fan.mqtt.markdown
fan.nest.markdown
feedreader.markdown
ffmpeg.markdown
foursquare.markdown
garage_door.markdown
garage_door.mqtt.markdown
garage_door.rpi_gpio.markdown
garage_door.wink.markdown
garage_door.zwave.markdown
graphite.markdown
group.markdown
hdmi_cec.markdown
history.markdown
homematic.markdown
http.markdown
hvac.markdown
hvac.zwave.markdown
ifttt.manything.markdown
ifttt.markdown
influxdb.markdown
input_boolean.markdown
input_select.markdown
input_slider.markdown
insteon_hub.markdown
introduction.markdown
isy994.markdown
joaoapps_join.markdown
keyboard.markdown
keyboard_remote.markdown
knx.markdown
light.blinksticklight.markdown
light.enocean.markdown
light.flux_led.markdown
light.homematic.markdown
light.hue.markdown
light.hyperion.markdown
light.insteon_hub.markdown
light.isy994.markdown
light.lifx.markdown
light.limitlessled.markdown
light.markdown
light.mqtt.markdown
light.mqtt_json.markdown
light.mysensors.markdown
light.osramlightify.markdown
light.qwikswitch.markdown
light.rfxtrx.markdown
light.scsgate.markdown
light.tellstick.markdown
light.vera.markdown
light.wemo.markdown
light.wink.markdown
light.x10.markdown
light.zigbee.markdown
light.zwave.markdown
lirc.markdown
lock.isy994.markdown
lock.markdown
lock.mqtt.markdown
lock.vera.markdown
lock.verisure.markdown
lock.wink.markdown
lock.zwave.markdown
logbook.markdown
logentries.markdown
logger.markdown
media_player.braviatv.markdown
media_player.cast.markdown
media_player.cmus.markdown
media_player.denon.markdown
media_player.directv.markdown
media_player.firetv.markdown
media_player.gpmdp.markdown
media_player.itunes.markdown
media_player.kodi.markdown
media_player.lg_netcast.markdown
media_player.markdown
media_player.mpchc.markdown
media_player.mpd.markdown
media_player.onkyo.markdown
media_player.panasonic_viera.markdown
media_player.pandora.markdown
media_player.pioneer.markdown
media_player.plex.markdown
media_player.roku.markdown
media_player.russound_rnet.markdown
media_player.samsungtv.markdown
media_player.snapcast.markdown
media_player.sonos.markdown
media_player.squeezebox.markdown
media_player.universal.markdown
media_player.webostv.markdown
media_player.yamaha.markdown
modbus.markdown
mqtt.markdown
mqtt_eventstream.markdown
mysensors.markdown
nest.markdown
netatmo.markdown
notify.aws_lambda.markdown
notify.aws_sns.markdown
notify.aws_sqs.markdown
notify.command_line.markdown
notify.ecobee.markdown
notify.file.markdown
notify.free_mobile.markdown
notify.gntp.markdown
notify.group.markdown
notify.html5.markdown
notify.instapush.markdown
notify.joaoapps_join.markdown
notify.kodi.markdown
notify.llamalab_automate.markdown
notify.markdown
notify.message_bird.markdown
notify.mqtt.markdown
notify.nma.markdown
notify.pushbullet.markdown
notify.pushetta.markdown
notify.pushover.markdown
notify.rest.markdown
notify.sendgrid.markdown
notify.simplepush.markdown
notify.slack.markdown
notify.smtp.markdown
notify.syslog.markdown
notify.telegram.markdown
notify.twilio_sms.markdown
notify.twitter.markdown
notify.webostv.markdown
notify.xmpp.markdown
nuimo_controller.markdown
octoprint.markdown
openalpr.markdown
panel_custom.markdown
panel_iframe.markdown
persistent_notification.markdown
pilight.markdown
proximity.markdown
qwikswitch.markdown
recorder.markdown
rfxtrx.markdown
rollershutter.command_line.markdown
rollershutter.homematic.markdown
rollershutter.markdown
rollershutter.mqtt.markdown
rollershutter.rfxtrx.markdown
rollershutter.scsgate.markdown
rollershutter.wink.markdown
rollershutter.zwave.markdown
rpi_gpio.markdown
scene.hunterdouglas_powerview.markdown
scene.markdown
script.markdown
scsgate.markdown
sensor.apcupsd.markdown
sensor.arduino.markdown
sensor.arest.markdown
sensor.bitcoin.markdown
sensor.bloomsky.markdown
sensor.bom.markdown
sensor.coinmarketcap.markdown
sensor.command_line.markdown
sensor.cpuspeed.markdown
sensor.deutsche_bahn.markdown
sensor.dht.markdown
sensor.dte_energy_bridge.markdown
sensor.dweet.markdown
sensor.efergy.markdown
sensor.eliqonline.markdown
sensor.emoncms.markdown
sensor.enocean.markdown
sensor.envisalink.markdown
sensor.fastdotcom.markdown
sensor.fitbit.markdown
sensor.fixer.markdown
sensor.forecast.markdown
sensor.fritzbox_callmonitor.markdown
sensor.glances.markdown
sensor.google_travel_time.markdown
sensor.gpsd.markdown
sensor.gtfs.markdown
sensor.homematic.markdown
sensor.hp_ilo.markdown
sensor.http.markdown
sensor.imap.markdown
sensor.imap_email_content.markdown
sensor.isy994.markdown
sensor.knx.markdown
sensor.lastfm.markdown
sensor.linux_battery.markdown
sensor.loop_energy.markdown
sensor.markdown
sensor.mfi.markdown
sensor.mhz19.markdown
sensor.miflora.markdown
sensor.modbus.markdown
sensor.moldindicator.markdown
sensor.mqtt.markdown
sensor.mqtt_room.markdown
sensor.mysensors.markdown
sensor.nest.markdown
sensor.nest_weather.markdown
sensor.netatmo.markdown
sensor.neurio_energy.markdown
sensor.nzbget.markdown
sensor.octoprint.markdown
sensor.ohmconnect.markdown
sensor.onewire.markdown
sensor.openexchangerates.markdown
sensor.openweathermap.markdown
sensor.pi_hole.markdown
sensor.plex.markdown
sensor.rest.markdown
sensor.rfxtrx.markdown
sensor.sabnzbd.markdown
sensor.serial_pm.markdown
sensor.sleepiq.markdown
sensor.snmp.markdown
sensor.speedtest.markdown
sensor.steam_online.markdown
sensor.supervisord.markdown
sensor.swiss_hydrological_data.markdown
sensor.swiss_public_transport.markdown
sensor.systemmonitor.markdown
sensor.tcp.markdown
sensor.tellduslive.markdown
sensor.tellstick.markdown
sensor.temper.markdown
sensor.template.markdown
sensor.thinkingcleaner.markdown
sensor.time_date.markdown
sensor.torque.markdown
sensor.transmission.markdown
sensor.twitch.markdown
sensor.uber.markdown
sensor.vera.markdown
sensor.verisure.markdown
sensor.wink.markdown
sensor.worldclock.markdown
sensor.wunderground.markdown
sensor.xbox_live.markdown
sensor.yahoo_finance.markdown
sensor.yr.markdown
sensor.yweather.markdown
sensor.zigbee.markdown
sensor.zwave.markdown
shell_command.markdown
simple_alarm.markdown
sleepiq.markdown
splunk.markdown
statsd.markdown
sun.markdown
switch.acer_projector.markdown
switch.arduino.markdown
switch.arest.markdown
switch.command_line.markdown
switch.dlink.markdown
switch.edimax.markdown
switch.enocean.markdown
switch.flux.markdown
switch.hikvision.markdown
switch.homematic.markdown
switch.isy994.markdown
switch.knx.markdown
switch.markdown
switch.mfi.markdown
switch.modbus.markdown
switch.mqtt.markdown
switch.mysensors.markdown
switch.mystrom.markdown
switch.netio.markdown
switch.orvibo.markdown
switch.pilight.markdown
switch.pulseaudio_loopback.markdown
switch.qwikswitch.markdown
switch.rest.markdown
switch.rfxtrx.markdown
switch.rpi_gpio.markdown
switch.rpi_rf.markdown
switch.scsgate.markdown
switch.tellduslive.markdown
switch.tellstick.markdown
switch.template.markdown
switch.thinkingcleaner.markdown
switch.tplink.markdown
switch.transmission.markdown
switch.vera.markdown
switch.verisure.markdown
switch.wake_on_lan.markdown
switch.wemo.markdown
switch.wink.markdown
switch.zigbee.markdown
switch.zwave.markdown
tellduslive.markdown
tellstick.markdown
thermostat.ecobee.markdown
thermostat.eq3btsmart.markdown
thermostat.heat_control.markdown
thermostat.heatmiser.markdown
thermostat.honeywell.markdown
thermostat.knx.markdown
thermostat.markdown
thermostat.nest.markdown
thermostat.proliphix.markdown
thermostat.radiotherm.markdown
thermostat.zwave.markdown
updater.markdown
upnp.markdown
vera.markdown
verisure.markdown
weather.markdown
weather.openweathermap.markdown
weblink.markdown
wemo.markdown
wink.markdown
zeroconf.markdown
zigbee.markdown
zone.markdown
zwave.markdown
_cookbook
_includes
_layouts
_posts
_topics
assets
blog
components
cookbook
demo
developers
font
getting-started
help
images
javascripts
static
topics
CNAME
atom.xml
favicon.png
googlef4f3693c209fe788.html
index.html
robots.txt
service_worker.js
stylesheets
.editorconfig
.gitattributes
.gitignore
.gitmodules
.powrc
.ruby-version
.slugignore
.travis.yml
CHANGELOG.markdown
CNAME_old
Gemfile
Gemfile.lock
README.markdown
Rakefile
_config.yml
atom.xml
config.rb
config.ru
favicon.png
index.html
robots.txt
sitemap.xml
2.5 KiB
2.5 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | MQTT Switch | Instructions how to integrate MQTT switches into Home Assistant. | 2015-08-30 23:38 | true | false | true | true | mqtt.png | Switch | 0.7 | 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:
# 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 to extract a value from the payload.
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.