common/include/zigbee_zcl_group_type.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
   3  *
   4  * Contact: Suresh Kumar N (suresh.n@samsung.com)
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #ifndef __ZIGBEE_ZCL_GROUP_TYPE_H__
  20 #define __ZIGBEE_ZCL_GROUP_TYPE_H__
  21
  22 #include <zigbee_types.h>
  23
  24 /* --------------------------------------------------------------------------------------
  25  * For Request
  26  * -------------------------------------------------------------------------------------*/
  27
  28 /**
  29  * @brief Definition for ZCL Group add group structure.
  30  * @since_tizen 3.0
  31  */
  32 typedef struct {
  33         unsigned short node_id; /**< Node ID */
  34         unsigned char dest_ep; /**< Destination endpoint */
  35         unsigned short group_id; /**< Group ID */
  36         char group_name[ZIGBEE_ZCL_GROUP_NAME_MAX_LEN + 1]; /**< Group name (NULL terminated) */
  37 } ZigbeeZclGroupAddGroup_t;
  38
  39 /**
  40  * @brief Definition for ZCL Group view group structure.
  41  * @since_tizen 3.0
  42  */
  43 typedef struct {
  44         unsigned short node_id; /**< Node ID */
  45         unsigned char dest_ep; /**< Destination endpoint */
  46         unsigned short group_id; /**< Group ID */
  47 } ZigbeeZclGroupViewGroup_t;
  48
  49 /**
  50  * @brief Definition for ZCL Group get group membership structure.
  51  * @since_tizen 3.0
  52  */
  53 typedef struct {
  54         unsigned short node_id; /**< Node ID */
  55         unsigned char dest_ep; /**< Destination endpoint */
  56         unsigned char group_count; /**< Group count */
  57         unsigned short *group_list; /**< Group list */
  58 } ZigbeeZclGroupGetGroupMembership_t;
  59
  60 /**
  61  * @brief Definition for ZCL Group remove group structure.
  62  * @since_tizen 3.0
  63  */
  64 typedef struct {
  65         unsigned short node_id; /**< Node ID */
  66         unsigned char dest_ep; /**< Destination endpoint */
  67         unsigned short group_id; /**< Group ID */
  68 } ZigbeeZclGroupRemoveGroup_t;
  69
  70 /**
  71  * @brief Definition for ZCL Group remove all group structure.
  72  * @since_tizen 3.0
  73  */
  74 typedef struct {
  75         unsigned short node_id; /**< Node ID */
  76         unsigned char dest_ep; /**< Destination endpoint */
  77 } ZigbeeZclGroupRemoveAllGroup_t;
  78
  79 /**
  80  * @brief Definition for ZCL Group add group if identifying structure.
  81  * @since_tizen 3.0
  82  */
  83 typedef struct {
  84         unsigned short node_id; /**< Node ID */
  85         unsigned char dest_ep; /**< Destination endpoint */
  86         unsigned short group_id; /**< Group ID */
  87         char group_name[ZIGBEE_ZCL_GROUP_NAME_MAX_LEN + 1]; /**< Group name (NULL terminated) */
  88 } ZigbeeZclGroupAddGroupIfIdentifying_t;
  89
  90 /* --------------------------------------------------------------------------------------
  91  * For Notifications
  92  * -------------------------------------------------------------------------------------*/
  93
  94 /**
  95  * @brief Definition for ZCL Group add group response structure.
  96  * @since_tizen 3.0
  97  */
  98 typedef struct {
  99         unsigned short node_id; /**< Node ID */
 100         unsigned char src_ep; /**< Source endpoint */
 101         unsigned char status; /**< Status code */
 102         unsigned short group_id; /**< Group ID */
 103 } ZigbeeZclGroupAddGroupNoti_t;
 104
 105 /**
 106  * @brief Definition for ZCL Group view group structure.
 107  * @since_tizen 3.0
 108  */
 109 typedef struct {
 110         unsigned short node_id; /**< Node ID */
 111         unsigned char src_ep; /**< Source endpoint */
 112         unsigned char status; /**< Status code */
 113         unsigned short group_id; /**< Group ID */
 114         char group_name[ZIGBEE_ZCL_GROUP_NAME_MAX_LEN + 1]; /**< Group name (NULL terminated) */
 115 } ZigbeeZclGroupViewGroupNoti_t;
 116
 117 /**
 118  * @brief Definition for ZCL Group get group membership structure.
 119  * @since_tizen 3.0
 120  */
 121 typedef struct {
 122         unsigned short node_id; /**< Node ID */
 123         unsigned char src_ep; /**< Source endpoint */
 124         unsigned char capacity; /**< Capacity of group */
 125         unsigned char group_count; /**< Group ID */
 126         unsigned short *group_list; /**< Group list */
 127 } ZigbeeZclGroupGetGroupMembershipNoti_t;
 128
 129 /**
 130  * @brief Definition for ZCL Group remove structure.
 131  * @since_tizen 3.0
 132  */
 133 typedef struct {
 134         unsigned short node_id; /**< Node ID */
 135         unsigned char src_ep; /**< Source endpoint */
 136         unsigned char status; /**< Status code */
 137         unsigned short group_id; /**< Group ID */
 138 } ZigbeeZclGroupRemoveGroupNoti_t;
 139
 140
 141 #endif /* __ZIGBEE_ZCL_GROUP_TYPE_H__ */