Detailed Description

ZStack C interface implementation on top of dispatcher messaging interface.

#include <string.h>
#include <ti/sysbios/knl/Task.h>
#include "ti_zstack_config.h"
#include "rom_jt_154.h"
#include "zstackapi.h"

Data Structures
struct	_genericreqrsp_t

Typedefs
typedef struct _genericreqrsp_t	GenericReqRsp_t

Functions
void	Zstackapi_init (uint8_t stackTaskId)

zstack_ZStatusValues	Zstackapi_sysResetReq (uint8_t appServiceTaskId, zstack_sysResetReq_t *pReq)
	Call to send a System Reset Request to the ZStack Thread. More...

zstack_ZStatusValues	Zstackapi_sysVersionReq (uint8_t appServiceTaskId, zstack_sysVersionRsp_t *pRsp)
	Call to send a System Version Request to the stack task Returns the core ZStack version (major, minor, maintenance). More...

zstack_ZStatusValues	Zstackapi_sysConfigReadReq (uint8_t appServiceTaskId, zstack_sysConfigReadReq_t pReq, zstack_sysConfigReadRsp_t pRsp)
	Call to send a System Config Read Request to the stack task Setup pReq (zstack_sysConfigReadReq_t) with the parameters that you would like to read (you can set one or many), call this function, pRsp (zstack_sysConfigReadRsp_t) will have the requested parameters if the return value is zstack_ZStatusValues_ZSuccess. More...

zstack_ZStatusValues	Zstackapi_sysConfigWriteReq (uint8_t appServiceTaskId, zstack_sysConfigWriteReq_t *pReq)
	Call to send a System Config Write Request to the stack task contains all the parameters that an application can change. You can set as many parameters as you like, one, two, ten or all, in the request structure, with one API call. Each of the parameters has a "has_" field that must be set to true, along with the parameter data, for the field to be used by the ZStack thread. More...

zstack_ZStatusValues	Zstackapi_sysSetTxPowerReq (uint8_t appServiceTaskId, zstack_sysSetTxPowerReq_t pReq, zstack_sysSetTxPowerRsp_t pRsp)
	Call to send a System Set TX Power Request to the stack task. More...

zstack_ZStatusValues	Zstackapi_sysForceLinkStatusReq (uint8_t appServiceTaskId)
	Call to send a System Force Link Status Request. Calling this function forces a Link Status to be sent, but it doesn't interrupt the normal Link Status cycle. More...

zstack_ZStatusValues	Zstackapi_sysNwkInfoReadReq (uint8_t appServiceTaskId, zstack_sysNwkInfoReadRsp_t *pRsp)
	Call to send a System Network Information Read Request. After calling this function, pRsp will contain the device's network parameters if the return value is zstack_ZStatusValues_ZSuccess. More...

zstack_ZStatusValues	Zstackapi_DevStartReq (uint8_t appServiceTaskId, zstack_devStartReq_t *pReq)
	Call to send a Device Start Request to the stack task start the device in the network. All of the network paramters [Zstackapi_sysConfigWriteReq()] must be set before calling this function. More...

zstack_ZStatusValues	Zstackapi_DevNwkDiscReq (uint8_t appServiceTaskId, zstack_devNwkDiscReq_t *pReq)
	Call to send a Device Network Discovery Request. More...

zstack_ZStatusValues	Zstackapi_SetNwkFrameFwdNotificationReq (uint8_t appServiceTaskId, zstack_setNwkFrameFwdNotificationReq_t *pReq)
	Call to send a Set Network Frame Forward Notification Request. More...

zstack_ZStatusValues	Zstackapi_DevJoinReq (uint8_t appServiceTaskId, zstack_devJoinReq_t *pReq)
	Call to send a Device Join Request, Use this function call to join a specific device in the manual joining process, don't call this if you are using the ZStack Thread's automatic joining process. Also, make sure to request a Join Confirm, by setting the has_joinCnfCB and joinCnfCB fields to true in zstack_devZDOCBReq_t can call Zstackapi_DevZDOCBReq(), to know when the join process is done. More...

zstack_ZStatusValues	Zstackapi_DevRejoinReq (uint8_t appServiceTaskId, zstack_devRejoinReq_t *pReq)
	Call to send a Device Rejoin Request. More...

