esphome::api::SensorEntity Class Reference

Handle to a Sensor entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::SensorEntity:

Collaboration diagram for esphome::api::SensorEntity:

Public Member Functions
std::optional< SensorInfo >	info () const
std::optional< SensorState >	state () const
std::string	unit_of_measurement () const
std::int32_t	accuracy_decimals () const
bool	force_update () const
std::string	device_class () const
SensorStateClass	state_class () const
bool	missing_state () const
float	value () const
	Latest numeric value (0 if unknown).
bool	has_value () const
Public Member Functions inherited from esphome::api::TypedEntity< SensorEntity >
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 Sensor entity.

Member Function Documentation

accuracy_decimals()

std::int32_t esphome::api::SensorEntity::accuracy_decimals ( ) const

inline

device_class()

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

inline

force_update()

bool esphome::api::SensorEntity::force_update ( ) const

inline

has_value()

bool esphome::api::SensorEntity::has_value ( ) const

inline

info()

std::optional< SensorInfo > esphome::api::SensorEntity::info ( ) const

inline

missing_state()

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

inline

state()

std::optional< SensorState > esphome::api::SensorEntity::state ( ) const

inline

state_class()

SensorStateClass esphome::api::SensorEntity::state_class ( ) const

inline

type()

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

inlinestaticconstexpr

unit_of_measurement()

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

inline

value()

float esphome::api::SensorEntity::value ( ) const

inline

Latest numeric value (0 if unknown).

---

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

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