zwave_command_class_agi.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAVE_COMMAND_CLASS_AGI_H
#define ZWAVE_COMMAND_CLASS_AGI_H
 
#include "sl_status.h"
#include "zwave_command_class_association_internals.h"
#include "zwave_controller_types.h"
#include "ZW_classcmd.h"
 
#define MAX_SUPPORTED_NODES_PER_GROUP 10
 
#define NUMBER_OF_SUPPORTED_GROUPS 1
 
#define AGI_NA_PROFILE 0x0000
 
#define LIFELINE_GROUP_ID 1
#define AGI_LIFELINE_PROFILE  0x0001
#define LIFELINE_NAME     "Lifeline"
 
#define AGI_RESERVED_PROFILE 0xFFFF
 
// Profile values for AGI
typedef uint32_t agi_profile_t;
 
#define AGI_INFO_REPORT_GROUP_COUNT_MASK 0x3F
#define MAX_GROUP_NAME_SIZE ATTRIBUTE_STORE_MAXIMUM_VALUE_LENGTH
// defining Association Group Name Report frame
typedef struct association_group_name_report_frame {
  uint8_t command_class;
  uint8_t command;
  association_group_id_t grouping_identifier;
  uint8_t name_length;
  uint8_t name[MAX_GROUP_CONTENT_SIZE];
} association_group_name_report_frame_t;
 
// defining Association Group Info Report frame
typedef struct association_group_info_report_frame {
  uint8_t command_class;
  uint8_t command;
  uint8_t properties;
  VG_ASSOCIATION_GROUP_INFO_REPORT_VG vg_ass_group_info[MAX_GROUP_CONTENT_SIZE];
} association_group_info_report_frame_t;
 
// defining Association Group Command List Report frame
typedef struct association_group_command_list_report_frame {
  uint8_t command_class;
  uint8_t command;
  association_group_id_t grouping_identifier;
  uint8_t list_length;
  uint8_t command_list[MAX_GROUP_CONTENT_SIZE];
} association_group_command_list_report_frame_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
sl_status_t zwave_command_class_agi_init();
 
agi_profile_t
  zwave_command_class_agi_get_group_profile(zwave_node_id_t node_id,
                                            zwave_endpoint_id_t endpoint_id,
                                            association_group_id_t group_id);
 
sl_status_t zwave_command_class_agi_add_group_commands(
  association_group_id_t group_id,
  zwave_command_class_t command_class,
  zwave_command_t command);
 
bool zwave_command_class_agi_is_command_allowed_for_group(
  association_group_id_t group_id,
  zwave_command_class_t command_class,
  zwave_command_t command);
 
void zwave_command_class_agi_request_to_establish_association(
  zwave_command_class_t command_class, zwave_command_t command);
 
bool zwave_command_class_agi_group_contains_listeners(
  zwave_node_id_t node_id,
  zwave_endpoint_id_t endpoint_id,
  association_group_id_t group_id);
 
#ifdef __cplusplus
}
#endif
 
#endif  //ZWAVE_COMMAND_CLASS_AGI_H