esphome::api::TimeEntity Class Reference

Handle to a Time entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::TimeEntity:

Collaboration diagram for esphome::api::TimeEntity:

Public Member Functions
std::optional< TimeInfo >	info () const
std::optional< TimeState >	state () const
bool	missing_state () const
std::uint32_t	hour () const
std::uint32_t	minute () const
std::uint32_t	second () const
void	command (TimeCommand c) const
	Send a fully-specified command (its key is set automatically).
void	set (const std::uint32_t hour, const std::uint32_t minute, const std::uint32_t second) const
Public Member Functions inherited from esphome::api::TypedEntity< TimeEntity >
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 Time entity.

Member Function Documentation

command()

void esphome::api::TimeEntity::command ( TimeCommand  c ) const

inline

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

hour()

std::uint32_t esphome::api::TimeEntity::hour ( ) const

inline

info()

std::optional< TimeInfo > esphome::api::TimeEntity::info ( ) const

inline

minute()

std::uint32_t esphome::api::TimeEntity::minute ( ) const

inline

missing_state()

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

inline

second()

std::uint32_t esphome::api::TimeEntity::second ( ) const

inline

set()

void esphome::api::TimeEntity::set ( const std::uint32_t  hour, const std::uint32_t  minute, const std::uint32_t  second  ) const

inline

state()

std::optional< TimeState > esphome::api::TimeEntity::state ( ) const

inline

type()

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

inlinestaticconstexpr

---

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

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