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	set_current_version (const StringRef &ref)
void	set_latest_version (const StringRef &ref)
void	set_title (const StringRef &ref)
void	set_release_summary (const StringRef &ref)
void	set_release_url (const StringRef &ref)
void	encode (ProtoWriteBuffer buffer) const override
void	calculate_size (ProtoSize &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
std::string	dump () const

Data Fields
bool	missing_state {false}
bool	in_progress {false}
bool	has_progress {false}
float	progress {0.0f}
StringRef	current_version_ref_ {}
StringRef	latest_version_ref_ {}
StringRef	title_ref_ {}
StringRef	release_summary_ref_ {}
StringRef	release_url_ref_ {}
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 2867 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 2963 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 2075 of file api_pb2_dump.cpp.

encode()

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

overridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 2948 of file api_pb2.cpp.

message_name()

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

inlineoverridevirtual

Reimplemented from esphome::api::ProtoMessage.

Definition at line 2872 of file api_pb2.h.

set_current_version()

void esphome::api::UpdateStateResponse::set_current_version ( const StringRef & ref )

inline

Definition at line 2879 of file api_pb2.h.

set_latest_version()

void esphome::api::UpdateStateResponse::set_latest_version ( const StringRef & ref )

inline

Definition at line 2881 of file api_pb2.h.

set_release_summary()

void esphome::api::UpdateStateResponse::set_release_summary ( const StringRef & ref )

inline

Definition at line 2885 of file api_pb2.h.

set_release_url()

void esphome::api::UpdateStateResponse::set_release_url ( const StringRef & ref )

inline

Definition at line 2887 of file api_pb2.h.

set_title()

void esphome::api::UpdateStateResponse::set_title ( const StringRef & ref )

inline

Definition at line 2883 of file api_pb2.h.

Field Documentation

current_version_ref_

StringRef esphome::api::UpdateStateResponse::current_version_ref_ {}

Definition at line 2878 of file api_pb2.h.

ESTIMATED_SIZE

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

staticconstexpr

Definition at line 2870 of file api_pb2.h.

has_progress

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

Definition at line 2876 of file api_pb2.h.

in_progress

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

Definition at line 2875 of file api_pb2.h.

latest_version_ref_

StringRef esphome::api::UpdateStateResponse::latest_version_ref_ {}

Definition at line 2880 of file api_pb2.h.

MESSAGE_TYPE

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

staticconstexpr

Definition at line 2869 of file api_pb2.h.

missing_state

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

Definition at line 2874 of file api_pb2.h.

progress

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

Definition at line 2877 of file api_pb2.h.

release_summary_ref_

StringRef esphome::api::UpdateStateResponse::release_summary_ref_ {}

Definition at line 2884 of file api_pb2.h.

release_url_ref_

StringRef esphome::api::UpdateStateResponse::release_url_ref_ {}

Definition at line 2886 of file api_pb2.h.

title_ref_

StringRef esphome::api::UpdateStateResponse::title_ref_ {}

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