esphome::api::UpdateStateResponse Class Reference

#include <api_pb2.h>

Inheritance diagram for esphome::api::UpdateStateResponse:

Public Member Functions
const char *	message_name () const override
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::StateResponseProtoMessage
	~StateResponseProtoMessage () override=default
Public Member Functions inherited from esphome::api::ProtoMessage
virtual	~ProtoMessage ()=default
void	decode (const uint8_t *buffer, size_t length)
std::string	dump () const

Data Fields
bool	missing_state {false}
bool	in_progress {false}
bool	has_progress {false}
float	progress {0.0f}
std::string	current_version {}
std::string	latest_version {}
std::string	title {}
std::string	release_summary {}
std::string	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

Additional Inherited Members
Protected Member Functions inherited from esphome::api::ProtoMessage
virtual bool	decode_varint (uint32_t field_id, ProtoVarInt value)
virtual bool	decode_length (uint32_t field_id, ProtoLengthDelimited value)
virtual bool	decode_32bit (uint32_t field_id, Proto32Bit value)
virtual bool	decode_64bit (uint32_t field_id, Proto64Bit value)

Detailed Description

Definition at line 2827 of file api_pb2.h.

Member Function Documentation

calculate_size()

void esphome::api::UpdateStateResponse::calculate_size ( uint32_t & total_size ) const

overridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 3172 of file api_pb2.cpp.

dump_to()

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

overridevirtual

Implements esphome::api::ProtoMessage.

Definition at line 4358 of file api_pb2_dump.cpp.

encode()

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

overridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 3159 of file api_pb2.cpp.

message_name()

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

inlineoverridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 2832 of file api_pb2.h.

Field Documentation

current_version

std::string esphome::api::UpdateStateResponse::current_version {}

Definition at line 2838 of file api_pb2.h.

ESTIMATED_SIZE

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

staticconstexpr

Definition at line 2830 of file api_pb2.h.

has_progress

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

Definition at line 2836 of file api_pb2.h.

in_progress

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

Definition at line 2835 of file api_pb2.h.

latest_version

std::string esphome::api::UpdateStateResponse::latest_version {}

Definition at line 2839 of file api_pb2.h.

MESSAGE_TYPE

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

staticconstexpr

Definition at line 2829 of file api_pb2.h.

missing_state

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

Definition at line 2834 of file api_pb2.h.

progress

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

Definition at line 2837 of file api_pb2.h.

release_summary

std::string esphome::api::UpdateStateResponse::release_summary {}

Definition at line 2841 of file api_pb2.h.

release_url

std::string esphome::api::UpdateStateResponse::release_url {}

Definition at line 2842 of file api_pb2.h.

title

std::string esphome::api::UpdateStateResponse::title {}

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