5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
Topics | Functions
Time
Operating system

Topics

 Date and Time
 
 Duration
 

Functions

wiced_result_t wiced_time_convert_iso8601_to_utc_ms (wiced_iso8601_time_t *iso8601_time, wiced_utc_time_ms_t *utc_time_ms)
 
wiced_result_t wiced_time_convert_utc_ms_to_iso8601 (wiced_utc_time_ms_t utc_time_ms, wiced_iso8601_time_t *iso8601_time)
 
wiced_result_t wiced_time_get_iso8601_time (wiced_iso8601_time_t *iso8601_time)
 
wiced_result_t wiced_time_get_time (wiced_time_t *time)
 
wiced_result_t wiced_time_get_utc_time (wiced_utc_time_t *utc_time)
 
wiced_result_t wiced_time_get_utc_time_ms (wiced_utc_time_ms_t *utc_time_ms)
 
wiced_result_t wiced_time_set_time (const wiced_time_t *time)
 
wiced_result_t wiced_time_set_utc_time_ms (const wiced_utc_time_ms_t *utc_time_ms)
 

Detailed Description

Functions to get and set the system time. System time is derived from timer ticks implemented by the underlying operating system. 

wiced_time_get_time
wiced_time_set_time
wiced_time_get_utc_time
wiced_time_get_utc_time_ms
wiced_time_set_utc_time_ms
wiced_time_get_iso8601_time
wiced_time_convert_utc_ms_to_iso8601

Nano-Second precision timer related functions 

 wiced_init_nanosecond_clock
 wiced_get_nanosecond_clock_value
 wiced_reset_nanosecond_clock
 wiced_deinit_nanosecond_clock

Function Documentation

◆ wiced_time_convert_iso8601_to_utc_ms()

wiced_result_t wiced_time_convert_iso8601_to_utc_ms ( wiced_iso8601_time_t * iso8601_time,
wiced_utc_time_ms_t * utc_time_ms )

Convert a time from iso 8601 format e.g. "2012-07-02T17:12:34.567890Z" to UTC milliseconds

Parameters
[in]iso8601_time: A pointer to the structure variable that will receive the time value
[out]utc_time_ms: The time value to convert
Returns
wiced_result_t

◆ wiced_time_convert_utc_ms_to_iso8601()

wiced_result_t wiced_time_convert_utc_ms_to_iso8601 ( wiced_utc_time_ms_t utc_time_ms,
wiced_iso8601_time_t * iso8601_time )

Convert a time from UTC milliseconds to iso 8601 format e.g. "2012-07-02T17:12:34.567890Z"

Parameters
[in]utc_time_ms: The time value to convert
[out]iso8601_time: A pointer to the structure variable that will receive the time value
Returns
wiced_result_t

◆ wiced_time_get_iso8601_time()

wiced_result_t wiced_time_get_iso8601_time ( wiced_iso8601_time_t * iso8601_time)

Get the current UTC time in iso 8601 format e.g. "2012-07-02T17:12:34.567890Z"

Note
The time will roll over every 49.7 days
Parameters
[out]iso8601_time: A pointer to the structure variable that will receive the time value
Returns
wiced_result_t

◆ wiced_time_get_time()

wiced_result_t wiced_time_get_time ( wiced_time_t * time)

Get the current system tick time in milliseconds

Note
The time will roll over every 49.7 days
Parameters
[out]time: A pointer to the variable which will receive the time value
Returns
wiced_result_t

◆ wiced_time_get_utc_time()

wiced_result_t wiced_time_get_utc_time ( wiced_utc_time_t * utc_time)

Get the current UTC time in seconds

This will only be accurate if the time has previously been set by using wiced_time_set_utc_time_ms

Parameters
[out]utc_time: A pointer to the variable which will receive the time value
Returns
wiced_result_t

◆ wiced_time_get_utc_time_ms()

wiced_result_t wiced_time_get_utc_time_ms ( wiced_utc_time_ms_t * utc_time_ms)

Get the current UTC time in milliseconds

This will only be accurate if the time has previously been set by using wiced_time_set_utc_time_ms

Parameters
[out]utc_time_ms: A pointer to the variable which will receive the time value
Returns
wiced_result_t

◆ wiced_time_set_time()

wiced_result_t wiced_time_set_time ( const wiced_time_t * time)

Set the current system tick time in milliseconds

Parameters
[in]time: The time value to set
Returns
wiced_result_t

◆ wiced_time_set_utc_time_ms()

wiced_result_t wiced_time_set_utc_time_ms ( const wiced_utc_time_ms_t * utc_time_ms)

Set the current UTC time in milliseconds

Parameters
[in]utc_time_ms: The time value to set
Returns
wiced_result_t