esphome::api::LockCommandRequest Class Reference

#include <api_pb2.h>

Inheritance diagram for esphome::api::LockCommandRequest:

Public Member Functions
const LogString *	message_name () const override
void	decode (const uint8_t *buffer, size_t length)
const char *	dump_to (DumpBuffer &out) const override
Public Member Functions inherited from esphome::api::ProtoMessage
uint8_t *	encode (ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const
uint32_t	calculate_size () const

Data Fields
enums::LockCommand	command {}
bool	has_code {false}
StringRef	code {}
Data Fields inherited from esphome::api::CommandProtoMessage
uint32_t	key {0}
uint32_t	device_id {0}

Static Public Attributes
static constexpr uint16_t	MESSAGE_TYPE = 60
static constexpr uint8_t	ESTIMATED_SIZE = 22

Static Protected Member Functions
static void	decode_field (void *self, uint32_t tag, const uint8_t *data, proto_varint_value_t scalar)

Additional Inherited Members
Public Types inherited from esphome::api::ProtoDecodableMessage
using	DecodeFieldFn = void (*)(void *msg, uint32_t tag, const uint8_t *data, proto_varint_value_t scalar)
	Stores one decoded field into msg; generated per message type.
Static Public Member Functions inherited from esphome::api::ProtoDecodableMessage
static void	decode_fields (void *msg, const uint8_t *buffer, size_t length, DecodeFieldFn field)
	Walk buffer and hand every field to field.
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.
Static Public Member Functions inherited from esphome::api::ProtoMessage
static uint8_t *	encode_msg (const void *self, uint8_t *pos PROTO_ENCODE_DEBUG_PARAM)
static uint32_t	calc_size_msg (const void *self)
Protected Member Functions inherited from esphome::api::CommandProtoMessage
	~CommandProtoMessage ()=default
Protected Member Functions inherited from esphome::api::ProtoMessage
	~ProtoMessage ()=default

Detailed Description

Definition at line 2189 of file api_pb2.h.

Member Function Documentation

decode()

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

inline

Definition at line 2199 of file api_pb2.h.

decode_field()

void esphome::api::LockCommandRequest::decode_field ( void * self, uint32_t tag, const uint8_t * data, proto_varint_value_t scalar )

staticprotected

Definition at line 2239 of file api_pb2.cpp.

dump_to()

const char * esphome::api::LockCommandRequest::dump_to ( DumpBuffer & out ) const

overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 2033 of file api_pb2_dump.cpp.

message_name()

const LogString * esphome::api::LockCommandRequest::message_name ( ) const

inlineoverridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 2194 of file api_pb2.h.

Field Documentation

code

StringRef esphome::api::LockCommandRequest::code {}

Definition at line 2198 of file api_pb2.h.

command

enums::LockCommand esphome::api::LockCommandRequest::command {}

Definition at line 2196 of file api_pb2.h.

ESTIMATED_SIZE

uint8_t esphome::api::LockCommandRequest::ESTIMATED_SIZE = 22

staticconstexpr

Definition at line 2192 of file api_pb2.h.

has_code

bool esphome::api::LockCommandRequest::has_code {false}

Definition at line 2197 of file api_pb2.h.

MESSAGE_TYPE

uint16_t esphome::api::LockCommandRequest::MESSAGE_TYPE = 60

staticconstexpr

Definition at line 2191 of file api_pb2.h.

---

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

• esphome/components/api/api_pb2.h
• esphome/components/api/api_pb2.cpp
• esphome/components/api/api_pb2_dump.cpp