esphome::api::SirenCommandRequest Class Reference

#include <api_pb2.h>

Inheritance diagram for esphome::api::SirenCommandRequest:

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

Data Fields
bool	has_state {false}
bool	state {false}
bool	has_tone {false}
StringRef	tone {}
bool	has_duration {false}
uint32_t	duration {0}
bool	has_volume {false}
float	volume {0.0f}
Data Fields inherited from esphome::api::CommandProtoMessage
uint32_t	key {0}
uint32_t	device_id {0}

Static Public Attributes
static constexpr uint8_t	MESSAGE_TYPE = 57
static constexpr uint8_t	ESTIMATED_SIZE = 37

Protected Member Functions
bool	decode_32bit (uint32_t field_id, Proto32Bit value) override
bool	decode_length (uint32_t field_id, ProtoLengthDelimited value) override
bool	decode_varint (uint32_t field_id, proto_varint_value_t value) override
Protected Member Functions inherited from esphome::api::CommandProtoMessage
	~CommandProtoMessage ()=default
Protected Member Functions inherited from esphome::api::ProtoDecodableMessage
	~ProtoDecodableMessage ()=default
Protected Member Functions inherited from esphome::api::ProtoMessage
	~ProtoMessage ()=default

Additional Inherited Members
Static Public Member Functions inherited from esphome::api::ProtoDecodableMessage
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.

Detailed Description

Definition at line 1677 of file api_pb2.h.

Member Function Documentation

decode_32bit()

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

overrideprotectedvirtual

Reimplemented from esphome::api::ProtoDecodableMessage.

Definition at line 1947 of file api_pb2.cpp.

decode_length()

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

overrideprotectedvirtual

Reimplemented from esphome::api::ProtoDecodableMessage.

Definition at line 1936 of file api_pb2.cpp.

decode_varint()

bool esphome::api::SirenCommandRequest::decode_varint ( uint32_t field_id, proto_varint_value_t value )

overrideprotectedvirtual

Reimplemented from esphome::api::ProtoDecodableMessage.

Definition at line 1906 of file api_pb2.cpp.

dump_to()

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

overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 1732 of file api_pb2_dump.cpp.

message_name()

const char * esphome::api::SirenCommandRequest::message_name ( ) const

inlineoverridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 1682 of file api_pb2.h.

Field Documentation

duration

uint32_t esphome::api::SirenCommandRequest::duration {0}

Definition at line 1689 of file api_pb2.h.

ESTIMATED_SIZE

uint8_t esphome::api::SirenCommandRequest::ESTIMATED_SIZE = 37

staticconstexpr

Definition at line 1680 of file api_pb2.h.

has_duration

bool esphome::api::SirenCommandRequest::has_duration {false}

Definition at line 1688 of file api_pb2.h.

has_state

bool esphome::api::SirenCommandRequest::has_state {false}

Definition at line 1684 of file api_pb2.h.

has_tone

bool esphome::api::SirenCommandRequest::has_tone {false}

Definition at line 1686 of file api_pb2.h.

has_volume

bool esphome::api::SirenCommandRequest::has_volume {false}

Definition at line 1690 of file api_pb2.h.

MESSAGE_TYPE

uint8_t esphome::api::SirenCommandRequest::MESSAGE_TYPE = 57

staticconstexpr

Definition at line 1679 of file api_pb2.h.

state

bool esphome::api::SirenCommandRequest::state {false}

Definition at line 1685 of file api_pb2.h.

tone

StringRef esphome::api::SirenCommandRequest::tone {}

Definition at line 1687 of file api_pb2.h.

volume

float esphome::api::SirenCommandRequest::volume {0.0f}

Definition at line 1691 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