Digi XBee(R) ANSI C Host Library
Data Structures | Macros | Functions | Variables
zcl_commissioning.h File Reference

Header for ZCL Commissioning Cluster. More...

#include "xbee/platform.h"
#include "wpan/types.h"
#include "zigbee/zcl.h"
#include "zigbee/zcl_types.h"

Go to the source code of this file.

Data Structures

struct  zcl_comm_startup_param_t
 
struct  zcl_comm_state_t
 
struct  zcl_comm_startup_attr_t
 
struct  zcl_comm_restart_device_cmd_t
 
struct  zcl_comm_save_startup_param_t
 
struct  zcl_comm_restore_startup_param_t
 
struct  zcl_comm_reset_startup_param_t
 

Macros

#define ZCL_CLUST_COMMISSIONING   0x0015
 
#define ZCL_CLUST_ENTRY_COMMISSIONING_SERVER
 
#define ZCL_COMM_GLOBAL_EPID   ZCL64_INIT( 0x0050C277, 0x10000000 )
 
#define ZCL_COMM_STARTUP_JOINED   0x00
 
#define ZCL_COMM_STARTUP_COORDINATOR   0x01
 
#define ZCL_COMM_STARTUP_REJOIN   0x02
 
#define ZCL_COMM_STARTUP_FROM_SCRATCH   0x03
 
#define ZCL_COMM_KEY_TYPE_STANDARD   0x01
 
#define ZCL_COMM_KEY_TYPE_HIGH_SECURITY   0x05
 
#define ZCL_COMM_SCAN_ATTEMPTS_DEFAULT   0x05
 
#define ZCL_COMM_TIME_BETWEEN_SCANS_DEFAULT   0x0064
 
#define ZCL_COMM_REJOIN_INTERVAL_DEFAULT   0x003c
 
#define ZCL_COMM_MAX_REJOIN_INTERVAL_DEFAULT   0x0e10
 
#define ZCL_COMM_CONCENTRATOR_RADIUS_DEFAULT   0x0F
 
#define ZCL_COMM_FLAG_SAVE_ON_JOIN   0x01
 if radio successfully joins a network, commit changes to NVRAM
 
#define ZCL_COMM_FLAG_DELAYED_RESTART   0x02
 there is a delayed action to perform
 
#define ZCL_COMM_FLAG_COORDINATOR_OK   0x04
 this device can be a coordinator
 
#define ZCL_COMM_FLAG_ROUTER_OK   0x08
 this device can be a router
 
#define ZCL_COMM_FLAG_ENDDEV_OK   0x10
 this device can be a end device
 
#define ZCL_COMM_FLAG_FACTORY_RESET   0x40
 reset to factory SAS at the delayed restart
 
#define ZCL_COMM_FLAG_INSTALL   0x80
 install the current SAS at the delayed restart
 
#define ZCL_COMM_STATE_INIT   0x00
 startup state
 
#define ZCL_COMM_STATE_LOADING   0x01
 loading structure
 
#define ZCL_COMM_STATE_STARTUP   0x02
 xbee_commissioning_tick() can process startup_control
 
#define ZCL_COMM_STATE_UNJOINED   0x03
 radio is not joined to a network
 
#define ZCL_COMM_STATE_REFRESH   0x04
 radio has joined a network and we're refreshing the structure
 
#define ZCL_COMM_STATE_JOINED   0x05
 radio is joined to a network
 
#define ZCL_COMM_ATTR_SHORT_ADDRESS   0x0000
 
#define ZCL_COMM_ATTR_EXTENDED_PANID   0x0001
 
#define ZCL_COMM_ATTR_PANID   0x0002
 
#define ZCL_COMM_ATTR_CHANNEL_MASK   0x0003
 
#define ZCL_COMM_ATTR_PROTOCOL_VERSION   0x0004
 
#define ZCL_COMM_ATTR_STACK_PROFILE   0x0005
 
#define ZCL_COMM_ATTR_STARTUP_CONTROL   0x0006
 
#define ZCL_COMM_ATTR_TRUST_CTR_ADDR   0x0010
 
#define ZCL_COMM_ATTR_TRUST_CTR_MASTER_KEY   0x0011
 
#define ZCL_COMM_ATTR_NETWORK_KEY   0x0012
 
#define ZCL_COMM_ATTR_USE_INSECURE_JOIN   0x0013
 
#define ZCL_COMM_ATTR_PRECONFIG_LINK_KEY   0x0014
 
#define ZCL_COMM_ATTR_NETWORK_KEY_SEQ_NUM   0x0015
 
#define ZCL_COMM_ATTR_NETWORK_KEY_TYPE   0x0016
 
#define ZCL_COMM_ATTR_NETWORK_MGR_ADDR   0x0017
 
#define ZCL_COMM_ATTR_SCAN_ATTEMPTS   0x0020
 
#define ZCL_COMM_ATTR_TIME_BTWN_SCANS   0x0021
 
#define ZCL_COMM_ATTR_REJOIN_INTERVAL   0x0022
 
#define ZCL_COMM_ATTR_MAX_REJOIN_INTERVAL   0x0023
 
#define ZCL_COMM_ATTR_INDIRECT_POLL_RATE   0x0030
 
#define ZCL_COMM_ATTR_PARENT_RETRY_THRESHOLD   0x0031
 
#define ZCL_COMM_ATTR_CONCENTRATOR_FLAG   0x0040
 
#define ZCL_COMM_ATTR_CONCENTRATOR_RADIUS   0x0041
 
#define ZCL_COMM_ATTR_CONCENTRATOR_DISC_TIME   0x0042
 
#define ZCL_COMM_CMD_RESTART_DEVICE   0x00
 
#define ZCL_COMM_CMD_SAVE_STARTUP_PARAM   0x01
 
#define ZCL_COMM_CMD_RESTORE_STARTUP_PARAM   0x02
 
#define ZCL_COMM_CMD_RESET_STARTUP_PARAM   0x03
 
#define ZCL_COMM_CMD_RESTART_DEVICE_RESP   0x00
 
#define ZCL_COMM_CMD_SAVE_STARTUP_PARAM_RESP   0x01
 
#define ZCL_COMM_CMD_RESTORE_STARTUP_PARAM_RESP   0x02
 
#define ZCL_COMM_CMD_RESET_STARTUP_PARAM_RESP   0x03
 

Functions

int zcl_comm_response (const wpan_envelope_t FAR *envelope, uint_fast8_t status)
 Send response to a Commissioning Server Cluster request.
 
int zcl_comm_restart_device (wpan_envelope_t FAR *envelope, const zcl_comm_restart_device_cmd_t *parameters)
 Send a "Restart Device" command to the ZCL Commissioning Cluster. More...
 
int zcl_comm_reset_parameters (wpan_envelope_t FAR *envelope, const zcl_comm_reset_startup_param_t *parameters)
 Send a "Reset Startup Parameters" command to the ZCL Commissioning Cluster. More...
 
void zcl_comm_sas_init (zcl_comm_startup_param_t *parameters)
 
int zcl_comm_clust_handler (const wpan_envelope_t FAR *envelope, void FAR *context)
 
void zcl_comm_factory_reset (uint16_t ms_delay)
 Perform a locally-triggered factory reset to default SAS. More...
 

Variables

const zcl64_t zcl_comm_global_epid
 
zcl_comm_state_t zcl_comm_state
 
const zcl_comm_startup_param_t zcl_comm_default_sas
 
const zcl_comm_startup_attr_t zcl_comm_startup_attributes
 
const zcl_attribute_tree_t zcl_comm_startup_attribute_tree []
 

Detailed Description

Header for ZCL Commissioning Cluster.