zdo.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  NodeAddr_t
 Information about the addresses of a device. More...
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
 This information is provided to enable ZigBee devices to report the condition on local channels to a network manager. The scanned channel list is the report of channels scanned and it is followed by a list of records, one for each channel scanned, each record including one byte of the energy level measured during the scan, or 0xff if there is too much interference on this channel. More...
struct  NetworkInf_t
 This information is provided to inform an application about new network parameters if a device rejoined a network. More...
struct  ZDO_MgmtNwkUpdateNotf_t
 This information is provided to notify application about network events. More...
struct  ZDO_MgmtLqiResp_t
 Desribes the parameters of the LQI response. More...
struct  ZDO_MgmtLqiReq_t
 Desribes the parameters of the LQI request. More...
struct  ZDO_SleepConf_t
 Desribes the parameters of the ZDO_SleepConf() function. More...
struct  ZDO_SleepReq_t
 Describes the parameters of the ZDO_SleepReq() function. More...
struct  ZDO_WakeUpConf_t
 Describes the parameters of the ZDO_WakeUp() function. More...
struct  ZDO_WakeUpReq_t
 Describes the parameters of the ZDO_SleepReq() function. More...
struct  ZDO_NwkAddrReq_t
 This request is generated from a Local Device wishing to inquire as to the 16-bit address of the Remote Device based on its known IEEE address. The destination addressing on this command shall be unicast or broadcast to all devices for which macRxOnWhenIdle = TRUE. More...
struct  ZDO_IeeeAddrReq_t
 This request is generated from a Local Device wishing to inquire as to the 64-bit IEEE address of the Remote Device based on their known 16-bit address. The destination addressing on this command shall be unicast. More...
struct  ZDO_NodeDescReq_t
 This request is generated from a local device wishing to inquire as to the node descriptor of a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_PowerDescReq_t
 This request is generated from a local device wishing to inquire as to the power descriptor of a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_ActiveEPReq_t
 This request is generated from a local device wishing to acquire the list of endpoints on a remote device with simple descriptors. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_ComplexDescReq_t
 This request is generated from a local device wishing to inquire as to the complex descriptor of a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_UserDescReq_t
 This request is generated from a local device wishing to inquire as to the user descriptor of a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_UserDescSetReq_t
 This is generated from a local device wishing to configure the user descriptor on a remote device. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_SimpleDescReq_t
 This request is generated from a local device wishing to inquire as to the simple descriptor of a remote device on a specified endpoint. This command shall be unicast either to the remote device itself or to an alternative device that contains the discovery information of the remote device. More...
struct  ZDO_DeviceAnnceReq_t
 This request is provided to enable ZigBee devices on the network to notify other ZigBee devices that the device has joined or re-joined the network, identifying the devices 64-bit IEEE address and new 16-bit NWK address, and informing the Remote Devices of the capability of the ZigBee device. This command shall be invoked for all ZigBee end devices upon join or rejoin. This command may also be invoked by ZigBee routers upon join or rejoin as part of NWK address conflict resolution. The destination addressing on this primitive is broadcast to all devices for which macRxOnWhenIdle = TRUE. More...
struct  ZDO_SystemServerDiscoveryReq_t
 This request is generated from a Local Device wishing to discover the location of a particular system server or servers as indicated by the ServerMask parameter. The destination addressing on this request is broadcast to all devices for which macRxOnWhenIdle = TRUE. More...
struct  ZDO_MgmtLeaveReq_t
 This request is generated from a Local Device requesting that a Remote Device leave the network or to request that another device leave the network. The Mgmt_Leave_req is generated by a management application which directs the request to a Remote Device where the NLME-LEAVE.request is to be executed using the parameter supplied by Mgmt_Leave_req. More...
struct  ZDO_MgmtPermitJoiningReq_t
 This request is generated from a Local Device requesting that a remote device or devices allow or disallow association. More...
struct  ZDO_MgmtNwkUpdateReq_t
 This command is provided to allow updating of network configuration parameters or to request information from devices on network conditions in the local operating environment. The destination addressing on this primitive shall be unicast or broadcast to all devices for which macRxOnWhenIdle = TRUE. More...
struct  ZDO_NwkAddrResp_t
 This command is generated by a Remote Device in response to a NWK_addr_req command inquiring as to the NWK address of the Remote Device or the NWK address of an address held in a local discovery cache. The destination addressing on this command is unicast. More...