zstack_ZStatusValues	Zstackapi_DevZDOCBReq (uint8_t appServiceTaskId, zstack_devZDOCBReq_t *pReq)
	Call to send a Device ZDO Callback Request The zstack_devZDOCBReq_t contains all the callbacks/indications that an application can subscribe to. You can set as many callback/indications as you like, one, two, ten or all, in the request structure, with one API call. Each of the parameters has a "has_" field that must be set to true, along with the parameter data, for the field to be used by the ZStack thread. More...

zstack_ZStatusValues	Zstackapi_DevNwkRouteReq (uint8_t appServiceTaskId, zstack_devNwkRouteReq_t *pReq)
	Call to send a Device Network Route Request Use this command to force a Route Request. More...

zstack_ZStatusValues	Zstackapi_DevNwkCheckRouteReq (uint8_t appServiceTaskId, zstack_devNwkCheckRouteReq_t *pReq)
	Call to send a Device Network Check Request, Use this command to check if a route is active or not. More...

zstack_ZStatusValues	Zstackapi_DevUpdateNeighborTxCostReq (uint8_t appServiceTaskId, zstack_devUpdateNeighborTxCostReq_t *pReq)
	Call to send a Device Update Neighbor's TxCost Request, Use this command to change a neighbor's TX Cost value. This command is only available in a router or coordinator. More...

zstack_ZStatusValues	Zstackapi_DevForceNetworkSettingsReq (uint8_t appServiceTaskId, zstack_devForceNetworkSettingsReq_t *pReq)
	Call to send a Device Force Network Settings Request, DON'T USE this function unless you know exactly what you are doing and can live the unpredictable consequences. When this message is received, the ZStack thread will force the values in the NIB then save the NIB. It would be better to let the ZStack thread set these items as they are determined. More...

zstack_ZStatusValues	Zstackapi_DevForceNetworkUpdateReq (uint8_t appServiceTaskId, zstack_devForceNetworkUpdateReq_t *pReq)
	Call to send a Device Force Network Update Request, DON'T USE this function unless you know exactly what you are doing and can live the unpredictable consequences. When this message is received, the ZStack thread will force the values in the NIB then save the NIB. It would be better to let the ZStack thread set these items as they are determined. More...

zstack_ZStatusValues	Zstackapi_DevForceMacParamsReq (uint8_t appServiceTaskId, zstack_devForceMacParamsReq_t *pReq)
	Call to send a Device Force MAC Parameters Request, DON'T USE this function unless you know exactly what you are doing and can live the unpredictable consequences. When this message is received, the ZStack thread will force the values in the MAC. It would be better to let the ZStack thread set these items as they are determined. More...

zstack_ZStatusValues	Zstackapi_ApsRemoveGroupReq (uint8_t appServiceTaskId, zstack_apsRemoveGroup_t *pReq)
	Call to send an APS Remove Group Request, Use this command to remove a group from an endpoint. More...

zstack_ZStatusValues	Zstackapi_ApsRemoveAllGroupsReq (uint8_t appServiceTaskId, zstack_apsRemoveAllGroups_t *pReq)
	Call to send an APS Remove All Groups Request, Use this command to remove all groups from an endpoint. More...

zstack_ZStatusValues	Zstackapi_ApsFindAllGroupsReq (uint8_t appServiceTaskId, zstack_apsFindAllGroupsReq_t pReq, zstack_apsFindAllGroupsRsp_t pRsp)
	Call to send an APS Find All Groups Request to the stack task Use this command to return a list of groups that exists for the given endpoint. More...

zstack_ZStatusValues	Zstackapi_ApsFindGroupReq (uint8_t appServiceTaskId, zstack_apsFindGroupReq_t pReq, zstack_apsFindGroupRsp_t pRsp)
	Call to send an APS Find Group Request to the stack task Use this command to return the group information (name) for a given group ID and endpoint. More...

zstack_ZStatusValues	Zstackapi_ApsAddGroupReq (uint8_t appServiceTaskId, zstack_apsAddGroup_t *pReq)
	Call to send an APS Add Group Request, Use this command to add a group to an endpoint. More...

