ESPHome 2025.6.0
Loading...
Searching...
No Matches
esphome::api::FanCommandRequest Class Reference

#include <api_pb2.h>

Inheritance diagram for esphome::api::FanCommandRequest:
esphome::api::ProtoMessage

Public Member Functions

void encode (ProtoWriteBuffer buffer) const override
 
void calculate_size (uint32_t &total_size) const override
 
void dump_to (std::string &out) const override
 
- Public Member Functions inherited from esphome::api::ProtoMessage
virtual ~ProtoMessage ()=default
 
void decode (const uint8_t *buffer, size_t length)
 
std::string dump () const
 

Static Public Member Functions

static constexpr const char * message_name ()
 

Data Fields

uint32_t key {0}
 
bool has_state {false}
 
bool state {false}
 
bool has_speed {false}
 
enums::FanSpeed speed {}
 
bool has_oscillating {false}
 
bool oscillating {false}
 
bool has_direction {false}
 
enums::FanDirection direction {}
 
bool has_speed_level {false}
 
int32_t speed_level {0}
 
bool has_preset_mode {false}
 
std::string preset_mode {}
 

Static Public Attributes

static constexpr uint16_t MESSAGE_TYPE = 31
 
static constexpr uint16_t ESTIMATED_SIZE = 38
 

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::ProtoMessage
virtual bool decode_64bit (uint32_t field_id, Proto64Bit value)
 

Detailed Description

Definition at line 664 of file api_pb2.h.

Member Function Documentation

◆ calculate_size()

void esphome::api::FanCommandRequest::calculate_size ( uint32_t & total_size) const
overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 1901 of file api_pb2.cpp.

◆ decode_32bit()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 1876 of file api_pb2.cpp.

◆ decode_length()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 1866 of file api_pb2.cpp.

◆ decode_varint()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 1816 of file api_pb2.cpp.

◆ dump_to()

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

Implements esphome::api::ProtoMessage.

Definition at line 1917 of file api_pb2.cpp.

◆ encode()

void esphome::api::FanCommandRequest::encode ( ProtoWriteBuffer buffer) const
overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 1886 of file api_pb2.cpp.

◆ message_name()

static constexpr const char * esphome::api::FanCommandRequest::message_name ( )
inlinestaticconstexpr

Definition at line 669 of file api_pb2.h.

Field Documentation

◆ direction

enums::FanDirection esphome::api::FanCommandRequest::direction {}

Definition at line 679 of file api_pb2.h.

◆ ESTIMATED_SIZE

uint16_t esphome::api::FanCommandRequest::ESTIMATED_SIZE = 38
staticconstexpr

Definition at line 667 of file api_pb2.h.

◆ has_direction

bool esphome::api::FanCommandRequest::has_direction {false}

Definition at line 678 of file api_pb2.h.

◆ has_oscillating

bool esphome::api::FanCommandRequest::has_oscillating {false}

Definition at line 676 of file api_pb2.h.

◆ has_preset_mode

bool esphome::api::FanCommandRequest::has_preset_mode {false}

Definition at line 682 of file api_pb2.h.

◆ has_speed

bool esphome::api::FanCommandRequest::has_speed {false}

Definition at line 674 of file api_pb2.h.

◆ has_speed_level

bool esphome::api::FanCommandRequest::has_speed_level {false}

Definition at line 680 of file api_pb2.h.

◆ has_state

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

Definition at line 672 of file api_pb2.h.

◆ key

uint32_t esphome::api::FanCommandRequest::key {0}

Definition at line 671 of file api_pb2.h.

◆ MESSAGE_TYPE

uint16_t esphome::api::FanCommandRequest::MESSAGE_TYPE = 31
staticconstexpr

Definition at line 666 of file api_pb2.h.

◆ oscillating

bool esphome::api::FanCommandRequest::oscillating {false}

Definition at line 677 of file api_pb2.h.

◆ preset_mode

std::string esphome::api::FanCommandRequest::preset_mode {}

Definition at line 683 of file api_pb2.h.

◆ speed

enums::FanSpeed esphome::api::FanCommandRequest::speed {}

Definition at line 675 of file api_pb2.h.

◆ speed_level

int32_t esphome::api::FanCommandRequest::speed_level {0}

Definition at line 681 of file api_pb2.h.

◆ state

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

Definition at line 673 of file api_pb2.h.


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