Public Functions

Public functions. More...

Functions
ketCube_cfg_DrvError_t	ketCube_RTC_Init (void)
	Initializes the RTC timer. More...
void	ketCube_RTC_StopAlarm ()
	Stop the Alarm. More...
uint32_t	ketCube_RTC_GetMinimumTimeout ()
	returns the wake up time in ticks More...
void	ketCube_RTC_SetAlarm (uint32_t timeout)
	Set the alarm. More...
uint32_t	ketCube_RTC_GetTimerElapsedTime (void)
	Get the RTC timer elapsed time since the last Alarm was set. More...
uint32_t	ketCube_RTC_GetTimerValue (void)
	Get the RTC timer value. More...
uint32_t	ketCube_RTC_SetTimerContext (void)
	set Time Reference set also the RTC_DateStruct and RTC_TimeStruct More...
uint32_t	ketCube_RTC_GetTimerContext (void)
	Get the RTC timer Reference. More...
void	ketCube_RTC_DelayMs (uint32_t delay)
	a delay of delay ms by polling RTC More...
void	ketCube_RTC_setMcuWakeUpTime ()
	calculates the wake up time between wake up and mcu start More...
int16_t	ketCube_RTC_getMcuWakeUpTime (void)
uint32_t	ketCube_RTC_ms2Tick (TimerTime_t timeMicroSec)
	converts time in ms to time in ticks More...
TimerTime_t	ketCube_RTC_Tick2ms (uint32_t tick)
	converts time in ticks to time in ms More...
uint32_t	ketCube_RTC_GetCalendarTime (uint16_t *subSeconds)
	Get system time. More...
uint32_t	ketCube_RTC_GetSysTime (void)
	Get system time. More...
void	ketCube_RTC_BKUPWrite (uint32_t Data0, uint32_t Data1)
void	ketCube_RTC_BKUPRead (uint32_t *Data0, uint32_t *Data1)
uint32_t	HAL_GetTick (void)
	HAL_GetTick RTC-based replacement. More...
void	ketCube_RTC_IrqHandler (void)
	RTC IRQ Handler on the RTC Alarm. More...
void	ketCube_RTC_AlarmAEventExec (void)
	Alarm A callback. More...

Detailed Description

Public functions.

Function Documentation

HAL_GetTick()

uint32_t HAL_GetTick

(

void

)

HAL_GetTick RTC-based replacement.

Return values

current

ms

ketCube_RTC_AlarmAEventExec()

void ketCube_RTC_AlarmAEventExec

(

void

)

Alarm A callback.

Parameters

hrtc	RTC handle

Return values

None

ketCube_RTC_BKUPRead()

void ketCube_RTC_BKUPRead	(	uint32_t *	Data0,
		uint32_t *	Data1
	)

ketCube_RTC_BKUPWrite()

void ketCube_RTC_BKUPWrite	(	uint32_t	Data0,
		uint32_t	Data1
	)

ketCube_RTC_DelayMs()

void ketCube_RTC_DelayMs

(

uint32_t

delay

)

a delay of delay ms by polling RTC

Parameters

delay

in ms

Return values

none

ketCube_RTC_GetCalendarTime()

uint32_t ketCube_RTC_GetCalendarTime

(

uint16_t *

mSeconds

)

Get system time.

Parameters

[IN]	pointer to ms

Returns

uint32_t seconds

ketCube_RTC_getMcuWakeUpTime()

int16_t ketCube_RTC_getMcuWakeUpTime

(

void

)

ketCube_RTC_GetMinimumTimeout()

uint32_t ketCube_RTC_GetMinimumTimeout

(

void

)

returns the wake up time in ticks

Parameters

none

Return values

wake	up time in ticks

ketCube_RTC_GetSysTime()

uint32_t ketCube_RTC_GetSysTime

(

void

)

Get system time.

Returns

uint32_t seconds

ketCube_RTC_GetTimerContext()

uint32_t ketCube_RTC_GetTimerContext

(

void

)

Get the RTC timer Reference.

Parameters

none

Return values

Timer

Value in Ticks

ketCube_RTC_GetTimerElapsedTime()

uint32_t ketCube_RTC_GetTimerElapsedTime

(

void

)

Get the RTC timer elapsed time since the last Alarm was set.

Parameters

none

Return values

RTC	Elapsed time in ticks

ketCube_RTC_GetTimerValue()

uint32_t ketCube_RTC_GetTimerValue

(

void

)

Get the RTC timer value.

Parameters

none

Return values

RTC	Timer value in ticks

ketCube_RTC_Init()

ketCube_cfg_DrvError_t ketCube_RTC_Init

(

void

)

Initializes the RTC timer.

Note

The timer is based on the RTC

Parameters

none

Return values

none

ketCube_RTC_IrqHandler()

void ketCube_RTC_IrqHandler

(

void

)

RTC IRQ Handler on the RTC Alarm.

Parameters

none

Return values

none

ketCube_RTC_ms2Tick()

uint32_t ketCube_RTC_ms2Tick

(

TimerTime_t

timeMicroSec

)

converts time in ms to time in ticks

Parameters

[IN]	time in milliseconds

Return values

returns

time in timer ticks

ketCube_RTC_SetAlarm()

void ketCube_RTC_SetAlarm

(

uint32_t

timeout

)

Set the alarm.

Note

The alarm is set at now (read in this funtion) + timeout

Parameters

timeout

Duration of the Timer ticks

ketCube_RTC_setMcuWakeUpTime()

void ketCube_RTC_setMcuWakeUpTime

(

void

)

calculates the wake up time between wake up and mcu start

Note

resulotion in RTC_ALARM_TIME_BASE in timer ticks

Parameters

none

Return values

none

ketCube_RTC_SetTimerContext()

uint32_t ketCube_RTC_SetTimerContext

(

void

)

set Time Reference set also the RTC_DateStruct and RTC_TimeStruct

Parameters

none

Return values

Timer

Value

ketCube_RTC_StopAlarm()

void ketCube_RTC_StopAlarm

(

void

)

Stop the Alarm.

Parameters

none

Return values

none

ketCube_RTC_Tick2ms()

TimerTime_t ketCube_RTC_Tick2ms

(

uint32_t

tick

)

converts time in ticks to time in ms

Parameters

[IN]	time in timer ticks

Return values

returns

time in milliseconds