zdo.h File Reference

The header file describes the public ZDO interface. More...

#include <macAddr.h>
#include <appFramework.h>
#include <aps.h>
#include <configServer.h>

Go to the source code of this file.

Data Structures

struct  ZDO_StartNetworkConf_t
 Describes the parameters of the ZDO_StartNetworkConf() function. More...
struct  ZDO_StartNetworkReq_t
 Describes the parameters of the ZDO_StartNetworkReq() function. More...
struct  ZDO_ResetNetworkConf_t
 Desribes the parameters of the ZDO_ResetNetworkConf() function. More...
struct  ZDO_ResetNetworkReq_t
 Describes the parameters of the ZDO_ResetNetworkReq() function. More...
struct  EDScan_t
struct  NetworkInf_t
struct  ZDO_MgmtNwkUpdateNotf_t
struct  ZDO_SleepConf_t
struct  ZDO_SleepReq_t
struct  ZDO_WakeUpConf_t
struct  ZDO_WakeUpReq_t
struct  ZDO_NwkAddrReq_t
struct  ZDO_IeeeAddrReq_t
struct  ZDO_NodeDescReq_t
struct  ZDO_PowerDescReq_t
struct  ZDO_ActiveEPReq_t
struct  ZDO_ComplexDescReq_t
struct  ZDO_UserDescReq_t
struct  ZDO_UserDescSetReq_t
struct  ZDO_SimpleDescReq_t
struct  ZDO_DeviceAnnceReq_t
struct  ZDO_SystemServerDiscoveryReq_t
struct  ZDO_MgmtLeaveReq_t
struct  ZDO_MgmtPermitJoiningReq_t
struct  ZDO_MgmtNwkUpdateReq_t
struct  ZDO_NwkAddrResp_t
struct  ZDO_IeeeAddrResp_t
struct  ZDO_NodeDescResp_t
struct  ZDO_PowerDescResp_t
struct  ZDO_ComplexDescResp_t
struct  ZDO_UserDescResp_t
struct  ZDO_UserDescConfResp_t
struct  ZDO_ActiveEPResp_t
struct  ZdpSimpleDescriptor_t
struct  ZDO_SimpleDescResp_t
struct  ZDO_SystemServerDiscoveryResp_t
struct  ZDO_ZdpRespFrame_t
struct  ZDO_ZdpReqFrame_t
struct  ZDO_ZdpFrame_t
struct  ZDO_ZdpResp_t
struct  ZDO_ZdpReq_t
struct  NodeAddr_t
struct  ZDO_GetLqiRssi_t
 Describes the parameters of the ZDO_LqiRssiReq() function. More...
struct  ZDO_GetChildrenAddr_t
 Describes the parameters of the ZDO_ChildrenAddrReq() function. More...
struct  ZDO_SetTxPowerConf_t
 Describes the parameters of the ZDO_SetTxPowerConf() function. More...
struct  ZDO_SetTxPowerReq_t
 Describes the parameters of the ZDO_SetTxPowerReq() function. More...
struct  ZDO_EndToEndAppKeyConf_t
struct  ZDO_EndToEndAppKeyReq_t

Enumerations

enum  NetLostReason_t { LEAVED_BY_PARENT, LINK_FAIL, LEAVE_REQ }
enum  ZDO_Status_t {
  ZDO_SUCCESS_STATUS = 0x00, ZDO_INVALID_PARAMETERS_STATUS = 0x01, ZDO_NOT_PERMITTED_STATUS = 0x03, ZDO_BUSY_STATUS = 0x04,
  ZDO_NO_NETWORKS_STATUS = 0x05, ZDO_EXTPANID_ALREADY_EXIST_STATUS = 0x06, ZDO_FAIL_STATUS = 0x07, ZDO_AUTHENTICATION_SUCCESS_STATUS = 0x08,
  ZDO_AUTHENTICATION_FAIL_STATUS = 0x09, ZDO_SECURITY_SUCCESS_STATUS = 0x0A, ZDO_SECURITY_FAIL_STATUS = 0x0B, ZDO_SECURITY_NOT_SUPPORTED_STATUS = 0x0C,
  ZDO_CMD_COMPLETED_STATUS = 0x0D, ZDO_INVALID_REQUEST_STATUS = 0x80, ZDO_DEVICE_NOT_FOUND_STATUS = 0x81, ZDO_INVALID_EP_STATUS = 0x82,
  ZDO_NOT_ACTIVE_STATUS = 0x83, ZDO_NOT_SUPPORTED_STATUS = 0x84, ZDO_TIMEOUT_STATUS = 0x85, ZDO_NO_MATCH_STATUS = 0x86,
  ZDO_NO_ENTRY_STATUS = 0x88, ZDO_NO_DESCRIPTOR_STATUS = 0x89, ZDO_INSUFFICIENT_SPACE_STATUS = 0x8A, ZDO_RESPONSE_WAIT_TIMEOUT_STATUS = 0x8B,
  ZDO_TABLE_FULL_STATUS = 0x8C, ZDO_NOT_AUTHORIZED_STATUS = 0x8D, ZDO_NWK_UPDATE_STATUS = 0x8E, ZDO_NETWORK_STARTED_STATUS = 0x8F,
  ZDO_NETWORK_LOST_STATUS = 0x90, ZDO_REJOIN_STARTED_STATUS = 0x91, ZDO_NETWORK_LEFT_STATUS = 0x92
}
 ZDO result status primitives. More...
