ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::api::UpdateStateResponse Class Referencefinal

#include <api_pb2.h>

Inheritance diagram for esphome::api::UpdateStateResponse:
esphome::api::StateResponseProtoMessage esphome::api::ProtoMessage

Public Member Functions

const LogString * message_name () const override
 
uint8_t * encode (ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const
 
uint32_t calculate_size () const
 
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
 

Static Public Member Functions

static uint8_t * encode_msg (const void *self, uint8_t *pos PROTO_ENCODE_DEBUG_PARAM)
 
static uint32_t calc_size_msg (const void *self)
 
- 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)
 

Data Fields

bool missing_state {false}
 
bool in_progress {false}
 
bool has_progress {false}
 
float progress {0.0f}
 
StringRef current_version {nullptr, 0}
 
StringRef latest_version {nullptr, 0}
 
StringRef title {nullptr, 0}
 
StringRef release_summary {nullptr, 0}
 
StringRef release_url {nullptr, 0}
 
- Data Fields inherited from esphome::api::StateResponseProtoMessage
uint32_t key {0}
 
uint32_t device_id {0}
 

Static Public Attributes

static constexpr uint16_t MESSAGE_TYPE = 117
 
static constexpr uint8_t ESTIMATED_SIZE = 65
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::api::StateResponseProtoMessage
 ~StateResponseProtoMessage ()=default
 
- Protected Member Functions inherited from esphome::api::ProtoMessage
 ~ProtoMessage ()=default
 

Detailed Description

Definition at line 3661 of file api_pb2.h.

Member Function Documentation

◆ calc_size_msg()

uint32_t esphome::api::UpdateStateResponse::calc_size_msg ( const void * self)
static

Definition at line 3896 of file api_pb2.cpp.

◆ calculate_size()

uint32_t esphome::api::UpdateStateResponse::calculate_size ( ) const
inline

Definition at line 3682 of file api_pb2.h.

◆ dump_to()

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

Implements esphome::api::ProtoMessage.

Definition at line 2784 of file api_pb2_dump.cpp.

◆ encode()

uint8_t * esphome::api::UpdateStateResponse::encode ( ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const
inline

Definition at line 3678 of file api_pb2.h.

◆ encode_msg()

uint8_t * esphome::api::UpdateStateResponse::encode_msg ( const void * self,
uint8_t *pos PROTO_ENCODE_DEBUG_PARAM )
static

Definition at line 3877 of file api_pb2.cpp.

◆ message_name()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 3666 of file api_pb2.h.

Field Documentation

◆ current_version

StringRef esphome::api::UpdateStateResponse::current_version {nullptr, 0}

Definition at line 3672 of file api_pb2.h.

◆ ESTIMATED_SIZE

uint8_t esphome::api::UpdateStateResponse::ESTIMATED_SIZE = 65
staticconstexpr

Definition at line 3664 of file api_pb2.h.

◆ has_progress

bool esphome::api::UpdateStateResponse::has_progress {false}

Definition at line 3670 of file api_pb2.h.

◆ in_progress

bool esphome::api::UpdateStateResponse::in_progress {false}

Definition at line 3669 of file api_pb2.h.

◆ latest_version

StringRef esphome::api::UpdateStateResponse::latest_version {nullptr, 0}

Definition at line 3673 of file api_pb2.h.

◆ MESSAGE_TYPE

uint16_t esphome::api::UpdateStateResponse::MESSAGE_TYPE = 117
staticconstexpr

Definition at line 3663 of file api_pb2.h.

◆ missing_state

bool esphome::api::UpdateStateResponse::missing_state {false}

Definition at line 3668 of file api_pb2.h.

◆ progress

float esphome::api::UpdateStateResponse::progress {0.0f}

Definition at line 3671 of file api_pb2.h.

◆ release_summary

StringRef esphome::api::UpdateStateResponse::release_summary {nullptr, 0}

Definition at line 3675 of file api_pb2.h.

◆ release_url

StringRef esphome::api::UpdateStateResponse::release_url {nullptr, 0}

Definition at line 3676 of file api_pb2.h.

◆ title

StringRef esphome::api::UpdateStateResponse::title {nullptr, 0}

Definition at line 3674 of file api_pb2.h.


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