All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups
Wall Time

Detailed Description

Functions, data structures and other things related to wall clock time.

This module contains utilities to get the current time and create strings with formatted dates and times.

Function Documentation

void clock_copy_time_string ( char *  buffer,
uint8_t  size 
)

Copies a time string into the buffer, formatted according to the user's time display preferences (such as 12h/24h time). Example results: "7:30" or "15:00".

Note
AM/PM are also outputted with the time if the user's preference is 12h time.
Parameters
[out]bufferA pointer to the buffer to copy the time string into
sizeThe maximum size of buffer
bool clock_is_24h_style ( void  )

Gets the user's 12/24h clock style preference.

Returns
true if the user prefers 24h-style time display or false if the user prefers 12h-style time display.
bool clock_is_timezone_set ( void  )

Checks if timezone is currently set, otherwise gmtime == localtime.

Note
This function was added in preparation of timezone support, currently always returns false
Returns
true if timezone has been set, false otherwise
time_t clock_to_timestamp ( WeekDay  day,
int  hour,
int  minute 
)

Converts a (day, hour, minute) specification to a UTC timestamp occurring in the future Always returns a timestamp for the next occurring instance, example: specifying TODAY@14:30 when it is 14:40 will return a timestamp for 7 days from now at 14:30.

Note
This function does not support Daylight Saving Time (DST) changes, events scheduled during a DST change will be off by an hour.
Parameters
dayWeekDay day of week including support for specifying TODAY
hourhour specified in 24-hour format [0-23]
minuteminute [0-59]

Enumeration Type Documentation

enum WeekDay

Weekday values.

Enumerator
TODAY 

Today.

SUNDAY 

Sunday.

MONDAY 

Monday.

TUESDAY 

Tuesday.

WEDNESDAY 

Wednesday.

THURSDAY 

Thursday.

FRIDAY 

Friday.

SATURDAY 

Saturday.