Notification#
Command Class Notification enables a device to send notifications like "smoke detected" or "window opened".
CC Notification is typically used in sensor applications because it supports many different notification/sensor types.
CC Notification requires at least one notification to be configured by implementing the functions declared in cc_notification_config_api.h. Simplicity Studio / SLC generates this configuration automatically based on user configuration in *.cc_config files.
This command class offers one single API function to be used by the application:
The specification of CC Notification can be found in https://github.com/Z-Wave-Alliance/AWG/blob/main/source/application_command_classes/command_class_definitions/notification_command_class_version_3-8.rst.
Modules#
Configuration of CC Notification
Enumerations#
General purpose notification event.
Notification type (8 bit).
Typedefs#
Struct used to pass operational data to TSE module.
Functions#
Triggers notification event and sends it to dedicated Agi profile.
Macros#
the maximum length of the notification bitmask array
Enumeration Documentation#
NOTIFICATION_EVENT#
NOTIFICATION_EVENT
General purpose notification event.
Enumerator | |
---|---|
NOTIFICATION_EVENT_NO_EVENT | |
NOTIFICATION_EVENT_UNKNOWN_EVENT |
notification_type_t#
notification_type_t
Notification type (8 bit).
Enumerator | |
---|---|
NOTIFICATION_TYPE_NONE | |
NOTIFICATION_TYPE_SMOKE_ALARM | |
NOTIFICATION_TYPE_CO_ALARM | |
NOTIFICATION_TYPE_CO2_ALARM | |
NOTIFICATION_TYPE_HEAT_ALARM | |
NOTIFICATION_TYPE_WATER_ALARM | |
NOTIFICATION_TYPE_ACCESS_CONTROL | |
NOTIFICATION_TYPE_HOME_SECURITY | |
NOTIFICATION_TYPE_POWER_MANAGEMENT | |
NOTIFICATION_TYPE_SYSTEM | |
NOTIFICATION_TYPE_EMERGENCY_ALARM | |
NOTIFICATION_TYPE_CLOCK | |
NOTIFICATION_TYPE_MULTIDEVICE |
Typedef Documentation#
s_CC_notification_data_t#
typedef struct s_CC_notification_data_t_ s_CC_notification_data_t
Struct used to pass operational data to TSE module.
Function Documentation#
CC_Notification_TriggerAndTransmit#
JOB_STATUS CC_Notification_TriggerAndTransmit (uint8_t index, uint8_t notificationEvent, uint8_t * pEvPar, uint8_t evParLen, void(*)(TRANSMISSION_RESULT *pTransmissionResult) pCallback, bool tse)
Triggers notification event and sends it to dedicated Agi profile.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | [in] | index | notification index. |
uint8_t | [in] | notificationEvent | Event triggered. |
uint8_t * | [in] | pEvPar | point to event parameters. |
uint8_t | [in] | evParLen | length of event parameters. |
void(*)(TRANSMISSION_RESULT *pTransmissionResult) | [out] | pCallback | callback function returning state on job |
bool | [in] | tse | True of false, depending if TSE should be triggered, or not |
Returns
JOB_STATUS