enum  { SINGLE_RESPONSE_REQUESTTYPE = 0x00, EXTENDED_RESPONSE_REQUESTTYPE = 0x01 }
enum  ZDO_ZdpClusterId_t {
  NWK_ADDR_CLID = 0x0000, IEEE_ADDR_CLID = 0x0001, NODE_DESCRIPTOR_CLID = 0x0002, POWER_DESCRIPTOR_CLID = 0x0003,
  SIMPLE_DESCRIPTOR_CLID = 0x0004, ACTIVE_ENDPOINTS_CLID = 0x0005, MATCH_DESCRIPTOR_CLID = 0x0006, COMPLEX_DESCRIPTOR_CLID = 0x0010,
  USER_DESCRIPTOR_CLID = 0x0011, DISCOVERY_CASH_CLID = 0x0012, DEVICE_ANNCE_CLID = 0x0013, USER_DESC_CONF_CLID = 0x0014,
  SYSTEM_SERVER_DISCOVERY_CLID = 0x0015, DISCOVERY_STORE_CLID = 0x0016, NODE_DESC_STORE_CLID = 0x0017, POWER_DESC_STORE_CLID = 0x0018,
  ACTIVE_EP_STORE_CLID = 0x0019, SIMPLE_DESC_STORE_CLID = 0x001A, REMOVE_NODE_CACHE_CLID = 0x001B, FIND_NODE_CACHE_CLID = 0x001C,
  EXTENDED_SIMPLE_DESC_CLID = 0x001D, EXTENDED_ACTIVE_EP_CLID = 0x001E, END_DEVICE_BIND_CLID = 0x0020, BIND_CLID = 0x0021,
  UNBIND_CLID = 0x0022, BIND_REGISTER_CLID = 0x0023, REPLACE_DEVICE_CLID = 0x0024, STORE_BCKUP_BIND_ENTRY_CLID = 0x0025,
  REMOVE_BCKUP_BIND_ENTRY_CLID = 0x0026, BACKUP_BIND_TABLE_CLID = 0x0027, RECOVER_BIND_TABLE_CLID = 0x0028, BACKUP_SOURCE_BIND_CLID = 0x0029,
  RECOVER_SOURCE_BIND_CLID = 0x002A, MGMT_NWK_DISC_CLID = 0x0030, MGMT_LQI_CLID = 0x0031, MGMT_RTG_CLID = 0x0032,
  MGMT_BIND_CLID = 0x0033, MGMT_LEAVE_CLID = 0x0034, MGMT_DIRECT_JOIN_CLID = 0x0035, MGMT_PERMIT_JOINING_CLID = 0x0036,
  MGMT_CACHE_CLID = 0x0037, MGMT_NWK_UPDATE_CLID = 0x0038
}
 The ZDP clusters ID list. More...
enum  AddrMode_t { SHORT_ADDR_MODE, EXT_ADDR_MODE }
enum  ZDO_NwkStatus_t { ZDO_IN_NETWORK_STATUS, ZDO_OUT_NETWORK_STATUS }
 List of network status. More...

Functions

void ZDO_StartNetworkReq (ZDO_StartNetworkReq_t *startingParams)
 Starts network for coordinator and joins the network for router.
void ZDO_ResetNetworkReq (ZDO_ResetNetworkReq_t *resetParams)
 Resets the stack without any commands to the network.
void ZDO_MgmtNwkUpdateNotf (ZDO_MgmtNwkUpdateNotf_t *nwkParams)
 Indicates about network parameters update.
void ZDO_SleepReq (ZDO_SleepReq_t *req)
 Puts the device to sleep mode.
void ZDO_SleepInd (void)
 Indicates to an application that the stack is ready to sleep.
void ZDO_SleepResp (void)
 Responds to the stack that an application is ready to sleep.
void ZDO_WakeUpInd (void)
 Indicates to an application that the stack sleep timer has fired.
void ZDO_WakeUpReq (ZDO_WakeUpReq_t *req)
 Forces the stack to wake up from the sleep mode.
void ZDO_ZdpReq (ZDO_ZdpReq_t *zdpReq)
void ZDO_GetLqiRssi (ZDO_GetLqiRssi_t *lqiRssi)
 Request of LQI and RSSI.