int	Zstackapi_ApsCountAllGroupsReq (uint8_t appServiceTaskId)
	Call to send an APS Count All Groups Request, Use this command to retrieve the number of entries in group table. For example if endpoint 1 and 2 both belong to group 1, then the count will be 2. More...

zstack_ZStatusValues	Zstackapi_AfRegisterReq (uint8_t appServiceTaskId, zstack_afRegisterReq_t *pReq)
	Call to send an AF Register Request, Use this command to register an endpoint descriptor with the ZStack thread. This will allow the application to send and receive data messages. These command is your registry for AF Data Indications. This command must be sent after every boot, this information is NOT saved in the ZStack Thread's non-volitile memory. The simple descriptor, which is part of the endpoint descriptor, is used during device discovery. More...

zstack_ZStatusValues	Zstackapi_AfUnRegisterReq (uint8_t appServiceTaskId, zstack_afUnRegisterReq_t *pReq)
	Call to send an AF Unregister Request, Use this command to remove an endpoint descriptor from the ZStack Threads memory. More...

zstack_ZStatusValues	Zstackapi_AfDataReq (uint8_t appServiceTaskId, zstack_afDataReq_t *pReq)
	Call to send an AF Data Request, Use this command to send over-the-air raw data messages. More...

zstack_ZStatusValues	Zstackapi_AfInterpanCtlReq (uint8_t appServiceTaskId, zstack_afInterPanCtlReq_t *pReq)
	Call to send an AF InterPAN Control Request,. More...

zstack_ZStatusValues	Zstackapi_AfConfigGetReq (uint8_t appServiceTaskId, zstack_afConfigGetReq_t pReq, zstack_afConfigGetRsp_t pRsp)
	Call to send an AF Config Get Request to the stack task Use this command to retrieve the AF fragmentation configuration information for the given endpoint. More...

zstack_ZStatusValues	Zstackapi_AfConfigSetReq (uint8_t appServiceTaskId, zstack_afConfigSetReq_t *pReq)
	Call to send an AF Config Set Request, Use this command to set the AF fragmentation configuration information for the given endpoint. More...

zstack_ZStatusValues	Zstackapi_ZdoNwkAddrReq (uint8_t appServiceTaskId, zstack_zdoNwkAddrReq_t *pReq)
	Call to send a ZDO Network Address Request, Use this command to send an over-the-air Network Address Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_nwkAddrRsp and nwkAddrRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). Calling this function will generate a message to ask for the 16 bit address of the Remote Device based on its known IEEE address. This message is sent as a broadcast message to all devices in the network. More...

zstack_ZStatusValues	Zstackapi_ZdoIeeeAddrReq (uint8_t appServiceTaskId, zstack_zdoIeeeAddrReq_t *pReq)
	Call to send a ZDO IEEE Address Request, Use this command to send an over-the-air IEEE Address Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_ieeeAddrRsp and ieeeAddrRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). Calling this function will generate a message to ask for the 64 bit address of the Remote Device based on its known 16 bit network address. More...

zstack_ZStatusValues	Zstackapi_ZdoNodeDescReq (uint8_t appServiceTaskId, zstack_zdoNodeDescReq_t *pReq)
	Call to send a ZDO Node Descriptor Request, Use this command to send an over-the-air Node Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_nodeDescRsp and nodeDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). This call will build and send a Node Descriptor Request to the Remote Device specified in t he destination address field. You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoPowerDescReq (uint8_t appServiceTaskId, zstack_zdoPowerDescReq_t *pReq)
	Call to send a ZDO Power Descriptor Request, Use this command to send an over-the-air Power Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_powerDescRsp and powerDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoSimpleDescReq (uint8_t appServiceTaskId, zstack_zdoSimpleDescReq_t *pReq)
	Call to send a ZDO Simple Descriptor Request, Use this command to send an over-the-air Simple Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_simpleDescRsp and simpleDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). More...

zstack_ZStatusValues	Zstackapi_ZdoActiveEndpointReq (uint8_t appServiceTaskId, zstack_zdoActiveEndpointReq_t *pReq)
	Call to send a ZDO Active Endpoint Request, Use this command to send an over-the-air Active Endpoint Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_activeEndpointRsp and activeEndpointRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoMatchDescReq (uint8_t appServiceTaskId, zstack_zdoMatchDescReq_t *pReq)
	Call to send a ZDO Match Descriptor Request, Use this command to send an over-the-air Match Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_matchDescRsp and matchDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). More...

