ESPHome  2024.12.2
Data Fields
esphome::mqtt::MQTTDiscoveryInfo Struct Reference

Internal struct for MQTT Home Assistant discovery. More...

#include <mqtt_client.h>

Data Fields

std::string prefix
 The Home Assistant discovery prefix. Empty means disabled. More...
 
bool retain
 Whether to retain discovery messages. More...
 
bool discover_ip
 Enable the Home Assistant device discovery. More...
 
bool clean
 
MQTTDiscoveryUniqueIdGenerator unique_id_generator
 
MQTTDiscoveryObjectIdGenerator object_id_generator
 

Detailed Description

Internal struct for MQTT Home Assistant discovery.

See MQTT Discovery.

Definition at line 80 of file mqtt_client.h.

Field Documentation

◆ clean

bool esphome::mqtt::MQTTDiscoveryInfo::clean

Definition at line 84 of file mqtt_client.h.

◆ discover_ip

bool esphome::mqtt::MQTTDiscoveryInfo::discover_ip

Enable the Home Assistant device discovery.

Definition at line 83 of file mqtt_client.h.

◆ object_id_generator

MQTTDiscoveryObjectIdGenerator esphome::mqtt::MQTTDiscoveryInfo::object_id_generator

Definition at line 86 of file mqtt_client.h.

◆ prefix

std::string esphome::mqtt::MQTTDiscoveryInfo::prefix

The Home Assistant discovery prefix. Empty means disabled.

Definition at line 81 of file mqtt_client.h.

◆ retain

bool esphome::mqtt::MQTTDiscoveryInfo::retain

Whether to retain discovery messages.

Definition at line 82 of file mqtt_client.h.

◆ unique_id_generator

MQTTDiscoveryUniqueIdGenerator esphome::mqtt::MQTTDiscoveryInfo::unique_id_generator

Definition at line 85 of file mqtt_client.h.


The documentation for this struct was generated from the following file: