↓

Filter results by

Older Versions

Older API versions are available as a download. To view, extract the file and open the index.html file in a web browser.

artik_zigbee_clusters.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2017 Samsung Electronics All Rights Reserved.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing,
12  * software distributed under the License is distributed on an
13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
14  * either express or implied. See the License for the specific
15  * language governing permissions and limitations under the License.
16  *
17  */
18 
19 #ifndef __ARTIK_ZIGBEE_CLUSTERS_H__
20 #define __ARTIK_ZIGBEE_CLUSTERS_H__
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
38 typedef enum {
39  ARTIK_ZIGBEE_GROUPS_ADD = 3230,
40  ARTIK_ZIGBEE_GROUPS_REMOVE,
41  ARTIK_ZIGBEE_GROUPS_REMOVE_ALL,
42  ARTIK_ZIGBEE_GROUPS_ADD_IF_IDENTIFYING
43 } artik_zigbee_group_command;
48 typedef struct {
49  unsigned short group_id;
50  int endpoint_id;
51  artik_zigbee_group_command group_cmd;
52 } artik_zigbee_groups_info;
56 typedef struct {
57  unsigned char scene_count;
58  unsigned char current_scene;
59  unsigned short current_group;
60  unsigned char scene_valid;
61 } artik_zigbee_scene_mgmt_info;
66 typedef enum {
67  ARTIK_ZIGBEE_ONOFF_OFF = 3220,
68  ARTIK_ZIGBEE_ONOFF_ON,
69  ARTIK_ZIGBEE_ONOFF_TOGGLE
70 } artik_zigbee_onoff_status;
75 typedef struct {
76  artik_zigbee_onoff_status prev_value;
77  artik_zigbee_onoff_status curr_value;
78  artik_zigbee_onoff_status command;
79  int endpoint_id;
80 } artik_zigbee_onoff_info;
84 typedef enum {
85  ARTIK_ZIGBEE_MOVE_TO_LEVEL = 0x00,
86  ARTIK_ZIGBEE_MOVE = 0x01,
87  ARTIK_ZIGBEE_STEP = 0x02,
88  ARTIK_ZIGBEE_STOP = 0x03,
89  ARTIK_ZIGBEE_MOVE_TO_LEVEL_ONOFF = 0x04,
90  ARTIK_ZIGBEE_MOVE_ONOFF = 0x05,
91  ARTIK_ZIGBEE_STEP_ONOFF = 0x06,
92  ARTIK_ZIGBEE_STOP_ONOFF = 0x07
93 } artik_zigbee_level_control_type;
97 typedef enum {
98  ARTIK_ZIGBEE_LEVEL_CONTROL_UP = 0x00,
99  ARTIK_ZIGBEE_LEVEL_CONTROL_DOWN = 0x01
100 } artik_zigbee_level_control_mode;
104 typedef struct {
105  artik_zigbee_level_control_type control_type;
106  union {
107  struct {
108  int level;
109  int transition_time; /* tenths of a second */
110  } move_to_level;
111  struct {
112  artik_zigbee_level_control_mode control_mode;
113  int rate; /* changes per second */
114  } move;
115  struct {
116  artik_zigbee_level_control_mode control_mode;
117  int step_size;
118  int transition_time; /* tehnths of a second */
119  } step;
120  } parameters;
121 } artik_zigbee_level_control_command;
126 typedef struct {
127  int prev_level;
128  int curr_level;
129  int endpoint_id;
130 } artik_zigbee_level_control_update;
134 typedef enum {
135  ARTIK_ZIGBEE_MOVE_TO_HUE = 0x00,
136  ARTIK_ZIGBEE_MOVE_HUE,
137  ARTIK_ZIGBEE_STEP_HUE,
138  ARTIK_ZIGBEE_MOVE_TO_SATURATION,
139  ARTIK_ZIGBEE_MOVE_SATURATION,
140  ARTIK_ZIGBEE_STEP_SATURATION,
141  ARTIK_ZIGBEE_MOVE_TO_HUE_SATURATION,
142  ARTIK_ZIGBEE_MOVE_TO_COLOR,
143  ARTIK_ZIGBEE_MOVE_COLOR,
144  ARTIK_ZIGBEE_STEP_COLOR,
145  ARTIK_ZIGBEE_MOVE_TO_COLOR_TEMP,
146  ARTIK_ZIGBEE_EMOVE_TO_HUE = 0x40,
147  ARTIK_ZIGBEE_EMOVE_HUE,
148  ARTIK_ZIGBEE_ESTEP_HUE,
149  ARTIK_ZIGBEE_EMOVE_TO_HUE_SATURATION,
150  ARTIK_ZIGBEE_COLOR_LOOP_SET,
151  ARTIK_ZIGBEE_STOP_MOVE_STEP = 0x47,
152  ARTIK_ZIGBEE_MOVE_COLOR_TEMP = 0x4b,
153  ARTIK_ZIGBEE_STEP_COLOR_TEMP = 0x4c
154 } artik_zigbee_color_control_type;
158 typedef enum {
159  ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_SHORTEST_DISTANCE = 0x00,
160  ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_LONGEST_DISTANCE = 0x01,
161  ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_UP = 0x02,
162  ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_DOWN = 0x03
163 } artik_zigbee_color_control_direction;
167 typedef enum {
168  ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_STOP = 0x00,
169  ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_UP = 0x01,
170  ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_DOWN = 0x03
171 } artik_zigbee_color_control_move_mode;
175 typedef enum {
176  ARTIK_ZIGBEE_COLOR_CONTROL_STEP_MODE_UP = 0x01,
177  ARTIK_ZIGBEE_COLOR_CONTROL_STEP_MODE_DOWN = 0x03
178 } artik_zigbee_color_control_step_mode;
182 typedef enum {
183 ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_DEACTIVATE = 0x00,
184 ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_ACTIVATE_FROM_START_ENHANCED_HUE = 0x01,
185 ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_ACTIVATE_FROM_ENHANCED_CURRENT_HUE = 0x02
186 } artik_zigbee_color_control_loop_set_action;
190 typedef struct {
191  artik_zigbee_color_control_type control_type;
192  union {
193  struct {
194  int hue;
195  artik_zigbee_color_control_direction direction;
196  int transition_time;
197  } move_to_hue;
198  struct {
199  artik_zigbee_color_control_move_mode move_mode;
200  int rate;
201  } move_hue;
202  struct {
203  artik_zigbee_color_control_step_mode step_mode;
204  int step_size;
205  int transition_time;
206  } step_hue;
207  struct {
208  int saturation;
209  int transition_time;
210  } move_to_sat;
211  struct {
212  artik_zigbee_color_control_move_mode move_mode;
213  int rate;
214  } move_sat;
215  struct {
216  artik_zigbee_color_control_step_mode step_mode;
217  int step_size;
218  int transition_time;
219  } step_sat;
220  struct {
221  int hue;
222  int saturation;
223  int transition_time;
224  } move_to_hue_sat;
225  struct {
226  int color_x;
227  int color_y;
228  int transition_time;
229  } move_to_color;
230  struct {
231  int rate_x;
232  int rate_y;
233  } move_color;
234  struct {
235  int step_x;
236  int step_y;
237  int transition_time;
238  } step_color;
239  struct {
240  int color_temp;
241  int transition_time;
242  } move_to_color_temp;
243  struct {
244  int update_flag;
245  artik_zigbee_color_control_loop_set_action action;
246  artik_zigbee_color_control_direction direction;
247  int time;
248  int start_hue;
249  } color_loop_set;
250  struct {
251  artik_zigbee_color_control_move_mode move_mode;
252  int rate;
253  int min_color_temp;
254  int max_color_temp;
255  } move_color_temp;
256  struct {
257  artik_zigbee_color_control_step_mode step_mode;
258  int step_size;
259  int transition_time;
260  int min_color_temp;
261  int max_color_temp;
262  } step_color_temp;
263  } parameters;
264 } artik_zigbee_color_control_command;
268 typedef struct {
269  int hue;
270  int saturation;
271  int color_x;
272  int color_y;
273  int color_temp;
274 } artik_zigbee_color_control_value;
275 
279 typedef enum {
280  ARTIK_ZIGBEE_OCCUPIED,
281  ARTIK_ZIGBEE_UNOCCUPIED
282 } artik_zigbee_occupancy_status;
283 
287 typedef enum {
288  ARTIK_ZIGBEE_OCCUPANCY_PIR,
289  ARTIK_ZIGBEE_OCCUPANCY_ULTRASONIC,
290  ARTIK_ZIGBEE_OCCUPANCY_PIR_ULTRASONIC
291 } artik_zigbee_occupancy_type;
292 
293 typedef enum {
294  ARTIK_ZIGBEE_FAN_MODE_OFF,
295  ARTIK_ZIGBEE_FAN_MODE_LOW,
296  ARTIK_ZIGBEE_FAN_MODE_MEDIUM,
297  ARTIK_ZIGBEE_FAN_MODE_HIGH,
298  ARTIK_ZIGBEE_FAN_MODE_ON,
299  ARTIK_ZIGBEE_FAN_MODE_AUTO,
300  ARTIK_ZIGBEE_FAN_MODE_SMART,
301  ARTIK_ZIGBEE_FAN_MODE_RESERVED
302 } artik_zigbee_fan_mode;
303 
304 typedef enum {
305  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_MED_HIGH,
306  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_HIGH,
307  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_MED_HIGH_AUTO,
308  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_HIGH_AUTO,
309  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_ON_AUTO,
310  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_RESERVED
311 } artik_zigbee_fan_mode_sequence;
312 
316 typedef enum {
317  ARTIK_ZIGBEE_SETPOINT_MODE_HEAT = 0x00,
318  ARTIK_ZIGBEE_SETPOINT_MODE_COOL,
319  ARTIK_ZIGBEE_SETPOINT_MODE_BOTH,
320  ARTIK_ZIGBEE_SETPOINT_MODE_RESERVED
321 } artik_zigbee_thermostat_setpoint_mode;
322 
326 typedef enum {
327  ARTIK_ZIGBEE_SYSTEM_MODE_OFF = 0x00,
328  ARTIK_ZIGBEE_SYSTEM_MODE_AUTO,
329  ARTIK_ZIGBEE_SYSTEM_MODE_COOL,
330  ARTIK_ZIGBEE_SYSTEM_MODE_HEAT,
331  ARTIK_ZIGBEE_SYSTEM_MODE_EMERGENCY_HEATING,
332  ARTIK_ZIGBEE_SYSTEM_MODE_PRECOOLING,
333  ARTIK_ZIGBEE_SYSTEM_MODE_FAN_ONLY,
334  ARTIK_ZIGBEE_SYSTEM_MODE_RESERVED
335 } artik_zigbee_thermostat_system_mode;
336 
340 typedef enum {
341  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_ONLY = 0x00,
342  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_WITH_REHEAT,
343  ARTIK_ZIGBEE_CONTROL_SEQUENCE_HEATING_ONLY,
344  ARTIK_ZIGBEE_CONTROL_SEQUENCE_HEATING_WITH_REHEAT,
345  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_HEATING,
346  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_HEATING_WITH_REHEAT,
347  ARTIK_ZIGBEE_CONTROL_SEQUENCE_RESERVED
348 } artik_zigbee_thermostat_control_sequence;
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 #endif /* __ARTIK_ZIGBEE_CLUSTERS_H__ */
354 
artik_zigbee_thermostat_control_sequence
artik_zigbee_thermostat_control_sequence
The Thermostat control sequence of operation.
Definition: artik_zigbee_clusters.h:340
artik_zigbee_color_control_move_mode
artik_zigbee_color_control_move_mode
The move mode for Color Control.
Definition: artik_zigbee_clusters.h:167
artik_zigbee_thermostat_system_mode
artik_zigbee_thermostat_system_mode
The Thermostat system mode.
Definition: artik_zigbee_clusters.h:326
artik_zigbee_onoff_status
artik_zigbee_onoff_status
On/Off status for On/Off cluster This is used when both sending and receiving command.
Definition: artik_zigbee_clusters.h:66
artik_zigbee_group_command
artik_zigbee_group_command
Group command for Group cluster This is used when both sending and receiving command.
Definition: artik_zigbee_clusters.h:38
artik_zigbee_color_control_value
The Color current values.
Definition: artik_zigbee_clusters.h:268
artik_zigbee_color_control_loop_set_action
artik_zigbee_color_control_loop_set_action
The loop action for Color Control.
Definition: artik_zigbee_clusters.h:182
artik_zigbee_level_control_type
artik_zigbee_level_control_type
Level Control cluster command type.
Definition: artik_zigbee_clusters.h:84
artik_zigbee_color_control_command
The command for cluster Color Control.
Definition: artik_zigbee_clusters.h:190
artik_zigbee_color_control_direction
artik_zigbee_color_control_direction
Color Control cluster command direction.
Definition: artik_zigbee_clusters.h:158
artik_zigbee_occupancy_type
artik_zigbee_occupancy_type
The sensor type of occupancy.
Definition: artik_zigbee_clusters.h:287
artik_zigbee_groups_info
Structure for receiving a notification of group command from ZigBee Daemon.
Definition: artik_zigbee_clusters.h:48
artik_zigbee_color_control_type
artik_zigbee_color_control_type
Color Control cluster command type.
Definition: artik_zigbee_clusters.h:134
artik_zigbee_onoff_info
Structure for receiving a command notification of On/Off cluster from ZigBee Daemon.
Definition: artik_zigbee_clusters.h:75
artik_zigbee_color_control_step_mode
artik_zigbee_color_control_step_mode
The step mode for Color Control.
Definition: artik_zigbee_clusters.h:175
artik_zigbee_occupancy_status
artik_zigbee_occupancy_status
The status of occupancy.
Definition: artik_zigbee_clusters.h:279
artik_zigbee_scene_mgmt_info
Structure for saving Scene information.
Definition: artik_zigbee_clusters.h:56
artik_zigbee_level_control_update
Structure for receiving a update notification of Level Control cluster from ZigBee Daemon...
Definition: artik_zigbee_clusters.h:126
artik_zigbee_level_control_command
Structure for Level Control cluster command.
Definition: artik_zigbee_clusters.h:104
artik_zigbee_thermostat_setpoint_mode
artik_zigbee_thermostat_setpoint_mode
The Thermostat setpoint mode.
Definition: artik_zigbee_clusters.h:316
artik_zigbee_level_control_mode
artik_zigbee_level_control_mode
Level Control cluster command mode.
Definition: artik_zigbee_clusters.h:97
Last updated on: