ESPHome 2026.1.4
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 char * message_name () const override
 
void encode (ProtoWriteBuffer buffer) const override
 
void calculate_size (ProtoSize &size) const override
 
const char * dump_to (DumpBuffer &out) const override
 
- Public Member Functions inherited from esphome::api::StateResponseProtoMessage
 ~StateResponseProtoMessage () override=default
 
- Public Member Functions inherited from esphome::api::ProtoMessage
virtual ~ProtoMessage ()=default
 

Data Fields

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

Static Public Attributes

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

Detailed Description

Definition at line 2971 of file api_pb2.h.

Member Function Documentation

◆ calculate_size()

void esphome::api::UpdateStateResponse::calculate_size ( ProtoSize & size) const
overridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 3263 of file api_pb2.cpp.

◆ dump_to()

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

Implements esphome::api::ProtoMessage.

Definition at line 2424 of file api_pb2_dump.cpp.

◆ encode()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 3248 of file api_pb2.cpp.

◆ message_name()

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

Reimplemented from esphome::api::ProtoMessage.

Definition at line 2976 of file api_pb2.h.

Field Documentation

◆ current_version

StringRef esphome::api::UpdateStateResponse::current_version {}

Definition at line 2982 of file api_pb2.h.

◆ ESTIMATED_SIZE

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

Definition at line 2974 of file api_pb2.h.

◆ has_progress

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

Definition at line 2980 of file api_pb2.h.

◆ in_progress

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

Definition at line 2979 of file api_pb2.h.

◆ latest_version

StringRef esphome::api::UpdateStateResponse::latest_version {}

Definition at line 2983 of file api_pb2.h.

◆ MESSAGE_TYPE

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

Definition at line 2973 of file api_pb2.h.

◆ missing_state

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

Definition at line 2978 of file api_pb2.h.

◆ progress

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

Definition at line 2981 of file api_pb2.h.

◆ release_summary

StringRef esphome::api::UpdateStateResponse::release_summary {}

Definition at line 2985 of file api_pb2.h.

◆ release_url

StringRef esphome::api::UpdateStateResponse::release_url {}

Definition at line 2986 of file api_pb2.h.

◆ title

StringRef esphome::api::UpdateStateResponse::title {}

Definition at line 2984 of file api_pb2.h.


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