esphome::api Namespace Reference

Namespaces
namespace	enums

Data Structures
class	ActionResponse
class	AlarmControlPanelCommandRequest
class	AlarmControlPanelStateResponse
class	APIConnectedCondition
class	APIConnection
class	APIFrameHelper
class	APINoiseContext
class	APINoiseFrameHelper
class	APIPlaintextFrameHelper
class	APIServer
class	APIServerConnection
class	APIServerConnectionBase
class	AreaInfo
class	AuthenticationRequest
class	AuthenticationResponse
class	BinarySensorStateResponse
class	BluetoothConnectionsFreeResponse
class	BluetoothDeviceClearCacheResponse
class	BluetoothDeviceConnectionResponse
class	BluetoothDevicePairingResponse
class	BluetoothDeviceRequest
class	BluetoothDeviceUnpairingResponse
class	BluetoothGATTCharacteristic
class	BluetoothGATTDescriptor
class	BluetoothGATTErrorResponse
class	BluetoothGATTGetServicesDoneResponse
class	BluetoothGATTGetServicesRequest
class	BluetoothGATTGetServicesResponse
class	BluetoothGATTNotifyDataResponse
class	BluetoothGATTNotifyRequest
class	BluetoothGATTNotifyResponse
class	BluetoothGATTReadDescriptorRequest
class	BluetoothGATTReadRequest
class	BluetoothGATTReadResponse
class	BluetoothGATTService
class	BluetoothGATTWriteDescriptorRequest
class	BluetoothGATTWriteRequest
class	BluetoothGATTWriteResponse
class	BluetoothLERawAdvertisement
class	BluetoothLERawAdvertisementsResponse
class	BluetoothScannerSetModeRequest
class	BluetoothScannerStateResponse
class	ButtonCommandRequest
class	CameraImageRequest
class	CameraImageResponse
struct	ClientInfo
class	ClimateCommandRequest
class	ClimateStateResponse
class	CommandProtoMessage
class	CoverCommandRequest
class	CoverStateResponse
class	CustomAPIDevice
class	CustomAPIDeviceService
class	DateCommandRequest
class	DateStateResponse
class	DateTimeCommandRequest
class	DateTimeStateResponse
class	DeviceInfo
class	DeviceInfoRequest
class	DeviceInfoResponse
class	DisconnectRequest
class	DisconnectResponse
class	EventResponse
class	ExecuteServiceArgument
class	ExecuteServiceRequest
class	FanCommandRequest
class	FanStateResponse
class	GetTimeRequest
class	GetTimeResponse
class	HelloRequest
class	HelloResponse
class	HomeassistantActionRequest
class	HomeassistantActionResponse
class	HomeAssistantServiceCallAction
class	HomeassistantServiceMap
class	HomeAssistantStateResponse
class	InfoResponseProtoMessage
class	InitialStateIterator
class	LightCommandRequest
class	LightStateResponse
class	ListEntitiesAlarmControlPanelResponse
class	ListEntitiesBinarySensorResponse
class	ListEntitiesButtonResponse
class	ListEntitiesCameraResponse
class	ListEntitiesClimateResponse
class	ListEntitiesCoverResponse
class	ListEntitiesDateResponse
class	ListEntitiesDateTimeResponse
class	ListEntitiesDoneResponse
class	ListEntitiesEventResponse
class	ListEntitiesFanResponse
class	ListEntitiesIterator
class	ListEntitiesLightResponse
class	ListEntitiesLockResponse
class	ListEntitiesMediaPlayerResponse
class	ListEntitiesNumberResponse
class	ListEntitiesRequest
class	ListEntitiesSelectResponse
class	ListEntitiesSensorResponse
class	ListEntitiesServicesArgument
class	ListEntitiesServicesResponse
class	ListEntitiesSirenResponse
class	ListEntitiesSwitchResponse
class	ListEntitiesTextResponse
class	ListEntitiesTextSensorResponse
class	ListEntitiesTimeResponse
class	ListEntitiesUpdateResponse
class	ListEntitiesValveResponse
class	LockCommandRequest
class	LockStateResponse
class	MediaPlayerCommandRequest
class	MediaPlayerStateResponse
class	MediaPlayerSupportedFormat
class	NoiseEncryptionSetKeyRequest
class	NoiseEncryptionSetKeyResponse
class	NumberCommandRequest
class	NumberStateResponse
struct	PacketInfo
class	PingRequest
class	PingResponse
class	Proto32Bit
class	ProtoDecodableMessage
class	ProtoLengthDelimited
class	ProtoMessage
class	ProtoService
class	ProtoSize
class	ProtoVarInt
	Representation of a VarInt - in ProtoBuf should be 64bit but we only use 32bit. More...