zstack_ZStatusValues	Zstackapi_ZdoComplexDescReq (uint8_t appServiceTaskId, zstack_zdoComplexDescReq_t *pReq)
	Call to send a ZDO Complex Descriptor Request, Use this command to send an over-the-air Complex Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_complexDescRsp and complexDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoUserDescReq (uint8_t appServiceTaskId, zstack_zdoUserDescReq_t *pReq)
	Call to send a ZDO User Descriptor Request, Use this command to send an over-the-air User Descriptor Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_userDescRsp and userDescRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoSetBindUnbindAuthAddrReq (uint8_t appServiceTaskId, zstack_zdoSetBindUnbindAuthAddr_t *pReq)
	Call to send a ZDO Set BindUnbind Authentication Request, With this command the application can restrict the permissions to bind/unbinds to a certain cluster to an especific device by setting its IEEE address. More...

zstack_ZStatusValues	Zstackapi_ZdoDeviceAnnounceReq (uint8_t appServiceTaskId, zstack_zdoDeviceAnnounceReq_t *pReq)
	Call to send a ZDO Device Announce Request, Use this command to send an over-the-air Device Announce message. There is no over-the-air response message. This function builds and sends a Device_annce command for Zigbee end device to notify other Zigbee devices on the network that the end device has joined or rejoined the network. The command contains the device's new 16-bit NWK address and its 64-bit IEEE address, as well as the capabilities of the Zigbee device. It is sent out as broadcast message. On receipt of the Device_annce, all receivers shall check all internal references to the IEEE address supplied in the announce, and substitute the corresponding NWK address with the new one. No response will be sent back for Device_annce. More...

zstack_ZStatusValues	Zstackapi_ZdoUserDescSetReq (uint8_t appServiceTaskId, zstack_zdoUserDescSetReq_t *pReq)
	Call to send a ZDO User Descriptor Set Request, Use this command to send an over-the-air User Descriptor Set Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_userDescCnf and userDescCnf fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). You can send this command to this device's address to set the local user descriptor. More...

zstack_ZStatusValues	Zstackapi_ZdoServerDiscReq (uint8_t appServiceTaskId, zstack_zdoServerDiscReq_t *pReq)
	Call to send a ZDO Server Discovery Request, Use this command to send an over-the-air Server Discovery Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_serverDiscoveryRsp and serverDiscoveryRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). The purpose of this request is to discover the locations of a particular system server or servers as indicated by the server mask. The message is broadcast to all device with RxOnWhenIdle. Remote devices will send responses back only if a match bit is found when comparing the received server mask with the mask stored in the local node descriptor, using unicast transmission. You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoEndDeviceBindReq (uint8_t appServiceTaskId, zstack_zdoEndDeviceBindReq_t *pReq)
	Call to send a ZDO End Device Bind Request, Use this command to send an over-the-air End Device Bind Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_endDeviceBindRsp and endDeviceBindRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). Send this message to attempt a hand bind for this device. After hand binding your can send indirect (no address) message to the coordinator and the coordinator will send the message to the device that this message is bound to, or you will receive messages from your new bound device. More...

zstack_ZStatusValues	Zstackapi_ZdoBindReq (uint8_t appServiceTaskId, zstack_zdoBindReq_t *pReq)
	Call to send a ZDO Bind Request, Use this command to send an over-the-air Bind Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_bindRsp and bindRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). Send this message to a device to build a binding record for/on that device. You can send this command to this device's address to create a local binding entry. More...

