esphome::api::NumberEntity Class Reference

Handle to a Number entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::NumberEntity:

Collaboration diagram for esphome::api::NumberEntity:

Public Member Functions
std::optional< NumberInfo >	info () const
std::optional< NumberState >	state () const
float	min_value () const
float	max_value () const
float	step () const
std::string	unit_of_measurement () const
NumberMode	mode () const
std::string	device_class () const
bool	missing_state () const
void	command (NumberCommand c) const
	Send a fully-specified command (its key is set automatically).
void	set (const float v) const
Public Member Functions inherited from esphome::api::TypedEntity< NumberEntity >
std::string	icon () const
bool	disabled_by_default () const
EntityCategory	entity_category () const
std::uint32_t	device_id () const
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
Public Member Functions inherited from esphome::api::Entity
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
std::uint32_t	key () const noexcept
const std::string &	object_id () const noexcept
const std::string &	name () const noexcept

Static Public Member Functions
static constexpr EntityType	type ()

Additional Inherited Members
Protected Attributes inherited from esphome::api::Entity
Client *	client_
std::uint32_t	key_
std::string	object_id_
std::string	name_

Detailed Description

Handle to a Number entity.

Member Function Documentation

command()

void esphome::api::NumberEntity::command ( NumberCommand  c ) const

inline

Send a fully-specified command (its key is set automatically).

device_class()

std::string esphome::api::NumberEntity::device_class ( ) const

inline

info()

std::optional< NumberInfo > esphome::api::NumberEntity::info ( ) const

inline

max_value()

float esphome::api::NumberEntity::max_value ( ) const

inline

min_value()

float esphome::api::NumberEntity::min_value ( ) const

inline

missing_state()

bool esphome::api::NumberEntity::missing_state ( ) const

inline

mode()

NumberMode esphome::api::NumberEntity::mode ( ) const

inline

set()

void esphome::api::NumberEntity::set ( const float  v ) const

inline

state()

std::optional< NumberState > esphome::api::NumberEntity::state ( ) const

inline

step()

float esphome::api::NumberEntity::step ( ) const

inline

type()

static constexpr EntityType esphome::api::NumberEntity::type ( )

inlinestaticconstexpr

unit_of_measurement()

std::string esphome::api::NumberEntity::unit_of_measurement ( ) const

inline

---

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

• include/esphome/api/model/entity_handles.hpp