class	ProtoWriteBuffer
struct	ReadPacketBuffer
struct	SavedNoisePsk
class	SelectCommandRequest
class	SelectStateResponse
class	SensorStateResponse
class	SirenCommandRequest
class	SirenStateResponse
class	StateResponseProtoMessage
class	SubscribeBluetoothConnectionsFreeRequest
class	SubscribeBluetoothLEAdvertisementsRequest
class	SubscribeHomeassistantServicesRequest
class	SubscribeHomeAssistantStateResponse
class	SubscribeHomeAssistantStatesRequest
class	SubscribeLogsRequest
class	SubscribeLogsResponse
class	SubscribeStatesRequest
class	SubscribeVoiceAssistantRequest
class	SwitchCommandRequest
class	SwitchStateResponse
class	TemplatableKeyValuePair
class	TemplatableStringValue
class	TextCommandRequest
class	TextSensorStateResponse
class	TextStateResponse
class	TimeCommandRequest
class	TimeStateResponse
class	UnsubscribeBluetoothLEAdvertisementsRequest
class	UpdateCommandRequest
class	UpdateStateResponse
class	UserServiceBase
class	UserServiceDescriptor
class	UserServiceDynamic
class	UserServiceTrigger
class	ValveCommandRequest
class	ValveStateResponse
class	VoiceAssistantAnnounceFinished
class	VoiceAssistantAnnounceRequest
class	VoiceAssistantAudio
class	VoiceAssistantAudioSettings
class	VoiceAssistantConfigurationRequest
class	VoiceAssistantConfigurationResponse
class	VoiceAssistantEventData
class	VoiceAssistantEventResponse
class	VoiceAssistantExternalWakeWord
class	VoiceAssistantRequest
class	VoiceAssistantResponse
class	VoiceAssistantSetConfiguration
class	VoiceAssistantTimerEventResponse
class	VoiceAssistantWakeWord
class	ZWaveProxyFrame
class	ZWaveProxyRequest

Typedefs
using	psk_t = std::array<uint8_t, 32>
template<typename... Ts>
using	ActionResponseCallback = std::function<void(const ActionResponse &, Ts...)>

Enumerations
enum class	APIError : uint16_t {   OK = 0 , WOULD_BLOCK = 1001 , BAD_INDICATOR = 1003 , BAD_DATA_PACKET = 1004 ,   TCP_NODELAY_FAILED = 1005 , TCP_NONBLOCKING_FAILED = 1006 , CLOSE_FAILED = 1007 , SHUTDOWN_FAILED = 1008 ,   BAD_STATE = 1009 , BAD_ARG = 1010 , SOCKET_READ_FAILED = 1011 , SOCKET_WRITE_FAILED = 1012 ,   OUT_OF_MEMORY = 1018 , CONNECTION_CLOSED = 1022 , BAD_HANDSHAKE_PACKET_LEN = 1002 , HANDSHAKESTATE_READ_FAILED = 1013 ,   HANDSHAKESTATE_WRITE_FAILED = 1014 , HANDSHAKESTATE_BAD_STATE = 1015 , CIPHERSTATE_DECRYPT_FAILED = 1016 , CIPHERSTATE_ENCRYPT_FAILED = 1017 ,   HANDSHAKESTATE_SETUP_FAILED = 1019 , HANDSHAKESTATE_SPLIT_FAILED = 1020 , BAD_HANDSHAKE_ERROR_BYTE = 1021 }

Functions
const LogString *	api_error_to_logstr (APIError err)
const LogString *	noise_err_to_logstr (int err)
	Convert a noise error code to a readable error.
