Command Class Notification Configuration API.
2022 Silicon Laboratories Inc.
Modules#
Enumerations#
Notification status.
Functions#
Returns the address of the first element in the notification array.
Returns the number of elements in the notification array.
Returns the total number of supported events for all notifications.
Returns the address of the notification located at the given index in the notification array.
Returns the index of a notification based on given type and endpoint.
Returns the notification type from the given index.
Returns the current event of a notification given by the index in the notification array.
Returns the AGI profile of a notification given by the index in the notification array.
Returns endpoint of a notification given by the index in the notification array.
Returns the status (on/off) of a notification given by the index in the notification array.
Returns whether a notification exists in the notification array based on a given notification type.
Returns the index of a given event, if supported, for a given notification index.
Returns the number of configured events for a given notification index.
Enumeration Documentation#
NOTIFICATION_STATUS#
NOTIFICATION_STATUS
Notification status.
Enumerator | |
---|---|
NOTIFICATION_STATUS_UNSOLICIT_DEACTIVATED | |
NOTIFICATION_STATUS_UNSOLICIT_ACTIVATED |
28
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
Typedef Documentation#
notification_event_state#
typedef uint8_t notification_event_state
23
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_t#
typedef struct _cc_notification_t cc_notification_t
43
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
Function Documentation#
cc_notification_get_config#
cc_notification_t * cc_notification_get_config (void )
Returns the address of the first element in the notification array.
N/A |
Returns
First element in the notification array.
49
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_config_length#
uint8_t cc_notification_get_config_length (void )
Returns the number of elements in the notification array.
N/A |
Returns
Number of elements in the notification array.
55
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_supported_events_length#
uint8_t cc_notification_get_supported_events_length (void )
Returns the total number of supported events for all notifications.
N/A |
Returns
Total number of supported events.
61
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get#
cc_notification_t * cc_notification_get (uint8_t index)
Returns the address of the notification located at the given index in the notification array.
[in] | index | Index in the notification array. |
Returns
Address of notification.
68
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_index_by_type_and_endpoint#
int8_t cc_notification_get_index_by_type_and_endpoint (notification_type_t type, uint8_t endpoint)
Returns the index of a notification based on given type and endpoint.
[in] | type | Notification type. |
[in] | endpoint | Endpoint. |
Returns
Index of notification.
76
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_type#
notification_type_t cc_notification_get_type (uint8_t index)
Returns the notification type from the given index.
[in] | index | Index in the notification array. |
Returns
Notification type.
83
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_current_event#
notification_event_state cc_notification_get_current_event (uint8_t index)
Returns the current event of a notification given by the index in the notification array.
[in] | index | Index in the notification array. |
Returns
Current event.
90
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_agi_profile#
agi_profile_t cc_notification_get_agi_profile (uint8_t index)
Returns the AGI profile of a notification given by the index in the notification array.
[in] | index | Index in the notification array. |
Returns
AGI profile.
97
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_endpoint#
uint8_t cc_notification_get_endpoint (uint8_t index)
Returns endpoint of a notification given by the index in the notification array.
[in] | index | Index in the notification array. |
Returns
Endpoint.
104
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_get_status#
NOTIFICATION_STATUS cc_notification_get_status (uint8_t index)
Returns the status (on/off) of a notification given by the index in the notification array.
[in] | index | Index in the notification array. |
Returns
Returns NOTIFICATION_STATUS_UNSOLICIT_DEACTIVATED if the notification is disabled.
Returns NOTIFICATION_STATUS_UNSOLICIT_ACTIVATED if the notification is enabled.
112
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_is_type_supported#
bool cc_notification_is_type_supported (notification_type_t type)
Returns whether a notification exists in the notification array based on a given notification type.
[in] | type | Notification type. |
This function is used to check whether incoming CC Notification commands must be discarded or not. Returns
true if available,
122
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_find_event#
int8_t cc_notification_find_event (uint8_t event, uint8_t index)
Returns the index of a given event, if supported, for a given notification index.
[in] | event | Event to be found. |
[in] | index | Notification index in notifications array |
Returns
Returns event index if found
Returns -1 if the event is not supported for the given notification index.
132
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h
cc_notification_config_get_number_of_events#
uint8_t cc_notification_config_get_number_of_events (uint8_t index)
Returns the number of configured events for a given notification index.
N/A | index | Notification index. |
Returns
Number of configured events.
140
of file /mnt/raid/workspaces/ws.1eyhFLSdc/overlay/gsdk/protocol/z-wave/ZAF/CommandClasses/Notification/src/cc_notification_config_api.h