CC_WakeUp.h File Reference

#include <ZW_TransportEndpoint.h>
#include <ZW_application_transport_interface.h>
#include <ZAF_nvm_app.h>
#include <ZAF_nvm.h>

Include dependency graph for CC_WakeUp.h:

Go to the source code of this file.

Data Structures
struct	SWakeupCcData

Macros
#define	ZAF_FILE_SIZE_WAKEUPCCDATA   (sizeof(SWakeupCcData))

Typedefs
typedef struct SWakeupCcData	SWakeupCcData

Functions
void	CC_WakeUp_notification_tx (void(*pCallback)(uint8_t txStatus, TX_STATUS_TYPE *pExtendedTxStatus))
uint32_t	cc_wake_up_config_get_default_sleep_time_sec (void)
	Used by the WakeUp Command Class configuration Returns with the default sleep time in second between Wake Up Notifications.
uint32_t	cc_wake_up_config_get_minimum_sleep_time_sec (void)
	Used by the WakeUp Command Class configuration Returns with the minimum sleep time in second between Wake Up Notifications.
uint32_t	cc_wake_up_config_get_maximum_sleep_time_sec (void)
	Used by the WakeUp Command Class configuration Returns with the maximum sleep time in second between Wake Up Notifications.
uint32_t	cc_wake_up_config_get_sleep_step_time_sec (void)
	Used by the WakeUp Command Class configuration Returns with the sleep step time in second.

Detailed Description

Handler for Command Class Wake Up.

CC WakeUp can be used in two scenarios: 1) as a standalone wake up node waking up from reset, or 2) combined with FLiRS waking up from sleep.

In both scenarios, an application might want to do something, like sending a Battery Report before transmitting a Wake Up Notification.

Having an init function that takes a reset reason and a callback function, the module could address both scenarios like this:

1) The init function is called with a reset reason set to ZPAL_RESET_REASON_DEEP_SLEEP_WUT. This means that the chip woke up from reset caused by the wake up timer. In this case, the callback must be invoked so that the application can do something.

2) The callback passed using the init function is registered with the timer. It is then invoked when the timer triggers.

In both scenarios, the application must call CC_WakeUp_notification_tx() when done with something.

General initialization: 1) Call init and set values 2) On resetting app: Call reset function

Copyright

2018 Silicon Laboratories Inc.