sl_si91x_calendar_build_datetime_struct(sl_calendar_datetime_config_t *date, uint8_t Century, uint8_t Year, sl_calendar_month_t Month, sl_calendar_days_of_week_t DayOfWeek, uint8_t Day, uint8_t Hour, uint8_t Minute, uint8_t Second, uint16_t Milliseconds)

Build the structure for date-time configuration.

sl_status_t

sl_si91x_calendar_convert_unix_time_to_ntp_time(uint32_t time, uint32_t *ntp_time)

Convert Unix timestamp to NTP timestamp.

sl_status_t

sl_si91x_calendar_convert_ntp_time_to_unix_time(uint32_t ntp_time, uint32_t *time)

Convert NTP timestamp to Unix timestamp.

boolean_t

sl_si91x_calendar_is_msec_trigger_enabled(void)

Return the state of msec trigger of RTC (enabled or disabled).

boolean_t

sl_si91x_calendar_is_sec_trigger_enabled(void)

Return the state of sec trigger of RTC (enabled or disabled).

boolean_t

sl_si91x_calendar_is_alarm_trigger_enabled(void)

Return the state of alarm trigger of RTC (enabled or disabled).

__STATIC_INLINE void

sl_si91x_calendar_rtc_start(void)

Start the Calendar RTC.

__STATIC_INLINE void

sl_si91x_calendar_rtc_stop(void)

Stop the Calendar RTC.

__STATIC_INLINE void

sl_si91x_calendar_calibration_init(void)

Initialize the calibration for Calendar clocks.

__STATIC_INLINE void

sl_si91x_calendar_clear_msec_trigger(void)

Clear the msec trigger.

__STATIC_INLINE void

sl_si91x_calendar_clear_sec_trigger(void)

Clear the sec trigger.

__STATIC_INLINE void

sl_si91x_calendar_clear_alarm_trigger(void)

Clear the alarm trigger.

__STATIC_INLINE void

sl_si91x_calendar_init(void)

De-initialize calendar operation.

__STATIC_INLINE void

sl_si91x_calendar_deinit(void)

De-initialize calendar operation.

sl_calendar_version_t

sl_si91x_calendar_get_version(void)

Get the calendar version.

Macros#

#define

SLI_ALARM_IRQHandler IRQ028_Handler

Alarm IRQ Handler.

#define

SLI_MSEC_SEC_IRQHandler IRQ029_Handler

RTC IRQ Handler.

#define

SLI_NVIC_ALARM MCU_CAL_ALARM_IRQn

Alarm NVIQ enable.

#define

SLI_NVIC_MSEC_SEC MCU_CAL_RTC_IRQn

RTC NVIQ enable.

#define

TIME_CONVERSION_ENUM (name)

Time Conversion format enum declaration.

#define

RC_CLOCK_CALIBRATION_ENUM (name)

Time Conversion format enum declaration.

#define

RO_CLOCK_CALIBRATION_ENUM (name)

Time Conversion format enum declaration.

Typedef Documentation#

sl_calendar_clock_t#

typedef AON_CLK_T sl_calendar_clock_t

Renaming clock type enum.

sl_calendar_datetime_config_t#

typedef RTC_TIME_CONFIG_T sl_calendar_datetime_config_t

Renaming datetime structure.

sl_calendar_month_t#

typedef RTC_MONTH_T sl_calendar_month_t

Renaming month structure.

sl_calendar_days_of_week_t#

typedef RTC_DAY_OF_WEEK_T sl_calendar_days_of_week_t

Renaming days of week structure.

calendar_callback_t#

typedef void(* calendar_callback_t) (void) )(void)

Typedef for the function pointer of the callback function.

Function Documentation#

TIME_CONVERSION_ENUM#

TIME_CONVERSION_ENUM (time_conversion_enum )

Enumeration to represent time conversion format.

Parameters

Type	Direction	Argument Name	Description
time_conversion_enum	N/A

RC_CLOCK_CALIBRATION_ENUM#

RC_CLOCK_CALIBRATION_ENUM (rc_clock_calibration_enum )

Enumeration to represent different rc clock calibration configurations.

Parameters

Type	Direction	Argument Name	Description
rc_clock_calibration_enum	N/A

RO_CLOCK_CALIBRATION_ENUM#

RO_CLOCK_CALIBRATION_ENUM (ro_clock_calibration_enum )

Enumeration to represent different ro clock calibration configurations.

Parameters

Type	Direction	Argument Name	Description
ro_clock_calibration_enum	N/A

sl_si91x_calendar_set_configuration#

sl_status_t sl_si91x_calendar_set_configuration (sl_calendar_clock_t clock_type)

Configuration and initialization of Calendar i.e., RTC clock.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_clock_t	[in]	clock_type	(sl_calendar_clock_t) Enum for RTC Clock Type (RO, RC or XTAL)

Returns

status 0 if successful, else errorcode. SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success SL_STATUS_FAIL (0x0001) - The function is failed