void	noise_rand_bytes (void *output, size_t len)
template<>
const char *	proto_enum_to_string< enums::EntityCategory > (enums::EntityCategory value)
template<>
const char *	proto_enum_to_string< enums::CoverOperation > (enums::CoverOperation value)
template<>
const char *	proto_enum_to_string< enums::FanDirection > (enums::FanDirection value)
template<>
const char *	proto_enum_to_string< enums::ColorMode > (enums::ColorMode value)
template<>
const char *	proto_enum_to_string< enums::SensorStateClass > (enums::SensorStateClass value)
template<>
const char *	proto_enum_to_string< enums::LogLevel > (enums::LogLevel value)
template<>
const char *	proto_enum_to_string< enums::ServiceArgType > (enums::ServiceArgType value)
template<>
const char *	proto_enum_to_string< enums::ClimateMode > (enums::ClimateMode value)
template<>
const char *	proto_enum_to_string< enums::ClimateFanMode > (enums::ClimateFanMode value)
template<>
const char *	proto_enum_to_string< enums::ClimateSwingMode > (enums::ClimateSwingMode value)
template<>
const char *	proto_enum_to_string< enums::ClimateAction > (enums::ClimateAction value)
template<>
const char *	proto_enum_to_string< enums::ClimatePreset > (enums::ClimatePreset value)
template<>
const char *	proto_enum_to_string< enums::NumberMode > (enums::NumberMode value)
template<>
const char *	proto_enum_to_string< enums::LockState > (enums::LockState value)
template<>
const char *	proto_enum_to_string< enums::LockCommand > (enums::LockCommand value)
template<>
const char *	proto_enum_to_string< enums::MediaPlayerState > (enums::MediaPlayerState value)
template<>
const char *	proto_enum_to_string< enums::MediaPlayerCommand > (enums::MediaPlayerCommand value)
template<>
const char *	proto_enum_to_string< enums::MediaPlayerFormatPurpose > (enums::MediaPlayerFormatPurpose value)
template<>
const char *	proto_enum_to_string< enums::BluetoothDeviceRequestType > (enums::BluetoothDeviceRequestType value)
template<>
const char *	proto_enum_to_string< enums::BluetoothScannerState > (enums::BluetoothScannerState value)
template<>
const char *	proto_enum_to_string< enums::BluetoothScannerMode > (enums::BluetoothScannerMode value)
template<>
const char *	proto_enum_to_string< enums::VoiceAssistantSubscribeFlag > (enums::VoiceAssistantSubscribeFlag value)
template<>
const char *	proto_enum_to_string< enums::VoiceAssistantRequestFlag > (enums::VoiceAssistantRequestFlag value)
template<>
const char *	proto_enum_to_string< enums::VoiceAssistantEvent > (enums::VoiceAssistantEvent value)
template<>
const char *	proto_enum_to_string< enums::VoiceAssistantTimerEvent > (enums::VoiceAssistantTimerEvent value)
template<>
const char *	proto_enum_to_string< enums::AlarmControlPanelState > (enums::AlarmControlPanelState value)
template<>
const char *	proto_enum_to_string< enums::AlarmControlPanelStateCommand > (enums::AlarmControlPanelStateCommand value)
template<>
const char *	proto_enum_to_string< enums::TextMode > (enums::TextMode value)
template<>
const char *	proto_enum_to_string< enums::ValveOperation > (enums::ValveOperation value)
template<>
const char *	proto_enum_to_string< enums::UpdateCommand > (enums::UpdateCommand value)
template<>
const char *	proto_enum_to_string< enums::ZWaveProxyRequestType > (enums::ZWaveProxyRequestType value)
	API_DISPATCH_UPDATE (binary_sensor::BinarySensor, binary_sensor) API_DISPATCH_UPDATE(cover
	API_DISPATCH_UPDATE (alarm_control_panel::AlarmControlPanel, alarm_control_panel) float APIServer
	LIST_ENTITIES_HANDLER (binary_sensor, binary_sensor::BinarySensor, ListEntitiesBinarySensorResponse) LIST_ENTITIES_HANDLER(cover
ListEntitiesCoverResponse	LIST_ENTITIES_HANDLER (fan, fan::Fan, ListEntitiesFanResponse) LIST_ENTITIES_HANDLER(light
ListEntitiesCoverResponse ListEntitiesLightResponse	LIST_ENTITIES_HANDLER (sensor, sensor::Sensor, ListEntitiesSensorResponse) LIST_ENTITIES_HANDLER(switch
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse	LIST_ENTITIES_HANDLER (button, button::Button, ListEntitiesButtonResponse) LIST_ENTITIES_HANDLER(text_sensor
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse	LIST_ENTITIES_HANDLER (lock, lock::Lock, ListEntitiesLockResponse) LIST_ENTITIES_HANDLER(valve
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse	LIST_ENTITIES_HANDLER (camera, camera::Camera, ListEntitiesCameraResponse) LIST_ENTITIES_HANDLER(climate
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse	LIST_ENTITIES_HANDLER (number, number::Number, ListEntitiesNumberResponse) LIST_ENTITIES_HANDLER(date
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse	LIST_ENTITIES_HANDLER (time, datetime::TimeEntity, ListEntitiesTimeResponse) LIST_ENTITIES_HANDLER(datetime
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse	LIST_ENTITIES_HANDLER (text, text::Text, ListEntitiesTextResponse) LIST_ENTITIES_HANDLER(select
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse ListEntitiesSelectResponse	LIST_ENTITIES_HANDLER (media_player, media_player::MediaPlayer, ListEntitiesMediaPlayerResponse) LIST_ENTITIES_HANDLER(alarm_control_panel
ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse ListEntitiesSelectResponse ListEntitiesAlarmControlPanelResponse	LIST_ENTITIES_HANDLER (event, event::Event, ListEntitiesEventResponse) LIST_ENTITIES_HANDLER(update
constexpr uint32_t	encode_zigzag32 (int32_t value)
constexpr uint64_t	encode_zigzag64 (int64_t value)
constexpr int32_t	decode_zigzag32 (uint32_t value)
constexpr int64_t	decode_zigzag64 (uint64_t value)
template<typename T >
const char *	proto_enum_to_string (T value)
	INITIAL_STATE_HANDLER (binary_sensor, binary_sensor::BinarySensor) INITIAL_STATE_HANDLER(cover
cover::Cover	INITIAL_STATE_HANDLER (fan, fan::Fan) INITIAL_STATE_HANDLER(light
cover::Cover light::LightState	INITIAL_STATE_HANDLER (sensor, sensor::Sensor) INITIAL_STATE_HANDLER(switch
cover::Cover light::LightState switch_::Switch	INITIAL_STATE_HANDLER (text_sensor, text_sensor::TextSensor) INITIAL_STATE_HANDLER(climate
cover::Cover light::LightState switch_::Switch climate::Climate	INITIAL_STATE_HANDLER (number, number::Number) INITIAL_STATE_HANDLER(date
cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity	INITIAL_STATE_HANDLER (time, datetime::TimeEntity) INITIAL_STATE_HANDLER(datetime
cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity	INITIAL_STATE_HANDLER (text, text::Text) INITIAL_STATE_HANDLER(select
cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select	INITIAL_STATE_HANDLER (lock, lock::Lock) INITIAL_STATE_HANDLER(valve
cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select valve::Valve	INITIAL_STATE_HANDLER (media_player, media_player::MediaPlayer) INITIAL_STATE_HANDLER(alarm_control_panel
cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select valve::Valve alarm_control_panel::AlarmControlPanel	INITIAL_STATE_HANDLER (update, update::UpdateEntity) InitialStateIterator
template<>
bool	get_execute_arg_value< bool > (const ExecuteServiceArgument &arg)
template<>
int32_t	get_execute_arg_value< int32_t > (const ExecuteServiceArgument &arg)
template<>
float	get_execute_arg_value< float > (const ExecuteServiceArgument &arg)
template<>
std::string	get_execute_arg_value< std::string > (const ExecuteServiceArgument &arg)
template<>
std::vector< bool >	get_execute_arg_value< std::vector< bool > > (const ExecuteServiceArgument &arg)
template<>
std::vector< int32_t >	get_execute_arg_value< std::vector< int32_t > > (const ExecuteServiceArgument &arg)
template<>
std::vector< float >	get_execute_arg_value< std::vector< float > > (const ExecuteServiceArgument &arg)
template<>
std::vector< std::string >	get_execute_arg_value< std::vector< std::string > > (const ExecuteServiceArgument &arg)
template<>
const FixedVector< bool > &	get_execute_arg_value< const FixedVector< bool > & > (const ExecuteServiceArgument &arg)
template<>
const FixedVector< int32_t > &	get_execute_arg_value< const FixedVector< int32_t > & > (const ExecuteServiceArgument &arg)
template<>
const FixedVector< float > &	get_execute_arg_value< const FixedVector< float > & > (const ExecuteServiceArgument &arg)
template<>
const FixedVector< std::string > &	get_execute_arg_value< const FixedVector< std::string > & > (const ExecuteServiceArgument &arg)
template<>
enums::ServiceArgType	to_service_arg_type< bool > ()
template<>
enums::ServiceArgType	to_service_arg_type< int32_t > ()
template<>
enums::ServiceArgType	to_service_arg_type< float > ()
template<>
enums::ServiceArgType	to_service_arg_type< std::string > ()
template<>
enums::ServiceArgType	to_service_arg_type< std::vector< bool > > ()
template<>
enums::ServiceArgType	to_service_arg_type< std::vector< int32_t > > ()
template<>
enums::ServiceArgType	to_service_arg_type< std::vector< float > > ()
template<>
enums::ServiceArgType	to_service_arg_type< std::vector< std::string > > ()
template<>
enums::ServiceArgType	to_service_arg_type< const FixedVector< bool > & > ()
template<>
enums::ServiceArgType	to_service_arg_type< const FixedVector< int32_t > & > ()
template<>
enums::ServiceArgType	to_service_arg_type< const FixedVector< float > & > ()
template<>
enums::ServiceArgType	to_service_arg_type< const FixedVector< std::string > & > ()
template<typename T >
T	get_execute_arg_value (const ExecuteServiceArgument &arg)
template<typename T >
enums::ServiceArgType	to_service_arg_type ()

Variables
APIServer *	global_api_server = nullptr
struct esphome::api::SavedNoisePsk	PACKED
constexpr uint8_t	WIRE_TYPE_VARINT = 0
constexpr uint8_t	WIRE_TYPE_LENGTH_DELIMITED = 2
constexpr uint8_t	WIRE_TYPE_FIXED32 = 5
constexpr uint8_t	WIRE_TYPE_MASK = 0b111

Typedef Documentation

ActionResponseCallback

template<typename... Ts>

using esphome::api::ActionResponseCallback = std::function<void(const ActionResponse &, Ts...)>

Definition at line 89 of file homeassistant_service.h.

psk_t

using esphome::api::psk_t = std::array<uint8_t, 32>

Definition at line 9 of file api_noise_context.h.

Enumeration Type Documentation

APIError

enum class esphome::api::APIError : uint16_t

strong

Enumerator
OK
WOULD_BLOCK
BAD_INDICATOR
BAD_DATA_PACKET
TCP_NODELAY_FAILED
TCP_NONBLOCKING_FAILED
CLOSE_FAILED
SHUTDOWN_FAILED
BAD_STATE
BAD_ARG
SOCKET_READ_FAILED
SOCKET_WRITE_FAILED
OUT_OF_MEMORY
CONNECTION_CLOSED
BAD_HANDSHAKE_PACKET_LEN
HANDSHAKESTATE_READ_FAILED
HANDSHAKESTATE_WRITE_FAILED
HANDSHAKESTATE_BAD_STATE
CIPHERSTATE_DECRYPT_FAILED
CIPHERSTATE_ENCRYPT_FAILED
HANDSHAKESTATE_SETUP_FAILED
HANDSHAKESTATE_SPLIT_FAILED
BAD_HANDSHAKE_ERROR_BYTE

Definition at line 53 of file api_frame_helper.h.

Function Documentation

API_DISPATCH_UPDATE() [1/2]

esphome::api::API_DISPATCH_UPDATE	(	alarm_control_panel::AlarmControlPanel	,
		alarm_control_panel	)

Definition at line 381 of file api_server.cpp.

API_DISPATCH_UPDATE() [2/2]

esphome::api::API_DISPATCH_UPDATE	(	binary_sensor::BinarySensor	,
		binary_sensor	)

Definition at line 283 of file api_server.cpp.

api_error_to_logstr()

const LogString * esphome::api::api_error_to_logstr

(

APIError

err

)

Definition at line 27 of file api_frame_helper.cpp.

decode_zigzag32()

int32_t esphome::api::decode_zigzag32 ( uint32_t value )

inlineconstexpr

Definition at line 34 of file proto.h.

decode_zigzag64()

int64_t esphome::api::decode_zigzag64 ( uint64_t value )

inlineconstexpr

Definition at line 38 of file proto.h.

encode_zigzag32()

uint32_t esphome::api::encode_zigzag32 ( int32_t value )

inlineconstexpr

Definition at line 26 of file proto.h.

encode_zigzag64()

uint64_t esphome::api::encode_zigzag64 ( int64_t value )

inlineconstexpr

Definition at line 30 of file proto.h.

get_execute_arg_value()

template<typename T >

T esphome::api::get_execute_arg_value

(

const ExecuteServiceArgument &

arg

)

get_execute_arg_value< bool >()

template<>

bool esphome::api::get_execute_arg_value< bool >

(

const ExecuteServiceArgument &

arg

)

Definition at line 6 of file user_services.cpp.

get_execute_arg_value< const FixedVector< bool > & >()

template<>

const FixedVector< bool > & esphome::api::get_execute_arg_value< const FixedVector< bool > & >

(

const ExecuteServiceArgument &

arg

)

Definition at line 43 of file user_services.cpp.

get_execute_arg_value< const FixedVector< float > & >()

template<>

const FixedVector< float > & esphome::api::get_execute_arg_value< const FixedVector< float > & >

(

const ExecuteServiceArgument &

arg

)

Definition at line 51 of file user_services.cpp.

get_execute_arg_value< const FixedVector< int32_t > & >()

template<>

const FixedVector< int32_t > & esphome::api::get_execute_arg_value< const FixedVector< int32_t > & >

(

const ExecuteServiceArgument &

arg

)

Definition at line 47 of file user_services.cpp.

get_execute_arg_value< const FixedVector< std::string > & >()

template<>

const FixedVector< std::string > & esphome::api::get_execute_arg_value< const FixedVector< std::string > & >

(

const ExecuteServiceArgument &

arg

)

Definition at line 55 of file user_services.cpp.

get_execute_arg_value< float >()

template<>

float esphome::api::get_execute_arg_value< float >

(

const ExecuteServiceArgument &

arg

)

Definition at line 12 of file user_services.cpp.

get_execute_arg_value< int32_t >()

template<>

int32_t esphome::api::get_execute_arg_value< int32_t >

(

const ExecuteServiceArgument &

arg

)

Definition at line 7 of file user_services.cpp.

get_execute_arg_value< std::string >()

template<>

std::string esphome::api::get_execute_arg_value< std::string >

(

const ExecuteServiceArgument &

arg

)

Definition at line 13 of file user_services.cpp.

get_execute_arg_value< std::vector< bool > >()

template<>

std::vector< bool > esphome::api::get_execute_arg_value< std::vector< bool > >

(

const ExecuteServiceArgument &

arg

)

Definition at line 13 of file user_services.cpp.

get_execute_arg_value< std::vector< float > >()

template<>

std::vector< float > esphome::api::get_execute_arg_value< std::vector< float > >

(

const ExecuteServiceArgument &

arg

)

Definition at line 13 of file user_services.cpp.

get_execute_arg_value< std::vector< int32_t > >()

template<>

std::vector< int32_t > esphome::api::get_execute_arg_value< std::vector< int32_t > >

(

const ExecuteServiceArgument &

arg

)

Definition at line 13 of file user_services.cpp.

get_execute_arg_value< std::vector< std::string > >()

template<>

std::vector< std::string > esphome::api::get_execute_arg_value< std::vector< std::string > >

(

const ExecuteServiceArgument &

arg

)

Definition at line 13 of file user_services.cpp.

INITIAL_STATE_HANDLER() [1/10]

esphome::api::INITIAL_STATE_HANDLER	(	binary_sensor	,
		binary_sensor::BinarySensor	)

INITIAL_STATE_HANDLER() [2/10]

cover::Cover esphome::api::INITIAL_STATE_HANDLER	(	fan	,
		fan::Fan	)

INITIAL_STATE_HANDLER() [3/10]

cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select esphome::api::INITIAL_STATE_HANDLER	(	lock	,
		lock::Lock	)

INITIAL_STATE_HANDLER() [4/10]

cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select valve::Valve esphome::api::INITIAL_STATE_HANDLER	(	media_player	,
		media_player::MediaPlayer	)

INITIAL_STATE_HANDLER() [5/10]

cover::Cover light::LightState switch_::Switch climate::Climate esphome::api::INITIAL_STATE_HANDLER	(	number	,
		number::Number	)

INITIAL_STATE_HANDLER() [6/10]

cover::Cover light::LightState esphome::api::INITIAL_STATE_HANDLER	(	sensor	,
		sensor::Sensor	)

INITIAL_STATE_HANDLER() [7/10]

cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity esphome::api::INITIAL_STATE_HANDLER	(	text	,
		text::Text	)

INITIAL_STATE_HANDLER() [8/10]

cover::Cover light::LightState switch_::Switch esphome::api::INITIAL_STATE_HANDLER	(	text_sensor	,
		text_sensor::TextSensor	)

INITIAL_STATE_HANDLER() [9/10]

cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity esphome::api::INITIAL_STATE_HANDLER	(	time	,
		datetime::TimeEntity	)

INITIAL_STATE_HANDLER() [10/10]

cover::Cover light::LightState switch_::Switch climate::Climate datetime::DateEntity datetime::DateTimeEntity select::Select valve::Valve alarm_control_panel::AlarmControlPanel esphome::api::INITIAL_STATE_HANDLER	(	update	,
		update::UpdateEntity	)

Definition at line 64 of file subscribe_state.cpp.

LIST_ENTITIES_HANDLER() [1/11]

esphome::api::LIST_ENTITIES_HANDLER	(	binary_sensor	,
		binary_sensor::BinarySensor	,
		ListEntitiesBinarySensorResponse	)

LIST_ENTITIES_HANDLER() [2/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse esphome::api::LIST_ENTITIES_HANDLER	(	button	,
		button::Button	,
		ListEntitiesButtonResponse	)

LIST_ENTITIES_HANDLER() [3/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse esphome::api::LIST_ENTITIES_HANDLER	(	camera	,
		camera::Camera	,
		ListEntitiesCameraResponse	)

LIST_ENTITIES_HANDLER() [4/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse ListEntitiesSelectResponse ListEntitiesAlarmControlPanelResponse esphome::api::LIST_ENTITIES_HANDLER	(	event	,
		event::Event	,
		ListEntitiesEventResponse	)

LIST_ENTITIES_HANDLER() [5/11]

ListEntitiesCoverResponse esphome::api::LIST_ENTITIES_HANDLER	(	fan	,
		fan::Fan	,
		ListEntitiesFanResponse	)

LIST_ENTITIES_HANDLER() [6/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse esphome::api::LIST_ENTITIES_HANDLER	(	lock	,
		lock::Lock	,
		ListEntitiesLockResponse	)

LIST_ENTITIES_HANDLER() [7/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse ListEntitiesSelectResponse esphome::api::LIST_ENTITIES_HANDLER	(	media_player	,
		media_player::MediaPlayer	,
		ListEntitiesMediaPlayerResponse	)

LIST_ENTITIES_HANDLER() [8/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse esphome::api::LIST_ENTITIES_HANDLER	(	number	,
		number::Number	,
		ListEntitiesNumberResponse	)

LIST_ENTITIES_HANDLER() [9/11]

ListEntitiesCoverResponse ListEntitiesLightResponse esphome::api::LIST_ENTITIES_HANDLER	(	sensor	,
		sensor::Sensor	,
		ListEntitiesSensorResponse	)

LIST_ENTITIES_HANDLER() [10/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse esphome::api::LIST_ENTITIES_HANDLER	(	text	,
		text::Text	,
		ListEntitiesTextResponse	)

LIST_ENTITIES_HANDLER() [11/11]

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse esphome::api::LIST_ENTITIES_HANDLER	(	time	,
		datetime::TimeEntity	,
		ListEntitiesTimeResponse	)

noise_err_to_logstr()

const LogString * esphome::api::noise_err_to_logstr

(

int

err

)

Convert a noise error code to a readable error.

Definition at line 39 of file api_frame_helper_noise.cpp.

noise_rand_bytes()

void esphome::api::noise_rand_bytes	(	void *	output,
		size_t	len )

Definition at line 594 of file api_frame_helper_noise.cpp.

proto_enum_to_string()

template<typename T >

const char * esphome::api::proto_enum_to_string

(

T

value

)

proto_enum_to_string< enums::AlarmControlPanelState >()

template<>

const char * esphome::api::proto_enum_to_string< enums::AlarmControlPanelState >

(

enums::AlarmControlPanelState

value

)

Definition at line 576 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::AlarmControlPanelStateCommand >()

template<>

const char * esphome::api::proto_enum_to_string< enums::AlarmControlPanelStateCommand >

(

enums::AlarmControlPanelStateCommand

value

)

Definition at line 603 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::BluetoothDeviceRequestType >()

template<>

const char * esphome::api::proto_enum_to_string< enums::BluetoothDeviceRequestType >

(

enums::BluetoothDeviceRequestType

value

)

Definition at line 449 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::BluetoothScannerMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::BluetoothScannerMode >

(

enums::BluetoothScannerMode

value

)

Definition at line 487 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::BluetoothScannerState >()

template<>

const char * esphome::api::proto_enum_to_string< enums::BluetoothScannerState >

(

enums::BluetoothScannerState

value

)

Definition at line 469 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ClimateAction >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ClimateAction >

(

enums::ClimateAction

value

)

Definition at line 294 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ClimateFanMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ClimateFanMode >

(

enums::ClimateFanMode

value

)

Definition at line 254 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ClimateMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ClimateMode >

(

enums::ClimateMode

value

)

Definition at line 234 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ClimatePreset >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ClimatePreset >

(

enums::ClimatePreset

value

)

Definition at line 312 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ClimateSwingMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ClimateSwingMode >

(

enums::ClimateSwingMode

value

)

Definition at line 280 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ColorMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ColorMode >

(

enums::ColorMode

value

)

Definition at line 142 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::CoverOperation >()

template<>

const char * esphome::api::proto_enum_to_string< enums::CoverOperation >

(

enums::CoverOperation

value

)

Definition at line 116 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::EntityCategory >()

template<>

const char * esphome::api::proto_enum_to_string< enums::EntityCategory >

(

enums::EntityCategory

value

)

Definition at line 103 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::FanDirection >()

template<>

const char * esphome::api::proto_enum_to_string< enums::FanDirection >

(

enums::FanDirection

value

)

Definition at line 130 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::LockCommand >()

template<>

const char * esphome::api::proto_enum_to_string< enums::LockCommand >

(

enums::LockCommand

value

)

Definition at line 368 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::LockState >()

template<>

const char * esphome::api::proto_enum_to_string< enums::LockState >

(

enums::LockState

value

)

Definition at line 350 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::LogLevel >()

template<>

const char * esphome::api::proto_enum_to_string< enums::LogLevel >

(

enums::LogLevel

value

)

Definition at line 187 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::MediaPlayerCommand >()

template<>

const char * esphome::api::proto_enum_to_string< enums::MediaPlayerCommand >

(

enums::MediaPlayerCommand

value

)

Definition at line 402 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::MediaPlayerFormatPurpose >()

template<>

const char * esphome::api::proto_enum_to_string< enums::MediaPlayerFormatPurpose >

(

enums::MediaPlayerFormatPurpose

value

)

Definition at line 436 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::MediaPlayerState >()

template<>

const char * esphome::api::proto_enum_to_string< enums::MediaPlayerState >

(

enums::MediaPlayerState

value

)

Definition at line 382 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::NumberMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::NumberMode >

(

enums::NumberMode

value

)

Definition at line 336 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::SensorStateClass >()

template<>

const char * esphome::api::proto_enum_to_string< enums::SensorStateClass >

(

enums::SensorStateClass

value

)

Definition at line 172 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ServiceArgType >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ServiceArgType >

(

enums::ServiceArgType

value

)

Definition at line 210 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::TextMode >()

template<>

const char * esphome::api::proto_enum_to_string< enums::TextMode >

(

enums::TextMode

value

)

Definition at line 625 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::UpdateCommand >()

template<>

const char * esphome::api::proto_enum_to_string< enums::UpdateCommand >

(

enums::UpdateCommand

value

)

Definition at line 651 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ValveOperation >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ValveOperation >

(

enums::ValveOperation

value

)

Definition at line 637 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::VoiceAssistantEvent >()

template<>

const char * esphome::api::proto_enum_to_string< enums::VoiceAssistantEvent >

(

enums::VoiceAssistantEvent

value

)

Definition at line 522 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::VoiceAssistantRequestFlag >()

template<>

const char * esphome::api::proto_enum_to_string< enums::VoiceAssistantRequestFlag >

(

enums::VoiceAssistantRequestFlag

value

)

Definition at line 509 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::VoiceAssistantSubscribeFlag >()

template<>

const char * esphome::api::proto_enum_to_string< enums::VoiceAssistantSubscribeFlag >

(

enums::VoiceAssistantSubscribeFlag

value

)

Definition at line 499 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::VoiceAssistantTimerEvent >()

template<>

const char * esphome::api::proto_enum_to_string< enums::VoiceAssistantTimerEvent >

(

enums::VoiceAssistantTimerEvent

value

)

Definition at line 560 of file api_pb2_dump.cpp.

proto_enum_to_string< enums::ZWaveProxyRequestType >()

template<>

const char * esphome::api::proto_enum_to_string< enums::ZWaveProxyRequestType >

(

enums::ZWaveProxyRequestType

value

)

Definition at line 665 of file api_pb2_dump.cpp.

to_service_arg_type()

template<typename T >

enums::ServiceArgType esphome::api::to_service_arg_type

(

)

to_service_arg_type< bool >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< bool >

(

)

Definition at line 60 of file user_services.cpp.

to_service_arg_type< const FixedVector< bool > & >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< const FixedVector< bool > & >

(

)

Definition at line 78 of file user_services.cpp.

to_service_arg_type< const FixedVector< float > & >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< const FixedVector< float > & >

(

)

Definition at line 84 of file user_services.cpp.

to_service_arg_type< const FixedVector< int32_t > & >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< const FixedVector< int32_t > & >

(

)

Definition at line 81 of file user_services.cpp.

to_service_arg_type< const FixedVector< std::string > & >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< const FixedVector< std::string > & >

(

)

Definition at line 87 of file user_services.cpp.

to_service_arg_type< float >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< float >

(

)

Definition at line 62 of file user_services.cpp.

to_service_arg_type< int32_t >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< int32_t >

(

)

Definition at line 61 of file user_services.cpp.

to_service_arg_type< std::string >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< std::string >

(

)

Definition at line 63 of file user_services.cpp.

to_service_arg_type< std::vector< bool > >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< std::vector< bool > >

(

)

Definition at line 66 of file user_services.cpp.

to_service_arg_type< std::vector< float > >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< std::vector< float > >

(

)

Definition at line 70 of file user_services.cpp.

to_service_arg_type< std::vector< int32_t > >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< std::vector< int32_t > >

(

)

Definition at line 67 of file user_services.cpp.

to_service_arg_type< std::vector< std::string > >()

template<>

enums::ServiceArgType esphome::api::to_service_arg_type< std::vector< std::string > >

(

)

Definition at line 73 of file user_services.cpp.

Variable Documentation

global_api_server

APIServer * esphome::api::global_api_server = nullptr

Definition at line 29 of file api_server.cpp.

PACKED

struct esphome::api::SavedNoisePsk esphome::api::PACKED

WIRE_TYPE_FIXED32

uint8_t esphome::api::WIRE_TYPE_FIXED32 = 5

constexpr

Definition at line 22 of file proto.h.

WIRE_TYPE_LENGTH_DELIMITED

uint8_t esphome::api::WIRE_TYPE_LENGTH_DELIMITED = 2

constexpr

Definition at line 21 of file proto.h.

WIRE_TYPE_MASK

uint8_t esphome::api::WIRE_TYPE_MASK = 0b111

constexpr

Definition at line 23 of file proto.h.

WIRE_TYPE_VARINT

uint8_t esphome::api::WIRE_TYPE_VARINT = 0

constexpr

Definition at line 20 of file proto.h.