Association Group Information#

General information#

CC Association Group Information (CC AGI) reports which commands a device can control and which commands are reported to the Lifeline.

CC AGI configuration#

The Lifeline group is automatically configured, but other groups may be manually configured if desired. For instance, a wall switch might control a bulb using CC Binary Switch. In such case, the wall switch would need to have an association group defined that lists Binary Switch Set. Simplicity Studio / SLC generates this configuration automatically based on user configuration in *.cc_config files.

Example of configuration:

zw_cc_agi:
  endpoints:
    - endpoint: 0
      groups:
        - name: BTN0
          profile_msb: ASSOCIATION_GROUP_INFO_REPORT_AGI_PROFILE_CONTROL
          profile_lsb: ASSOCIATION_GROUP_INFO_REPORT_AGI_CONTROL_KEY01
          commands:
            - command_class: COMMAND_CLASS_BASIC_V2
              command: BASIC_SET_V2

The specification of CC AGI can be found in https://github.com/Z-Wave-Alliance/AWG/tree/main/source/management_command_classes/command_class_definitions

Modules#

Configuration of CC Association Group Information

Functions#

uint8_t

CC_AGI_groupCount_handler(uint8_t endpoint)

Returns the number of configured association groups for a given endpoint.

uint8_t

cc_agi_get_group_id(agi_profile_t const *const profile, ccc_pair_t const *const cmdGrp, uint8_t const endpoint)

Returns the association group ID that matches the given AGI profile, command class/command-pair and endpoint.

Function Documentation#

CC_AGI_groupCount_handler#

uint8_t CC_AGI_groupCount_handler (uint8_t endpoint)

Returns the number of configured association groups for a given endpoint.

Parameters

Type	Direction	Argument Name	Description
uint8_t	[in]	endpoint	A given endpoint where 0 is the root device.

This function will return 1 for any endpoint if the node is added to a Z-Wave LR network.

Returns

Number of configured association groups.

cc_agi_get_group_id#

uint8_t cc_agi_get_group_id (agi_profile_t const *const profile, ccc_pair_t const *const cmdGrp, uint8_t const endpoint)

Returns the association group ID that matches the given AGI profile, command class/command-pair and endpoint.

Parameters

Type	Direction	Argument Name	Description
agi_profile_t const *const	[in]	profile	AGI profile to search for.
ccc_pair_t const *const	[in]	cmdGrp	Command class / command pair to search for.
uint8_t const	[in]	endpoint	Endpoint.

Returns

Returns the group ID, if found. Otherwise 0xFF.