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

34 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Status Binary Sensor
====================
The Status Binary Sensor exposes the node state (if its connected to
2018-06-01 18:10:00 +02:00
MQTT or not) for Home Assistant. It uses the :ref:`MQTT birth and last will messages <mqtt-last_will_birth>`
2018-05-13 11:37:02 +02:00
to do this.
2018-06-01 18:10:00 +02:00
.. figure:: images/status-ui.png
:align: center
:width: 80.0%
2018-05-13 11:37:02 +02:00
.. code:: yaml
# Example configuration entry
binary_sensor:
- platform: status
name: "Living Room Status"
Configuration variables:
2018-08-24 22:44:01 +02:00
------------------------
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
- **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
2018-08-24 22:44:01 +02:00
--------
2018-06-01 18:10:00 +02:00
- :doc:`/esphomeyaml/components/binary_sensor/index`
- :doc:`/esphomeyaml/components/mqtt`
- :doc:`API Reference </api/binary_sensor/status>`
2018-06-04 08:17:22 +02:00
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/binary_sensor/status.rst>`__