sl_si91x_calendar_set_date_time#

sl_status_t sl_si91x_calendar_set_date_time (sl_calendar_datetime_config_t * config)

Set the date and time of the Calendar RTC.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_datetime_config_t *	[in]	config	(sl_calendar_datetime_config_t) Pointer to the Date Configuration Structure

sl_si91x_calendar_set_configuration sl_si91x_calendar_init

Returns

status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_get_date_time#

sl_status_t sl_si91x_calendar_get_date_time (sl_calendar_datetime_config_t * config)

Get the date and time of an existing Calendar RTC.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_datetime_config_t *	[in]	config	(sl_calendar_datetime_config_t) Pointer to the Date Configuration Structure

sl_si91x_calendar_set_configuration sl_si91x_calendar_init sl_si91x_calendar_set_date_time

Returns

status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_rcclk_calibration#

sl_status_t sl_si91x_calendar_rcclk_calibration (clock_calibration_config_t * clock_calibration_config)

Calibrate the RC Clock.

Parameters

Type	Direction	Argument Name	Description
clock_calibration_config_t *	[in]	clock_calibration_config	(clock_calibration_config_t) pointer to the clock calibration structure

sl_si91x_calendar_calibration_init

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_roclk_calibration#

sl_status_t sl_si91x_calendar_roclk_calibration (clock_calibration_config_t * clock_calibration_config)

Calibrate the RO Clock.

Parameters

Type	Direction	Argument Name	Description
clock_calibration_config_t *	[in]	clock_calibration_config	(clock_calibration_config_t) pointer to the clock calibration structure

sl_si91x_calendar_calibration_init

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_register_msec_trigger_callback#

sl_status_t sl_si91x_calendar_register_msec_trigger_callback (calendar_callback_t callback)

Parameters

Type	Direction	Argument Name	Description
calendar_callback_t	[in]	callback	(function pointer) Callback function pointer to be called when msec interrupt is triggered

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_OK (0x0000) - Success SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister previous callback before registering new one

sl_si91x_calendar_register_sec_trigger_callback#

sl_status_t sl_si91x_calendar_register_sec_trigger_callback (calendar_callback_t callback)

Parameters

Type	Direction	Argument Name	Description
calendar_callback_t	[in]	callback	(function pointer) Callback function pointer to be called when sec interrupt is triggered

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_OK (0x0000) - Success SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister previous callback before registering new one

sl_si91x_calendar_register_alarm_trigger_callback#

sl_status_t sl_si91x_calendar_register_alarm_trigger_callback (calendar_callback_t callback)

Parameters

Type	Direction	Argument Name	Description
calendar_callback_t	[in]	callback	(function pointer) Callback function pointer to be called when alarm interrupt is triggered

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_OK (0x0000) - Success SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister previous callback before registering new one

sl_si91x_calendar_unregister_msec_trigger_callback#

sl_status_t sl_si91x_calendar_unregister_msec_trigger_callback (void )

Unregister the callback of the msec trigger and disable it.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_msec_trigger_callback

Returns

status 0 if successful, else error code SL_STATUS_OK (0x0000) - Success SL_STATUS_FAIL (0x0001) - The function is failed

sl_si91x_calendar_unregister_sec_trigger_callback#

sl_status_t sl_si91x_calendar_unregister_sec_trigger_callback (void )

Unregister the callback of the sec trigger and disable it.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_sec_trigger_callback

Returns

status 0 if successful, else error code SL_STATUS_OK (0x0000) - Success SL_STATUS_FAIL (0x0001) - The function is failed

sl_si91x_calendar_unregister_alarm_trigger_callback#

sl_status_t sl_si91x_calendar_unregister_alarm_trigger_callback (void )

Unregister the callback of the alarm trigger and disable it.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_alarm_trigger_callback

Returns

status 0 if successful, else error code SL_STATUS_OK (0x0000) - Success SL_STATUS_FAIL (0x0001) - The function is failed

sl_si91x_calendar_set_alarm#

sl_status_t sl_si91x_calendar_set_alarm (sl_calendar_datetime_config_t * alarm)

Set the date and time of new alarm in RTC.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_datetime_config_t *	[in]	alarm	Pointer to the Date Configuration Structure

sl_si91x_calendar_set_configuration sl_si91x_calendar_init

Returns

status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_get_alarm#

sl_status_t sl_si91x_calendar_get_alarm (sl_calendar_datetime_config_t * alarm)

Get the date and time of an existing alarm in RTC.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_datetime_config_t *	[in]	alarm	Pointer to the Date Configuration Structure

sl_si91x_calendar_set_configuration sl_si91x_calendar_init sl_si91x_calendar_set_alarm

Returns

status 0 if successful, else error code SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_build_datetime_struct#

sl_status_t sl_si91x_calendar_build_datetime_struct (sl_calendar_datetime_config_t * date, uint8_t Century, uint8_t Year, sl_calendar_month_t Month, sl_calendar_days_of_week_t DayOfWeek, uint8_t Day, uint8_t Hour, uint8_t Minute, uint8_t Second, uint16_t Milliseconds)

