mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-26 17:27:47 +01:00
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
MQTT Subscribe Sensor
|
|
=====================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up MQTT subscribe sensors
|
|
:image: mqtt.png
|
|
:keywords: MQTT
|
|
|
|
The ``mqtt_subscribe`` sensor platform allows you to get external data into ESPHome.
|
|
The sensor will subscribe to messages on the given MQTT topic and parse each message into
|
|
a floating point number.
|
|
|
|
Please note this integration only works with MQTT topics that have numeric data! Each time
|
|
a message that is not a number is published a warning will be shown. Please use the MQTT subscribe
|
|
text sensor for importing arbitrary text into the ESPHome ecosystem.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: mqtt_subscribe
|
|
name: "Data from topic"
|
|
id: mysensor
|
|
topic: the/topic
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **name** (**Required**, string): The name of the sensor.
|
|
- **topic** (**Required**, string): The MQTT topic to listen for numeric messages.
|
|
- **qos** (*Optional*, int): The MQTT QoS to subscribe with. Defaults to ``0``.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :ref:`sensor-filters`
|
|
- :apiref:`sensor/mqtt_subscribe_sensor.h`
|
|
- :ghedit:`Edit`
|