logo资料库

《Z-Stack API 接口》(中).pdf

第1页 / 共78页
第2页 / 共78页
第3页 / 共78页
第4页 / 共78页
第5页 / 共78页
第6页 / 共78页
第7页 / 共78页
第8页 / 共78页
资料共78页,剩余部分请下载后查看
1、引言
1.1 目的
1.2 范围
1.3 缩写词语
2、层次概述
2.1 ZDO层
2.2 AF层
2.3 APS层
2.4 NWK层
3、应用程序编程接口
3.1 ZigBee设备对象(ZDO)
3.1.1 概述
3.1.2 ZDO网络启动
3.1.3 ZDO信息回调
3.1.4 ZDO查询API
3.1.5 ZDO绑定API
3.1.6 ZDO管理API
3.1.7 ZDO解析函数
3.2 应用层框架(AF)
3.2.1 概述
3.3 应用支持子层(APS)
3.3.1 概述
3.3.2 绑定表管理
3.3.3 组表管理
3.3.4 快速地址查找
3.4 NetworkLayer(NWK)网络层
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 郑州新双恒译 版本 1.0 1.1 1.2 描述 初始版本 附加ZDO设备网络启动 改变ZDO接口 日期 12/11/2006 03/07/2007 08/07/2007 i 版权 © 德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API) F8W-2006-0021 版本 1.2 www.zigbee-sh.cn 郑州新双恒译 目录 1111、引言........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................1111 1.1 目的....................................................................................................................................1 1.2 范围....................................................................................................................................1 1.3 缩写词语............................................................................................................................1 2222、层次概述........................................................................................................................................................................................................................................................................................................................................................................................................................................................................2222 2.1 ZDO 层...............................................................................................................................2 2.2 AF 层.................................................................................................................................. 2 2.3 APS 层................................................................................................................................2 2.4 NWK 层............................................................................................................................. 2 3333、应用程序编程接口........................................................................................................................................................................................................................................................................................................................................................................................................3333 3.1 ZigBee 设备对象(ZDO)...............................................................................................3 3.1.1 概述.........................................................................................................................3 3.1.2 ZDO网络启动........................................................................................................3 3.1.2.1 ZDOInitDevice()..........................................................................................3 3.1.3 ZDO信息回调........................................................................................................4 3.1.3.1 ZDO_RegisterForZDOMsg()...................................................................... 4 3.1.3.2 ZDO_RemoveRegisteredCB().....................................................................5 3.1.4 ZDO查询API.........................................................................................................5 3.1.4.1 ZDP_NwkAddrReq()...................................................................................6 3.1.4.2 ZDP_NWKAddrRsp()................................................................................. 7 3.1.4.3 ZDP_IEEEAddrReq()..................................................................................8 3.1.4.4 ZDP_IEEEAddrRsp().................................................................................. 9 3.1.4.5 ZDP_NodeDescReq()................................................................................ 10 3.1.4.6 ZDP_NodeDescMsg()............................................................................... 10 3.1.4.7 ZDP_PowerDescReq()...............................................................................11 3.1.4.8 ZDP_PowerDescMsg().............................................................................. 11 3.1.4.9 ZDP_SimpleDescReq()............................................................................. 12 3.1.4.10 ZDP_SimpleDescRsp()............................................................................12 3.1.4.11 ZDP_ComplexDescReq()........................................................................ 13 3.1.4.12 ZDP_ActiveEPIFReq()............................................................................13 3.1.4.13 ZDP_ActiveEPIFRsp()............................................................................ 14 3.1.4.14 ZDP_MatchDescReq().............................................................................15 3.1.4.15 ZDP_MatchDescRsp().............................................................................15 3.1.4.16 ZDP_UserDescSet().................................................................................16 3.1.4.17 ZDP_UserDescConf()..............................................................................16 3.1.4.18 ZDP_UserDescReq()............................................................................... 17 3.1.4.19 ZDP_UserDescRsp()............................................................................... 17 3.1.4.20 ZDP_EndDeviceAnnce().........................................................................18 3.1.4.21 ZDP_ServerDiscReq().............................................................................19 3.1.4.22 ZDP_ServerDiscRsp()............................................................................. 19 3.1.5 ZDO绑定API......................................................................................................20 ii 版权 © 德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API) F8W-2006-0021 版本 1.2 www.zigbee-sh.cn 郑州新双恒译 3.1.5.1 ZDP_EndDeviceBindReq()....................................................................... 20 3.1.5.2 ZDP_EndDeviceBindRsp()....................................................................... 21 3.1.5.3 ZDP_BindReq()......................................................................................... 21 3.1.5.4 ZDP_BindRsp()......................................................................................... 22 3.1.5.5 ZDP_UnbindReq().....................................................................................23 3.1.5.6 ZDP_UnbindRsp()..................................................................................... 23 3.1.6 ZDO管理API......................................................................................................25 3.1.6.1 ZDP_MgmtNwkDiscReq()........................................................................25 3.1.6.2 ZDP_MgmtNwkDiscRsp()........................................................................ 26 3.1.6.3 ZDP_MgmtLqiReq()..................................................................................27 3.1.6.4 ZDP_MgmtLqiRsp()..................................................................................27 3.1.6.5 ZDP_MgmtRtgReq()................................................................................. 28 3.1.6.6 ZDP_MgmtRtgRsp()..................................................................................28 3.1.6.7 ZDP_MgmtBindReq ().............................................................................. 29 3.1.6.8 ZDP_MgmtBindRsp()............................................................................... 29 3.1.6.9 ZDP_MgmtLeaveReq ()............................................................................ 30 3.1.6.10 ZDP_MgmtLeaveRsp()........................................................................... 31 3.1.6.11 ZDP_MgmtDirectJoinReq ()................................................................... 31 3.1.6.12 ZDP_MgmtDirectJoinRsp().....................................................................32 3.1.6.13 ZDP_MgmtPermitJoinReq()....................................................................32 3.1.6.14 ZDP_MgmtPermitJoinRsp.......................................................................33 3.1.7 ZDO解析函数......................................................................................................33 3.1.7.1 ZDO_ParseAddrRsp.................................................................................. 33 3.1.7.2 ZDO_ParseNodeDescRsp..........................................................................34 3.1.7.3 ZDO_ParsePowerDescRsp........................................................................ 34 3.1.7.4 ZDO_ParseSimpleDescRsp.......................................................................34 3.1.7.5 ZDO_ParseEPListRsp................................................................................35 3.1.7.6 ZDO_ParseBindRsp...................................................................................35 3.1.7.7 ZDO_ParseMgmNwkDiscRsp.................................................................. 36 3.1.7.8 ZDO_ParseMgmtLqiRsp...........................................................................36 3.1.7.9 ZDO_ParseMgmtRtgRsp...........................................................................36 3.1.7.10 ZDO_ParseMgmtBindRsp.......................................................................37 3.1.7.11 ZDO_ParseMgmtDirectJoinRsp..............................................................37 3.1.7.12 ZDO_ParseMgmtLeaveRsp.....................................................................37 3.1.7.13 ZDO_ParseMgmtPermitJoinRsp............................................................. 38 3.1.7.14 ZDO_ParseUserDescRsp.........................................................................38 3.1.7.15 ZDO_ParseServerDiscRsp.......................................................................38 3.1.7.16 ZDO_ParseEndDeviceBindReq.............................................................. 39 3.1.7.17 ZDO_ParseBindUnbindReq.................................................................... 39 3.1.7.18 ZDO_ParseUserDescConf.......................................................................39 3.1.7.19 ZDO_ParseDeviceAnnce.........................................................................40 3.2 应用层框架(AF)..............................................................................................................41 3.2.1 概述.......................................................................................................................41 3.2.1.1 终端管理....................................................................................................41 3.2.1.1.1 简单描述—SimpleDescriptionFormat_t....................................... 41 iii 版权 © 德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API) F8W-2006-0021 版本 1.2 www.zigbee-sh.cn 郑州新双恒译 3.2.1.1.2 终端描述符—endPointDesc_t.......................................................42 3.2.1.1.3 afRegister()................................................................................... 42 3.2.1.1.4 afRegisterExtended()...................................................................... 42 3.2.1.1.5 afFindEndPointDesc().................................................................... 43 3.2.1.1.6 afFindSimpleDesc()........................................................................43 3.2.1.1.7 afGetMatch()...................................................................................43 3.2.1.1.8 afSetMatch()................................................................................... 44 3.2.1.1.9 afNumEndPoints().......................................................................... 44 3.2.1.1.10 afEndPoints ()............................................................................... 44 3.2.1.2 发送数据....................................................................................................45 3.2.1.2.1 AF_DataRequest().......................................................................... 45 3.2.1.2.2 afDataReqMTU()............................................................................46 3.3 应用支持子层(APS)........................................................................................................46 3.3.1 概述.......................................................................................................................46 3.3.2 绑定表管理...........................................................................................................47 3.3.2.1 绑定记录数据结构—BindingEntry_t...................................................... 47 3.3.2.2 绑定表的维护............................................................................................47 3.3.2.2.1 bindAddEntry()...............................................................................47 3.3.2.2.2 bindRemoveEntry()........................................................................ 48 3.3.2.2.3 bindRemoveClusterIdFromList()................................................... 48 3.3.2.2.4 bindAddClusterIdToList().............................................................. 49 3.3.2.2.5 bindRemoveDev()...........................................................................49 3.3.2.2.6 bindRemoveSrcDev()..................................................................... 49 3.3.2.2.7 bindUpdateAddr ()..........................................................................50 3.3.2.3 绑定表的查找............................................................................................50 3.3.2.3.1 bindFindExisting ().........................................................................50 3.3.2.3.2 bindIsClusterIDinList()...................................................................51 3.3.2.4 绑定表的统计............................................................................................51 3.3.2.4.1 bindNumBoundTo()........................................................................51 3.3.2.4.2 bindNumOfEntries()....................................................................... 52 3.3.2.4.3 bindCapacity().................................................................................52 3.3.2.5 绑定表 Non-Volitile 存储..........................................................................52 3.3.2.5.1 BindWriteNV()............................................................................... 52 3.3.3 组表管理...............................................................................................................53 3.3.3.1 组表数据结构............................................................................................53 3.3.3.1.1 Group Item - aps_Group_t..............................................................53 3.3.3.1.2 Group Table Entry - apsGroupItem_t............................................. 53 3.3.3.2 组表维护....................................................................................................54 3.3.3.2.1 aps_AddGroup()............................................................................. 54 3.3.3.2.2 aps_RemoveGroup().......................................................................54 3.3.3.2.3 aps_ RemoveAllGroup().................................................................54 3.3.3.3 组表查询....................................................................................................55 3.3.3.3.1 aps_ FindGroup ()...........................................................................55 3.3.3.3.2 aps_ FindGroupForEndpoint ()...................................................... 55 3.3.3.3.3 aps_FindAllGroupsForEndpoint()..................................................55 iv 版权 © 德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API) F8W-2006-0021 版本 1.2 www.zigbee-sh.cn 郑州新双恒译 3.3.3.3.4 aps_ CountGroups()........................................................................56 3.3.3.3.5 aps_CountAllGroups ()...................................................................56 3.3.3.4 组表 Non-Volitile 存储..............................................................................57 3.3.3.4.1 aps_GroupsWriteNV()....................................................................57 3.3.4 快速地址查找.......................................................................................................57 3.3.4.1 APSME_LookupExtAddr()....................................................................... 57 3.3.4.2 APSME_ LookupNwkAddr ()....................................................................58 3.4 Network Layer (NWK)网络层........................................................................................ 58 3.4.1.1 网络管理....................................................................................................58 3.4.1.1.1 NLME_NetworkDiscoveryRequest().............................................58 3.4.1.1.2 NLME_NwkDiscReq2().................................................................59 3.4.1.1.3 NLME_NwkDiscTerm().................................................................60 3.4.1.1.4 NLME_NetworkFormationRequest().............................................60 3.4.1.1.5 NLME_StartRouterRequest().........................................................61 3.4.1.1.6 NLME_JoinRequest().....................................................................61 3.4.1.1.7 NLME_ReJoinRequest()................................................................ 62 3.4.1.1.8 NLME_OrphanJoinRequest().........................................................62 3.4.1.1.9 NLME_PermitJoiningRequest().....................................................63 3.4.1.1.10 NLME_DirectJoinRequest().........................................................63 3.4.1.1.11 NLME_LeaveReq()...................................................................... 64 3.4.1.1.12 NLME_RemoveChild()................................................................ 64 3.4.1.1.13 NwkPollReq()............................................................................... 65 3.4.1.1.14 NLME_SetPollRate()....................................................................65 3.4.1.1.15 NLME_SetQueuedPollRate().......................................................65 3.4.1.1.16 NLME_SetResponseRate()...........................................................66 3.4.1.2 地址管理....................................................................................................66 3.4.1.3 网络参数和功能函数............................................................................... 66 3.4.1.3.1 NLME_GetExtAddr().....................................................................66 3.4.1.3.2 NLME_GetShortAddr()..................................................................67 3.4.1.3.3 NLME_GetCoordShortAddr()........................................................67 3.4.1.3.4 NLME_GetCoordExtAddr()...........................................................67 3.4.1.3.5 NLME_SetRequest()...................................................................... 68 3.4.1.3.6 NLME_GetRequest()......................................................................68 3.4.1.3.7 NLME_IsAddressBroadcast()........................................................ 69 3.4.1.3.8 NLME_GetProtocolVersion().........................................................69 3.4.1.3.9 NLME_SetBroadcastFilter()...........................................................70 3.4.1.4 网络 Non-Volitile 存储..............................................................................70 3.4.1.4.1 NLME_UpdateNV()....................................................................... 70 v 版权 © 德州仪器股份有限公司 2006 版权所有 违者必究
Z-Stack 应用程序编程接口(API) F8W-2006-0021 版本 1.2 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 郑州新双恒译 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 版权所有 违者必究
分享到:
收藏