2f1f2d3d3a2df73011ec0f76b70d3d4050fe4c64
[platform/core/connectivity/zigbee-manager.git] / 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 /**
23  * @brief Definition for maximum size of  Zcl scene name (16).
24  * @since_tizen 3.0
25  */
26 #define ZIGBEE_ZCL_SCENE_NAME_MAX_LEN 16
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         short *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 #endif /* __ZIGBEE_ZCL_SCENE_TYPE_H__ */