jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-08-12 10:49:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
.github
.themes
_deploy
credits_generator
plugins
sass
source
_components
alarm_control_panel.alarmdotcom.markdown
alarm_control_panel.concord232.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
alarm_control_panel.wink.markdown
alert.markdown
alexa.markdown
android_ip_webcam.markdown
apcupsd.markdown
apiai.markdown
arduino.markdown
automation.markdown
bbb_gpio.markdown
binary_sensor.android_ip_webcam.markdown
binary_sensor.apcupsd.markdown
binary_sensor.arest.markdown
binary_sensor.aurora.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.ecobee.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.modbus.markdown
binary_sensor.mqtt.markdown
binary_sensor.mysensors.markdown
binary_sensor.nest.markdown
binary_sensor.netatmo.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.threshold.markdown
binary_sensor.trend.markdown
binary_sensor.vera.markdown
binary_sensor.wink.markdown
binary_sensor.zigbee.markdown
binary_sensor.zwave.markdown
blink.markdown
bloomsky.markdown
browser.markdown
calendar.google.markdown
calendar.markdown
camera.amcrest.markdown
camera.blink.markdown
camera.bloomsky.markdown
camera.ffmpeg.markdown
camera.foscam.markdown
camera.generic.markdown
camera.local_file.markdown
camera.markdown
camera.mjpeg.markdown
camera.nest.markdown
camera.netatmo.markdown
camera.rpi_camera.markdown
camera.synology.markdown
camera.uvc.markdown
camera.verisure.markdown
camera.zoneminder.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.netatmo.markdown
climate.oem.markdown
climate.proliphix.markdown
climate.radiotherm.markdown
climate.vera.markdown
climate.wink.markdown
climate.zwave.markdown
config.markdown
configurator.markdown
conversation.markdown
cover.command_line.markdown
cover.garadget.markdown
cover.homematic.markdown
cover.isy994.markdown
cover.markdown
cover.mqtt.markdown
cover.myq.markdown
cover.mysensors.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.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.gpslogger.markdown
device_tracker.icloud.markdown
device_tracker.linksys_ap.markdown
device_tracker.locative.markdown
device_tracker.luci.markdown
device_tracker.markdown
device_tracker.mqtt.markdown
device_tracker.mysensors.markdown
device_tracker.netgear.markdown
device_tracker.nmap_tracker.markdown
device_tracker.owntracks.markdown
device_tracker.ping.markdown
device_tracker.sky_hub.markdown
device_tracker.snmp.markdown
device_tracker.swisscom.markdown
device_tracker.tado.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
downloader.markdown
dweet.markdown
ecobee.markdown
emoncms_history.markdown
emulated_hue.markdown
enocean.markdown
envisalink.markdown
fan.insteon_hub.markdown
fan.isy994.markdown
fan.markdown
fan.mqtt.markdown
fan.wink.markdown
feedreader.markdown
ffmpeg.markdown
foursquare.markdown
frontend.markdown
graphite.markdown
group.markdown
ha.markdown
hdmi_cec.markdown
history.markdown
homematic.markdown
http.markdown
ifttt.manything.markdown
ifttt.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
influxdb.markdown
input_boolean.markdown
input_select.markdown
input_slider.markdown
insteon_hub.markdown
insteon_local.markdown
insteon_plm.markdown
introduction.markdown
isy994.markdown
joaoapps_join.markdown
keyboard.markdown
keyboard_remote.markdown
knx.markdown
light.avion.markdown
light.blinksticklight.markdown
light.decora.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.lifx.markdown
light.limitlessled.markdown
light.litejet.markdown
light.markdown
light.mqtt.markdown
light.mqtt_json.markdown
light.mqtt_template.markdown
light.mysensors.markdown
light.osramlightify.markdown
light.piglow.markdown
light.qwikswitch.markdown
light.rflink.markdown
light.rfxtrx.markdown
light.scsgate.markdown
light.tellstick.markdown
light.tikteck.markdown
light.vera.markdown
light.wemo.markdown
light.wink.markdown
light.x10.markdown
light.yeelight.markdown
light.yeelightsunflower.markdown
light.zengge.markdown
light.zigbee.markdown
light.zwave.markdown
lirc.markdown
litejet.markdown
lock.isy994.markdown
lock.markdown
lock.mqtt.markdown
lock.nuki.markdown
lock.vera.markdown
lock.verisure.markdown
lock.wink.markdown
lock.zwave.markdown
logbook.markdown
logentries.markdown
logger.markdown
lutron.markdown
maxcube.markdown
media_player.anthemav.markdown
media_player.apple_tv.markdown
media_player.aquostv.markdown
media_player.braviatv.markdown
media_player.cast.markdown
media_player.clementine.markdown
media_player.cmus.markdown
media_player.denon.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.mpchc.markdown
media_player.mpd.markdown
media_player.nad.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_rnet.markdown
media_player.samsungtv.markdown
media_player.snapcast.markdown
media_player.sonos.markdown
media_player.soundtouch.markdown
media_player.squeezebox.markdown
media_player.universal.markdown
media_player.vlc.markdown
media_player.webostv.markdown
media_player.yamaha.markdown
microsoft_face.markdown
mochad.markdown
modbus.markdown
mqtt.markdown
mqtt_eventstream.markdown
mysensors.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.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.html5.markdown
notify.instapush.markdown
notify.joaoapps_join.markdown
notify.kodi.markdown
notify.lannouncer.markdown
notify.llamalab_automate.markdown
notify.mailgun.markdown
notify.markdown
notify.matrix.markdown
notify.message_bird.markdown
notify.mqtt.markdown
notify.mysensors.markdown
notify.nfandroidtv.markdown
notify.nma.markdown
notify.pushbullet.markdown
notify.pushetta.markdown
notify.pushover.markdown
notify.pushsafer.markdown
notify.rest.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
openalpr.markdown
panel_custom.markdown
panel_iframe.markdown
persistent_notification.markdown
pilight.markdown
proximity.markdown
qwikswitch.markdown
recorder.markdown
remote.harmony.markdown
remote.itach.markdown
remote.markdown
rest_command.markdown
rflink.markdown
rfxtrx.markdown
rpi_gpio.markdown
scene.hunterdouglas_powerview.markdown
scene.litejet.markdown
scene.markdown
script.markdown
scsgate.markdown
sensor.amcrest.markdown
sensor.android_ip_webcam.markdown
sensor.apcupsd.markdown
sensor.api_stream.markdown
sensor.arduino.markdown
sensor.arest.markdown
sensor.arwn.markdown
sensor.bbox.markdown
sensor.bitcoin.markdown
sensor.blink.markdown
sensor.bloomsky.markdown
sensor.bom.markdown
sensor.broadlink.markdown
sensor.coinmarketcap.markdown
sensor.comed_hourly_pricing.markdown
sensor.command_line.markdown
sensor.cpuspeed.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.dweet.markdown
sensor.ebox.markdown
sensor.efergy.markdown
sensor.eliqonline.markdown
sensor.emoncms.markdown
sensor.enocean.markdown
sensor.envisalink.markdown
sensor.fastdotcom.markdown
sensor.fedex.markdown
sensor.fido.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.haveibeenpwned.markdown
sensor.hddtemp.markdown
sensor.history_stats.markdown
sensor.homematic.markdown
sensor.hp_ilo.markdown
sensor.http.markdown
sensor.hydroquebec.markdown
sensor.imap.markdown
sensor.imap_email_content.markdown
sensor.influxdb.markdown
sensor.iss.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.min_max.markdown
sensor.modbus.markdown
sensor.modem_callerid.markdown
sensor.moldindicator.markdown
sensor.moon.markdown
sensor.mqtt.markdown
sensor.mqtt_room.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.openweathermap.markdown
sensor.pi_hole.markdown
sensor.pilight.markdown
sensor.plex.markdown
sensor.pocketcasts.markdown
sensor.pvoutput.markdown
sensor.qnap.markdown
sensor.random.markdown
sensor.rest.markdown
sensor.rflink.markdown
sensor.rfxtrx.markdown
sensor.ring.markdown
sensor.sabnzbd.markdown
sensor.scrape.markdown
sensor.sensehat.markdown
sensor.serial_pm.markdown
sensor.skybeacon.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.tcp.markdown
sensor.ted5000.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.ups.markdown
sensor.usps.markdown
sensor.vasttrafik.markdown
sensor.vera.markdown
sensor.verisure.markdown
sensor.waqi.markdown
sensor.wink.markdown
sensor.worldclock.markdown
sensor.wsdot.markdown
sensor.wunderground.markdown
sensor.xbox_live.markdown
sensor.yahoo_finance.markdown
sensor.yr.markdown
sensor.yweather.markdown
sensor.zabbix.markdown
sensor.zamg.markdown
sensor.zigbee.markdown
sensor.zoneminder.markdown
sensor.zwave.markdown
shell_command.markdown
sleepiq.markdown
splunk.markdown
statsd.markdown
sun.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.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.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.rest.markdown
switch.rflink.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.zoneminder.markdown
switch.zwave.markdown
telegram_webhooks.markdown
tellduslive.markdown
tellstick.markdown
thingspeak.markdown
tts.amazon_polly.markdown
tts.google.markdown
tts.markdown
tts.picotts.markdown
tts.voicerss.markdown
tts.yandextts.markdown
twilio.markdown
updater.markdown
upnp.markdown
vera.markdown
verisure.markdown
weather.bom.markdown
weather.markdown
weather.openweathermap.markdown
weather.zamg.markdown
weblink.markdown
wemo.markdown
wink.markdown
zabbix.markdown
zeroconf.markdown
zigbee.markdown
zone.markdown
zoneminder.markdown
zwave.markdown
_cookbook
_docs
_includes
_layouts
_posts
assets
blog
components
cookbook
demo
developers
docs
font
getting-started
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
.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
05d3796c2a2bc44771752a6a940c82fded8d335c
home-assistant.io/source/_components/binary_sensor.mqtt.markdown
Fabian Affolter f19ab6fa7f Merge branch 'next' into device-class
2017-02-11 17:55:16 +01:00