zstack_ZStatusValues	Zstackapi_ZdoUnbindReq (uint8_t appServiceTaskId, zstack_zdoUnbindReq_t *pReq)
	Call to send a ZDO Unbind Request, Use this command to send an over-the-air Unbind Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_unbindRsp and unbindRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). Send this message to a device to remove a binding record on that device. You can send this command to this device's address to unbind a local entry. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtNwkDiscReq (uint8_t appServiceTaskId, zstack_zdoMgmtNwkDiscReq_t *pReq)
	Call to send a ZDO Mgmt Network Discovery Request, Use this command to send an over-the-air Management Network Discovery Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtNwkDiscRsp and mgmtNwkDiscRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device to perform a network scan and return the result in the response message. You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtLqiReq (uint8_t appServiceTaskId, zstack_zdoMgmtLqiReq_t *pReq)
	Call to send a ZDO Mgmt LQI Request, Use this command to send an over-the-air Management LQI Discovery Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtLqiRsp and mgmtLqiRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device to return its neighbor list in the response message. You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtRtgReq (uint8_t appServiceTaskId, zstack_zdoMgmtRtgReq_t *pReq)
	Call to send a ZDO Mgmt Routing Request to the stack task Use this command to send an over-the-air Management Routing Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtRtgRsp and mgmtRtgRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device to return its routing table in the response message. You can send this command to this device's address to perform the command locally. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtBindReq (uint8_t appServiceTaskId, zstack_zdoMgmtBindReq_t *pReq)
	Call to send a ZDO Mgmt Bind Request, Use this command to send an over-the-air Management Binding Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtBindRsp and mgmtBindRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device to return its binding table in the response message. You can send this command to this device's address to perform a local Mgmt Bind command. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtLeaveReq (uint8_t appServiceTaskId, zstack_zdoMgmtLeaveReq_t *pReq)
	Call to send a ZDO Mgmt Leave Request, Use this command to send an over-the-air Management Leave Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtLeaveRsp and mgmtLeaveRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device or another device to leave the network. You can send this command to this device's address to make this device leave. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtDirectJoinReq (uint8_t appServiceTaskId, zstack_zdoMgmtDirectJoinReq_t *pReq)
	Call to send a ZDO Mgmt Direct Join Request, Use this command to send an over-the-air Management Direct Join Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtDirectJoinRsp and mgmtDirectJoinRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device to direct join another device. You can send this command to this device's address to make a local direct join. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtPermitJoinReq (uint8_t appServiceTaskId, zstack_zdoMgmtPermitJoinReq_t *pReq)
	Call to send a ZDO Mgmt Permit Join Request, Use this command to send an over-the-air Management Permit Join Request message. This function will not wait for the over-the-air response message, you will need to subscribe to response message by setting the has_mgmtPermitJoinRsp and mgmtPermitJoinRsp fields of zstack_devZDOCBReq_t to true and calling Zstackapi_DevZDOCBReq(). If the destination device supports this command (optional), calling this function will generate the request for the destination device control permit joining. You can send this command to this device's address to locally control permit joining. More...

zstack_ZStatusValues	Zstackapi_ZdoMgmtNwkUpdateReq (uint8_t appServiceTaskId, zstack_zdoMgmtNwkUpdateReq_t *pReq)
	Call to send a ZDO Mgmt Network Update Request, 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. More...

zstack_ZStatusValues	Zstackapi_secNwkKeyGetReq (uint8_t appServiceTaskId, zstack_secNwkKeyGetReq_t pReq, zstack_secNwkKeyGetRsp_t pRsp)
	Call to send a Security Network Key Get Request Use this command to retrieve the active or alternate network key from the ZStack Thread. More...

zstack_ZStatusValues	Zstackapi_secNwkKeySetReq (uint8_t appServiceTaskId, zstack_secNwkKeySetReq_t *pReq)
	Call to send a Security Network Key Set Request, Use this command to set a network key (active or alternate). More...

zstack_ZStatusValues	Zstackapi_secNwkKeyUpdateReq (uint8_t appServiceTaskId, zstack_secNwkKeyUpdateReq_t *pReq)
	Call to send a Security Network Key Update Request, Use this command to send an over-the-air network key update message. More...

zstack_ZStatusValues	Zstackapi_secNwkKeySwitchReq (uint8_t appServiceTaskId, zstack_secNwkKeySwitchReq_t *pReq)
	Call to send a Security Network Key Switch Request, Use this command to send an over-the-air network key switch message. More...

