BitCloud Stack Documentation Data Structures

Here are the data structures with brief descriptions:
APS_AddGroupConf_tParameters structure of the APS_AddGroupConf() function. The APSME-ADD-GROUP.confirm primitive
APS_AddGroupReq_tParameters structure of the APS_AddGroupReq() function. The APSME-ADD-GROUP.request primitive
APS_Address_tCommon APS Address type
APS_AibAttribute_tTypes of parameters which can be set to the APS AIB
APS_AibPermissionsConfiguration_tAPS SubLayer Constants
APS_DataConf_tParameters structure of the APS_DataReq_t::APS_DataConf() function. The APSDE-DATA.confirm primitive
APS_DataInd_tParameters structure of the APS_RegisterEndpointReq_t::APS_DataInd() function The function is determined by certain End Point. The APSDE-DATA.indication primitive
APS_DataReq_tParameters structure of the APS_DataReq() function. The APSDE-DATA.request primitive
APS_GetConf_tParameters structure of the APS_GetConf() function. The APSME-GET.confirm primitive
APS_GetReq_tParameters structure of the APS_GetReq() function. The APSME-GET.request primitive
APS_RegisterEndpointReq_tParameters structure of the APS_RegisterEndpointReq() function. APSME-REGISTER-ENDPOINT.request primitive
APS_RemoveAllGroupsConf_tParameters structure of the APS_RemoveAllGroupsConf() function. The APSME-REMOVE-ALL-GROUPS.confirm primitive
APS_RemoveAllGroupsReq_tParameters structure of the APS_RemoveAllGroupsReq() function. The APSME-REMOVE-ALL-GROUPS.request primitive
APS_RemoveGroupConf_tParameters structure of the APS_RemoveGroupConf() function. The APSME-REMOVE-GROUP.confirm primitive
APS_RemoveGroupReq_tParameters structure of the APS_RemoveGroupReq() function. The APSME-REMOVE-GROUP.request primitive
APS_SetConf_tParameters structure of the APS_SetConf() function The APSME-SET.confirm primitive
APS_SetReq_tParameters structure of the APS_SetReq() function The APSME-SET.request primitive
APS_TxOptions_tDescribes the options of data transmission
APS_UnregisterEndpointReq_tParameters structure of the APS_UnregisterEndpointReq() function. APSME-UNREGISTER-ENDPOINT.request primitive
ComplexDescriptor_tComplex Descriptor
ComplexDescriptorField_tComplex Descriptor field
EDScan_tThis 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
HAL_AdcParams_tAdc structure of parameters
HAL_EepromParams_tEeprom access control structure
HAL_i2cMode_tI2c baud rate TWI clock rate
HAL_I2cParams_tI2c access control structure
HAL_UartDescriptor_tUart descriptor
HAL_UsbEndPointDescptr_t
MacCapabilityFlags_tMAC capability flags
NetworkInf_tThis information is provided to inform an application about new network parameters if a device rejoined a network
NodeAddr_tInformation about the addresses of a device
NodeDescriptor_tNode descriptor
PowerDescriptor_tPower descriptor
SimpleDescriptor_tSimple Descriptor
UserDescriptor_tUser descriptor
ZDO_ActiveEPReq_tThis 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
ZDO_ActiveEPResp_tThis 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
ZDO_ComplexDescReq_tThis 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
ZDO_ComplexDescResp_tThis 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
ZDO_DeviceAnnceReq_tThis 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
ZDO_GetChildrenAddr_tDescribes the parameters of the ZDO_ChildrenAddrReq() function
ZDO_GetLqiRssi_tDescribes the parameters of the ZDO_LqiRssiReq() function
ZDO_GetNeibAmount_tDescribes the parameters of the ZDO_GetNeibAmount() function
ZDO_IeeeAddrReq_tThis 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
ZDO_IeeeAddrResp_tThis 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
ZDO_MgmtLeaveReq_tThis 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
ZDO_MgmtLqiReq_tDesribes the parameters of the LQI request
ZDO_MgmtLqiResp_tDesribes the parameters of the LQI response
ZDO_MgmtNwkUpdateNotf_tThis information is provided to notify application about network events
ZDO_MgmtNwkUpdateReq_tThis 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
ZDO_MgmtPermitJoiningReq_tThis request is generated from a Local Device requesting that a remote device or devices allow or disallow association
ZDO_Neib_tDescribes neighbor table entry
ZDO_NodeDescReq_tThis 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
ZDO_NodeDescResp_tThis 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
ZDO_NwkAddrReq_tThis 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
ZDO_NwkAddrResp_tThis 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
ZDO_PowerDescReq_tThis 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
ZDO_PowerDescResp_tThis 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
ZDO_ResetNetworkConf_tDesribes the parameters of the ZDO_ResetNetworkConf() function
ZDO_ResetNetworkReq_tDescribes the parameters of the ZDO_ResetNetworkReq() function
ZDO_SetTxPowerConf_tDescribes the parameters of the ZDO_SetTxPowerConf() function
ZDO_SetTxPowerReq_tDescribes the parameters of the ZDO_SetTxPowerReq() function
ZDO_SimpleDescReq_tThis 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
ZDO_SimpleDescResp_tThis 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
ZDO_SleepConf_tDesribes the parameters of the ZDO_SleepConf() function
ZDO_SleepReq_tDescribes the parameters of the ZDO_SleepReq() function
ZDO_StartNetworkConf_tDescribes the parameters of the ZDO_StartNetworkConf() function
ZDO_StartNetworkReq_tDescribes the parameters of the ZDO_StartNetworkReq() function
ZDO_SystemServerDiscoveryReq_tThis 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
ZDO_SystemServerDiscoveryResp_tThis 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
ZDO_UserDescConfResp_tThis 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
ZDO_UserDescReq_tThis 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
ZDO_UserDescResp_tThe 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
ZDO_UserDescSetReq_tThis 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
ZDO_WakeUpConf_tDescribes the parameters of the ZDO_WakeUp() function
ZDO_WakeUpReq_tDescribes the parameters of the ZDO_SleepReq() function
ZDO_ZdpFrame_tFrame for transmission one of the ZDP requests
ZDO_ZdpReq_tZDP request. Describes the parameters of the ZDO_ZdpReq() function
ZDO_ZdpReqFrame_tThis struct contains one of the ZDP requests
ZDO_ZdpResp_tZDP response
ZDO_ZdpRespFrame_tThis struct contains response to one of the ZDP requests
ZdpSimpleDescriptor_tThe simple descriptor contains information specific to each endpoint contained in this node. The simple descriptor is mandatory for each endpoint present in the node

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