Z-Wave System Startup API

Collaboration diagram for Z-Wave System Startup API:

Functions
bool	IsWakeupCausedByRtccTimeout (void)
uint32_t	GetCompletedSleepDurationMs (void)
uint32_t	GetDeepSleepWakeupTick (void)
uint32_t	GetLastTickBeforeDeepSleep (void)
zpal_reset_reason_t	GetResetReason (void)
bool	ZW_ApplicationRegisterTask (void(*appTaskFunc)(SApplicationHandles *), uint8_t iZwRxQueueTaskNotificationBitNumber, uint8_t iZwCommandStatusQueueTaskNotificationBitNumber, const SProtocolConfig_t *pProtocolConfig)
SApplicationHandles *	ZW_system_startup_getAppHandles (void)
void	ZW_system_startup_SetEventNotificationBitNumbers (uint8_t iZwRxQueueTaskNotificationBitNumber, uint8_t iZwCommandStatusQueueTaskNotificationBitNumber, const SProtocolConfig_t *pProtocolConfig)
void	ZW_system_startup_SetMainApplicationTaskHandle (TaskHandle_t xHandle)
void	ZW_system_startup_SetCCSet (SCommandClassSet_t *CCSet)
SCommandClassSet_t *	ZW_system_startup_GetCCSet (void)
	Gets the Command Class Set.
bool	ZW_system_startup_IsSchedulerStarted (void)
const SAppNodeInfo_t *	ZW_system_startup_getAppNodeInfo (void)

Detailed Description

Function Documentation

GetCompletedSleepDurationMs()

uint32_t GetCompletedSleepDurationMs

(

void

)

Get number of milliseconds the device has spent sleeping in deep sleep before it was woken up.

This function can safely be called from multiple threads.

Returns

Number of milliseconds.

GetDeepSleepWakeupTick()

uint32_t GetDeepSleepWakeupTick

(

void

)

Get the sleeptimer tick value of the device when it woke up from deep sleep

This function can safely be called from multiple threads.

Returns

RTCC ticks.

GetLastTickBeforeDeepSleep()

uint32_t GetLastTickBeforeDeepSleep

(

void

)

Get the sleeptimer tick value of the device when it last went to Deep Sleep. (It is stored in retention RAM)

This function can safely be called from multiple threads.

Returns

RTCC ticks.

GetResetReason()

zpal_reset_reason_t GetResetReason

(

void

)

Get the reset reason of the device when it was last reset or woke up from EM4 sleep.

This function can safely be called from multiple threads.

Returns

reset reason.

IsWakeupCausedByRtccTimeout()

bool IsWakeupCausedByRtccTimeout

(

void

)

Was the device woken up by an RTCC timer interrupt?

This function can safely be called from multiple threads.

Returns

true if woken up by RTCC timeout, false otherwise.

ZW_ApplicationRegisterTask()

bool ZW_ApplicationRegisterTask	(	void(*)(SApplicationHandles *)	appTaskFunc,
		uint8_t	iZwRxQueueTaskNotificationBitNumber,
		uint8_t	iZwCommandStatusQueueTaskNotificationBitNumber,
		const SProtocolConfig_t *	pProtocolConfig )

Please

See also

ZW_UserTask_ApplicationRegisterTask() in ZW_UserTask.h for more info.

ZW_system_startup_getAppHandles()

SApplicationHandles * ZW_system_startup_getAppHandles

(

void

)

Used to get the pointer to the application handles structure! Needed to insert task related data when creating user task.

ZW_system_startup_getAppNodeInfo()

const SAppNodeInfo_t * ZW_system_startup_getAppNodeInfo

(

void

)

Used to get a pointer to The Application node information SAppNodeInfo_t structure.

Returns

const SAppNodeInfo_t*

ZW_system_startup_GetCCSet()

SCommandClassSet_t * ZW_system_startup_GetCCSet

(

void

)

Gets the Command Class Set.

Returns

SCommandClassSet_t* A pointer to the Command Class Set

ZW_system_startup_IsSchedulerStarted()

bool ZW_system_startup_IsSchedulerStarted

(

void

)

INCLUDE_xTaskGetSchedulerState did not include xTaskGetSchedulerState in the build. This is a workaround!

This function indicated whether the Scheduler has ever been started. This will not indicate the current state, e.g. whether the scheduler is in suspended state or running!

ZW_system_startup_SetCCSet()

void ZW_system_startup_SetCCSet

(

SCommandClassSet_t *

CCSet

)

Passed the Command Class set from the Application to the Protocol using a shared variable

Parameters

[in]

CCSet

Command Class Set

ZW_system_startup_SetEventNotificationBitNumbers()

void ZW_system_startup_SetEventNotificationBitNumbers	(	uint8_t	iZwRxQueueTaskNotificationBitNumber,
		uint8_t	iZwCommandStatusQueueTaskNotificationBitNumber,
		const SProtocolConfig_t *	pProtocolConfig )

Used by ZW_UserTask_ApplicationRegisterTask() in ZW_UserTask.h to set the Event Notification Bit Numbers in the Application Interface structure!

ZW_system_startup_SetMainApplicationTaskHandle()

void ZW_system_startup_SetMainApplicationTaskHandle

(

TaskHandle_t

xHandle

)

Used by ZW_UserTask_ApplicationRegisterTask() in ZW_UserTask.h to set the Main Application Task Handle in the Application Interface structure, after ZW_UserTask_ApplicationRegisterTask() has created the task!