ESPHome  2024.11.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::datetime::TimeCall Class Reference

#include <time_entity.h>

Public Member Functions

 TimeCall (TimeEntity *parent)
 
void perform ()
 
TimeCallset_time (uint8_t hour, uint8_t minute, uint8_t second)
 
TimeCallset_time (ESPTime time)
 
TimeCallset_time (const std::string &time)
 
TimeCallset_hour (uint8_t hour)
 
TimeCallset_minute (uint8_t minute)
 
TimeCallset_second (uint8_t second)
 
optional< uint8_t > get_hour () const
 
optional< uint8_t > get_minute () const
 
optional< uint8_t > get_second () const
 

Protected Member Functions

void validate_ ()
 

Protected Attributes

TimeEntityparent_
 
optional< uint8_t > hour_
 
optional< uint8_t > minute_
 
optional< uint8_t > second_
 

Detailed Description

Definition at line 67 of file time_entity.h.

Constructor & Destructor Documentation

◆ TimeCall()

esphome::datetime::TimeCall::TimeCall ( TimeEntity parent)
inlineexplicit

Definition at line 69 of file time_entity.h.

Member Function Documentation

◆ get_hour()

optional<uint8_t> esphome::datetime::TimeCall::get_hour ( ) const
inline

Definition at line 88 of file time_entity.h.

◆ get_minute()

optional<uint8_t> esphome::datetime::TimeCall::get_minute ( ) const
inline

Definition at line 89 of file time_entity.h.

◆ get_second()

optional<uint8_t> esphome::datetime::TimeCall::get_second ( ) const
inline

Definition at line 90 of file time_entity.h.

◆ perform()

void esphome::datetime::TimeCall::perform ( )

Definition at line 51 of file time_entity.cpp.

◆ set_hour()

TimeCall& esphome::datetime::TimeCall::set_hour ( uint8_t  hour)
inline

Definition at line 75 of file time_entity.h.

◆ set_minute()

TimeCall& esphome::datetime::TimeCall::set_minute ( uint8_t  minute)
inline

Definition at line 79 of file time_entity.h.

◆ set_second()

TimeCall& esphome::datetime::TimeCall::set_second ( uint8_t  second)
inline

Definition at line 83 of file time_entity.h.

◆ set_time() [1/3]

TimeCall & esphome::datetime::TimeCall::set_time ( uint8_t  hour,
uint8_t  minute,
uint8_t  second 
)

Definition at line 66 of file time_entity.cpp.

◆ set_time() [2/3]

TimeCall & esphome::datetime::TimeCall::set_time ( ESPTime  time)

Definition at line 73 of file time_entity.cpp.

◆ set_time() [3/3]

TimeCall & esphome::datetime::TimeCall::set_time ( const std::string &  time)

Definition at line 75 of file time_entity.cpp.

◆ validate_()

void esphome::datetime::TimeCall::validate_ ( )
protected

Definition at line 36 of file time_entity.cpp.

Field Documentation

◆ hour_

optional<uint8_t> esphome::datetime::TimeCall::hour_
protected

Definition at line 97 of file time_entity.h.

◆ minute_

optional<uint8_t> esphome::datetime::TimeCall::minute_
protected

Definition at line 98 of file time_entity.h.

◆ parent_

TimeEntity* esphome::datetime::TimeCall::parent_
protected

Definition at line 95 of file time_entity.h.

◆ second_

optional<uint8_t> esphome::datetime::TimeCall::second_
protected

Definition at line 99 of file time_entity.h.


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