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

internal struct for MQTT credentials. More...

#include <mqtt_client.h>

Data Fields

std::string address
 The address of the server without port number. More...
 
uint16_t port
 The port number of the server. More...
 
std::string username
 
std::string password
 
std::string client_id
 The client ID. Will automatically be truncated to 23 characters. More...
 
bool clean_session
 Whether the session will be cleaned or remembered between connects. More...
 

Detailed Description

internal struct for MQTT credentials.

Definition at line 48 of file mqtt_client.h.

Field Documentation

◆ address

std::string esphome::mqtt::MQTTCredentials::address

The address of the server without port number.

Definition at line 49 of file mqtt_client.h.

◆ clean_session

bool esphome::mqtt::MQTTCredentials::clean_session

Whether the session will be cleaned or remembered between connects.

Definition at line 54 of file mqtt_client.h.

◆ client_id

std::string esphome::mqtt::MQTTCredentials::client_id

The client ID. Will automatically be truncated to 23 characters.

Definition at line 53 of file mqtt_client.h.

◆ password

std::string esphome::mqtt::MQTTCredentials::password

Definition at line 52 of file mqtt_client.h.

◆ port

uint16_t esphome::mqtt::MQTTCredentials::port

The port number of the server.

Definition at line 50 of file mqtt_client.h.

◆ username

std::string esphome::mqtt::MQTTCredentials::username

Definition at line 51 of file mqtt_client.h.


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