void ZDO_GetParentAddr (NodeAddr_t *parentAddr)
 Request of parent information.
void ZDO_GetChildrenAddr (ZDO_GetChildrenAddr_t *childrenAddr)
 Request of children information.
void ZDO_SetTxPowerReq (ZDO_SetTxPowerReq_t *req)
 Setting of tx power.
ZDO_NwkStatus_t ZDO_GetNwkStatus ()
 Gets network status.

Detailed Description

The header file describes the public ZDO interface.

The file describes the public interface and types of ZDO

Definition in file zdo.h.

Enumeration Type Documentation

anonymous enum

Enumerator:
SINGLE_RESPONSE_REQUESTTYPE 
EXTENDED_RESPONSE_REQUESTTYPE 

Definition at line 104 of file zdo.h.

enum AddrMode_t

Enumerator:
SHORT_ADDR_MODE 
EXT_ADDR_MODE 

Definition at line 164 of file zdo.h.

enum NetLostReason_t

Enumerator:
LEAVED_BY_PARENT 
LINK_FAIL 
LEAVE_REQ 

Definition at line 39 of file zdo.h.

enum ZDO_NwkStatus_t

List of network status.

Enumerator:
ZDO_IN_NETWORK_STATUS  device is in network
ZDO_OUT_NETWORK_STATUS  device is out of network

Definition at line 593 of file zdo.h.

enum ZDO_Status_t

ZDO result status primitives.

Enumerator:
ZDO_SUCCESS_STATUS  The primitive has finished successfully.
ZDO_INVALID_PARAMETERS_STATUS  Wrong parameters were put into primitive.
ZDO_NOT_PERMITTED_STATUS  Calling a primitive is not permited.
ZDO_BUSY_STATUS  ZDO layer is busy and cannot execute primitive.
ZDO_NO_NETWORKS_STATUS  No network was found.
ZDO_EXTPANID_ALREADY_EXIST_STATUS  There is a network with the same extended PANID.
ZDO_FAIL_STATUS  Unknown error.
ZDO_AUTHENTICATION_SUCCESS_STATUS 
ZDO_AUTHENTICATION_FAIL_STATUS 
ZDO_SECURITY_SUCCESS_STATUS 
ZDO_SECURITY_FAIL_STATUS 
ZDO_SECURITY_NOT_SUPPORTED_STATUS 
ZDO_CMD_COMPLETED_STATUS 
ZDO_INVALID_REQUEST_STATUS  ZDP request is invalid.
ZDO_DEVICE_NOT_FOUND_STATUS  The requested device has not been found.
ZDO_INVALID_EP_STATUS  Unsupported endpoint of 0x00 or between 0xF1 and 0xFF was requested.
ZDO_NOT_ACTIVE_STATUS  The requested endpoint has not been registered.
ZDO_NOT_SUPPORTED_STATUS  The requested optional feature is not supported.
ZDO_TIMEOUT_STATUS  A timeout has occured during the requested operation.
ZDO_NO_MATCH_STATUS  The end device bind request was unsuccessful due to a failure to match any suitable clusters.
ZDO_NO_ENTRY_STATUS  Unbind request was unsuccessful.
ZDO_NO_DESCRIPTOR_STATUS  A child descriptor was not available.
ZDO_INSUFFICIENT_SPACE_STATUS  The device does not have enough storage space.
ZDO_RESPONSE_WAIT_TIMEOUT_STATUS 
ZDO_TABLE_FULL_STATUS  The device does not have enough table space.
ZDO_NOT_AUTHORIZED_STATUS  The request is not authorized from this device.
ZDO_NWK_UPDATE_STATUS  Network parameters has been updated.
ZDO_NETWORK_STARTED_STATUS 
ZDO_NETWORK_LOST_STATUS 
ZDO_REJOIN_STARTED_STATUS 
ZDO_NETWORK_LEFT_STATUS 

Definition at line 49 of file zdo.h.

enum ZDO_ZdpClusterId_t

The ZDP clusters ID list.

The ZDP cluster ID determines the type of ZDP request/confirm

