common/include/zigbee_zcl_scene_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_SCENE_TYPE_H__
  20 #define __ZIGBEE_ZCL_SCENE_TYPE_H__
  21
  22 #include <zigbee_types.h>
  23
  24 /* -----------------------------------------------------------------------------
  25  * For Requests
  26  * ---------------------------------------------------------------------------*/
  27
  28 /**
  29  * @brief Definition for ZCL scene add scene structure.
  30  * @since_tizen 3.0
  31  */
  32 typedef struct {
  33         short node_id; /**< Node ID */
  34         char dest_ep; /**< Destination endpoint */
  35         short group_id; /**< Group ID */
  36         char scene_id; /**< Scene ID */
  37         short transition_time; /**< Transition time */
  38         char scene_name[ZIGBEE_ZCL_SCENE_NAME_MAX_LEN + 1]; /**< Scene name (NULL terminated */
  39         short ext_field_set_len; /**< Extended field set length */
  40         char *ext_field_set; /**< Extended field set */
  41 } ZigbeeZclSceneAddScene_t;
  42
  43 /**
  44  * @brief Definition for ZCL scene view scene structure.
  45  * @since_tizen 3.0
  46  */
  47 typedef struct {
  48         short node_id; /**< Node ID */
  49         char dest_ep; /**< Destination endpoint */
  50         short group_id; /**< Group ID */
  51         char scene_id; /**< Scene ID */
  52 } ZigbeeZclSceneViewScene_t;
  53
  54 /**
  55  * @brief Definition for ZCL scene remove scene structure.
  56  * @since_tizen 3.0
  57  */
  58 typedef struct {
  59         short node_id; /**< Node ID */
  60         char dest_ep; /**< Destination endpoint */
  61         short group_id; /**< Group ID */
  62         char scene_id; /**< Scene ID */
  63 } ZigbeeZclSceneRemoveScene_t;
  64
  65 /**
  66  * @brief Definition for ZCL scene store scene structure.
  67  * @since_tizen 3.0
  68  */
  69 typedef struct {
  70         short node_id; /**< Node ID */
  71         char dest_ep; /**< Destination endpoint */
  72         short group_id; /**< Group ID */
  73         char scene_id; /**< Scene ID */
  74 } ZigbeeZclSceneStoreScene_t;
  75
  76 /**
  77  * @brief Definition for ZCL scene recall scene structure.
  78  * @since_tizen 3.0
  79  */
  80 typedef struct {
  81         short node_id; /**< Node ID */
  82         char dest_ep; /**< Destination endpoint */
  83         short group_id; /**< Group ID */
  84         char scene_id; /**< Scene ID */
  85 } ZigbeeZclSceneRecallScene_t;
  86
  87 /**
  88  * @brief Definition for ZCL scene remove all scene structure.
  89  * @since_tizen 3.0
  90  */
  91 typedef struct {
  92         short node_id; /**< Node ID */
  93         char dest_ep; /**< Destination endpoint */
  94         short group_id; /**< Group ID */
  95 } ZigbeeZclSceneRemoveAllScene_t;
  96
  97 /**
  98  * @brief Definition for ZCL scene get scene membership structure.
  99  * @since_tizen 3.0
 100  */
 101 typedef struct {
 102         short node_id; /**< Node ID */
 103         char dest_ep; /**< Destination endpoint */
 104         short group_id; /**< Group ID */
 105 } ZigbeeZclSceneGetSceneMembership_t;
 106
 107 /* -----------------------------------------------------------------------------
 108  * For Notification
 109  * ---------------------------------------------------------------------------*/
 110
 111 /**
 112  * @brief Definition for ZCL scene add scene response structure.
 113  * @since_tizen 3.0
 114  */
 115 typedef struct {
 116         short node_id; /**< Node ID */
 117         char src_ep; /**< Destination endpoint */
 118         char status; /**< Status */
 119         short group_id; /**< Group ID */
 120         char scene_id; /**< Scene ID */
 121 } ZigbeeZclSceneAddSceneResp_t;
 122
 123 /**
 124  * @brief Definition for ZCL scene view scene response structure.
 125  * @since_tizen 3.0
 126  */
 127 typedef struct {
 128         short node_id; /**< Node ID */
 129         char src_ep; /**< Source endpoint */
 130         short group_id; /**< Group ID */
 131         char status; /**< Status */
 132         char scene_id; /**< Scene ID */
 133         short transition_time; /**< Transition time */
 134         char *scene_name; /**< Scene name (NULL terminated */
 135         short ext_field_set_len; /**< Extended field set length */
 136         char *ext_field_set; /**< Extended field set */
 137 } ZigbeeZclSceneViewSceneResp_t;
 138
 139 /**
 140  * @brief Definition for ZCL scene remove scene response structure.
 141  * @since_tizen 3.0
 142  */
 143 typedef struct {
 144         short node_id; /**< Node ID */
 145         char src_ep; /**< Source endpoint */
 146         char status; /**< Status */
 147         short group_id; /**< Group ID */
 148         char scene_id; /**< Scene ID */
 149 } ZigbeeZclSceneRemoveSceneResp_t;
 150
 151 /**
 152  * @brief Definition for ZCL scene remove all scene response structure.
 153  * @since_tizen 3.0
 154  */
 155 typedef struct {
 156         short node_id; /**< Node ID */
 157         char src_ep; /**< Source endpoint */
 158         char status; /**< Status */
 159         short group_id; /**< Group ID */
 160 } ZigbeeZclSceneRemoveAllSceneResp_t;
 161
 162 /**
 163  * @brief Definition for ZCL scene store scene response structure.
 164  * @since_tizen 3.0
 165  */
 166 typedef struct {
 167         short node_id; /**< Node ID */
 168         char src_ep; /**< Source endpoint */
 169         char status; /**< Status */
 170         short group_id; /**< Group ID */
 171         char scene_id; /**< Scene ID */
 172 } ZigbeeZclSceneStoreSceneResp_t;
 173
 174 /**
 175  * @brief Definition for ZCL scene get scene membership response structure.
 176  * @since_tizen 3.0
 177  */
 178 typedef struct {
 179         short node_id; /**< Node ID */
 180         char src_ep; /**< Source endpoint */
 181         char status; /**< Status */
 182         char capacity; /**< Capacity */
 183         short group_id; /**< Group ID */
 184         char scene_count; /**< Scene count */
 185         char *scene_list; /**< Scene list */
 186 } ZigbeeZclSceneGetSceneMembershipResp_t;
 187
 188
 189 #endif /* __ZIGBEE_ZCL_SCENE_TYPE_H__ */