zstack_ZStatusValues	Zstackapi_secApsLinkKeyGetReq (uint8_t appServiceTaskId, zstack_secApsLinkKeyGetReq_t pReq, zstack_secApsLinkKeyGetRsp_t pRsp)
	Call to send a Security APS Link Key Get Request Use this command to get an APS Link key or TC Link key from the ZStack Thread's non-volatile memory. More...

zstack_ZStatusValues	Zstackapi_secApsLinkKeySetReq (uint8_t appServiceTaskId, zstack_secApsLinkKeySetReq_t *pReq)
	Call to send a Security APS Link Key Set Request Use this command to set an APS Link key or TC Link key into the ZStack Thread's non-volatile memory. More...

zstack_ZStatusValues	Zstackapi_secApsLinkKeyRemoveReq (uint8_t appServiceTaskId, zstack_secApsLinkKeyRemoveReq_t *pReq)
	Call to send a Security APS Link Key Remove Request Use this command to delete an APS Link key or TC Link key from the ZStack Thread's non-volatile memory. More...

zstack_ZStatusValues	Zstackapi_secApsRemoveReq (uint8_t appServiceTaskId, zstack_secApsRemoveReq_t *pReq)
	Call to send a Security APS Remove Request (to remove a a device from the network) This only works if this device is a coordinator (Trust Center). More...

zstack_ZStatusValues	Zstackapi_secMgrSetupPartnerReq (uint8_t appServiceTaskId, zstack_secMgrSetupPartnerReq_t *pReq)
	Call to send a Security Setup Partner Request. This only works if this device is a coordinator (Trust Center). More...

zstack_ZStatusValues	Zstackapi_secMgrAppKeyTypeSetReq (uint8_t appServiceTaskId, zstack_secMgrAppKeyTypeSetReq_t *pReq)
	Call to send a Security Mgr App Key Type Set Request. This only works if this device is a coordinator (Trust Center). More...

zstack_ZStatusValues	Zstackapi_secMgrAppKeyReq (uint8_t appServiceTaskId, zstack_secMgrAppKeyReq_t *pReq)
	Call to send a Security Mgr App Key Request. More...

zstack_ZStatusValues	Zstackapi_devNwkManagerSetReq (uint8_t appServiceTaskId)
	Call to set device as NWK MANAGER. More...

zstack_ZStatusValues	Zstackapi_bdbStartCommissioningReq (uint8_t appServiceTaskId, zstack_bdbStartCommissioningReq_t *pReq)
	Call to send a BDB Start Commissioning Request (to start the commissioning process according to the commissioning mask given). More...

zstack_ZStatusValues	Zstackapi_bdbSetIdentifyActiveEndpointReq (uint8_t appServiceTaskId, zstack_bdbSetIdentifyActiveEndpointReq_t *pReq)
	Call to send a BDB Get Identify Active Endpoint Request (to set the endpoint which will perform the finding and binding, either Target or Initiator) More...

zstack_ZStatusValues	Zstackapi_bdbGetIdentifyActiveEndpointReq (uint8_t appServiceTaskId, zstack_bdbGetIdentifyActiveEndpointRsp_t *pRsp)
	Call to send a BDB Get Identify Active Endpoint Request (to get the endpoint which will perform the finding and binding, either Target or Initiator) More...

