esphome::api::ProtoDecodableMessage Class Reference

#include <proto.h>

Inheritance diagram for esphome::api::ProtoDecodableMessage:

Public Member Functions
virtual void	decode (const uint8_t *buffer, size_t length)
Public Member Functions inherited from esphome::api::ProtoMessage
virtual	~ProtoMessage ()=default
virtual void	encode (ProtoWriteBuffer buffer) const
virtual void	calculate_size (ProtoSize &size) const
std::string	dump () const
virtual void	dump_to (std::string &out) const =0
virtual const char *	message_name () const

Static Public Member Functions
static uint32_t	count_repeated_field (const uint8_t *buffer, size_t length, uint32_t target_field_id)
	Count occurrences of a repeated field in a protobuf buffer.

Protected Member Functions
virtual bool	decode_varint (uint32_t field_id, ProtoVarInt value)
virtual bool	decode_length (uint32_t field_id, ProtoLengthDelimited value)
virtual bool	decode_32bit (uint32_t field_id, Proto32Bit value)

Detailed Description

Definition at line 362 of file proto.h.

Member Function Documentation

count_repeated_field()

uint32_t esphome::api::ProtoDecodableMessage::count_repeated_field ( const uint8_t * buffer, size_t length, uint32_t target_field_id )

static

Count occurrences of a repeated field in a protobuf buffer.

This is a lightweight scan that only parses tags and skips field data.

Parameters

buffer	Pointer to the protobuf buffer
length	Length of the buffer in bytes
target_field_id	The field ID to count

Returns

Number of times the field appears in the buffer

Definition at line 10 of file proto.cpp.

decode()

void esphome::api::ProtoDecodableMessage::decode ( const uint8_t * buffer, size_t length )

virtual

Reimplemented in esphome::api::ExecuteServiceArgument, and esphome::api::ExecuteServiceRequest.

Definition at line 73 of file proto.cpp.

decode_32bit()

virtual bool esphome::api::ProtoDecodableMessage::decode_32bit ( uint32_t field_id, Proto32Bit value )

inlineprotectedvirtual

Reimplemented in esphome::api::AlarmControlPanelCommandRequest, esphome::api::ButtonCommandRequest, esphome::api::ClimateCommandRequest, esphome::api::CoverCommandRequest, esphome::api::DateCommandRequest, esphome::api::DateTimeCommandRequest, esphome::api::ExecuteServiceArgument, esphome::api::ExecuteServiceRequest, esphome::api::FanCommandRequest, esphome::api::GetTimeResponse, esphome::api::LightCommandRequest, esphome::api::LockCommandRequest, esphome::api::MediaPlayerCommandRequest, esphome::api::NumberCommandRequest, esphome::api::SelectCommandRequest, esphome::api::SirenCommandRequest, esphome::api::SwitchCommandRequest, esphome::api::TextCommandRequest, esphome::api::TimeCommandRequest, esphome::api::UpdateCommandRequest, and esphome::api::ValveCommandRequest.

Definition at line 380 of file proto.h.

decode_length()

virtual bool esphome::api::ProtoDecodableMessage::decode_length ( uint32_t field_id, ProtoLengthDelimited value )

inlineprotectedvirtual

Reimplemented in esphome::api::AlarmControlPanelCommandRequest, esphome::api::AuthenticationRequest, esphome::api::BluetoothGATTWriteDescriptorRequest, esphome::api::BluetoothGATTWriteRequest, esphome::api::ClimateCommandRequest, esphome::api::ExecuteServiceArgument, esphome::api::ExecuteServiceRequest, esphome::api::FanCommandRequest, esphome::api::GetTimeResponse, esphome::api::HelloRequest, esphome::api::HomeassistantActionResponse, esphome::api::HomeAssistantStateResponse, esphome::api::LightCommandRequest, esphome::api::LockCommandRequest, esphome::api::MediaPlayerCommandRequest, esphome::api::NoiseEncryptionSetKeyRequest, esphome::api::SelectCommandRequest, esphome::api::SirenCommandRequest, esphome::api::TextCommandRequest, esphome::api::VoiceAssistantAnnounceRequest, esphome::api::VoiceAssistantAudio, esphome::api::VoiceAssistantConfigurationRequest, esphome::api::VoiceAssistantEventData, esphome::api::VoiceAssistantEventResponse, esphome::api::VoiceAssistantExternalWakeWord, esphome::api::VoiceAssistantSetConfiguration, esphome::api::VoiceAssistantTimerEventResponse, esphome::api::ZWaveProxyFrame, and esphome::api::ZWaveProxyRequest.

Definition at line 379 of file proto.h.

decode_varint()

virtual bool esphome::api::ProtoDecodableMessage::decode_varint ( uint32_t field_id, ProtoVarInt value )

inlineprotectedvirtual

Reimplemented in esphome::api::AlarmControlPanelCommandRequest, esphome::api::BluetoothDeviceRequest, esphome::api::BluetoothGATTGetServicesRequest, esphome::api::BluetoothGATTNotifyRequest, esphome::api::BluetoothGATTReadDescriptorRequest, esphome::api::BluetoothGATTReadRequest, esphome::api::BluetoothGATTWriteDescriptorRequest, esphome::api::BluetoothGATTWriteRequest, esphome::api::BluetoothScannerSetModeRequest, esphome::api::ButtonCommandRequest, esphome::api::CameraImageRequest, esphome::api::ClimateCommandRequest, esphome::api::CoverCommandRequest, esphome::api::DateCommandRequest, esphome::api::DateTimeCommandRequest, esphome::api::ExecuteServiceArgument, esphome::api::FanCommandRequest, esphome::api::HelloRequest, esphome::api::HomeassistantActionResponse, esphome::api::LightCommandRequest, esphome::api::LockCommandRequest, esphome::api::MediaPlayerCommandRequest, esphome::api::NumberCommandRequest, esphome::api::SelectCommandRequest, esphome::api::SirenCommandRequest, esphome::api::SubscribeBluetoothLEAdvertisementsRequest, esphome::api::SubscribeLogsRequest, esphome::api::SubscribeVoiceAssistantRequest, esphome::api::SwitchCommandRequest, esphome::api::TextCommandRequest, esphome::api::TimeCommandRequest, esphome::api::UpdateCommandRequest, esphome::api::ValveCommandRequest, esphome::api::VoiceAssistantAnnounceRequest, esphome::api::VoiceAssistantAudio, esphome::api::VoiceAssistantEventResponse, esphome::api::VoiceAssistantExternalWakeWord, esphome::api::VoiceAssistantResponse, esphome::api::VoiceAssistantTimerEventResponse, and esphome::api::ZWaveProxyRequest.

Definition at line 378 of file proto.h.

---

The documentation for this class was generated from the following files:

• esphome/components/api/proto.h
• esphome/components/api/proto.cpp