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 File Reference

ZIGBEE module definition. More...

Go to the source code of this file.

Data Structures

struct  artik_zigbee_groups_info
 Structure for receiving a notification of group command from ZigBee Daemon. More...
 
struct  artik_zigbee_scene_mgmt_info
 Structure for saving Scene information. More...
 
struct  artik_zigbee_onoff_info
 Structure for receiving a command notification of On/Off cluster from ZigBee Daemon. More...
 
struct  artik_zigbee_level_control_command
 Structure for Level Control cluster command. More...
 
struct  artik_zigbee_level_control_update
 Structure for receiving a update notification of Level Control cluster from ZigBee Daemon. More...
 
struct  artik_zigbee_color_control_command
 The command for cluster Color Control. More...
 
struct  artik_zigbee_color_control_value
 The Color current values. More...
 

Enumerations

enum  artik_zigbee_group_command { ARTIK_ZIGBEE_GROUPS_ADD = 3230, ARTIK_ZIGBEE_GROUPS_REMOVE, ARTIK_ZIGBEE_GROUPS_REMOVE_ALL, ARTIK_ZIGBEE_GROUPS_ADD_IF_IDENTIFYING }
 Group command for Group cluster This is used when both sending and receiving command.
 
enum  artik_zigbee_onoff_status { ARTIK_ZIGBEE_ONOFF_OFF = 3220, ARTIK_ZIGBEE_ONOFF_ON, ARTIK_ZIGBEE_ONOFF_TOGGLE }
 On/Off status for On/Off cluster This is used when both sending and receiving command.
 
enum  artik_zigbee_level_control_type {
  ARTIK_ZIGBEE_MOVE_TO_LEVEL = 0x00, ARTIK_ZIGBEE_MOVE = 0x01, ARTIK_ZIGBEE_STEP = 0x02, ARTIK_ZIGBEE_STOP = 0x03,
  ARTIK_ZIGBEE_MOVE_TO_LEVEL_ONOFF = 0x04, ARTIK_ZIGBEE_MOVE_ONOFF = 0x05, ARTIK_ZIGBEE_STEP_ONOFF = 0x06, ARTIK_ZIGBEE_STOP_ONOFF = 0x07
}
 Level Control cluster command type.
 
enum  artik_zigbee_level_control_mode { ARTIK_ZIGBEE_LEVEL_CONTROL_UP = 0x00, ARTIK_ZIGBEE_LEVEL_CONTROL_DOWN = 0x01 }
 Level Control cluster command mode.
 
enum  artik_zigbee_color_control_type {
  ARTIK_ZIGBEE_MOVE_TO_HUE = 0x00, ARTIK_ZIGBEE_MOVE_HUE, ARTIK_ZIGBEE_STEP_HUE, ARTIK_ZIGBEE_MOVE_TO_SATURATION,
  ARTIK_ZIGBEE_MOVE_SATURATION, ARTIK_ZIGBEE_STEP_SATURATION, ARTIK_ZIGBEE_MOVE_TO_HUE_SATURATION, ARTIK_ZIGBEE_MOVE_TO_COLOR,
  ARTIK_ZIGBEE_MOVE_COLOR, ARTIK_ZIGBEE_STEP_COLOR, ARTIK_ZIGBEE_MOVE_TO_COLOR_TEMP, ARTIK_ZIGBEE_EMOVE_TO_HUE = 0x40,
  ARTIK_ZIGBEE_EMOVE_HUE, ARTIK_ZIGBEE_ESTEP_HUE, ARTIK_ZIGBEE_EMOVE_TO_HUE_SATURATION, ARTIK_ZIGBEE_COLOR_LOOP_SET,
  ARTIK_ZIGBEE_STOP_MOVE_STEP = 0x47, ARTIK_ZIGBEE_MOVE_COLOR_TEMP = 0x4b, ARTIK_ZIGBEE_STEP_COLOR_TEMP = 0x4c
}
 Color Control cluster command type.
 
enum  artik_zigbee_color_control_direction { ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_SHORTEST_DISTANCE = 0x00, ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_LONGEST_DISTANCE = 0x01, ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_UP = 0x02, ARTIK_ZIGBEE_COLOR_CONTROL_DIRECTION_DOWN = 0x03 }
 Color Control cluster command direction.
 
