Z-Wave System Startup API#

Functions#

bool
IsWakeupCausedByRtccTimeout(void)

Was the device woken up by an RTCC timer interrupt?

uint32_t
GetCompletedSleepDurationMs(void)

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

uint32_t
GetDeepSleepWakeupTick(void)

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

uint32_t
GetLastTickBeforeDeepSleep(void)

Get the sleeptimer tick value of the device when it last went to Deep Sleep.

zpal_reset_reason_t
GetResetReason(void)

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

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

Please.

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.

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!

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!

void
ZW_system_startup_SetCCSet(SCommandClassSet_t *CCSet)

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

SCommandClassSet_t *
ZW_system_startup_GetCCSet(void)

Gets the Command Class Set.

bool
ZW_system_startup_IsSchedulerStarted(void)

INCLUDE_xTaskGetSchedulerState did not include xTaskGetSchedulerState in the build.

const SAppNodeInfo_t *
ZW_system_startup_getAppNodeInfo(void)

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

Function Documentation#

IsWakeupCausedByRtccTimeout#

bool IsWakeupCausedByRtccTimeout (void)

Was the device woken up by an RTCC timer interrupt?

Parameters
N/A

This function can safely be called from multiple threads.

Returns

  • true if woken up by RTCC timeout, false otherwise.


Definition at line 26 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

GetCompletedSleepDurationMs#

uint32_t GetCompletedSleepDurationMs (void)

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

Parameters
N/A

This function can safely be called from multiple threads.

Returns

  • Number of milliseconds.


Definition at line 36 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

GetDeepSleepWakeupTick#

uint32_t GetDeepSleepWakeupTick (void)

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

Parameters
N/A

This function can safely be called from multiple threads.

Returns

  • RTCC ticks.


Definition at line 46 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

GetLastTickBeforeDeepSleep#

uint32_t GetLastTickBeforeDeepSleep (void)

Get the sleeptimer tick value of the device when it last went to Deep Sleep.

Parameters
N/A

(It is stored in retention RAM)

This function can safely be called from multiple threads.

Returns

  • RTCC ticks.


Definition at line 56 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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.

Parameters
N/A

This function can safely be called from multiple threads.

Returns

  • reset reason.


Definition at line 66 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

ZW_ApplicationRegisterTask#

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

Please.

Parameters
N/AappTaskFunc
N/AiZwRxQueueTaskNotificationBitNumber
N/AiZwCommandStatusQueueTaskNotificationBitNumber
N/ApProtocolConfig

See Also


Definition at line 71 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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.

Parameters
N/A

Definition at line 80 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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!

Parameters
N/AiZwRxQueueTaskNotificationBitNumber
N/AiZwCommandStatusQueueTaskNotificationBitNumber
N/ApProtocolConfig

Definition at line 86 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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!

Parameters
N/AxHandle

Definition at line 95 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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


Definition at line 103 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

ZW_system_startup_GetCCSet#

SCommandClassSet_t * ZW_system_startup_GetCCSet (void)

Gets the Command Class Set.

Parameters
N/A

Returns

  • SCommandClassSet_t* A pointer to the Command Class Set


Definition at line 110 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

ZW_system_startup_IsSchedulerStarted#

bool ZW_system_startup_IsSchedulerStarted (void)

INCLUDE_xTaskGetSchedulerState did not include xTaskGetSchedulerState in the build.

Parameters
N/A

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!


Definition at line 120 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h

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.

Parameters
N/A

Returns

  • const SAppNodeInfo_t*


Definition at line 127 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h