ESPHome  2024.7.1
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::datetime::DateTimeEntity Class Referenceabstract

#include <datetime_entity.h>

Inheritance diagram for esphome::datetime::DateTimeEntity:
esphome::datetime::DateTimeBase esphome::EntityBase esphome::template_::TemplateDateTime

Public Member Functions

void publish_state ()
DateTimeCall make_call ()
ESPTime state_as_esptime () const override
- Public Member Functions inherited from esphome::datetime::DateTimeBase
bool has_state () const
 Return whether this Datetime has gotten a full state yet. More...
void add_on_state_callback (std::function< void()> &&callback)
void set_rtc (time::RealTimeClock *rtc)
time::RealTimeClockget_rtc () const
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
void set_name (const char *name)
bool has_own_name () const
std::string get_object_id () const
void set_object_id (const char *object_id)
uint32_t get_object_id_hash ()
bool is_internal () const
void set_internal (bool internal)
bool is_disabled_by_default () const
void set_disabled_by_default (bool disabled_by_default)
EntityCategory get_entity_category () const
void set_entity_category (EntityCategory entity_category)
std::string get_icon () const
void set_icon (const char *icon)

Data Fields

const uint16_t & year = year_
const uint8_t & month = month_
const uint8_t & day = day_
const uint8_t & hour = hour_
const uint8_t & minute = minute_
const uint8_t & second = second_

Protected Member Functions

virtual void control (const DateTimeCall &call)=0
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()

Protected Attributes

uint16_t year_
uint8_t month_
uint8_t day_
uint8_t hour_
uint8_t minute_
uint8_t second_
- Protected Attributes inherited from esphome::datetime::DateTimeBase
CallbackManager< void()> state_callback_
bool has_state_ {false}
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
const char * object_id_c_str_ {nullptr}
const char * icon_c_str_ {nullptr}
uint32_t object_id_hash_
bool has_own_name_ {false}
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}

Detailed Description

Definition at line 39 of file datetime_entity.h.

Member Function Documentation

◆ control()

virtual void esphome::datetime::DateTimeEntity::control ( const DateTimeCall call)
protectedpure virtual

◆ make_call()

DateTimeCall esphome::datetime::DateTimeEntity::make_call ( )

Definition at line 53 of file datetime_entity.cpp.

◆ publish_state()

void esphome::datetime::DateTimeEntity::publish_state ( )

Definition at line 12 of file datetime_entity.cpp.

◆ state_as_esptime()

ESPTime esphome::datetime::DateTimeEntity::state_as_esptime ( ) const

Implements esphome::datetime::DateTimeBase.

Definition at line 55 of file datetime_entity.cpp.

Field Documentation

◆ day

const uint8_t& esphome::datetime::DateTimeEntity::day = day_

Definition at line 56 of file datetime_entity.h.

◆ day_

uint8_t esphome::datetime::DateTimeEntity::day_

Definition at line 43 of file datetime_entity.h.

◆ hour

const uint8_t& esphome::datetime::DateTimeEntity::hour = hour_

Definition at line 57 of file datetime_entity.h.

◆ hour_

uint8_t esphome::datetime::DateTimeEntity::hour_

Definition at line 44 of file datetime_entity.h.

◆ minute

const uint8_t& esphome::datetime::DateTimeEntity::minute = minute_

Definition at line 58 of file datetime_entity.h.

◆ minute_

uint8_t esphome::datetime::DateTimeEntity::minute_

Definition at line 45 of file datetime_entity.h.

◆ month

const uint8_t& esphome::datetime::DateTimeEntity::month = month_

Definition at line 55 of file datetime_entity.h.

◆ month_

uint8_t esphome::datetime::DateTimeEntity::month_

Definition at line 42 of file datetime_entity.h.

◆ second

const uint8_t& esphome::datetime::DateTimeEntity::second = second_

Definition at line 59 of file datetime_entity.h.

◆ second_

uint8_t esphome::datetime::DateTimeEntity::second_

Definition at line 46 of file datetime_entity.h.

◆ year

const uint16_t& esphome::datetime::DateTimeEntity::year = year_

Definition at line 54 of file datetime_entity.h.

◆ year_

uint16_t esphome::datetime::DateTimeEntity::year_

Definition at line 41 of file datetime_entity.h.

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