Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Clk_DateTimeToTS_NTP()

Convert a date/time structure to NTP timestamp.

Files

clk.h/clk.c

Prototype

Arguments

p_ts_ntp_sec Pointer to variable that will receive the NTP timestamp:

In seconds UTC+00, if no errors;
CLK_TS_SEC_NONE, otherwise.

p_date_time Date/time structure to convert.

Returned Values

DEF_OK, if date/time structure successfully converted.

DEF_FAIL, otherwise.

Required Configuration

Available only if CLK_CFG_NTP_EN is DEF_ENABLED in clk_cfg.h (see section 3-1-1).

Notes / Warnings

Date/time structure (p_date_time) must be representable in NTP timestamp. Thus date to convert must be greater than or equal to CLK_NTP_EPOCH_YR_START and less than CLK_NTP_EPOCH_YR_END. Date/time should be set to local time with correct time zone offset (p_date_time->TZ_sec). Clk_DateTimeToTS_NTP() removes the time zone offset from the date/time to calculate and return an NTP timestamp at UTC+00.

Example Usage

  • No labels