Notification

Collaboration diagram for Notification:

Topics
	Configuration of CC Notification
	Storage for CC Notification

Data Structures
struct	s_CC_notification_data_t_

Macros
#define	NOTIFICATION_BITMASK_ARRAY_LENGTH   32

Typedefs
typedef struct s_CC_notification_data_t_	s_CC_notification_data_t

Enumerations
enum	NOTIFICATION_EVENT {   NOTIFICATION_EVENT_NO_EVENT ,   NOTIFICATION_EVENT_UNKNOWN_EVENT = 0xFE }
enum	notification_type_t {   NOTIFICATION_TYPE_NONE ,   NOTIFICATION_TYPE_SMOKE_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_SMOKE_ALARM) ,   NOTIFICATION_TYPE_CO_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_CO_ALARM) ,   NOTIFICATION_TYPE_CO2_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_CO2_ALARM) ,   NOTIFICATION_TYPE_HEAT_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_HEAT_ALARM) ,   NOTIFICATION_TYPE_WATER_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_WATER_ALARM) ,   NOTIFICATION_TYPE_ACCESS_CONTROL = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_ACCESS_CONTROL) ,   NOTIFICATION_TYPE_HOME_SECURITY = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_HOME_SECURITY) ,   NOTIFICATION_TYPE_POWER_MANAGEMENT = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_POWER_MANAGEMENT) ,   NOTIFICATION_TYPE_SYSTEM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_SYSTEM) ,   NOTIFICATION_TYPE_EMERGENCY_ALARM = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_EMERGENCY_ALARM) ,   NOTIFICATION_TYPE_CLOCK = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_CLOCK) ,   NOTIFICATION_TYPE_MULTIDEVICE = (0xFF & ICON_TYPE_SPECIFIC_SENSOR_NOTIFICATION_MULTIDEVICE) }

Functions
JOB_STATUS	CC_Notification_TriggerAndTransmit (uint8_t index, uint8_t notificationEvent, uint8_t *pEvPar, uint8_t evParLen, void(*pCallback)(TRANSMISSION_RESULT *pTransmissionResult), bool tse)
	Triggers notification event and sends it to dedicated Agi profile.

Detailed Description

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 *.yaml files.

This command class offers one single API function to be used by the application:

• CC_Notification_TriggerAndTransmit()

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.

Macro Definition Documentation

NOTIFICATION_BITMASK_ARRAY_LENGTH

#define NOTIFICATION_BITMASK_ARRAY_LENGTH   32

the maximum length of the notification bitmask array

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

Enumeration Type Documentation

NOTIFICATION_EVENT

enum NOTIFICATION_EVENT

General purpose notification event

Enumerator
NOTIFICATION_EVENT_NO_EVENT
NOTIFICATION_EVENT_UNKNOWN_EVENT

notification_type_t

enum 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

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.

Parameters

[in]	index	notification index.
[in]	notificationEvent	Event triggered.
[in]	pEvPar	point to event parameters.
[in]	evParLen	length of event parameters.
[out]	pCallback	callback function returning state on job
[in]	tse	True of false, depending if TSE should be triggered, or not

Returns

JOB_STATUS