Enumerator:
NWK_ADDR_CLID 
IEEE_ADDR_CLID 
NODE_DESCRIPTOR_CLID 
POWER_DESCRIPTOR_CLID 
SIMPLE_DESCRIPTOR_CLID 
ACTIVE_ENDPOINTS_CLID 
MATCH_DESCRIPTOR_CLID 
COMPLEX_DESCRIPTOR_CLID 
USER_DESCRIPTOR_CLID 
DISCOVERY_CASH_CLID 
DEVICE_ANNCE_CLID 
USER_DESC_CONF_CLID 
SYSTEM_SERVER_DISCOVERY_CLID 
DISCOVERY_STORE_CLID 
NODE_DESC_STORE_CLID 
POWER_DESC_STORE_CLID 
ACTIVE_EP_STORE_CLID 
SIMPLE_DESC_STORE_CLID 
REMOVE_NODE_CACHE_CLID 
FIND_NODE_CACHE_CLID 
EXTENDED_SIMPLE_DESC_CLID 
EXTENDED_ACTIVE_EP_CLID 
END_DEVICE_BIND_CLID 
BIND_CLID 
UNBIND_CLID 
BIND_REGISTER_CLID 
REPLACE_DEVICE_CLID 
STORE_BCKUP_BIND_ENTRY_CLID 
REMOVE_BCKUP_BIND_ENTRY_CLID 
BACKUP_BIND_TABLE_CLID 
RECOVER_BIND_TABLE_CLID 
BACKUP_SOURCE_BIND_CLID 
RECOVER_SOURCE_BIND_CLID 
MGMT_NWK_DISC_CLID 
MGMT_LQI_CLID 
MGMT_RTG_CLID 
MGMT_BIND_CLID 
MGMT_LEAVE_CLID 
MGMT_DIRECT_JOIN_CLID 
MGMT_PERMIT_JOINING_CLID 
MGMT_CACHE_CLID 
MGMT_NWK_UPDATE_CLID 

Definition at line 115 of file zdo.h.

Function Documentation

void ZDO_GetChildrenAddr ( ZDO_GetChildrenAddr_t *  childrenAddr  ) 

Request of children information.

This function requests children information of the node.

Parameters:
[in] req - Determines the parameters of the request.

void ZDO_GetLqiRssi ( ZDO_GetLqiRssi_t *  lqiRssi  ) 

Request of LQI and RSSI.

This function requests LQI and RSSI of an remote node.

Parameters:
[in] req - Determines the parameters of the request.

ZDO_NwkStatus_t ZDO_GetNwkStatus (  ) 

Gets network status.

This function returns network status.

Returns:
- network status

void ZDO_GetParentAddr ( NodeAddr_t *  parentAddr  ) 

Request of parent information.

This function requests parent information of the node.

Parameters:
[in] req - Determines the parameters of the request.

void ZDO_MgmtNwkUpdateNotf ( ZDO_MgmtNwkUpdateNotf_t *  nwkParams  ) 

Indicates about network parameters update.

The function should be defined by an application. It is called when the device has resolved address/panid conflict or rejoined the network

Parameters:
[out] nwkUpdateParams - Describes the reason of network update and new parameters.

void ZDO_ResetNetworkReq ( ZDO_ResetNetworkReq_t *  resetParams  ) 

Resets the stack without any commands to the network.

This function resets the stack to default state. No data is send to the network.

Parameters:
[in] resetParams - Determines the parameters of the request

void ZDO_SetTxPowerReq ( ZDO_SetTxPowerReq_t *  req  ) 

Setting of tx power.

This function sets tx power.

Parameters:
[in] req - Determines the parameters of the request.

void ZDO_SleepInd ( void   ) 

Indicates to an application that the stack is ready to sleep.

After this function the stack is waiting for response. An application should stop and close all HW activities, sending data and commands to the stack and wait all confirmations from the stack, after which the application should call ZDO_SleepResp.

void ZDO_SleepReq ( ZDO_SleepReq_t *  req  ) 

Puts the device to sleep mode.

This function can be used only when the active period in Config Server is set to 0. The time of sleep period is determined by CS_END_DEVICE_SLEEP_PERIOD in Config Server.

Parameters:
[in] sleepParams - Determines the sleep parameters.

void ZDO_SleepResp ( void   ) 

Responds to the stack that an application is ready to sleep.

The function should be called in response to ZDO_SleepInd. It can be called only after stopping all HW and stack activities. On receiving this function call, stack goes to sleep mode.

void ZDO_StartNetworkReq ( ZDO_StartNetworkReq_t *  startingParams  ) 

Starts network for coordinator and joins the network for router.

This function forms a network for coordinator and joins an existing network for router or end device.

Parameters:
[in] startingParams - Determines the network parameters for join and formation

void ZDO_WakeUpInd ( void   ) 

Indicates to an application that the stack sleep timer has fired.

If the stack is in sleep mode, it wakes up and is ready to work. Application can continue its activities.

void ZDO_WakeUpReq ( ZDO_WakeUpReq_t *  req  ) 

Forces the stack to wake up from the sleep mode.

This function is used by an application when the sleep timer is not used and an application is woken up from sleep mode by an external interrupt.

Parameters:
[in] wakeUpParams - Determines the parameters of the wakeup request

void ZDO_ZdpReq ( ZDO_ZdpReq_t *  zdpReq  ) 

Generated on Wed Apr 9 17:48:41 2008 for ZigBeeNet Stack Documentation by  doxygen 1.5.1-p1