esphome-docs/esphomeyaml/components/binary_sensor/status.rst

40 lines
1.2 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Status Binary Sensor
====================
.. seo::
:description: Instructions for setting up MQTT status binary sensors.
:image: server-network.png
The Status Binary Sensor exposes the node state (if its connected to
MQTT or not) for Home Assistant. It uses the :ref:`MQTT birth and last will messages <mqtt-last_will_birth>`
to do this.
.. figure:: images/status-ui.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
binary_sensor:
- platform: status
name: "Living Room Status"
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`
and :ref:`MQTT Component <config-mqtt-component>`. (Inverted mode is not supported)
See Also
--------
- :doc:`/esphomeyaml/components/binary_sensor/index`
- :doc:`/esphomeyaml/components/mqtt`
- :doc:`API Reference </api/binary_sensor/status>`
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/status.rst>`__
.. disqus::