ESPHome 2026.10.0
Loading...
Searching...
No Matches
esphome::api::LightCommandRequest Class Referencefinal

#include <api_pb2.h>

Inheritance diagram for esphome::api::LightCommandRequest:
esphome::api::CommandProtoMessage esphome::api::ProtoDecodableMessage esphome::api::ProtoMessage

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

bool has_state {false}
 
bool state {false}
 
bool has_brightness {false}
 
float brightness {0.0f}
 
bool has_color_mode {false}
 
enums::ColorMode color_mode {}
 
bool has_color_brightness {false}
 
float color_brightness {0.0f}
 
bool has_rgb {false}
 
float red {0.0f}
 
float green {0.0f}
 
float blue {0.0f}
 
bool has_white {false}
 
float white {0.0f}
 
bool has_color_temperature {false}
 
float color_temperature {0.0f}
 
bool has_cold_white {false}
 
float cold_white {0.0f}
 
bool has_warm_white {false}
 
float warm_white {0.0f}
 
bool has_transition_length {false}
 
uint32_t transition_length {0}
 
bool has_flash_length {false}
 
uint32_t flash_length {0}
 
bool has_effect {false}
 
StringRef effect {}
 
- 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 = 32
 
static constexpr uint8_t ESTIMATED_SIZE = 112
 

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 1107 of file api_pb2.h.

Member Function Documentation

◆ decode()

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

Definition at line 1140 of file api_pb2.h.

◆ decode_field()

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

Definition at line 791 of file api_pb2.cpp.

◆ dump_to()

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

Implements esphome::api::ProtoMessage.

Definition at line 1355 of file api_pb2_dump.cpp.

◆ message_name()

const LogString * esphome::api::LightCommandRequest::message_name ( ) const
inlineoverridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 1112 of file api_pb2.h.

Field Documentation

◆ blue

float esphome::api::LightCommandRequest::blue {0.0f}

Definition at line 1125 of file api_pb2.h.

◆ brightness

float esphome::api::LightCommandRequest::brightness {0.0f}

Definition at line 1117 of file api_pb2.h.

◆ cold_white

float esphome::api::LightCommandRequest::cold_white {0.0f}

Definition at line 1131 of file api_pb2.h.

◆ color_brightness

float esphome::api::LightCommandRequest::color_brightness {0.0f}

Definition at line 1121 of file api_pb2.h.

◆ color_mode

enums::ColorMode esphome::api::LightCommandRequest::color_mode {}

Definition at line 1119 of file api_pb2.h.

◆ color_temperature

float esphome::api::LightCommandRequest::color_temperature {0.0f}

Definition at line 1129 of file api_pb2.h.

◆ effect

StringRef esphome::api::LightCommandRequest::effect {}

Definition at line 1139 of file api_pb2.h.

◆ ESTIMATED_SIZE

uint8_t esphome::api::LightCommandRequest::ESTIMATED_SIZE = 112
staticconstexpr

Definition at line 1110 of file api_pb2.h.

◆ flash_length

uint32_t esphome::api::LightCommandRequest::flash_length {0}

Definition at line 1137 of file api_pb2.h.

◆ green

float esphome::api::LightCommandRequest::green {0.0f}

Definition at line 1124 of file api_pb2.h.

◆ has_brightness

bool esphome::api::LightCommandRequest::has_brightness {false}

Definition at line 1116 of file api_pb2.h.

◆ has_cold_white

bool esphome::api::LightCommandRequest::has_cold_white {false}

Definition at line 1130 of file api_pb2.h.

◆ has_color_brightness

bool esphome::api::LightCommandRequest::has_color_brightness {false}

Definition at line 1120 of file api_pb2.h.

◆ has_color_mode

bool esphome::api::LightCommandRequest::has_color_mode {false}

Definition at line 1118 of file api_pb2.h.

◆ has_color_temperature

bool esphome::api::LightCommandRequest::has_color_temperature {false}

Definition at line 1128 of file api_pb2.h.

◆ has_effect

bool esphome::api::LightCommandRequest::has_effect {false}

Definition at line 1138 of file api_pb2.h.

◆ has_flash_length

bool esphome::api::LightCommandRequest::has_flash_length {false}

Definition at line 1136 of file api_pb2.h.

◆ has_rgb

bool esphome::api::LightCommandRequest::has_rgb {false}

Definition at line 1122 of file api_pb2.h.

◆ has_state

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

Definition at line 1114 of file api_pb2.h.

◆ has_transition_length

bool esphome::api::LightCommandRequest::has_transition_length {false}

Definition at line 1134 of file api_pb2.h.

◆ has_warm_white

bool esphome::api::LightCommandRequest::has_warm_white {false}

Definition at line 1132 of file api_pb2.h.

◆ has_white

bool esphome::api::LightCommandRequest::has_white {false}

Definition at line 1126 of file api_pb2.h.

◆ MESSAGE_TYPE

uint16_t esphome::api::LightCommandRequest::MESSAGE_TYPE = 32
staticconstexpr

Definition at line 1109 of file api_pb2.h.

◆ red

float esphome::api::LightCommandRequest::red {0.0f}

Definition at line 1123 of file api_pb2.h.

◆ state

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

Definition at line 1115 of file api_pb2.h.

◆ transition_length

uint32_t esphome::api::LightCommandRequest::transition_length {0}

Definition at line 1135 of file api_pb2.h.

◆ warm_white

float esphome::api::LightCommandRequest::warm_white {0.0f}

Definition at line 1133 of file api_pb2.h.

◆ white

float esphome::api::LightCommandRequest::white {0.0f}

Definition at line 1127 of file api_pb2.h.


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