esphome::api::UserServiceStatic Class Reference

#include <user_services.h>

Inheritance diagram for esphome::api::UserServiceStatic:

Public Member Functions
	UserServiceStatic (const char *const *strings, uint32_t key, enums::SupportsResponseType supports_response=enums::SUPPORTS_RESPONSE_NONE)
Public Member Functions inherited from esphome::api::UserServiceDescriptor
virtual ListEntitiesServicesResponse	encode_list_service_response (std::span< char > scratch)=0
	Build the list-entities message.
virtual bool	execute_service (const ExecuteServiceRequest &req)=0
virtual bool	execute_service (const ExecuteServiceRequest &req, uint32_t action_call_id)=0
bool	is_internal ()

Protected Member Functions
ListEntitiesServicesResponse	encode_list_service_response_ (std::span< const enums::ServiceArgType > arg_types, std::span< char > scratch) const
StringRef	str_ (size_t idx, std::span< char > &scratch) const
	Reference table entry idx; nullptr gives an empty StringRef.

Protected Attributes
const char *const *	strings_
uint32_t	key_
enums::SupportsResponseType	supports_response_

Detailed Description

Definition at line 59 of file user_services.h.

Constructor & Destructor Documentation

UserServiceStatic()

esphome::api::UserServiceStatic::UserServiceStatic ( const char *const * strings, uint32_t key, enums::SupportsResponseType supports_response = enums::SUPPORTS_RESPONSE_NONE )

inline

Definition at line 61 of file user_services.h.

Member Function Documentation

encode_list_service_response_()

ListEntitiesServicesResponse esphome::api::UserServiceStatic::encode_list_service_response_ ( std::span< const enums::ServiceArgType > arg_types, std::span< char > scratch ) const

protected

Definition at line 27 of file user_services.cpp.

str_()

StringRef esphome::api::UserServiceStatic::str_ ( size_t idx, std::span< char > & scratch ) const

protected

Reference table entry idx; nullptr gives an empty StringRef.

On ESP8266 the bytes are copied out of PROGMEM into scratch with a terminator, and the span is advanced past the copy.

Definition at line 8 of file user_services.cpp.

Field Documentation

key_

uint32_t esphome::api::UserServiceStatic::key_

protected

Definition at line 74 of file user_services.h.

strings_

const char* const* esphome::api::UserServiceStatic::strings_

protected

Definition at line 73 of file user_services.h.

supports_response_

enums::SupportsResponseType esphome::api::UserServiceStatic::supports_response_

protected

Definition at line 75 of file user_services.h.

---

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

• esphome/components/api/user_services.h
• esphome/components/api/user_services.cpp