artik_zigbee.h File Reference
ZigBee module definition. More...
#include <stdint.h>#include "artik_error.h"#include "artik_types.h"#include "artik_zigbee_clusters.h"Go to the source code of this file.
Data Structures | |
| struct | artik_zigbee_local_endpoint |
| Local endpoint. More... | |
| struct | artik_zigbee_local_endpoint_info |
| Local endpoint information. More... | |
| struct | artik_zigbee_endpoint |
| Structure for endpoint information. More... | |
| struct | artik_zigbee_endpoint_list |
| Structure for endpoint list to find endpoints by cluster ID. More... | |
| struct | artik_zigbee_device |
| Structure for device information This is used when sending cluster commands to select device. More... | |
| struct | artik_zigbee_device_info |
| List of device information. More... | |
| struct | artik_zigbee_device_discovery |
| Device discovery response. More... | |
| struct | artik_zigbee_network_info |
| Structure for network information. More... | |
| struct | artik_zigbee_network_find_result |
| Network find result. More... | |
| struct | artik_zigbee_received_command |
| Received command from remote device. More... | |
| struct | artik_zigbee_attribute_changed_response |
| Attribute changed response from zigbeed. More... | |
| struct | artik_zigbee_reporting_info |
| A structure used to store reporting configurations. If endpoint field is ::EMBER_AF_PLUGIN_REPORTING_UNUSED_ENDPOINT_ID, this configure is unused. More... | |
| struct | artik_zigbee_report_attribute_info |
| Structure for report attribute from remote server. More... | |
| struct | artik_zigbee_identify_feedback_info |
| A structure for notifying identify feedback. More... | |
| struct | artik_zigbee_commissioning_target_info |
| Structure of target that ezmode commissioning find Used in callback, to notify user. More... | |
| struct | artik_zigbee_commissioning_bound_info |
| Structure of clusters that bound by ezmode commissioning Used in callback, to notify user. More... | |
| struct | artik_zigbee_simple_descriptor_response |
| Simple descriptor response Used in callback, to notify user. More... | |
| struct | artik_zigbee_broadcast_identify_query_response |
| Broadcast identify query response Used in callback, to notify user. More... | |
| struct | artik_zigbee_ieee_addr_response |
| Ieee addr response Used in callback, to notify user. More... | |
| struct | artik_zigbee_match_desc_response |
| Match descriptor response Used in callback, to notify user. More... | |
| struct | artik_zigbee_binding_table_entry |
| Zigbee binding table entry. More... | |
| struct | artik_zigbee_device_on_off_switch |
| Structure for device on/off switch, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_device_level_control_switch |
| Structure for device level control switch, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_device_on_off_light |
| Structure for device on/off light, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_device_dimmable_light |
| Structure for device dimmable light, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_device_light_sensor |
| Structure for device light sensor, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_device_remote_control |
| Structure for device remote control, to storage the local endpoint information and functions can be invoked. More... | |
| struct | artik_zigbee_module |
| ZigBee module operations. More... | |
Typedefs | |
| typedef unsigned short | ARTIK_ZIGBEE_PROFILE |
| typedef unsigned short | ARTIK_ZIGBEE_DEVICEID |
| typedef void * | artik_zigbee_endpoint_handle |
| endpoint instance | |
| typedef void(* | artik_zigbee_client_callback) (void *user_data, artik_zigbee_response_type response_type, void *payload) |
| Callback function type. | |
Enumerations | |
| enum | artik_zigbee_notification { ARTIK_ZIGBEE_CMD_SUCCESS = 0, ARTIK_ZIGBEE_CMD_ERR_PORT_PROBLEM = -3001, ARTIK_ZIGBEE_CMD_ERR_NO_SUCH_COMMAND = -3002, ARTIK_ZIGBEE_CMD_ERR_WRONG_NUMBER_OF_ARGUMENTS = -3003, ARTIK_ZIGBEE_CMD_ERR_ARGUMENT_OUT_OF_RANGE = -3004, ARTIK_ZIGBEE_CMD_ERR_ARGUMENT_SYNTAX_ERROR = -3005, ARTIK_ZIGBEE_CMD_ERR_STRING_TOO_LONG = -3006, ARTIK_ZIGBEE_CMD_ERR_INVALID_ARGUMENT_TYPE = -3007, ARTIK_ZIGBEE_CMD_ERR = -3008 } |
| Receiving command notification type from ZigBee Daemon This is one of response types. | |
| enum | artik_zigbee_network_notification { ARTIK_ZIGBEE_NETWORK_JOIN = 3100, ARTIK_ZIGBEE_NETWORK_LEAVE, ARTIK_ZIGBEE_NETWORK_FIND_FORM_SUCCESS, ARTIK_ZIGBEE_NETWORK_FIND_FORM_FAILED, ARTIK_ZIGBEE_NETWORK_FIND_JOIN_SUCCESS, ARTIK_ZIGBEE_NETWORK_FIND_JOIN_FAILED, ARTIK_ZIGBEE_NETWORK_EXIST, ARTIK_ZIGBEE_NETWORK_FORM_SUCCESS, ARTIK_ZIGBEE_NETWORK_FORM_FAILED, ARTIK_ZIGBEE_NETWORK_JOIN_SUCCESS, ARTIK_ZIGBEE_NETWORK_JOIN_FAILED } |
| Receiving network notification type from ZigBee Daemon This is one of response types. | |
| enum | artik_zigbee_node_type { ARTIK_ZIGBEE_UNKNOWN_DEVICE = 3200, ARTIK_ZIGBEE_COORDINATOR = 3201, ARTIK_ZIGBEE_ROUTER = 3202, ARTIK_ZIGBEE_END_DEVICE = 3203, ARTIK_ZIGBEE_SLEEPY_END_DEVICE = 3204 } |
| Receiving node type from ZigBee Daemon This is one of response types. | |
| enum | artik_zigbee_network_state { ARTIK_ZIGBEE_NO_NETWORK = 3210, ARTIK_ZIGBEE_JOINING_NETWORK, ARTIK_ZIGBEE_JOINED_NETWORK, ARTIK_ZIGBEE_JOINED_NETWORK_NO_PARENT, ARTIK_ZIGBEE_LEAVING_NETWORK } |
| Receiving network state from ZigBee Daemon This is one of response types. | |
| enum | artik_zigbee_device_discovery_status { ARTIK_ZIGBEE_DEVICE_DISCOVERY_NO_DEVICE = 3220, ARTIK_ZIGBEE_DEVICE_DISCOVERY_FOUND, ARTIK_ZIGBEE_DEVICE_DISCOVERY_DONE, ARTIK_ZIGBEE_DEVICE_DISCOVERY_START, ARTIK_ZIGBEE_DEVICE_DISCOVERY_ERROR, ARTIK_ZIGBEE_DEVICE_DISCOVERY_IN_PROGRESS, ARTIK_ZIGBEE_DEVICE_DISCOVERY_CHANGED, ARTIK_ZIGBEE_DEVICE_DISCOVERY_LOST } |
| Device discovery result. | |
| enum | artik_zigbee_network_find_status { ARTIK_ZIGBEE_NETWORK_FOUND = 3230, ARTIK_ZIGBEE_NETWORK_FIND_FINISHED, ARTIK_ZIGBEE_NETWORK_FIND_ERR } |
| Network find status. | |
| enum | artik_zigbee_service_discovery_result { ARTIK_ZIGBEE_SERVICE_DISCOVERY_RECEIVED = 3240, ARTIK_ZIGBEE_SERVICE_DISCOVERY_DONE, ARTIK_ZIGBEE_SERVICE_DISCOVERY_ERROR } |
| enum | artik_zigbee_response_type { ARTIK_ZIGBEE_RESPONSE_NOTIFICATION = 3300, ARTIK_ZIGBEE_RESPONSE_CLIENT_TO_SERVER_COMMAND_RECEIVED, ARTIK_ZIGBEE_RESPONSE_ATTRIBUTE_CHANGE, ARTIK_ZIGBEE_RESPONSE_REPORTING_CONFIGURE, ARTIK_ZIGBEE_RESPONSE_REPORT_ATTRIBUTE, ARTIK_ZIGBEE_RESPONSE_IDENTIFY_FEEDBACK_START, ARTIK_ZIGBEE_RESPONSE_IDENTIFY_FEEDBACK_STOP, ARTIK_ZIGBEE_RESPONSE_NETWORK_NOTIFICATION, ARTIK_ZIGBEE_RESPONSE_NETWORK_FIND, ARTIK_ZIGBEE_RESPONSE_DEVICE_DISCOVER, ARTIK_ZIGBEE_RESPONSE_BROADCAST_IDENTIFY_QUERY, ARTIK_ZIGBEE_RESPONSE_GROUPS_INFO, ARTIK_ZIGBEE_RESPONSE_COMMISSIONING_STATUS, ARTIK_ZIGBEE_RESPONSE_COMMISSIONING_TARGET_INFO, ARTIK_ZIGBEE_RESPONSE_COMMISSIONING_BOUND_INFO, ARTIK_ZIGBEE_RESPONSE_IEEE_ADDR_RESP, ARTIK_ZIGBEE_RESPONSE_SIMPLE_DESC_RESP, ARTIK_ZIGBEE_RESPONSE_MATCH_DESC_RESP, ARTIK_ZIGBEE_RESPONSE_END_DEVICE_BIND, ARTIK_ZIGBEE_RESPONSE_BASIC_RESET_TO_FACTORY, ARTIK_ZIGBEE_RESPONSE_LEVEL_CONTROL, ARTIK_ZIGBEE_RESPONSE_NONE = 3399 } |
| Receiving response type from ZigBee Daemon. | |
| enum | artik_zigbee_attribute_type { ARTIK_ZIGBEE_ATTR_ONOFF_STATUS, ARTIK_ZIGBEE_ATTR_LEVELCONTROL_LEVEL, ARTIK_ZIGBEE_ATTR_COLOR_HUE, ARTIK_ZIGBEE_ATTR_COLOR_SATURATION, ARTIK_ZIGBEE_ATTR_COLOR_CURRENT_X, ARTIK_ZIGBEE_ATTR_COLOR_CURRENT_Y, ARTIK_ZIGBEE_ATTR_COLOR_TEMP, ARTIK_ZIGBEE_ATTR_FAN_MODE, ARTIK_ZIGBEE_ATTR_FAN_MODE_SEQUENCE, ARTIK_ZIGBEE_ATTR_OCCUPIED_HEATING_SETPOINT, ARTIK_ZIGBEE_ATTR_OCCUPIED_COOLING_SETPOINT, ARTIK_ZIGBEE_ATTR_SYSTEM_MODE, ARTIK_ZIGBEE_ATTR_CONTROL_SEQUENCE, ARTIK_ZIGBEE_ATTR_ILLUMINANCE, ARTIK_ZIGBEE_ATTR_TEMPERATURE, ARTIK_ZIGBEE_ATTR_OCCUPANCY, ARTIK_ZIGBEE_ATTR_THERMOSTAT_TEMPERATURE, ARTIK_ZIGBEE_ATTR_NONE } |
| Attribute change type. | |
| enum | artik_zigbee_tx_power { ARTIK_ZIGBEE_TX_POWER_8 = 8, ARTIK_ZIGBEE_TX_POWER_7 = 7, ARTIK_ZIGBEE_TX_POWER_6 = 6, ARTIK_ZIGBEE_TX_POWER_5 = 5, ARTIK_ZIGBEE_TX_POWER_4 = 4, ARTIK_ZIGBEE_TX_POWER_3 = 3, ARTIK_ZIGBEE_TX_POWER_2 = 2, ARTIK_ZIGBEE_TX_POWER_1 = 1, ARTIK_ZIGBEE_TX_POWER_0 = 0, ARTIK_ZIGBEE_TX_POWER_MINUS1 = -1, ARTIK_ZIGBEE_TX_POWER_MINUS2 = -2, ARTIK_ZIGBEE_TX_POWER_MINUS3 = -3, ARTIK_ZIGBEE_TX_POWER_MINUS4 = -4, ARTIK_ZIGBEE_TX_POWER_MINUS5 = -5, ARTIK_ZIGBEE_TX_POWER_MINUS6 = -6, ARTIK_ZIGBEE_TX_POWER_MINUS7 = -7, ARTIK_ZIGBEE_TX_POWER_MINUS8 = -8, ARTIK_ZIGBEE_TX_POWER_MINUS9 = -9, ARTIK_ZIGBEE_TX_POWER_MINUS11 = -11, ARTIK_ZIGBEE_TX_POWER_MINUS12 = -12, ARTIK_ZIGBEE_TX_POWER_MINUS14 = -14, ARTIK_ZIGBEE_TX_POWER_MINUS17 = -17, ARTIK_ZIGBEE_TX_POWER_MINUS20 = -20, ARTIK_ZIGBEE_TX_POWER_MINUS26 = -26, ARTIK_ZIGBEE_TX_POWER_MINUS43 = -43 } |
| Selectable tx power level. | |
| enum | artik_zigbee_reporting_type { ARTIK_ZIGBEE_REPORTING_THERMOSTAT_TEMPERATURE = 0, ARTIK_ZIGBEE_REPORTING_OCCUPANCY_SENSING, ARTIK_ZIGBEE_REPORTING_MEASURED_ILLUMINANCE, ARTIK_ZIGBEE_REPORTING_MEASURED_TEMPERATURE } |
| Request for device attribute information reporting. | |
| enum | artik_zigbee_commissioning_state { ARTIK_ZIGBEE_COMMISSIONING_ERROR = 0x00, ARTIK_ZIGBEE_COMMISSIONING_ERR_IN_PROGRESS, ARTIK_ZIGBEE_COMMISSIONING_NETWORK_STEERING_FORM, ARTIK_ZIGBEE_COMMISSIONING_NETWORK_STEERING_SUCCESS, ARTIK_ZIGBEE_COMMISSIONING_NETWORK_STEERING_FAILED, ARTIK_ZIGBEE_COMMISSIONING_WAIT_NETWORK_STEERING, ARTIK_ZIGBEE_COMMISSIONING_TARGET_SUCCESS, ARTIK_ZIGBEE_COMMISSIONING_TARGET_STOP, ARTIK_ZIGBEE_COMMISSIONING_TARGET_FAILED, ARTIK_ZIGBEE_COMMISSIONING_INITIATOR_SUCCESS, ARTIK_ZIGBEE_COMMISSIONING_INITIATOR_STOP, ARTIK_ZIGBEE_COMMISSIONING_INITIATOR_FAILED } |
| Commissioning state Used in callback, to notify user. | |
| enum | artik_zigbee_binding_type { ARTIK_UNUSED_BINDING = 0, ARTIK_UNICAST_BINDING = 1, ARTIK_MANY_TO_ONE_BINDING = 2, ARTIK_MULTICAST_BINDING = 3 } |
| Zigbee binding type. | |
Variables | |
| const artik_zigbee_device_on_off_switch | device_on_off_switch_func |
| const artik_zigbee_device_level_control_switch | device_level_control_switch_func |
| const artik_zigbee_device_on_off_light | device_on_off_light_func |
| const artik_zigbee_device_dimmable_light | device_dimmable_light_func |
| const artik_zigbee_device_light_sensor | device_light_sensor_func |
| const artik_zigbee_device_remote_control | device_remote_control_func |
| const artik_zigbee_module | zigbee_module |
Detailed Description
Definitions and functions for accessing the ZigBee module and performing operations
Definition in file artik_zigbee.h.
Last updated on: