esphome-docs/components/text_sensor/version.rst
2019-03-05 20:42:43 +01:00

34 lines
820 B
ReStructuredText

Version Text Sensor
===================
.. seo::
:description: Instructions for setting up version text sensors.
:image: new-box.png
The ``version`` text sensor platform exposes the ESPHome version the firmware
was compiled against as a text sensor.
.. figure:: images/version-ui.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
text_sensor:
- platform: version
name: "ESPHome Version"
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the text sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Text Sensor <config-text_sensor>`.
See Also
--------
- :apiref:`text_sensor/version_text_sensor.h`
- :ghedit:`Edit`