Time module definition. More...
Go to the source code of this file.
Data Structures | |
| struct | artik_time |
| Time storage type. More... | |
| struct | artik_time_module |
| Time module operations. More... | |
Macros | |
| #define | ARTIK_TIME_DFORMAT "%I:%M:%S-%w-%d/%m/%Y" |
| Default format for Time module. More... | |
Typedefs | |
| typedef void * | artik_alarm_handle |
| Alarm handle type. More... | |
| typedef char | artik_time_gmt |
| Time gmt type. More... | |
| typedef unsigned int long | artik_msecond |
| Time millisecond type. More... | |
| typedef void(* | alarm_callback) (void *user_data) |
| This callback function gets triggered after timeout. More... | |
Enumerations | |
| enum | artik_time_zone { ARTIK_TIME_UTC = 0, ARTIK_TIME_GMT1, ARTIK_TIME_GMT2, ARTIK_TIME_GMT3, ARTIK_TIME_GMT4, ARTIK_TIME_GMT5, ARTIK_TIME_GMT6, ARTIK_TIME_GMT7, ARTIK_TIME_GMT8, ARTIK_TIME_GMT9, ARTIK_TIME_GMT10, ARTIK_TIME_GMT11, ARTIK_TIME_GMT12 } |
| Time zone type. More... | |
Variables | |
| artik_time_module | time_module |
Detailed Description
Definitions and functions for accessing the Time module and performing operations.
Definition in file artik_time.h.
Macro Definition Documentation
| #define ARTIK_TIME_DFORMAT "%I:%M:%S-%w-%d/%m/%Y" |
Base representation of time into a string with the Time module. Each character has a specification : 'I' = 'hours' for 12h format or 'H' = 'hours' for 24h format 'M' = 'minutes' 'S' = 'seconds' 'w' = 'day of week' 'd' = 'day of month' 'm' = 'month' 'Y' = 'year'
- Examples:
- time_test/artik_time_test.c.
Definition at line 55 of file artik_time.h.
Typedef Documentation
| typedef void(* alarm_callback) (void *user_data) |
- Parameters
-
[in] user_data The user data passed from the register callback function
Definition at line 147 of file artik_time.h.
| typedef void* artik_alarm_handle |
Handle type used to carry instance specific alarm information for the Time API.
Definition at line 63 of file artik_time.h.
| typedef unsigned int long artik_msecond |
Define the time cooldown in milliseconds.
Definition at line 119 of file artik_time.h.
| typedef char artik_time_gmt |
GMT used to define the jetlag of a Time object.
Definition at line 112 of file artik_time.h.
Enumeration Type Documentation
| enum artik_time_zone |
Define the different time-zone.
Definition at line 126 of file artik_time.h.