struct  ZDO_IeeeAddrResp_t
 This command is generated by a Remote Device in response to an IEEE_addr_req command inquiring as to the 64-bit IEEE address of the Remote Device or the 64-bit IEEE address of an address held in a local discovery cache. The destination addressing on this command shall be unicast. More...
struct  ZDO_NodeDescResp_t
 This command is generated by a remote device in response to a Node_Desc_req directed to the remote device. This command shall be unicast to the originator of the Node_Desc_req command. More...
struct  ZDO_PowerDescResp_t
 This command is generated by a remote device in response to a Power_Desc_req directed to the remote device. This command shall be unicast to the originator of the Power_Desc_req command. More...
struct  ZDO_ComplexDescResp_t
 This command is generated by a remote device in response to a Complex_Desc_req directed to the remote device. This command shall be unicast to the originator of the Complex_Desc_req command. More...
struct  ZDO_UserDescResp_t
 The User_Desc_rsp is generated by a remote device in response to a User_Desc_req directed to the remote device. This command shall be unicast to the originator of the User_Desc_req command. More...
struct  ZDO_UserDescConfResp_t
 This command is generated by a remote device in response to a User_Desc_set directed to the remote device. This command shall be unicast to the originator of the User_Desc_set command. More...
struct  ZDO_ActiveEPResp_t
 This command is generated by a remote device in response to an Active_EP_req directed to the remote device. This command shall be unicast to the originator of the Active_EP_req command. More...
struct  ZdpSimpleDescriptor_t
 The simple descriptor contains information specific to each endpoint contained in this node. The simple descriptor is mandatory for each endpoint present in the node. More...
struct  ZDO_SimpleDescResp_t
 This command is generated by a remote device in response to a Simple_Desc_req directed to the remote device. This command shall be unicast to the originator of the Simple_Desc_req command. More...
struct  ZDO_SystemServerDiscoveryResp_t
 This command is generated from Remote Devices on receipt of a System_Server_Discovery_req primitive if the parameter matches the Server Mask field in its node descriptor. If there is no match, the System_Server_Discovery_req shall be ignored and no response given. Matching is performed by masking the ServerMask parameter of the System_Server_Discovery_req with the Server Mask field in the node descriptor. This command shall be unicast to the device which sent System_Server_Discovery_req with Acknowledge request set in TxOptions. The parameter ServerMask contains the bits in the parameter of the request which match the server mask in the node descriptor. More...
struct  ZDO_ZdpRespFrame_t
 This struct contains response to one of the ZDP requests. More...
struct  ZDO_ZdpReqFrame_t
 This struct contains one of the ZDP requests. More...
struct  ZDO_ZdpFrame_t
 Frame for transmission one of the ZDP requests. More...
struct  ZDO_ZdpResp_t
 ZDP response. More...
struct  ZDO_ZdpReq_t
 ZDP request. Describes the parameters of the ZDO_ZdpReq() function. More...
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_GetNeibAmount_t
 Describes the parameters of the ZDO_GetNeibAmount() function. More...
struct  ZDO_Neib_t
 Describes neighbor table entry. More...

Defines

#define ZDO_MGMT_ED_SCAN_DUR_0   0x00
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_ED_SCAN_DUR_1   0x01
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_ED_SCAN_DUR_2   0x02
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_ED_SCAN_DUR_3   0x03
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_ED_SCAN_DUR_4   0x04
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_ED_SCAN_DUR_5   0x05
 Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_CHANNEL_CHANGE   0xFE
 Used as a special value for ZDO_MgmtNwkUpdateReq_t::scanDuration.
#define ZDO_MGMT_NWK_PARAMS_CHANGE   0xFF
 Used as a special value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Enumerations

enum  NetLostReason_t { LEAVED_BY_PARENT, LINK_FAIL, LEAVE_REQ }
 Reasons of device leaving. More...
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_NETWORK_LEFT_STATUS = 0x91, ZDO_CHILD_JOINED_STATUS = 0x92, ZDO_CHILD_REMOVED_STATUS = 0x93,
  ZDO_USER_DESCRIPTOR_UPDATE_STATUS = 0x94, ZDO_STATIC_ADDRESS_CONFLICT_STATUS = 0x95
}
 ZDO result status primitives. More...
