Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
ZZZZ----SSSSttttackackackack APIAPIAPIAPI接口
文件编号: F8W-2006-0021
德州仪器股份有限公司
美国加利福尼亚州圣迭戈
(619)542-1200
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
版本
1.0
1.1
1.2
描述
初始版本
附加Z DO设备网络启动
改变ZDO接口
日期
12/11/ 2006
03/07/2007
08/07/2007
ii
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
目录
目录.................................................................................................................................................................3
1、引言...........................................................................................................................................................6
1.1 目的................................................................................................................................................6
1.2 范围................................................................................................................................................6
1.3 缩写词语........................................................................................................................................6
2、层次概述...................................................................................................................................................8
2.1
ZDO 层........................................................................................................................................ 8
2.2 AF 层............................................................................................................................................8
2.3 APS 层........................................................................................................................................... 8
2.4 NWK 层........................................................................................................................................ 8
3、应用程序编程接口.................................................................................................................................. 9
3.1 ZigBee 设备对象(ZDO).......................................................................................................... 9
3.1.1 概述....................................................................................................................................9
3.1.2 ZDO网络启动...................................................................................................................9
3.1.2.1 ZDOInitDevice()..................................................................................................... 9
3.1.3 ZDO信息回调..................................................................................................................11
3.1.3.1 ZDO_RegisterForZDOMsg()................................................................................11
3.1.3.2 ZDO_RemoveRegisteredCB()..............................................................................12
3.1.4 ZDO查询API..................................................................................................................12
3.1.4.1 ZDP_NwkAddrReq()............................................................................................ 13
3.1.4.2 ZDP_NWKAddrRsp()...........................................................................................14
3.1.4.3 ZDP_IEEEAddrReq()........................................................................................... 15
3.1.4.4 ZDP_IEEEAddrRsp()............................................................................................16
3.1.4.5 ZDP_NodeDescReq()............................................................................................17
3.1.4.6 ZDP_NodeDescMsg()...........................................................................................17
3.1.4.7 ZDP_PowerDescReq().......................................................................................... 18
3.1.4.8 ZDP_PowerDescMsg()......................................................................................... 18
3.1.4.9 ZDP_SimpleDescReq().........................................................................................19
3.1.4.10 ZDP_SimpleDescRsp().......................................................................................19
3.1.4.11 ZDP_ComplexDescReq()................................................................................... 20
3.1.4.12 ZDP_ActiveEPIFReq ()...................................................................................... 20
3.1.4.13 ZDP_ActiveEPIFRsp()........................................................................................21
3.1.4.14 ZDP_MatchDescReq()........................................................................................22
3.1.4.15 ZDP_MatchDescRsp()........................................................................................ 22
3.1.4.16 ZDP_UserDescSet()............................................................................................23
3.1.4.17 ZDP_UserDescConf().........................................................................................23
3.1.4.18 ZDP_UserDescReq()...........................................................................................24
3.1.4.19 ZDP_UserDescRsp()...........................................................................................24
3.1.4.20 ZDP_EndDeviceAnnce().................................................................................... 25
3.1.4.21 ZDP_ServerDiscReq()........................................................................................ 26
3.1.4.22 ZDP_ServerDiscRsp().........................................................................................26
3.1.5 ZDO绑定API..................................................................................................................27
3.1.5.1 ZDP_EndDeviceBindReq()...................................................................................27
3.1.5.2 ZDP_EndDeviceBindRsp()...................................................................................28
3.1.5.3 ZDP_BindReq().....................................................................................................28
3.1.5.4 ZDP_BindRsp().....................................................................................................29
3.1.5.5 ZDP_UnbindReq ()............................................................................................... 30
3.1.5.6 ZDP_UnbindRsp().................................................................................................30
3.1.6 ZDO管理API..................................................................................................................32
3.1.6.1 ZDP_MgmtNwkDiscReq()................................................................................... 32
iii
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
3.1.6.2 ZDP_MgmtNwkDiscRsp()................................................................................... 33
3.1.6.3 ZDP_MgmtLqiReq().............................................................................................34
3.1.6.4 ZDP_MgmtLqiRsp()............................................................................................. 34
3.1.6.5 ZDP_MgmtRtgReq ()............................................................................................35
3.1.6.6 ZDP_MgmtRtgRsp().............................................................................................35
3.1.6.7 ZDP_MgmtBindReq ()..........................................................................................36
3.1.6.8 ZDP_MgmtBindRsp()...........................................................................................36
3.1.6.9 ZDP_MgmtLeaveReq ()........................................................................................37
3.1.6.10 ZDP_MgmtLeaveRsp().......................................................................................38
3.1.6.11 ZDP_MgmtDirectJoinReq ()...............................................................................38
3.1.6.12 ZDP_MgmtDirectJoinRsp()................................................................................39
3.1.6.13 ZDP_MgmtPermitJoinReq()...............................................................................39
3.1.6.14 ZDP_MgmtPermitJoinRsp..................................................................................40
3.1.7 ZDO解析函数.................................................................................................................40
3.1.7.1 ZDO_ParseAddrRsp..............................................................................................40
3.1.7.2 ZDO_ParseNodeDescRsp.....................................................................................41
3.1.7.3 ZDO_ParsePowerDescRsp................................................................................... 41
3.1.7.4 ZDO_ParseSimpleDescRsp.................................................................................. 41
3.1.7.5 ZDO_ParseEPListRsp...........................................................................................42
3.1.7.6 ZDO_ParseBi ndRsp.............................................................................................. 42
3.1.7.7 ZDO_ParseMgmNwkDiscRsp..............................................................................43
3.1.7.8 ZDO_ParseMgmtLqiRsp...................................................................................... 43
3.1.7.9 ZDO_ParseMgmtRtgRsp...................................................................................... 43
3.1.7.10 ZDO_ParseMgmtBi ndRsp.................................................................................. 44
3.1.7.11 ZDO_ParseMgmtDirectJoinRsp......................................................................... 44
3.1.7.12 ZDO_ParseMgmtLeaveRsp................................................................................44
3.1.7.13 ZDO_ParseMgmtPermitJoinRsp........................................................................ 45
3.1.7.14 ZDO_ParseUserDescRsp.................................................................................... 45
3.1.7.15 ZDO_ParseServerDiscRsp..................................................................................45
3.1.7.16 ZDO_ParseEndDeviceBi ndReq..........................................................................46
3.1.7.17 ZDO_ParseBindUnbindReq................................................................................46
3.1.7.18 ZDO_ParseUserDescConf.................................................................................. 46
3.1.7.19 ZDO_ParseDeviceAnnce.................................................................................... 47
3.2 应用层框架(AF).........................................................................................................................48
3.2.1 概述..................................................................................................................................48
3.2.1.1 终端管理................................................................................................................48
3.2.1.1.1 简单描述—SimpleDescriptionFormat_t....................................................48
3.2.1.1.2 终端描述符—endPointDesc_t....................................................................49
3.2.1.1.3
afRegister()............................................................................................... 49
afRegisterExtended()..................................................................................49
3.2.1.1.4
3.2.1.1.5
afFindEndPointDesc()................................................................................50
3.2.1.1.6 afFindSimpleDesc()....................................................................................50
3.2.1.1.7 afGetMatch().............................................................................................. 50
afSetMatch()...............................................................................................51
3.2.1.1.8
3.2.1.1.9 afNumEndPoints()......................................................................................51
3.2.1.1.10 afEndPoints ()...........................................................................................51
3.2.1.2 发送数据................................................................................................................52
3.2.1.2.1 AF_DataRequest()......................................................................................52
3.2.1.2.2 afDataReqMTU()....................................................................................... 53
3.3 应用支持子层(APS)................................................................................................................... 53
3.3.1 概述..................................................................................................................................53
3.3.2 绑定表管理.......................................................................................................................54
iv
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
3.3.2.1 绑定记录数据结构—Bi ndingEntry_t...................................................................54
3.3.2.2 绑定表的维护.......................................................................................................54
3.3.2.2.1 bindAddEntry()...........................................................................................54
3.3.2.2.2 bindRemoveEntry().................................................................................... 55
3.3.2.2.3
bindRemoveClusterIdFromList()...............................................................55
3.3.2.2.4 bindAddClusterIdToList()..........................................................................56
3.3.2.2.5 bindRemoveDev()...................................................................................... 56
3.3.2.2.6 bindRemoveSrcDev().................................................................................56
3.3.2.2.7
bindUpdateAddr ()..................................................................................... 57
3.3.2.3 绑定表的查找....................................................................................................... 57
3.3.2.3.1 bindFindExisting ().....................................................................................57
3.3.2.3.2 bindIsClusterIDinList().............................................................................. 58
3.3.2.4 绑定表的统计........................................................................................................ 58
3.3.2.4.1 bindNumBoundTo()................................................................................... 58
3.3.2.4.2
bindNumOfEntries().................................................................................. 59
3.3.2.4.3 bindCapacity()............................................................................................ 59
3.3.2.5 绑定表 Non-Volitile 存储..................................................................................... 59
3.3.2.5.1 BindWriteNV()...........................................................................................59
3.3.3 组表管理..........................................................................................................................60
3.3.3.1 组表数据结构....................................................................................................... 60
3.3.3.1.1 Group Item - aps_Group_t......................................................................... 60
3.3.3.1.2 Group Table Entry - apsGroupItem_t........................................................ 60
3.3.3.2 组表维护............................................................................................................... 61
3.3.3.2.1
aps_AddGroup().........................................................................................61
3.3.3.2.2 aps_ RemoveGroup()..................................................................................61
3.3.3.2.3
aps_ RemoveAllGroup ()...........................................................................61
3.3.3.3 组表查询............................................................................................................... 62
3.3.3.3.1 aps_ FindGroup ().......................................................................................62
3.3.3.3.2
aps_ FindGroupForEndpoint ()..................................................................62
3.3.3.3.3 aps_ FindAllGroupsForEndpoint()............................................................ 62
3.3.3.3.4
aps_ CountGroups()................................................................................... 63
aps_ CountAllGroups ()............................................................................. 63
3.3.3.3.5
3.3.3.4 组表 Non-Volitile 存储......................................................................................... 64
3.3.3.4.1 aps_GroupsWriteNV()............................................................................... 64
3.3.4 快速地址查找..................................................................................................................64
3.3.4.1 APSME_LookupExtAddr()...................................................................................64
3.3.4.2 APSME_ LookupNwkAddr ().............................................................................. 65
3.4 Network Layer (NWK)网络层....................................................................................................65
3.4.1.1 网络管理............................................................................................................... 65
3.4.1.1.1 NLME_NetworkDiscoveryRequest().........................................................65
3.4.1.1.2 NLME_NwkDiscReq2()............................................................................ 66
3.4.1.1.3 NLME_NwkDiscTerm()............................................................................ 67
3.4.1.1.4 NLME_NetworkFormationRequest()........................................................ 67
3.4.1.1.5 NLME_StartRouterRequest().....................................................................68
3.4.1.1.7 NLME_ReJoinRequest()............................................................................69
3.4.1.1.8 NLME_OrphanJoinRequest().................................................................... 69
3.4.1.1.9 NLME_PermitJoiningRequest()................................................................ 70
3.4.1.1.10 NLME_DirectJoinRequest().................................................................... 70
3.4.1.1.11 NLME_LeaveReq()..................................................................................71
3.4.1.1.12 NLME_RemoveChild()............................................................................71
3.4.1.1.13 NwkPollReq ()...........................................................................................72
3.4.1.1.14 NLME_SetPollRate()...............................................................................72
v
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
3.4.1.1.15 NLME_SetQueuedPollRate()...................................................................72
3.4.1.1.16 NLME_SetResponseRate()...................................................................... 73
3.4.1.2 地址管理............................................................................................................... 73
3.4.1.3 网络参数和功能函数...........................................................................................73
3.4.1.3.1 NLME_GetExtAddr().................................................................................73
3.4.1.3.2 NLME_GetShortAddr()............................................................................. 74
3.4.1.3.3 NLME_GetCoordShortAddr()...................................................................74
3.4.1.3.4 NLME_GetCoordExtAddr()...................................................................... 74
3.4.1.3.5 NLME_SetRequest().................................................................................. 75
3.4.1.3.6 NLME_GetRequest()................................................................................. 75
3.4.1.3.7 NLME_IsAddressBroadcast()....................................................................76
3.4.1.3.8 NLME_GetProtocolVersion()....................................................................76
3.4.1.3.9 NLME_SetBroadcastFilter()...................................................................... 77
3.4.1.4 网络 Non-Volitile 存储.........................................................................................77
3.4.1.4.1 NLME_UpdateNV()...................................................................................77
vi
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
1.1 目的
1、引言
此文件介绍了 ZigBee2006 规范兼容 Z-Stack 1.4.0 版本中的 Z-Stack 组件的应用程序编程接口
(API)。
1.2 范围
此文件列举了 ZigBee2006 规范兼容 Z-Stack1.4.0 版本中所有组件的 API 接口。有关各个接口的
详细信息,包括数据结构和函数调用已做出详细说明,以便于程序员在开发过程中理解和使用。
API 接口从上(应用层)至下依次介绍。
1.3 缩写词语
AF
AIB
API
APS
APSDE
APSME
ASDU
MSG
NHLE
NWK
PAN
STAR
ZDO
应用构架层
APS 信息库
应用程序编程接口
应用支持子层
APS 数据实体
APS 管理实体
APS 服务数据报单元
信息
下一个更高层实体
网络层
个人区域网络
一种含有一个主设备和若干从设备的网络拓扑结构
ZigBee 设备对象
1
版权©德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API)
F8W-2006-0021 版本 1.2
www.zigbee-sh.cn
www.zigbee-sh.cn))))译译译译
www.zigbee-sh.cn
郑州新双恒((((www.zigbee-sh.cn
2、层次概述
本节概述了此文件中所包含的层。
2.1 ZDO 层
ZigBee 设备对象层(ZDO)提供了管理一个 ZigBee 设备的功能。ZDO 层的 API 为应用程序的终
端提供了管理 ZigBee 协调器、路由器或终端设备的接口。这包括创建、查找和加入一个 ZigBee 网
络,绑定应用程序终端以及安全管理。
2.2 AF 层
应用构架层(AF)接口支持一个终端(包括ZDO层)接口的基本协议栈。Z-Stack的AF层提供
了开发人员建立一个设备描述所需的数据结构和辅助功能,是传入信息的终端多路复用器。
2.3 APS 层
应用支持子层(APS)的 API 提供一般性的支持服务,能同时用于 ZDO 层和制造商定义的应
用对象。
2.4 NWK 层
ZigBee 网络层(NWK)为更高层次的(应用层)组件提供管理和数据服务。
2
版权©德州仪器股份有限公司 2006 版权所有 违者必究