zstack_ZStatusValues	Zstackapi_bdbStopInitiatorFindingBindingReq (uint8_t appServiceTaskId)
	Call to send a BDB Stop Initiator Finding and Binding Request (to Stops Finding & Binding for initiator devices. More...

zstack_ZStatusValues	Zstackapi_getZCLFrameCounterReq (uint8_t appServiceTaskId, zstack_getZCLFrameCounterRsp_t *pRsp)
	Call to send a Get ZCL Frame Counter Request (to get the next ZCL frame counter for packet sequence number) More...

zstack_ZStatusValues	Zstackapi_bdbZclIdentifyCmdIndReq (uint8_t appServiceTaskId, zstack_bdbZCLIdentifyCmdIndReq_t *pReq)
	Call to send a BDB Zcl Identify Command Indication to process identify command in the stack. This is necessary to allow BDB callbacks and notifications to work properly. More...

zstack_ZStatusValues	Zstackapi_bdbSetEpDescListToActiveEndpoint (uint8_t appServiceTaskId, zstack_bdbSetEpDescListToActiveEndpointRsp_t *pRsp)
	Call to send a BDB Set Endpoint Descriptor List to Active Endpoint (Set active endpoint selected by the application for F&B process). More...

zstack_ZStatusValues	Zstackapi_bdbResetLocalActionReq (uint8_t appServiceTaskId)
	Call to send a BDB Reset Local Action Request (to call application interface to perform BDB Reset to factory new). More...

zstack_ZStatusValues	Zstackapi_bdbSetAttributesReq (uint8_t appServiceTaskId, zstack_bdbSetAttributesReq_t *pReq)
	Call to send a BDB Set Attribute Request (to set the Base Device Behavior attributes used by the commissioning methods invoked with Zstackapi_bdbStartCommissioningReq) More...

zstack_ZStatusValues	Zstackapi_bdbGetAttributesReq (uint8_t appServiceTaskId, zstack_bdbGetAttributesRsp_t *pRsp)
	Call to send a BDB Get Attributes Request (to get the Base Device Behavior attributes used by the commissioning methods invoked with Zstackapi_bdbStartCommissioningReq) More...

zstack_ZStatusValues	Zstackapi_bdbGetFBInitiatorStatusReq (uint8_t appServiceTaskId, zstack_bdbGetFBInitiatorStatusRsp_t *pRsp)
	Call to send a BDB Get Finding and Binding Initiator Status Request (to get the remaining time and attempts to search for Finding and Binding Target devices when periodic Finding And Binding commissioning process is enabled) More...

zstack_ZStatusValues	Zstackapi_bdbGenerateInstallCodeCRCReq (uint8_t appServiceTaskId, zstack_bdbGenerateInstallCodeCRCReq_t pReq, zstack_bdbGenerateInstallCodeCRCRsp_t pRsp)
	Call to send a BDB Generate Install Code CRC Request (to generate CRC codes using as input an install code) More...

zstack_ZStatusValues	Zstackapi_bdbRepAddAttrCfgRecordDefaultToListReq (uint8_t appServiceTaskId, zstack_bdbRepAddAttrCfgRecordDefaultToListReq_t *pReq)
	Call to send a BDB Reporting Attribute Configuration Record Default Request (to add a default configuration value for a reportable attribute) More...

zstack_ZStatusValues	Zstackapi_bdbRepChangedAttrValueReq (uint8_t appServiceTaskId, zstack_bdbRepChangedAttrValueReq_t *pReq)
	Call to send a BDB Report Changed Attribute Value Request (to notify the stack that an attribute has changed and allow the stack to validate the triggering of a reporting attribute message) More...

zstack_ZStatusValues	Zstackapi_bdbProcessInConfigReportCmd (uint8_t appServiceTaskId, zstack_bdbProcessInConfigReportReq_t *pReq)
	Call to process an Incomming Configure Report command (to adjust the reporting mechanism and generate the response to this command) More...

zstack_ZStatusValues	Zstackapi_bdbProcessInReadReportCfgCmd (uint8_t appServiceTaskId, zstack_bdbProcessInReadReportCfgReq_t *pReq)
	Call to process an Incomming Read Reporting Configuration (to generate a response with the current report configuration) More...

zstack_ZStatusValues	Zstackapi_bdbAddInstallCodeReq (uint8_t appServiceTaskId, zstack_bdbAddInstallCodeReq_t *pReq)
	Call to send a BDB Add Install Code Request (to add an install code to be used in the commissioning process of a new joining device) ZC interface only. More...

zstack_ZStatusValues	Zstackapi_bdbTouchLinkTargetEnableCommissioningReq (uint8_t appServiceTaskId, zstack_bdbTouchLinkTargetEnableCommissioningReq_t *pReq)
	Call to send a BDB Touchlink Target Enable Commissioning Request (to enable the reception of Touchlink commissioning commands) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbTouchLinkTargetDisableCommissioningReq (uint8_t appServiceTaskId)
	Call to send a BDB Touchlink Target Disable Commissioning Request (to Disable the reception of commissioning commands) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbTouchLinkTargetGetTimerReq (uint8_t appServiceTaskId, zstack_bdbTouchLinkTargetGetTimerRsp_t *pRsp)
	Call to send a BDB Touchlink Target Get Timer Request (to get the remaining time enabled of Touchlink commissioning as Target) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbSetActiveCentralizedLinkKeyReq (uint8_t appServiceTaskId, zstack_bdbSetActiveCentralizedLinkKeyReq_t *pReq)
	Call to send a BDB Set Active Centralized Link Key Request (to set the active centralized key to be used: default global trust center link key Or install code derived preconfigured key) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbCBKETCLinkKeyExchangeAttemptReq (uint8_t appServiceTaskId, zstack_bdbCBKETCLinkKeyExchangeAttemptReq_t *pReq)
	Call to send a BDB CBKE TustCenter Link Key Exchange Attempt Request (to indicate to the stack the result of the Certificate Base Key Exchange, if any. If CBKE is not used, then just report not-success and default TrustCenterLinkKey exchange mechanism will be excecuted) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbNwkDescFreeReq (uint8_t appServiceTaskId, zstack_bdbNwkDescFreeReq_t *pReq)
	Call to send a BDB Network Descriptor Free Request (to release the network descriptors of those networks that are not intended to be joined) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbFilterNwkDescComplete (uint8_t appServiceTaskId)
	Call to send a BDB Filter Network Descriptor Comple Request (to indicate the stack that the networks that are not of interest to the application has been removed and the remaining network descritptors must be attempted to joined) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbTouchlinkSetAllowStealingReq (uint8_t appServiceTaskId, zstack_bdbTouchlinkSetAllowStealingReq_t *pReq)
	Call to send a BDB Touchlink Set Allow Stealing Request (to allow Touchlink stealing when Touchlink commissioning is enabled as target) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbTouchlinkGetAllowStealingReq (uint8_t appServiceTaskId, zstack_bdbTouchlinkGetAllowStealingRsp_t *pRsp)
	Call to send a BDB Touchlink Get Allow Stealing Request (to know if allow stealing is enabled or not) ZR/ZED interface only. More...

zstack_ZStatusValues	Zstackapi_bdbZedAttemptRecoverNwkReq (uint8_t appServiceTaskId, zstack_bdbZedAttemptRecoverNwkRsp_t *pRsp)
	Call to send a BDB ZED Attempt Recover Network Request (to instruct the ZED to try to rejoin its previews network) ZED only. More...

zstack_ZStatusValues	Zstackapi_gpAllowChangeChannelReq (uint8_t appServiceTaskId, zstack_gpAllowChangeChannelReq_t *pReq)

zstack_ZStatusValues	Zstackapi_gpSecRsp (uint8_t appServiceTaskId, zstack_gpSecRsp_t *pReq)

zstack_ZStatusValues	Zstackapi_gpAliasConflict (uint8_t appServiceTaskId, zstack_gpAddrConflict_t *pReq)

zstack_ZStatusValues	Zstackapi_tlScanReqInd (uint8_t appServiceTaskId, zstack_tlScanReq_t *pReq)

zstack_ZStatusValues	Zstackapi_touchlinkNwkJoinReqInd (uint8_t appServiceTaskId, zstack_touchlinkNwkJointReq_t *pReq)

zstack_ZStatusValues	Zstackapi_touchlinkNwkUpdateReqInd (uint8_t appServiceTaskId, zstack_touchlinkNwkUpdateReq_t *pReq)

zstack_ZStatusValues	Zstackapi_pauseResumeDeviceReq (uint8_t appServiceTaskId, zstack_pauseResumeDeviceReq_t *pReq)
	Call to pause/resume the device on the nwk. More...

bool	Zstackapi_freeIndMsg (void *pMsg)
	Call to free the memory used by an Indication message, messages sent asynchronously from the ZStack thread. More...

Variables
uint8_t	stackServiceTaskId

Function Documentation

§ Zstackapi_AfConfigGetReq()

zstack_ZStatusValues Zstackapi_AfConfigGetReq	(	uint8_t	appServiceTaskId,
		zstack_afConfigGetReq_t *	pReq,
		zstack_afConfigGetRsp_t *	pRsp
	)

Call to send an AF Config Get Request to the stack task Use this command to retrieve the AF fragmentation configuration information for the given endpoint.

Call to send an AF Config Get Request