enum  { SINGLE_RESPONSE_REQUESTTYPE = 0x00, EXTENDED_RESPONSE_REQUESTTYPE = 0x01 }
 Types of response to address request. More...
enum  {
  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 }
 Possible address modes. More...
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)
 Send ZDP request.
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 the network status.
void ZDO_GetNeibAmount (ZDO_GetNeibAmount_t *amount)
 Gets neighbor routers and children amount.
void ZDO_GetNeibTable (ZDO_Neib_t *table)
 Gets the neighbor table.
ZDO_Status_t ZDO_StartSyncReq (void)
 Start sending sync requests.
ZDO_Status_t ZDO_StopSyncReq (void)
 Stop sending sync requests.


Detailed Description

The header file describes the public ZDO interface and ZDO types.

Author:
Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com
Copyright (c) 2008 , Atmel Corporation. All rights reserved. Licensed under Atmel's Limited License Agreement (BitCloudTM).

Definition in file zdo.h.


Define Documentation

#define ZDO_MGMT_ED_SCAN_DUR_0   0x00

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 201 of file zdo.h.

#define ZDO_MGMT_ED_SCAN_DUR_1   0x01

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 202 of file zdo.h.

#define ZDO_MGMT_ED_SCAN_DUR_2   0x02

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 203 of file zdo.h.

#define ZDO_MGMT_ED_SCAN_DUR_3   0x03

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 204 of file zdo.h.

#define ZDO_MGMT_ED_SCAN_DUR_4   0x04

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 205 of file zdo.h.

#define ZDO_MGMT_ED_SCAN_DUR_5   0x05

Used as a value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 206 of file zdo.h.

#define ZDO_MGMT_CHANNEL_CHANGE   0xFE

Used as a special value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 207 of file zdo.h.

#define ZDO_MGMT_NWK_PARAMS_CHANGE   0xFF

Used as a special value for ZDO_MgmtNwkUpdateReq_t::scanDuration.

Definition at line 208 of file zdo.h.


Enumeration Type Documentation

enum NetLostReason_t

Reasons of device leaving.

Enumerator:
LEAVED_BY_PARENT 
LINK_FAIL 
LEAVE_REQ 

Definition at line 54 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 the primitive.
ZDO_NOT_PERMITTED_STATUS  Calling the primitive is not permitted.
ZDO_BUSY_STATUS  ZDO layer is busy and cannot execute the 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  Requested device was not found.
ZDO_INVALID_EP_STATUS  Unsupported endpoint of 0x00 or between 0xF1 and 0xFF was requested.
ZDO_NOT_ACTIVE_STATUS  Requested endpoint has not been registered.
ZDO_NOT_SUPPORTED_STATUS  Requested optional feature is not supported.
ZDO_TIMEOUT_STATUS  Timeout occured during the requested operation.
ZDO_NO_MATCH_STATUS  End device bind request is unsuccessful due to a failure to match any suitable clusters.
ZDO_NO_ENTRY_STATUS  Unbind request is unsuccessful.
ZDO_NO_DESCRIPTOR_STATUS  Child descriptor is not available.
ZDO_INSUFFICIENT_SPACE_STATUS  Device does not have enough storage space.
ZDO_RESPONSE_WAIT_TIMEOUT_STATUS 
ZDO_TABLE_FULL_STATUS  Device does not have enough table space.
ZDO_NOT_AUTHORIZED_STATUS  Request is not authorized from this device.
ZDO_NWK_UPDATE_STATUS  Network parameters have been updated (channel, PanId, shortAddr...).
ZDO_NETWORK_STARTED_STATUS  Device has joined/rejoined a network and data can be transmitted.
ZDO_NETWORK_LOST_STATUS  Device has lost connection with a parent and the stack tries rejoin by itself. In this case transmission should be stopped.
ZDO_NETWORK_LEFT_STATUS  Device has left a network. If autonetwork option is on, the stack will rejoin a network. Otherwise, an application should rejoin.
ZDO_CHILD_JOINED_STATUS  New device has joined a network as a child of this device.
ZDO_CHILD_REMOVED_STATUS  Child has been removed from children list.
ZDO_USER_DESCRIPTOR_UPDATE_STATUS  User descriptor is changed event.
ZDO_STATIC_ADDRESS_CONFLICT_STATUS  On the device with static addressing the conflict of network addresses has been detected.

