MQTT Subscribe Text Sensor

The mqtt_subscribe text sensor platform allows you to get external data into ESPHome. The sensor will subscribe to messages on the given MQTT topic and save the most recent value in its id(mysensor).state.

# Example configuration entry
text_sensor:
  - platform: mqtt_subscribe
    name: "Data from topic"
    id: mysensor
    topic: the/topic

Configuration variables:

  • name (Required, string): The name of the text sensor.

  • topic (Required, string): The MQTT topic to listen for string data.

  • qos (Optional, int): The MQTT QoS to subscribe with. Defaults to 0.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • All other options from Text Sensor.

Example Usage for Displays

This integration is especially useful for displays, to show external data on the display. Please note you have to use the .c_str() method on the .state object together with the %s format to use it in printf expressions.

# Example configuration entry
text_sensor:
  - platform: mqtt_subscribe
    name: "Data from topic"
    id: mysensor
    topic: the/topic

display:
  - platform: ...
    # ...
    lambda: |-
      it.printf(0, 0, id(font), "The data is: %s", id(mysensor).state.c_str());

See Also