esphome::api::SirenCommandRequest Class Reference

#include <api_pb2.h>

Inheritance diagram for esphome::api::SirenCommandRequest:

Public Member Functions
const char *	message_name () const override
void	dump_to (std::string &out) const override
Public Member Functions inherited from esphome::api::CommandProtoMessage
	~CommandProtoMessage () override=default
Public Member Functions inherited from esphome::api::ProtoDecodableMessage
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

Data Fields
bool	has_state {false}
bool	state {false}
bool	has_tone {false}
std::string	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, ProtoVarInt value) override
Protected Member Functions inherited from esphome::api::ProtoDecodableMessage

Detailed Description

Definition at line 1563 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 1547 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 1537 of file api_pb2.cpp.

decode_varint()

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

overrideprotectedvirtual

Reimplemented from esphome::api::ProtoDecodableMessage.

Definition at line 1507 of file api_pb2.cpp.

dump_to()

void esphome::api::SirenCommandRequest::dump_to ( std::string & out ) const

overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 1387 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 1568 of file api_pb2.h.

Field Documentation

duration

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

Definition at line 1575 of file api_pb2.h.

ESTIMATED_SIZE

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

staticconstexpr

Definition at line 1566 of file api_pb2.h.

has_duration

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

Definition at line 1574 of file api_pb2.h.

has_state

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

Definition at line 1570 of file api_pb2.h.

has_tone

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

Definition at line 1572 of file api_pb2.h.

has_volume

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

Definition at line 1576 of file api_pb2.h.

MESSAGE_TYPE

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

staticconstexpr

Definition at line 1565 of file api_pb2.h.

state

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

Definition at line 1571 of file api_pb2.h.

tone

std::string esphome::api::SirenCommandRequest::tone {}

Definition at line 1573 of file api_pb2.h.

volume

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

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