mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-08-15 12:19:40 +00:00
.github
.themes
_deploy
credits_generator
plugins
sass
source
_addons
_components
abode.markdown
alarm_control_panel.abode.markdown
alarm_control_panel.alarmdecoder.markdown
alarm_control_panel.alarmdotcom.markdown
alarm_control_panel.arlo.markdown
alarm_control_panel.concord232.markdown
alarm_control_panel.egardia.markdown
alarm_control_panel.envisalink.markdown
alarm_control_panel.manual.markdown
alarm_control_panel.manual_mqtt.markdown
alarm_control_panel.markdown
alarm_control_panel.mqtt.markdown
alarm_control_panel.nx584.markdown
alarm_control_panel.satel_integra.markdown
alarm_control_panel.simplisafe.markdown
alarm_control_panel.spc.markdown
alarm_control_panel.totalconnect.markdown
alarm_control_panel.verisure.markdown
alarm_control_panel.wink.markdown
alarmdecoder.markdown
alert.markdown
alexa.markdown
amcrest.markdown
android_ip_webcam.markdown
apcupsd.markdown
apiai.markdown
apple_tv.markdown
arduino.markdown
arlo.markdown
asterisk_mbox.markdown
automation.markdown
axis.markdown
bbb_gpio.markdown
binary_sensor.abode.markdown
binary_sensor.alarmdecoder.markdown
binary_sensor.android_ip_webcam.markdown
binary_sensor.apcupsd.markdown
binary_sensor.arest.markdown
binary_sensor.aurora.markdown
binary_sensor.axis.markdown
binary_sensor.bayesian.markdown
binary_sensor.bbb_gpio.markdown
binary_sensor.blink.markdown
binary_sensor.bloomsky.markdown
binary_sensor.command_line.markdown
binary_sensor.concord232.markdown
binary_sensor.digital_ocean.markdown
binary_sensor.doorbird.markdown
binary_sensor.ecobee.markdown
binary_sensor.eight_sleep.markdown
binary_sensor.enocean.markdown
binary_sensor.envisalink.markdown
binary_sensor.ffmpeg_motion.markdown
binary_sensor.ffmpeg_noise.markdown
binary_sensor.flic.markdown
binary_sensor.hikvision.markdown
binary_sensor.homematic.markdown
binary_sensor.http.markdown
binary_sensor.insteon_plm.markdown
binary_sensor.iss.markdown
binary_sensor.isy994.markdown
binary_sensor.knx.markdown
binary_sensor.markdown
binary_sensor.maxcube.markdown
binary_sensor.modbus.markdown
binary_sensor.mqtt.markdown
binary_sensor.mysensors.markdown
binary_sensor.mystrom.markdown
binary_sensor.nest.markdown
binary_sensor.netatmo.markdown
binary_sensor.nx584.markdown
binary_sensor.octoprint.markdown
binary_sensor.pilight.markdown
binary_sensor.ping.markdown
binary_sensor.raincloud.markdown
binary_sensor.raspihats.markdown
binary_sensor.rest.markdown
binary_sensor.rfxtrx.markdown
binary_sensor.ring.markdown
binary_sensor.rpi_gpio.markdown
binary_sensor.rpi_pfio.markdown
binary_sensor.satel_integra.markdown
binary_sensor.skybell.markdown
binary_sensor.sleepiq.markdown
binary_sensor.spc.markdown
binary_sensor.tapsaff.markdown
binary_sensor.tcp.markdown
binary_sensor.template.markdown
binary_sensor.tesla.markdown
binary_sensor.threshold.markdown
binary_sensor.trend.markdown
binary_sensor.velbus.markdown
binary_sensor.vera.markdown
binary_sensor.verisure.markdown
binary_sensor.wink.markdown
binary_sensor.workday.markdown
binary_sensor.xiaomi_aqara.markdown
binary_sensor.zha.markdown
binary_sensor.zigbee.markdown
binary_sensor.zwave.markdown
blink.markdown
bloomsky.markdown
browser.markdown
calendar.google.markdown
calendar.markdown
calendar.todoist.markdown
camera.abode.markdown
camera.amcrest.markdown
camera.arlo.markdown
camera.axis.markdown
camera.blink.markdown
camera.bloomsky.markdown
camera.dispatcher.markdown
camera.doorbird.markdown
camera.ffmpeg.markdown
camera.foscam.markdown
camera.generic.markdown
camera.local_file.markdown
camera.markdown
camera.mjpeg.markdown
camera.mqtt.markdown
camera.neato.markdown
camera.nest.markdown
camera.netatmo.markdown
camera.onvif.markdown
camera.rpi_camera.markdown
camera.skybell.markdown
camera.synology.markdown
camera.usps.markdown
camera.uvc.markdown
camera.verisure.markdown
camera.yi.markdown
camera.zoneminder.markdown
climate.ecobee.markdown
climate.eq3btsmart.markdown
climate.flexit.markdown
climate.generic_thermostat.markdown
climate.heatmiser.markdown
climate.homematic.markdown
climate.honeywell.markdown
climate.knx.markdown
climate.markdown
climate.maxcube.markdown
climate.mqtt.markdown
climate.mysensors.markdown
climate.nest.markdown
climate.netatmo.markdown
climate.oem.markdown
climate.proliphix.markdown
climate.radiotherm.markdown
climate.sensibo.markdown
climate.tado.markdown
climate.tesla.markdown
climate.vera.markdown
climate.wink.markdown
climate.zwave.markdown
comfoconnect.markdown
config.markdown
configurator.markdown
conversation.markdown
counter.markdown
cover.abode.markdown
cover.command_line.markdown
cover.garadget.markdown
cover.homematic.markdown
cover.isy994.markdown
cover.knx.markdown
cover.lutron_caseta.markdown
cover.markdown
cover.mqtt.markdown
cover.myq.markdown
cover.mysensors.markdown
cover.opengarage.markdown
cover.rflink.markdown
cover.rfxtrx.markdown
cover.rpi_gpio.markdown
cover.scsgate.markdown
cover.template.markdown
cover.vera.markdown
cover.wink.markdown
cover.xiaomi_aqara.markdown
cover.zwave.markdown
datadog.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.bbox.markdown
device_tracker.bluetooth_le_tracker.markdown
device_tracker.bluetooth_tracker.markdown
device_tracker.bt_home_hub_5.markdown
device_tracker.cisco_ios.markdown
device_tracker.ddwrt.markdown
device_tracker.fritz.markdown
device_tracker.geofency.markdown
device_tracker.gpslogger.markdown
device_tracker.huawei_router.markdown
device_tracker.icloud.markdown
device_tracker.keenetic_ndms2.markdown
device_tracker.linksys_ap.markdown
device_tracker.linksys_smart.markdown
device_tracker.locative.markdown
device_tracker.luci.markdown
device_tracker.markdown
device_tracker.mikrotik.markdown
device_tracker.mqtt.markdown
device_tracker.mqtt_json.markdown
device_tracker.mysensors.markdown
device_tracker.netgear.markdown
device_tracker.nmap_tracker.markdown
device_tracker.owntracks.markdown
device_tracker.owntracks_http.markdown
device_tracker.ping.markdown
device_tracker.sky_hub.markdown
device_tracker.snmp.markdown
device_tracker.swisscom.markdown
device_tracker.tado.markdown
device_tracker.tesla.markdown
device_tracker.thomson.markdown
device_tracker.tomato.markdown
device_tracker.tplink.markdown
device_tracker.trackr.markdown
device_tracker.ubus.markdown
device_tracker.unifi.markdown
device_tracker.upc_connect.markdown
device_tracker.volvooncall.markdown
device_tracker.xiaomi.markdown
digital_ocean.markdown
discoverable.markdown
discovery.markdown
doorbird.markdown
downloader.markdown
duckdns.markdown
dweet.markdown
dyson.markdown
ecobee.markdown
eight_sleep.markdown
emoncms_history.markdown
emulated_hue.markdown
enocean.markdown
envisalink.markdown
fan.comfoconnect.markdown
fan.dyson.markdown
fan.insteon_hub.markdown
fan.insteon_local.markdown
fan.isy994.markdown
fan.markdown
fan.mqtt.markdown
fan.velbus.markdown
fan.wink.markdown
fan.zwave.markdown
feedreader.markdown
ffmpeg.markdown
foursquare.markdown
frontend.markdown
google_assistant.markdown
graphite.markdown
group.markdown
hdmi_cec.markdown
history.markdown
history_graph.markdown
homematic.markdown
http.markdown
ifttt.manything.markdown
ifttt.markdown
image_processing.dlib_face_detect.markdown
image_processing.dlib_face_identify.markdown
image_processing.markdown
image_processing.microsoft_face_detect.markdown
image_processing.microsoft_face_identify.markdown
image_processing.openalpr_cloud.markdown
image_processing.openalpr_local.markdown
image_processing.opencv.markdown
image_processing.seven_segments.markdown
influxdb.markdown
input_boolean.markdown
input_datetime.markdown
input_number.markdown
input_select.markdown
input_text.markdown
insteon_hub.markdown
insteon_local.markdown
insteon_plm.markdown
intent_script.markdown
introduction.markdown
isy994.markdown
joaoapps_join.markdown
juicenet.markdown
keyboard.markdown
keyboard_remote.markdown
kira.markdown
knx.markdown
lametric.markdown
light.abode.markdown
light.avion.markdown
light.blinksticklight.markdown
light.blinkt.markdown
light.decora.markdown
light.decora_wifi.markdown
light.enocean.markdown
light.flux_led.markdown
light.homematic.markdown
light.hue.markdown
light.hyperion.markdown
light.insteon_hub.markdown
light.insteon_local.markdown
light.insteon_plm.markdown
light.isy994.markdown
light.knx.markdown
light.lifx.markdown
light.limitlessled.markdown
light.litejet.markdown
light.lutron.markdown
light.lutron_caseta.markdown
light.markdown
light.mochad.markdown
light.mqtt.markdown
light.mqtt_json.markdown
light.mqtt_template.markdown
light.mysensors.markdown
light.mystrom.markdown
light.osramlightify.markdown
light.piglow.markdown
light.qwikswitch.markdown
light.rflink.markdown
light.rfxtrx.markdown
light.rpi_gpio_pwm.markdown
light.scsgate.markdown
light.sensehat.markdown
light.skybell.markdown
light.tellstick.markdown
light.template.markdown
light.tikteck.markdown
light.tplink.markdown
light.tradfri.markdown
light.velbus.markdown
light.vera.markdown
light.wemo.markdown
light.wink.markdown
light.x10.markdown
light.xiaomi_aqara.markdown
light.xiaomi_miio.markdown
light.yeelight.markdown
light.yeelightsunflower.markdown
light.zengge.markdown
light.zha.markdown
light.zigbee.markdown
light.zwave.markdown
lirc.markdown
litejet.markdown
lock.abode.markdown
lock.isy994.markdown
lock.lockitron.markdown
lock.markdown
lock.mqtt.markdown
lock.nello.markdown
lock.nuki.markdown
lock.sesame.markdown
lock.tesla.markdown
lock.vera.markdown
lock.verisure.markdown
lock.wink.markdown
lock.zwave.markdown
logbook.markdown
logentries.markdown
logger.markdown
lutron.markdown
lutron_caseta.markdown
mailbox.asterisk_mbox.markdown
mailbox.markdown
mailgun.markdown
map.markdown
maxcube.markdown
media_extractor.markdown
media_player.anthemav.markdown
media_player.apple_tv.markdown
media_player.aquostv.markdown
media_player.bluesound.markdown
media_player.braviatv.markdown
media_player.cast.markdown
media_player.clementine.markdown
media_player.cmus.markdown
media_player.denon.markdown
media_player.denonavr.markdown
media_player.directv.markdown
media_player.dunehd.markdown
media_player.emby.markdown
media_player.firetv.markdown
media_player.frontier_silicon.markdown
media_player.gpmdp.markdown
media_player.gstreamer.markdown
media_player.itunes.markdown
media_player.kodi.markdown
media_player.lg_netcast.markdown
media_player.liveboxplaytv.markdown
media_player.markdown
media_player.monoprice.markdown
media_player.mpchc.markdown
media_player.mpd.markdown
media_player.nad.markdown
media_player.nadtcp.markdown
media_player.onkyo.markdown
media_player.openhome.markdown
media_player.panasonic_viera.markdown
media_player.pandora.markdown
media_player.philips_js.markdown
media_player.pioneer.markdown
media_player.plex.markdown
media_player.roku.markdown
media_player.russound_rio.markdown
media_player.russound_rnet.markdown
media_player.samsungtv.markdown
media_player.snapcast.markdown
media_player.sonos.markdown
media_player.soundtouch.markdown
media_player.spotify.markdown
media_player.squeezebox.markdown
media_player.universal.markdown
media_player.vizio.markdown
media_player.vlc.markdown
media_player.volumio.markdown
media_player.webostv.markdown
media_player.yamaha.markdown
media_player.yamaha_musiccast.markdown
microsoft_face.markdown
mochad.markdown
modbus.markdown
mqtt.markdown
mqtt_eventstream.markdown
mqtt_statestream.markdown
mycroft.markdown
mysensors.markdown
namecheapdns.markdown
neato.markdown
nest.markdown
netatmo.markdown
notify.apns.markdown
notify.aws_lambda.markdown
notify.aws_sns.markdown
notify.aws_sqs.markdown
notify.ciscospark.markdown
notify.clickatell.markdown
notify.clicksend.markdown
notify.clicksend_tts.markdown
notify.command_line.markdown
notify.discord.markdown
notify.ecobee.markdown
notify.facebook.markdown
notify.file.markdown
notify.free_mobile.markdown
notify.gntp.markdown
notify.group.markdown
notify.hipchat.markdown
notify.html5.markdown
notify.instapush.markdown
notify.joaoapps_join.markdown
notify.knx.markdown
notify.kodi.markdown
notify.lametric.markdown
notify.lannouncer.markdown
notify.llamalab_automate.markdown
notify.mailgun.markdown
notify.markdown
notify.matrix.markdown
notify.message_bird.markdown
notify.mqtt.markdown
notify.mycroft.markdown
notify.mysensors.markdown
notify.nfandroidtv.markdown
notify.nma.markdown
notify.prowl.markdown
notify.pushbullet.markdown
notify.pushetta.markdown
notify.pushover.markdown
notify.pushsafer.markdown
notify.rest.markdown
notify.rocketchat.markdown
notify.sendgrid.markdown
notify.simplepush.markdown
notify.slack.markdown
notify.smtp.markdown
notify.syslog.markdown
notify.telegram.markdown
notify.telstra.markdown
notify.twilio_call.markdown
notify.twilio_sms.markdown
notify.twitter.markdown
notify.webostv.markdown
notify.xmpp.markdown
nuimo_controller.markdown
octoprint.markdown
panel_custom.markdown
panel_iframe.markdown
persistent_notification.markdown
pilight.markdown
plant.markdown
prometheus.markdown
proximity.markdown
python_script.markdown
qwikswitch.markdown
raincloud.markdown
raspihats.markdown
recorder.markdown
remote.apple_tv.markdown
remote.harmony.markdown
remote.itach.markdown
remote.kira.markdown
remote.markdown
rest_command.markdown
rflink.markdown
rfxtrx.markdown
ring.markdown
rpi_gpio.markdown
rpi_pfio.markdown
rss_feed_template.markdown
satel_integra.markdown
scene.hunterdouglas_powerview.markdown
scene.lifx_cloud.markdown
scene.litejet.markdown
scene.lutron_caseta.markdown
scene.markdown
scene.velux.markdown
scene.wink.markdown
script.markdown
scsgate.markdown
sensor.abode.markdown
sensor.airvisual.markdown
sensor.alarmdecoder.markdown
sensor.amcrest.markdown
sensor.android_ip_webcam.markdown
sensor.apcupsd.markdown
sensor.api_stream.markdown
sensor.arduino.markdown
sensor.arest.markdown
sensor.arlo.markdown
sensor.arwn.markdown
sensor.bbox.markdown
sensor.bh1750.markdown
sensor.bitcoin.markdown
sensor.blink.markdown
sensor.blockchain.markdown
sensor.bloomsky.markdown
sensor.bme280.markdown
sensor.bom.markdown
sensor.broadlink.markdown
sensor.buienradar.markdown
sensor.cert_expiry.markdown
sensor.citybikes.markdown
sensor.coinmarketcap.markdown
sensor.comed_hourly_pricing.markdown
sensor.comfoconnect.markdown
sensor.command_line.markdown
sensor.cpuspeed.markdown
sensor.crimereports.markdown
sensor.cups.markdown
sensor.currencylayer.markdown
sensor.darksky.markdown
sensor.deutsche_bahn.markdown
sensor.dht.markdown
sensor.dnsip.markdown
sensor.dovado.markdown
sensor.dsmr.markdown
sensor.dte_energy_bridge.markdown
sensor.dublin_bus_transport.markdown
sensor.dwd_weather_warnings.markdown
sensor.dweet.markdown
sensor.dyson.markdown
sensor.ebox.markdown
sensor.ecobee.markdown
sensor.eddystone_temperature.markdown
sensor.efergy.markdown
sensor.eight_sleep.markdown
sensor.eliqonline.markdown
sensor.emoncms.markdown
sensor.enocean.markdown
sensor.envirophat.markdown
sensor.envisalink.markdown
sensor.etherscan.markdown
sensor.fastdotcom.markdown
sensor.fedex.markdown
sensor.fido.markdown
sensor.file.markdown
sensor.fitbit.markdown
sensor.fixer.markdown
sensor.fritzbox_callmonitor.markdown
sensor.fritzbox_netmonitor.markdown
sensor.geizhals.markdown
sensor.geo_rss_events.markdown
sensor.gitter.markdown
sensor.glances.markdown
sensor.google_travel_time.markdown
sensor.google_wifi.markdown
sensor.gpsd.markdown
sensor.gtfs.markdown
sensor.haveibeenpwned.markdown
sensor.hddtemp.markdown
sensor.history_stats.markdown
sensor.homematic.markdown
sensor.hp_ilo.markdown
sensor.http.markdown
sensor.htu21d.markdown
sensor.hydroquebec.markdown
sensor.imap.markdown
sensor.imap_email_content.markdown
sensor.influxdb.markdown
sensor.ios.markdown
sensor.isy994.markdown
sensor.juicenet.markdown
sensor.kira.markdown
sensor.knx.markdown
sensor.kwb.markdown
sensor.lastfm.markdown
sensor.linux_battery.markdown
sensor.london_air.markdown
sensor.london_underground.markdown
sensor.loop_energy.markdown
sensor.lyft.markdown
sensor.markdown
sensor.metoffice.markdown
sensor.mfi.markdown
sensor.mhz19.markdown
sensor.miflora.markdown
sensor.min_max.markdown
sensor.modbus.markdown
sensor.modem_callerid.markdown
sensor.mold_indicator.markdown
sensor.moon.markdown
sensor.mopar.markdown
sensor.mqtt.markdown
sensor.mqtt_room.markdown
sensor.mvglive.markdown
sensor.mysensors.markdown
sensor.neato.markdown
sensor.nest.markdown
sensor.nest_weather.markdown
sensor.netatmo.markdown
sensor.netdata.markdown
sensor.neurio_energy.markdown
sensor.nut.markdown
sensor.nzbget.markdown
sensor.octoprint.markdown
sensor.ohmconnect.markdown
sensor.onewire.markdown
sensor.openevse.markdown
sensor.openexchangerates.markdown
sensor.openhardwaremonitor.markdown
sensor.opensky.markdown
sensor.openweathermap.markdown
sensor.otp.markdown
sensor.pi_hole.markdown
sensor.pilight.markdown
sensor.plex.markdown
sensor.pocketcasts.markdown
sensor.pushbullet.markdown
sensor.pvoutput.markdown
sensor.qnap.markdown
sensor.radarr.markdown
sensor.raincloud.markdown
sensor.random.markdown
sensor.rest.markdown
sensor.rflink.markdown
sensor.rfxtrx.markdown
sensor.ring.markdown
sensor.ripple.markdown
sensor.sabnzbd.markdown
sensor.scrape.markdown
sensor.season.markdown
sensor.sensehat.markdown
sensor.serial.markdown
sensor.serial_pm.markdown
sensor.shodan.markdown
sensor.skybeacon.markdown
sensor.skybell.markdown
sensor.sleepiq.markdown
sensor.sma.markdown
sensor.snmp.markdown
sensor.sonarr.markdown
sensor.speedtest.markdown
sensor.statistics.markdown
sensor.steam_online.markdown
sensor.supervisord.markdown
sensor.swiss_hydrological_data.markdown
sensor.swiss_public_transport.markdown
sensor.synologydsm.markdown
sensor.systemmonitor.markdown
sensor.tado.markdown
sensor.tank_utility.markdown
sensor.tcp.markdown
sensor.ted5000.markdown
sensor.tellduslive.markdown
sensor.tellstick.markdown
sensor.temper.markdown
sensor.template.markdown
sensor.tesla.markdown
sensor.thethingsnetwork.markdown
sensor.thinkingcleaner.markdown
sensor.tibber.markdown
sensor.time_date.markdown
sensor.torque.markdown
sensor.transmission.markdown
sensor.travisci.markdown
sensor.twitch.markdown
sensor.uber.markdown
sensor.uk_transport.markdown
sensor.upnp.markdown
sensor.ups.markdown
sensor.uptime.markdown
sensor.usps.markdown
sensor.vasttrafik.markdown
sensor.vera.markdown
sensor.verisure.markdown
sensor.version.markdown
sensor.waqi.markdown
sensor.wink.markdown
sensor.worldclock.markdown
sensor.worldtidesinfo.markdown
sensor.worxlandroid.markdown
sensor.wsdot.markdown
sensor.wunderground.markdown
sensor.xbox_live.markdown
sensor.xiaomi_aqara.markdown
sensor.yahoo_finance.markdown
sensor.yr.markdown
sensor.yweather.markdown
sensor.zabbix.markdown
sensor.zamg.markdown
sensor.zha.markdown
sensor.zigbee.markdown
sensor.zoneminder.markdown
sensor.zwave.markdown
shell_command.markdown
shiftr.markdown
shopping_list.markdown
skybell.markdown
sleepiq.markdown
snips.markdown
spc.markdown
splunk.markdown
statsd.markdown
sun.markdown
switch.abode.markdown
switch.acer_projector.markdown
switch.android_ip_webcam.markdown
switch.anel_pwrctrl.markdown
switch.arduino.markdown
switch.arest.markdown
switch.bbb_gpio.markdown
switch.broadlink.markdown
switch.command_line.markdown
switch.digital_ocean.markdown
switch.digitalloggers.markdown
switch.dlink.markdown
switch.doorbird.markdown
switch.edimax.markdown
switch.enocean.markdown
switch.flux.markdown
switch.fritzdect.markdown
switch.hikvision.markdown
switch.homematic.markdown
switch.hook.markdown
switch.insteon_local.markdown
switch.insteon_plm.markdown
switch.isy994.markdown
switch.kankun.markdown
switch.knx.markdown
switch.litejet.markdown
switch.lutron_caseta.markdown
switch.markdown
switch.mfi.markdown
switch.mochad.markdown
switch.modbus.markdown
switch.mqtt.markdown
switch.mysensors.markdown
switch.mystrom.markdown
switch.neato.markdown
switch.netio.markdown
switch.orvibo.markdown
switch.pilight.markdown
switch.pulseaudio_loopback.markdown
switch.qwikswitch.markdown
switch.rachio.markdown
switch.raincloud.markdown
switch.rainmachine.markdown
switch.raspihats.markdown
switch.rest.markdown
switch.rflink.markdown
switch.rfxtrx.markdown
switch.rpi_gpio.markdown
switch.rpi_pfio.markdown
switch.rpi_rf.markdown
switch.scsgate.markdown
switch.skybell.markdown
switch.tellduslive.markdown
switch.tellstick.markdown
switch.telnet.markdown
switch.template.markdown
switch.tesla.markdown
switch.thinkingcleaner.markdown
switch.tplink.markdown
switch.transmission.markdown
switch.velbus.markdown
switch.vera.markdown
switch.verisure.markdown
switch.wake_on_lan.markdown
switch.wemo.markdown
switch.wink.markdown
switch.xiaomi_aqara.markdown
switch.xiaomi_miio.markdown
switch.zha.markdown
switch.zigbee.markdown
switch.zoneminder.markdown
switch.zwave.markdown
tado.markdown
telegram_bot.broadcast.markdown
telegram_bot.markdown
telegram_bot.polling.markdown
telegram_bot.webhooks.markdown
tellduslive.markdown
tellstick.markdown
tesla.markdown
thethingsnetwork.markdown
thingspeak.markdown
tradfri.markdown
tts.amazon_polly.markdown
tts.google.markdown
tts.markdown
tts.marytts.markdown
tts.picotts.markdown
tts.voicerss.markdown
tts.yandextts.markdown
twilio.markdown
updater.markdown
upnp.markdown
usps.markdown
vacuum.dyson.markdown
vacuum.markdown
vacuum.mqtt.markdown
vacuum.roomba.markdown
vacuum.xiaomi_miio.markdown
velbus.markdown
velux.markdown
vera.markdown
verisure.markdown
volvooncall.markdown
wake_on_lan.markdown
weather.bom.markdown
weather.buienradar.markdown
weather.markdown
weather.metoffice.markdown
weather.openweathermap.markdown
weather.yweather.markdown
weather.zamg.markdown
weblink.markdown
wemo.markdown
wink.markdown
xiaomi_aqara.markdown
zabbix.markdown
zeroconf.markdown
zha.markdown
zigbee.markdown
zone.markdown
zoneminder.markdown
zwave.markdown
_cookbook
_data
_docs
_faq
_includes
_layouts
_posts
addons
assets
blog
components
cookbook
demo
developers
docs
faq
font
getting-started
hassio
help
images
javascripts
static
CNAME
atom.xml
favicon.png
googlef4f3693c209fe788.html
index.html
robots.txt
service_worker.js
version.json
.editorconfig
.gitattributes
.gitignore
.gitmodules
.powrc
.project
.ruby-version
.slugignore
.travis.yml
CLA.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE.md
README.markdown
Rakefile
_config.yml
config.rb
config.ru
39128242c9
* Add documentation for availability topic and payloads Added documentation for availabiltiy topic and payloads added in a pull request. Also cleaned up documentation for the MQTT cover generally to make clear the differences between state topic and messages and availability topic and messages. * Add default qos level * Add documentation for availability topic and payloads Added documentation for availability topic and payloads added to the MQTT binary sensor in a pull request. Also cleaned up documentation for the MQTT binary sensor generally. * Remove sending
68 lines
3.9 KiB
Markdown
68 lines
3.9 KiB
Markdown
---
|
|
layout: page
|
|
title: "MQTT Binary Sensor"
|
|
description: "Instructions how to integrate MQTT binary sensors within Home Assistant."
|
|
date: 2015-05-30 23:21
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: mqtt.png
|
|
ha_category: Binary Sensor
|
|
ha_release: 0.9
|
|
ha_iot_class: "depends"
|
|
---
|
|
|
|
|
|
The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`.
|
|
|
|
The binary sensor state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
|
|
|
|
The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT cover device goes offline (i.e. publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` is defined, Home Assistant will consider the MQTT device to be available.
|
|
|
|
To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
- platform: mqtt
|
|
state_topic: "home-assistant/window/contact"
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **name** (*Optional*): The name of the binary sensor. Default is `MQTT Binary Sensor`.
|
|
- **state_topic** (*Required*): The MQTT topic subscribed to receive sensor values.
|
|
- **payload_on** (*Optional*): The payload that represents the on state. Default is `ON`.
|
|
- **payload_off** (*Optional*): The payload that represents the off state. Default is `OFF`.
|
|
- **availability_topic** (*Optional*): The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default.
|
|
- **payload_available** (*Optional*): The payload that represents the online state. Default is `online`.
|
|
- **payload_not_available** (*Optional*): The payload that represents the offline state. Default is `offline`.
|
|
- **qos** (*Optional*): The maximum QoS level to be used when receiving messages. Default is `0`.
|
|
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
|
|
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
|
|
|
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. To set the state of the binary sensor manually:
|
|
|
|
```bash
|
|
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF"
|
|
```
|
|
|
|
The example below shows a full configuration for a binary sensor:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
- platform: mqtt
|
|
name: "Window Contact Sensor"
|
|
state_topic: "home-assistant/window/contact"
|
|
payload_on: "ON"
|
|
payload_off: "OFF"
|
|
availability_topic: "home-assistant/window/availability"
|
|
payload_available: "online"
|
|
payload_not_available: "offline"
|
|
qos: 0
|
|
device_class: opening
|
|
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
|
```
|