Definition at line 64 of file zdo.h.

anonymous enum

Types of response to address request.

Enumerator:
SINGLE_RESPONSE_REQUESTTYPE 
EXTENDED_RESPONSE_REQUESTTYPE 

Definition at line 132 of file zdo.h.

anonymous enum

The ZDP clusters ID list.

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

Enumerator:
NWK_ADDR_CLID  Request for the 16-bit address of a remote device based on its known IEEE address.
IEEE_ADDR_CLID  Request for the 64-bit IEEE address of a remote device based on its known 16-bit address.
NODE_DESCRIPTOR_CLID  Request for the node descriptor of a remote device.
POWER_DESCRIPTOR_CLID  Request for the power descriptor of a remote device.
SIMPLE_DESCRIPTOR_CLID  Request for the simple descriptor of a remote device on the specified endpoint.
ACTIVE_ENDPOINTS_CLID  Request for the list of endpoints on a remote device with simple descriptors.
MATCH_DESCRIPTOR_CLID  Request for remote devices supporting a specific simple descriptor match criterion.
COMPLEX_DESCRIPTOR_CLID  Request for the complex descriptor of a remote device.
USER_DESCRIPTOR_CLID  Request for the user descriptor of a remote device.
DISCOVERY_CASH_CLID  Request to locate a Primary Discovery Cache device on the network.
DEVICE_ANNCE_CLID  Request to notify other ZigBee devices on the network that the device has joined or re-joined the network.
USER_DESC_CONF_CLID  Command to configure the user descriptor on a remote device.
SYSTEM_SERVER_DISCOVERY_CLID  Request for the location of a particular system server or servers.
DISCOVERY_STORE_CLID  Request for the storage of the device's discovery cache information on a Primary Discovery Cache device.
NODE_DESC_STORE_CLID  Request for the storage of the device's Node Descriptor on a Primary Discovery Cache device.
POWER_DESC_STORE_CLID  Request for the storage of the device's Descriptor on a Primary Discovery Cache device.
ACTIVE_EP_STORE_CLID  Request for the storage of the device's list of Active Endpoints on a Primary Discovery Cache device.
SIMPLE_DESC_STORE_CLID  Request for the storage of the device's list of Simple Descriptors on a Primary Discovery Cache device.
REMOVE_NODE_CACHE_CLID  Command for removal of discovery cache information for a specified ZigBee end device from a Primary Discovery Cache device.
FIND_NODE_CACHE_CLID  Request for a device on the network that holds discovery information for the device of interest.
EXTENDED_SIMPLE_DESC_CLID  Request for the simple descriptor of a remote device on the specified endpoint, to be used with devices which support more active endpoints than can be returned by a single SIMPLE_DESCRIPTOR_CLID request.
EXTENDED_ACTIVE_EP_CLID  Request for the list of endpoints on a remote device with simple descriptors, to be used with devices which support more active endpoints than can be returned by a single ACTIVE_ENDPOINTS_CLID request.
END_DEVICE_BIND_CLID  Request generated from a Local Device wishing to perform End Device Bind with a Remote Device.
BIND_CLID  Request generated from a Local Device wishing to create a Binding Table entry for the source and destination addresses contained as parameters.
UNBIND_CLID  Request generated from a Local Device wishing to remove a Binding Table entry for the source and destination addresses contained as parameters.
BIND_REGISTER_CLID  Request generated from a Local Device and sent to a primary binding table cache device to register that the local device wishes to hold its own binding table entries.
REPLACE_DEVICE_CLID  Request sent to a primary binding table cache device to change all binding table entries which match OldAddress and OldEndpoint as specified.
STORE_BCKUP_BIND_ENTRY_CLID  Request generated from a local primary binding table cache and sent to a remote backup binding table cache device to request backup storage of the entry.
REMOVE_BCKUP_BIND_ENTRY_CLID  Request generated from a local primary binding table cache and sent to a remote backup binding table cache device to request removal of the entry from backup storage.
BACKUP_BIND_TABLE_CLID  Request generated from a local primary binding table cache and sent to the remote backup binding table cache device to request backup storage of its entire binding table.
RECOVER_BIND_TABLE_CLID  Request generated from a local primary binding table cache and sent to a remote backup binding table cache device when it wants a complete restore of the binding table.
BACKUP_SOURCE_BIND_CLID  Request generated from a local primary binding table cache and sent to a remote backup binding table cache device to request backup storage of its entire source table.
RECOVER_SOURCE_BIND_CLID  Request generated from a local primary binding table cache and sent to the remote backup binding table cache device when it wants a complete restore of the source binding table.
MGMT_NWK_DISC_CLID  Request generated from a Local Device requesting that the Remote Device execute a Scan to report back networks in the vicinity of the Local Device.
MGMT_LQI_CLID  Request generated from a Local Device wishing to obtain a neighbor list for the Remote Device along with associated LQI values to each neighbor.
MGMT_RTG_CLID  Request generated from a Local Device wishing to retrieve the contents of the Routing Table from the Remote Device.
MGMT_BIND_CLID  Request generated from a Local Device wishing to retrieve the contents of the Binding Table from the Remote Device.
MGMT_LEAVE_CLID  Request generated from a Local Device requesting that a Remote Device leave the network or to request that another device leave the network.
MGMT_DIRECT_JOIN_CLID  Request generated from a Local Device requesting that a Remote Device permit a device designated by DeviceAddress to join the network directly.
MGMT_PERMIT_JOINING_CLID  Request generated from a Local Device requesting that a remote device or devices allow or disallow association.
MGMT_CACHE_CLID  Request The Mgmt_Cache_req is provided to enable ZigBee devices on the network to retrieve a list of ZigBee End Devices registered with a Primary Discovery Cache device.
MGMT_NWK_UPDATE_CLID  Command provided to allow updating of network configuration parameters or to request information from devices on network conditions in the local operating environment.

