ESPHome  2021.10.2
Public Member Functions | Static Public Member Functions | Data Fields
esphome::time::ESPTime Struct Reference

A more user-friendly version of struct tm from time.h. More...

#include <real_time_clock.h>

Public Member Functions

size_t strftime (char *buffer, size_t buffer_len, const char *format)
 Convert this ESPTime struct to a null-terminated c string buffer as specified by the format argument. More...
 
std::string strftime (const std::string &format)
 Convert this ESPTime struct to a string as specified by the format argument. More...
 
bool is_valid () const
 Check if this ESPTime is valid (all fields in range and year is greater than 2018) More...
 
bool fields_in_range () const
 Check if all time fields of this ESPTime are in range. More...
 
void recalc_timestamp_utc (bool use_day_of_year=true)
 Recalculate the timestamp field from the other fields of this ESPTime instance (must be UTC). More...
 
struct tm to_c_tm ()
 Convert this ESPTime instance back to a tm struct. More...
 
void increment_second ()
 Increment this clock instance by one second. More...
 
bool operator< (ESPTime other)
 
bool operator<= (ESPTime other)
 
bool operator== (ESPTime other)
 
bool operator>= (ESPTime other)
 
bool operator> (ESPTime other)
 

Static Public Member Functions

static ESPTime from_c_tm (struct tm *c_tm, time_t c_time)
 Convert a C tm struct instance with a C unix epoch timestamp to an ESPTime instance. More...
 
static ESPTime from_epoch_local (time_t epoch)
 Convert an UTC epoch timestamp to a local time ESPTime instance. More...
 
static ESPTime from_epoch_utc (time_t epoch)
 Convert an UTC epoch timestamp to a UTC time ESPTime instance. More...
 

Data Fields

uint8_t second
 seconds after the minute [0-60] More...
 
uint8_t minute
 minutes after the hour [0-59] More...
 
uint8_t hour
 hours since midnight [0-23] More...
 
uint8_t day_of_week
 day of the week; sunday=1 [1-7] More...
 
uint8_t day_of_month
 day of the month [1-31] More...
 
uint16_t day_of_year
 day of the year [1-366] More...
 
uint8_t month
 month; january=1 [1-12] More...
 
uint16_t year
 year More...
 
bool is_dst
 daylight saving time flag More...
 
time_t timestamp
 unix epoch time (seconds since UTC Midnight January 1, 1970) More...
 

Detailed Description

A more user-friendly version of struct tm from time.h.

Definition at line 14 of file real_time_clock.h.

Member Function Documentation

◆ fields_in_range()

bool esphome::time::ESPTime::fields_in_range ( ) const
inline

Check if all time fields of this ESPTime are in range.

Definition at line 57 of file real_time_clock.h.

◆ from_c_tm()

ESPTime esphome::time::ESPTime::from_c_tm ( struct tm *  c_tm,
time_t  c_time 
)
static

Convert a C tm struct instance with a C unix epoch timestamp to an ESPTime instance.

Definition at line 48 of file real_time_clock.cpp.

◆ from_epoch_local()

static ESPTime esphome::time::ESPTime::from_epoch_local ( time_t  epoch)
inlinestatic

Convert an UTC epoch timestamp to a local time ESPTime instance.

Parameters
epochSeconds since 1st January 1970. In UTC.
Returns
The generated ESPTime

Definition at line 71 of file real_time_clock.h.

◆ from_epoch_utc()

static ESPTime esphome::time::ESPTime::from_epoch_utc ( time_t  epoch)
inlinestatic

Convert an UTC epoch timestamp to a UTC time ESPTime instance.

Parameters
epochSeconds since 1st January 1970. In UTC.
Returns
The generated ESPTime

Definition at line 80 of file real_time_clock.h.

◆ increment_second()

void esphome::time::ESPTime::increment_second ( )

Increment this clock instance by one second.

