Clk_TS_NTP_ToTS
Convert NTP timestamp to Clock timestamp.
Files
clk.h/clk.c
Prototype
CPU_BOOLEAN Clk_TS_NTP_ToTS (CLK_TS_SEC *p_ts_sec, CLK_TS_SEC ts_ntp_sec);
Arguments
p_ts_sec
Pointer to variable that will receive the Clock timestamp:
In seconds UTC+00, if no errors;CLK_TS_SEC_NONE
, otherwise.
ts_ntp_sec
NTP timestamp value to convert (in seconds, UTC+00).
Returned Values
DEF_OK
, if timestamp successfully converted.
DEF_FAIL
, otherwise.
Required Configuration
Available only if CLK_CFG_NTP_EN
is DEF_ENABLED
in clk_cfg.h
(see Module Configuration).
Notes / Warnings
Returned timestamp does not include any time zone offset. Thus any local time zone offset should be applied before or after calling Clk_TS_NTP_ToTS()
.
Only years supported by Clock and NTP can be converted, thus the timestamp date must be greater than or equal to CLK_EPOCH_YR_START
and less than CLK_NTP_EPOCH_YR_END
.
Example Usage
Listing - Clk_TS_NTP_ToTS() Example Usage
CLK_TS_SEC ts_sec; CLK_TS_SEC ts_ntp_sec; CPU_BOOLEAN valid; ts_ntp_sec = 1000000; valid = Clk_TS_NTP_ToTS(&ts_sec, ts_ntp_sec); if (valid == DEF_OK) { printf("Timestamp = %u", ts_sec); } else { printf("Convert timestamp error\n\r"); }