esphome::api::DeviceInfo Struct Reference

Ergonomic, copyable snapshot of a device's identity and capabilities, converted from the raw DeviceInfoResponse. More...

#include <device_info.hpp>

Collaboration diagram for esphome::api::DeviceInfo:

Static Public Member Functions
static DeviceInfo	from_proto (const proto::DeviceInfoResponse &msg)
	Build a DeviceInfo from a decoded DeviceInfoResponse.

Public Attributes
std::string	name
std::string	friendly_name
std::string	mac_address
std::string	bluetooth_mac_address
std::string	esphome_version
std::string	compilation_time
std::string	model
std::string	manufacturer
std::string	project_name
std::string	project_version
std::string	suggested_area
bool	has_deep_sleep = false
std::uint32_t	webserver_port = 0
bool	api_encryption_supported = false
std::uint32_t	bluetooth_proxy_feature_flags = 0
std::uint32_t	voice_assistant_feature_flags = 0
std::uint32_t	zwave_proxy_feature_flags = 0
std::uint32_t	zwave_home_id = 0
std::vector< SerialProxyPortInfo >	serial_proxies
	Serial-proxy ports exposed by the device (index = instance).

Detailed Description

Ergonomic, copyable snapshot of a device's identity and capabilities, converted from the raw DeviceInfoResponse.

Member Function Documentation

from_proto()

static DeviceInfo esphome::api::DeviceInfo::from_proto ( const proto::DeviceInfoResponse &  msg )

static

Build a DeviceInfo from a decoded DeviceInfoResponse.

Member Data Documentation

api_encryption_supported

bool esphome::api::DeviceInfo::api_encryption_supported = false

bluetooth_mac_address

std::string esphome::api::DeviceInfo::bluetooth_mac_address

bluetooth_proxy_feature_flags

std::uint32_t esphome::api::DeviceInfo::bluetooth_proxy_feature_flags = 0

compilation_time

std::string esphome::api::DeviceInfo::compilation_time

esphome_version

std::string esphome::api::DeviceInfo::esphome_version

friendly_name

std::string esphome::api::DeviceInfo::friendly_name

has_deep_sleep

bool esphome::api::DeviceInfo::has_deep_sleep = false

mac_address

std::string esphome::api::DeviceInfo::mac_address

manufacturer

std::string esphome::api::DeviceInfo::manufacturer

model

std::string esphome::api::DeviceInfo::model

name

std::string esphome::api::DeviceInfo::name

project_name

std::string esphome::api::DeviceInfo::project_name

project_version

std::string esphome::api::DeviceInfo::project_version

serial_proxies

std::vector<SerialProxyPortInfo> esphome::api::DeviceInfo::serial_proxies

Serial-proxy ports exposed by the device (index = instance).

suggested_area

std::string esphome::api::DeviceInfo::suggested_area

voice_assistant_feature_flags

std::uint32_t esphome::api::DeviceInfo::voice_assistant_feature_flags = 0

webserver_port

std::uint32_t esphome::api::DeviceInfo::webserver_port = 0

zwave_home_id

std::uint32_t esphome::api::DeviceInfo::zwave_home_id = 0

zwave_proxy_feature_flags

std::uint32_t esphome::api::DeviceInfo::zwave_proxy_feature_flags = 0

---

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

• include/esphome/api/model/device_info.hpp