Build the structure for date-time configuration.

Parameters

Type	Direction	Argument Name	Description
sl_calendar_datetime_config_t *	[in]	date	Pointer to the Date Configuration Structure
uint8_t	[in]	Century	(uint8_t) Century (0-4)
uint8_t	[in]	Year	(uint8_t) Year (1-99) + (Century * 1000)
sl_calendar_month_t	[in]	Month	(enum) Month from the RTC_MONTH_T enum
sl_calendar_days_of_week_t	[in]	DayOfWeek	(enum) Day of Week from the RTC_DAY_OF_WEEK_T enum
uint8_t	[in]	Day	Day (uint8_t) (1-31)
uint8_t	[in]	Hour	Hour (uint8_t) (0-23)
uint8_t	[in]	Minute	Minutes (uint8_t) (0-59)
uint8_t	[in]	Second	Seconds (uint8_t) (0-59)
uint16_t	[in]	Milliseconds	Milliseconds (uint16_t) (0-999)

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_convert_unix_time_to_ntp_time#

sl_status_t sl_si91x_calendar_convert_unix_time_to_ntp_time (uint32_t time, uint32_t * ntp_time)

Convert Unix timestamp to NTP timestamp.

Parameters

Type	Direction	Argument Name	Description
uint32_t	[in]	time	(uint32_t) Unix timestamp
uint32_t *	[in]	ntp_time	(uint32_t) variable to store NTP timestamp

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_convert_ntp_time_to_unix_time#

sl_status_t sl_si91x_calendar_convert_ntp_time_to_unix_time (uint32_t ntp_time, uint32_t * time)

Convert NTP timestamp to Unix timestamp.

Parameters

Type	Direction	Argument Name	Description
uint32_t	[in]	ntp_time	(uint32_t) NTP timestamp
uint32_t *	[in]	time	(uint32_t) variable to store Unix timestamp

Returns

status 0 if successful, else error code SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_INVALID_PARAMETER (0x0021) - Parameters are invalid SL_STATUS_OK (0x0000) - Success

sl_si91x_calendar_is_msec_trigger_enabled#

boolean_t sl_si91x_calendar_is_msec_trigger_enabled (void )

Return the state of msec trigger of RTC (enabled or disabled).

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_msec_trigger_callback

Returns

(boolean)true if trigger is enabled, false otherwise

sl_si91x_calendar_is_sec_trigger_enabled#

boolean_t sl_si91x_calendar_is_sec_trigger_enabled (void )

Return the state of sec trigger of RTC (enabled or disabled).

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_sec_trigger_callback

Returns

(boolean)true if trigger is enabled, false otherwise

sl_si91x_calendar_is_alarm_trigger_enabled#

boolean_t sl_si91x_calendar_is_alarm_trigger_enabled (void )

Return the state of alarm trigger of RTC (enabled or disabled).

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_register_alarm_trigger_callback

Returns

(boolean)true if trigger is enabled, false otherwise

sl_si91x_calendar_rtc_start#

__STATIC_INLINE void sl_si91x_calendar_rtc_start (void )

Start the Calendar RTC.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_set_configuration sl_si91x_calendar_init

Returns

none

sl_si91x_calendar_rtc_stop#

__STATIC_INLINE void sl_si91x_calendar_rtc_stop (void )

Stop the Calendar RTC.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_set_configuration sl_si91x_calendar_init sl_si91x_calendar_rtc_start

Returns

none

sl_si91x_calendar_calibration_init#

__STATIC_INLINE void sl_si91x_calendar_calibration_init (void )

Initialize the calibration for Calendar clocks.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

none

sl_si91x_calendar_clear_msec_trigger#

__STATIC_INLINE void sl_si91x_calendar_clear_msec_trigger (void )

Clear the msec trigger.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

none

sl_si91x_calendar_clear_sec_trigger#

__STATIC_INLINE void sl_si91x_calendar_clear_sec_trigger (void )

Clear the sec trigger.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

none

sl_si91x_calendar_clear_alarm_trigger#

__STATIC_INLINE void sl_si91x_calendar_clear_alarm_trigger (void )

Clear the alarm trigger.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

none

sl_si91x_calendar_init#

__STATIC_INLINE void sl_si91x_calendar_init (void )

De-initialize calendar operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_set_configuration

Returns

none

sl_si91x_calendar_deinit#

__STATIC_INLINE void sl_si91x_calendar_deinit (void )

De-initialize calendar operation.

Parameters

Type	Direction	Argument Name	Description
void	N/A

sl_si91x_calendar_init

Returns

none

sl_si91x_calendar_get_version#

sl_calendar_version_t sl_si91x_calendar_get_version (void )

Get the calendar version.

Parameters

Type	Direction	Argument Name	Description
void	[in]

This function is used to know the calendar version.

Returns

sl_calendar_version_t type version