Definition at line 107 of file real_time_clock.cpp.

◆ is_valid()

bool esphome::time::ESPTime::is_valid ( ) const
inline

Check if this ESPTime is valid (all fields in range and year is greater than 2018)

Definition at line 54 of file real_time_clock.h.

◆ operator<()

bool esphome::time::ESPTime::operator< ( ESPTime  other)

Definition at line 162 of file real_time_clock.cpp.

◆ operator<=()

bool esphome::time::ESPTime::operator<= ( ESPTime  other)

Definition at line 163 of file real_time_clock.cpp.

◆ operator==()

bool esphome::time::ESPTime::operator== ( ESPTime  other)

Definition at line 164 of file real_time_clock.cpp.

◆ operator>()

bool esphome::time::ESPTime::operator> ( ESPTime  other)

Definition at line 166 of file real_time_clock.cpp.

◆ operator>=()

bool esphome::time::ESPTime::operator>= ( ESPTime  other)

Definition at line 165 of file real_time_clock.cpp.

◆ recalc_timestamp_utc()

void esphome::time::ESPTime::recalc_timestamp_utc ( bool  use_day_of_year = true)

Recalculate the timestamp field from the other fields of this ESPTime instance (must be UTC).

Definition at line 134 of file real_time_clock.cpp.

◆ strftime() [1/2]

size_t esphome::time::ESPTime::strftime ( char *  buffer,
size_t  buffer_len,
const char *  format 
)

Convert this ESPTime struct to a null-terminated c string buffer as specified by the format argument.

Up to buffer_len bytes are written.

See also
https://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#index-strftime

Definition at line 44 of file real_time_clock.cpp.

◆ strftime() [2/2]

std::string esphome::time::ESPTime::strftime ( const std::string &  format)

Convert this ESPTime struct to a string as specified by the format argument.

See also
https://www.gnu.org/software/libc/manual/html_node/Formatting-Calendar-Time.html#index-strftime
Warning
This method uses dynamically allocated strings which can cause heap fragmentation with some microcontrollers.

Definition at line 75 of file real_time_clock.cpp.

◆ to_c_tm()

struct tm esphome::time::ESPTime::to_c_tm ( )

Convert this ESPTime instance back to a tm struct.

Definition at line 62 of file real_time_clock.cpp.

Field Documentation

◆ day_of_month

uint8_t esphome::time::ESPTime::day_of_month

day of the month [1-31]

Definition at line 26 of file real_time_clock.h.

◆ day_of_week

uint8_t esphome::time::ESPTime::day_of_week

day of the week; sunday=1 [1-7]

Definition at line 24 of file real_time_clock.h.

◆ day_of_year

uint16_t esphome::time::ESPTime::day_of_year

day of the year [1-366]

Definition at line 28 of file real_time_clock.h.

◆ hour

uint8_t esphome::time::ESPTime::hour

hours since midnight [0-23]

Definition at line 22 of file real_time_clock.h.

◆ is_dst

bool esphome::time::ESPTime::is_dst

daylight saving time flag

Definition at line 34 of file real_time_clock.h.

◆ minute

uint8_t esphome::time::ESPTime::minute

minutes after the hour [0-59]

Definition at line 20 of file real_time_clock.h.

◆ month

uint8_t esphome::time::ESPTime::month

month; january=1 [1-12]

Definition at line 30 of file real_time_clock.h.

◆ second

uint8_t esphome::time::ESPTime::second

seconds after the minute [0-60]

Note
second is generally 0-59; the extra range is to accommodate leap seconds.

Definition at line 18 of file real_time_clock.h.

◆ timestamp

time_t esphome::time::ESPTime::timestamp

unix epoch time (seconds since UTC Midnight January 1, 1970)

Definition at line 36 of file real_time_clock.h.

◆ year

uint16_t esphome::time::ESPTime::year

year

Definition at line 32 of file real_time_clock.h.


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