enum  artik_zigbee_color_control_move_mode { ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_STOP = 0x00, ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_UP = 0x01, ARTIK_ZIGBEE_COLOR_CONTROL_MOVE_MODE_DOWN = 0x03 }
 The move mode for Color Control.
 
enum  artik_zigbee_color_control_step_mode { ARTIK_ZIGBEE_COLOR_CONTROL_STEP_MODE_UP = 0x01, ARTIK_ZIGBEE_COLOR_CONTROL_STEP_MODE_DOWN = 0x03 }
 The step mode for Color Control.
 
enum  artik_zigbee_color_control_loop_set_action { ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_DEACTIVATE = 0x00, ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_ACTIVATE_FROM_START_ENHANCED_HUE = 0x01, ARTIK_ZIGBEE_COLOR_CONTROL_LOOP_ACTION_ACTIVATE_FROM_ENHANCED_CURRENT_HUE = 0x02 }
 The loop action for Color Control.
 
enum  artik_zigbee_occupancy_status { ARTIK_ZIGBEE_OCCUPIED, ARTIK_ZIGBEE_UNOCCUPIED }
 The status of occupancy.
 
enum  artik_zigbee_occupancy_type { ARTIK_ZIGBEE_OCCUPANCY_PIR, ARTIK_ZIGBEE_OCCUPANCY_ULTRASONIC, ARTIK_ZIGBEE_OCCUPANCY_PIR_ULTRASONIC }
 The sensor type of occupancy.
 
enum  artik_zigbee_fan_mode {
  ARTIK_ZIGBEE_FAN_MODE_OFF, ARTIK_ZIGBEE_FAN_MODE_LOW, ARTIK_ZIGBEE_FAN_MODE_MEDIUM, ARTIK_ZIGBEE_FAN_MODE_HIGH,
  ARTIK_ZIGBEE_FAN_MODE_ON, ARTIK_ZIGBEE_FAN_MODE_AUTO, ARTIK_ZIGBEE_FAN_MODE_SMART, ARTIK_ZIGBEE_FAN_MODE_RESERVED
}
 
enum  artik_zigbee_fan_mode_sequence {
  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_MED_HIGH, ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_HIGH, ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_MED_HIGH_AUTO, ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_LOW_HIGH_AUTO,
  ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_ON_AUTO, ARTIK_ZIGBEE_FAN_MODE_SEQUENCE_RESERVED
}
 
enum  artik_zigbee_thermostat_setpoint_mode { ARTIK_ZIGBEE_SETPOINT_MODE_HEAT = 0x00, ARTIK_ZIGBEE_SETPOINT_MODE_COOL, ARTIK_ZIGBEE_SETPOINT_MODE_BOTH, ARTIK_ZIGBEE_SETPOINT_MODE_RESERVED }
 The Thermostat setpoint mode.
 
enum  artik_zigbee_thermostat_system_mode {
  ARTIK_ZIGBEE_SYSTEM_MODE_OFF = 0x00, ARTIK_ZIGBEE_SYSTEM_MODE_AUTO, ARTIK_ZIGBEE_SYSTEM_MODE_COOL, ARTIK_ZIGBEE_SYSTEM_MODE_HEAT,
  ARTIK_ZIGBEE_SYSTEM_MODE_EMERGENCY_HEATING, ARTIK_ZIGBEE_SYSTEM_MODE_PRECOOLING, ARTIK_ZIGBEE_SYSTEM_MODE_FAN_ONLY, ARTIK_ZIGBEE_SYSTEM_MODE_RESERVED
}
 The Thermostat system mode.
 
enum  artik_zigbee_thermostat_control_sequence {
  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_ONLY = 0x00, ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_WITH_REHEAT, ARTIK_ZIGBEE_CONTROL_SEQUENCE_HEATING_ONLY, ARTIK_ZIGBEE_CONTROL_SEQUENCE_HEATING_WITH_REHEAT,
  ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_HEATING, ARTIK_ZIGBEE_CONTROL_SEQUENCE_COOLING_HEATING_WITH_REHEAT, ARTIK_ZIGBEE_CONTROL_SEQUENCE_RESERVED
}
 The Thermostat control sequence of operation.
 

Detailed Description

Definitions and functions for accessing the ZIGBEE Clusters

Definition in file artik_zigbee_clusters.h.

Last updated on: