Configuration of CC Notification

Collaboration diagram for Configuration of CC Notification:

Data Structures
struct	_cc_notification_t

Typedefs
typedef uint8_t	notification_event_state
typedef struct _cc_notification_t	cc_notification_t

Enumerations
enum	NOTIFICATION_STATUS {   NOTIFICATION_STATUS_UNSOLICIT_DEACTIVATED = 0x00 ,   NOTIFICATION_STATUS_UNSOLICIT_ACTIVATED = 0xFF }

Functions
cc_notification_t *	cc_notification_get_config (void)
uint8_t	cc_notification_get_config_length (void)
uint8_t	cc_notification_get_supported_events_length (void)
cc_notification_t *	cc_notification_get (uint8_t index)
int8_t	cc_notification_get_index_by_type_and_endpoint (notification_type_t type, uint8_t endpoint)
notification_type_t	cc_notification_get_type (uint8_t index)
notification_event_state	cc_notification_get_current_event (uint8_t index)
agi_profile_t	cc_notification_get_agi_profile (uint8_t index)
uint8_t	cc_notification_get_endpoint (uint8_t index)
NOTIFICATION_STATUS	cc_notification_get_status (uint8_t index)
bool	cc_notification_is_type_supported (notification_type_t type)
int8_t	cc_notification_find_event (uint8_t event, uint8_t index)
uint8_t	cc_notification_config_get_number_of_events (uint8_t index)

Detailed Description

Typedef Documentation

cc_notification_t

typedef struct _cc_notification_t cc_notification_t

notification_event_state

typedef uint8_t notification_event_state

Enumeration Type Documentation

NOTIFICATION_STATUS

enum NOTIFICATION_STATUS

Notification status

Enumerator
NOTIFICATION_STATUS_UNSOLICIT_DEACTIVATED
NOTIFICATION_STATUS_UNSOLICIT_ACTIVATED

Function Documentation

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.

Parameters

index

Notification index.

Returns

Number of configured events.

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.

Parameters

[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.

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.

Parameters

[in]

index

Index in the notification array.

Returns

Address of notification.

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.

Parameters

[in]

index

Index in the notification array.

Returns

AGI profile.

cc_notification_get_config()

cc_notification_t * cc_notification_get_config

(

void

)

Returns the address of the first element in the notification array.

Returns

First element in the notification array.

cc_notification_get_config_length()

uint8_t cc_notification_get_config_length

(

void

)

Returns the number of elements in the notification array.

Returns

Number of elements in the notification array.

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.

Parameters

[in]

index

Index in the notification array.

Returns

Current event.

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.

Parameters

[in]

index

Index in the notification array.

Returns

Endpoint.

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.

Parameters

[in]	type	Notification type.
[in]	endpoint	Endpoint.

Returns

Index of notification.

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.

Parameters

[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.

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.

Returns

Total number of supported events.

cc_notification_get_type()

notification_type_t cc_notification_get_type

(

uint8_t

index

)

Returns the notification type from the given index.

Parameters

[in]

index

Index in the notification array.

Returns

Notification type.

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.

This function is used to check whether incoming CC Notification commands must be discarded or not.

Parameters

[in]

type

Notification type.

Returns

true if available,