Definition at line 143 of file zdo.h.

enum AddrMode_t

Possible address modes.

Enumerator:
SHORT_ADDR_MODE  Short address.
EXT_ADDR_MODE  Extended address.

Definition at line 195 of file zdo.h.

enum ZDO_NwkStatus_t

List of network status.

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

Definition at line 1037 of file zdo.h.


Function Documentation

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_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_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] nwkParams - Describes the reason of network update and new parameters.

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] req - Determines the sleep parameters.

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_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_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] req - Determines the parameters of the wakeup request

void ZDO_ZdpReq ( ZDO_ZdpReq_t zdpReq  ) 

Send ZDP request.

This function is used by an application to send ZDP request.

Parameters:
[in] zdpReq - Determines the parameters of the ZDP request

void ZDO_GetLqiRssi ( ZDO_GetLqiRssi_t lqiRssi  ) 

Request of LQI and RSSI.

This function requests LQI and RSSI for a remote node whose address is contained in ZDO_GetLqiRssi_t::nodeAddr. If called for an unknown node (i.e. with no link established to it), will return zeros.

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

void ZDO_GetParentAddr ( NodeAddr_t parentAddr  ) 

Request of parent information.

This function requests parent information of the node.

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

void ZDO_GetChildrenAddr ( ZDO_GetChildrenAddr_t childrenAddr  ) 

Request of children information.

This function requests children information of the node.

Parameters:
[in] childrenAddr - 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.

ZDO_NwkStatus_t ZDO_GetNwkStatus (  ) 

Gets the network status.

This function returns network status.

Returns:
- network status

void ZDO_GetNeibAmount ( ZDO_GetNeibAmount_t amount  ) 

Gets neighbor routers and children amount.

Parameters:
[out] amount - routers and children amount information

void ZDO_GetNeibTable ( ZDO_Neib_t table  ) 

Gets the neighbor table.

Parameters:
[out] table - neighbor table

ZDO_Status_t ZDO_StartSyncReq ( void   ) 

Start sending sync requests.

Returns:
- ZDO status. The primitive returns one of following values:
  • ZDO_SUCCESS_STATUS
  • ZDO_BUSY_STATUS

ZDO_Status_t ZDO_StopSyncReq ( void   ) 

Stop sending sync requests.

Returns:
- ZDO status. The primitive returns one of following values:
  • ZDO_SUCCESS_STATUS
  • ZDO_INVALID_REQUEST_STATUS


Generated on Mon Feb 16 17:53:40 2009 for BitCloud Stack Documentation by  doxygen 1.5.1-p1