Everything needed to reach and authenticate with one ESPHome device. More...

#include <client_options.hpp>

Collaboration diagram for esphome::api::ClientOptions:

[legend]

Public Member Functions
	ClientOptions ()=default

	ClientOptions (std::string h, const std::uint16_t p=static_cast< std::uint16_t >(default_port))

Public Attributes
std::string	host
	Device hostname or IP.

std::uint16_t	port = static_cast<std::uint16_t>(default_port)
	TCP port (default 6053).

ConnectionOptions	connection
	Handshake / keepalive tunables (client_info, Noise PSK, timeouts, ...).

bool	subscribe_on_connect = true
	When true (default), SyncClient::connect() automatically enumerates the device's entities and subscribes to state updates, so entities() is populated and live as soon as connect() returns.

Detailed Description

Everything needed to reach and authenticate with one ESPHome device.

Constructor & Destructor Documentation

◆ ClientOptions() [1/2]

esphome::api::ClientOptions::ClientOptions ( )

default

◆ ClientOptions() [2/2]

esphome::api::ClientOptions::ClientOptions	(	std::string	h,
		const std::uint16_t	p = `static_cast<std::uint16_t>(default_port)`
	)

inline

Member Data Documentation

◆ connection

ConnectionOptions esphome::api::ClientOptions::connection

Handshake / keepalive tunables (client_info, Noise PSK, timeouts, ...).

◆ host

std::string esphome::api::ClientOptions::host

Device hostname or IP.

◆ port

std::uint16_t esphome::api::ClientOptions::port = static_cast<std::uint16_t>(default_port)

TCP port (default 6053).

◆ subscribe_on_connect

bool esphome::api::ClientOptions::subscribe_on_connect = true

When true (default), SyncClient::connect() automatically enumerates the device's entities and subscribes to state updates, so entities() is populated and live as soon as connect() returns.

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

include/esphome/api/client_options.hpp

Public Member Functions

Public Attributes