2.1 KiB
Raw Blame History

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 Binary Sensor Instructions how to integrate MQTT binary sensors within Home Assistant. 2015-05-30 23:21 true false true true mqtt.png Binary Sensor 0.9 Depends

The mqtt binary sensor platform uses the MQTT message payload as the sensor value. If messages in this state_topic are published with RETAIN flag, the sensor will receive an instant update with the last known value. Otherwise, the initial state will be off.

To use your MQTT binary sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yml entry
binary_sensor:
  - platform: mqtt
    state_topic: "home-assistant/window/contact"

Configuration variables:

  • state_topic (Required): The MQTT topic subscribed to receive sensor values.
  • name (Optional): The name of the sensor. Default is 'MQTT Sensor'.
  • qos (Optional): The maximum QoS level of the state topic. Default is 0.
  • payload_on (Optional): The payload that represents on state. Default is "ON".
  • payload_off (Optional): The payload that represents state. Default is "OFF".
  • device_class (Optional): The type/class of the sensor to set the icon in the frontend.
  • value_template (Optional): Defines a template to extract a value from the payload.

For a quick check you can use the commandline tools shipped with mosquitto to send MQTT messages. Set the state of a sensor manually:

$  mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF"

An extended configuration for the same sensor could look like this if you want/need to be more specific.

# Example configuration.yml entry
binary_sensor:
  - platform: mqtt
    state_topic: "home-assistant/window/contact"
    name: "Windows contact"
    qos: 0
    payload_on: "1"
    payload_off: "0"
    device_class: opening
    value_template: '{% raw %}{{ value.x }}{% endraw %}'