Z-Wave System Startup API#
Functions#
Was the device woken up by an RTCC timer interrupt?
Get number of milliseconds the device has spent sleeping in deep sleep before it was woken up.
Get the sleeptimer tick value of the device when it woke up from deep sleep.
Get the sleeptimer tick value of the device when it last went to Deep Sleep.
Get the reset reason of the device when it was last reset or woke up from EM4 sleep.
Please.
Used to get the pointer to the application handles structure! Needed to insert task related data when creating user task.
Used by ZW_UserTask_ApplicationRegisterTask() in ZW_UserTask.h to set the Event Notification Bit Numbers in the Application Interface structure!
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!
Passed the Command Class set from the Application to the Protocol using a shared variable.
Gets the Command Class Set.
INCLUDE_xTaskGetSchedulerState did not include xTaskGetSchedulerState in the build.
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?
N/A |
This function can safely be called from multiple threads.
Returns
true if woken up by RTCC timeout, false otherwise.
26
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
This function can safely be called from multiple threads.
Returns
Number of milliseconds.
36
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
This function can safely be called from multiple threads.
Returns
RTCC ticks.
46
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
(It is stored in retention RAM)
This function can safely be called from multiple threads.
Returns
RTCC ticks.
56
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
This function can safely be called from multiple threads.
Returns
reset reason.
66
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h
ZW_ApplicationRegisterTask#
bool ZW_ApplicationRegisterTask (void(*)(SApplicationHandles *) appTaskFunc, uint8_t iZwRxQueueTaskNotificationBitNumber, uint8_t iZwCommandStatusQueueTaskNotificationBitNumber, const SProtocolConfig_t * pProtocolConfig)
Please.
N/A | appTaskFunc | |
N/A | iZwRxQueueTaskNotificationBitNumber | |
N/A | iZwCommandStatusQueueTaskNotificationBitNumber | |
N/A | pProtocolConfig |
See Also
ZW_UserTask_ApplicationRegisterTask() in ZW_UserTask.h for more info.
71
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
80
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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!
N/A | iZwRxQueueTaskNotificationBitNumber | |
N/A | iZwCommandStatusQueueTaskNotificationBitNumber | |
N/A | pProtocolConfig |
86
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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!
N/A | xHandle |
95
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
[in] | CCSet | Command Class Set |
103
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
Returns
SCommandClassSet_t* A pointer to the Command Class Set
110
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
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!
120
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
N/A |
Returns
const SAppNodeInfo_t*
127
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_system_startup_api.h