源码分析SampleApp.xls

《源码分析SampleApp.xls》由会员分享，可在线阅读，更多相关《源码分析SampleApp.xls（60页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、关于Zigbee协议的C语言实现一、协议：Zigbee联盟规范了协议，具体的协议编程语言表述则由IC厂商指定，如德州仪器TI公司的基于CC2430与CC2530的Z-Stack意法半导体ST等公司也有自己的Zigbee协议的实现方式二、开源：虽然宣称的Zigbee是开源的，但是跟底层硬件（如CC2530的寄存器具体配置）密切相关部分：MAC层与NWK层TI并未开源，而是以lib（库）配合相应的头文件（用户接口）实现，lib库的位置在：ZStack-CC2530-2.4.0-1.4.0ProjectszstackLibraries下所以更上的AF（应用程序框架），ZCL，ZDO等层只要包含lib

2、对应的头文件，即可调用库里的API函数三、Z-Stack：Z-Stack几乎都是C语言写的，即便是平时经常用C写过单片机程序的，读Z-Stack代码是还是有点困难的，原因如下1、用了大量的宏定义。程序中把用到的常量统统用宏定义表示，这样程序维护起来很方便2、用到大量的结构体struct与枚举emun比如简单的类型定义int，char，unsigned char等，只能表示简单的数据结构，复杂的数据结构用struct定义。如描述EndPoint的数据结构endPointDesc_t定义如下：此数据结构中又包含一层数据结构：SimpleDescriptionFormat_t最后在编写应用程序时，只

3、要用像 int num;一样定义一个变量就可以描述很复杂的数据了枚举：enum协议里的状态值基本上都是enum定义的值，如在SampleApp中的devStates_t SampleApp_NwkState;函数的状态返回值一般是用uint8（unsigned char）类型定义的，但是这样不够直观，不能通过名称表达返回的状态属于谁所以经过层层的typedef 定义得到 afStatus_t退去一层typedeftypedef ZStatus_t afStatus_t;再退去一层typedeftypedef Status_t ZStatus_t;最后得到的uint8typedef uint8

4、Status_t;到这一层定义我们就熟悉的typedef unsigned char uint8;unsigned char则是C语言中的基本数据类型3、随处可见的指针、引用（以下例子在上图的AF_DataRequest()函数的参数中抽取）协议里的指针有如下几种3.1最简单的指针类型uint8*buf 即一维数组3.2结构体指针afAddrType_t*dstAddr3.3函数指针2tasksArr其实是函数指针类型定义的函数指针数据，说得有点绕，看下图pTaskEventHandlerFn是可以定义形如下面语句的 指针数据类型即可以定义像这样的函数：unsigned short Funct

5、ion（参数1，参数2）其中unsigned short是返回值这样 就可以用pTaskEventHandlerFn定义 函数变量 了pTaskEventHandlerFn taskArr,由于taskArr是数组类型，所以只要给taskArr指定不同的索引值就可以调用不同的函数OSAL层的任务切换就是通过此方法协议里的引用引用是函数参数传递的一种变种，因为函数要求参数传递要一一对应，如上参数afAddrType_t*dstAddr的，所以当调用AF_DataRequest()函数时，必须传递一个afAddrType_t类型的指针变量但是，请看，在SampleApp.c文件中并不是结构体指针，

6、而是普通的结构体变量，所以在AF_DataRequest()函数调用时要使用引用，此时函数获得的仍然是此变量的地址，而不是变量的值四四、OSALOSALZ-Stack中引入了操作系统层OSAL，这样大大提高编程的灵活性，并且提高了CPU的运行效率但是此OS不是真正意义上的OS，因为他是通过在OS的一个主循环不停的调用task任务函数来实现任务调度的,并未实现真正的上下文切换Z-Stack的难度之一是OSAL层的编程，还有task、events、msg的理解，还有任务切换的方法具体分析请看Sheet2表五、最后是对协议本身的理解对TI提供的文档阅读几遍是必要的，即使不能完全理解，但是多读几遍会有

7、一个整体的理解，这样在code中遇到的陌生词汇ZDO、ZCL，AF等就不会陌生这样再去翻阅具体的ZDO等部分就会理解更深了对协议最简单的概述（我的理解过程）PD-SAP、MLDE-SAP、NLDE-SAP等都是协议各层的数据实体，也就是数据交换的接口，有具体的API函数PLME-SAP、MLME-SAP，等是协议各层的管理实体，也有具体的API函数建议：初学Zigbee或者单纯的开发简单的通信任务程序，根本不用管这些东西，看了反而更加复杂安全服务部分：最简单的安全设置就是修改那一串密钥了，暂时也不用管这些与应用程序编写 相关的部分有：Zigbee设备对象ZDO，应用支持子层AFS，还有协议族Z

8、CL这三个部分要好好的理解，对协议的理解和应用程序的编写都离不开他们，最好是对照协议的描述看他们对应的API函数注意ZCL层，Zigbee联盟为了使不同的IC厂商，不同的终端公司提供的zigbee设备都能互相访问而设置的ZCL与profile（我的理解）所以ZCL这一层与profile初学时也不必深究应用程序对象1240这里的1240就是EndPoint对应的值，0被zdo保留，240以上被协议保留，所以应程序可以定义的是1240这个功能是为复杂的程序应用提供的了方便，EndPoint相当于入口点，或者说是TCP/IP里的端口号，比如网页访问的80端口所以在一个程序中可以有多个EndPoint

9、，SampleApp实例中只用到了一个Profile，这个东西要从zigbee联盟获取商用的时候，但是实验室可以用公用的profile，只要相互访问的设备中保证profile的值相同就可以了在sheet2中分析OSAL层在sheet3中分析SampleApp示例程序的流程一、协议：Zigbee联盟规范了协议，具体的协议编程语言表述则由IC厂商指定，如德州仪器TI公司的基于CC2430与CC2530的Z-Stack二、开源：虽然宣称的Zigbee是开源的，但是跟底层硬件（如CC2530的寄存器具体配置）密切相关部分：MAC层与NWK层TI并未开源，而是以lib（库）配合相应的头文件（用户接口）实

10、现，lib库的位置在：ZStack-CC2530-2.4.0-1.4.0ProjectszstackLibraries下所以更上的AF（应用程序框架），ZCL，ZDO等层只要包含lib对应的头文件，即可调用库里的API函数三、Z-Stack：Z-Stack几乎都是C语言写的，即便是平时经常用C写过单片机程序的，读Z-Stack代码是还是有点困难的，原因如下比如简单的类型定义int，char，unsigned char等，只能表示简单的数据结构，复杂的数据结构用struct定义。最后在编写应用程序时，只要用像 int num;一样定义一个变量就可以描述很复杂的数据了协议里的状态值基本上都是enu

11、m定义的值，如在SampleApp中的devStates_t SampleApp_NwkState;函数的状态返回值一般是用uint8（unsigned char）类型定义的，但是这样不够直观，不能通过名称表达返回的状态属于谁3、随处可见的指针、引用（以下例子在上图的AF_DataRequest()函数的参数中抽取）tasksArr其实是函数指针类型定义的函数指针数据，说得有点绕，看下图即可以定义像这样的函数：unsigned short Function（参数1，参数2）pTaskEventHandlerFn taskArr,由于taskArr是数组类型，所以只要给taskArr指定不同的索

12、引值就可以调用不同的函数引用是函数参数传递的一种变种，因为函数要求参数传递要一一对应，如上参数afAddrType_t*dstAddr的，所以当调用AF_DataRequest()函数时，必须传递一个afAddrType_t类型的指针变量并不是结构体指针，而是普通的结构体变量，所以在AF_DataRequest()函数调用时要使用引用，此时函数获得的仍然是此变量的地址，Z-Stack中引入了操作系统层OSAL，这样大大提高编程的灵活性，并且提高了CPU的运行效率但是此OS不是真正意义上的OS，因为他是通过在OS的一个主循环不停的调用task任务函数来实现任务调度的,并未实现真正的上下文切换Z-

13、Stack的难度之一是OSAL层的编程，还有task、events、msg的理解，还有任务切换的方法对TI提供的文档阅读几遍是必要的，即使不能完全理解，但是多读几遍会有一个整体的理解，这样在code中遇到的陌生词汇ZDO、ZCL，AF等就不会陌生PD-SAP、MLDE-SAP、NLDE-SAP等都是协议各层的数据实体，也就是数据交换的接口，有具体的API函数建议：初学Zigbee或者单纯的开发简单的通信任务程序，根本不用管这些东西，看了反而更加复杂与应用程序编写 相关的部分有：Zigbee设备对象ZDO，应用支持子层AFS，还有协议族ZCL这三个部分要好好的理解，对协议的理解和应用程序的编写都

14、离不开他们，最好是对照协议的描述看他们对应的API函数注意ZCL层，Zigbee联盟为了使不同的IC厂商，不同的终端公司提供的zigbee设备都能互相访问而设置的ZCL与profile（我的理解）这里的1240就是EndPoint对应的值，0被zdo保留，240以上被协议保留，所以应程序可以定义的是1240这个功能是为复杂的程序应用提供的了方便，EndPoint相当于入口点，或者说是TCP/IP里的端口号，比如网页访问的80端口Profile，这个东西要从zigbee联盟获取商用的时候，但是实验室可以用公用的profile，只要相互访问的设备中保证profile的值相同就可以了OSAL层的运行

15、方式的，任务的调度，msg消息的传递，以及事件的响应总述：其实Z-Stack已经把协议封装的很好了，要用到了API函数就那么几个，所以研究Zigbee初期的重点在OSAL运行流程的理解一、OSAL运行流程main函数在Zmain.c文件中上图是main函数的末尾部分osal_start_system()函数里调用了函数大循环，所有的任务调度都在这里面实现在系统运行之前还要有一些初始化：硬件初始化UART，LED，KEY等，还有就是任务初始化在OSAL.c文件中主循环在osal_run_system()中，在文件OSAL.c中osal_run_system（）的流程图Osal runosalTi

16、meUpdate()Hal_ProcessPoll()If(tasksEventsidx)HAL_ENTER _CRITICAL_SECTIONevents=(tasksArridx)(idx,events)HAL_EXIT_CRITICAL_SECTIONtasksEventsidx=events是否If(+idx tasksCnt)是否更新Time硬件查询（keys）判断每个task的tasksEvents是否有事件存在taskEvents为uint16类型的数据，16位，因此每个tasks最多可以有16个内部事件每个tasks调度前必须关闭中断，进入绝对控制阶段tasksArr为函数指针

17、数据，通过指定idx索引实现调用不同的函数，并且给被调用的函数传递了两个参数：idx，events退出绝对控制保存尚未处理的事件OS的tasks任务每次只处理一个事件，保证每个tasks不会占用太多CPU时间二，tasks任务流程OS里面已经做好所有工作用户只需编写自己的tasks函数，tasks初始化函数即可然后在任务列表tasksArr中添加任务与用户有关的OS层的代码在OSAL_SampleApp.c中的，（这样的OSAL_XXXApp.c）OSAL_SampleApp.cOsal runosalTimeUpdate()Hal_ProcessPoll()If(tasksEventsidx

18、)HAL_ENTER _CRITICAL_SECTIONevents=(tasksArridx)(idx,events)HAL_EXIT_CRITICAL_SECTIONtasksEventsidx=events是否If(+idx tasksCnt)是否更新Time硬件查询（keys）判断每个task的tasksEvents是否有事件存在taskEvents为uint16类型的数据，16位，因此每个tasks最多可以有16个内部事件每个tasks调度前必须关闭中断，进入绝对控制阶段tasksArr为函数指针数据，通过指定idx索引实现调用不同的函数，并且给被调用的函数传递了两个参数：idx，e

19、vents退出绝对控制保存尚未处理的事件OS的tasks任务每次只处理一个事件，保证每个tasks不会占用太多CPU时间三、消息的发送，此处以KEY按键事件为例关于回调函数在某一个源文件中的某个函数里，通过函数指针的方式调用了此函数指针变量，这样就调用了这个回调函数，但是此回调函数并未在此文件中实现而是以一定的模板（如参数1，参数2）提供给用户完善这个回调函数1、zmain.c文件中的 main()函数的initBoard()初始化程序的Hal_Key部分InitBoard中调用HalKeyConfig设置key为查询方式，且回调函数为OnBoard_KeyCallbackHalKeyConf

20、ig函数中将回调函数地址cback传给全局指针变量pHalKeyProcessFunction最终可以找到调用OnBoard_KeyCallback的地方由于pHalKeyProcessFunction=cback所以在Hal_key.c中，最后四、消息的接收用户的消息是在SampleApp.c中接收然后处理的afIncomingMSGPacket_t是一个接受消息的数据结构，用于声明消息变量，但此变量的具体值由osal_msg_receive（）函数决定MSGpkt由osal_msg_receive填充，注意此处，有一个强制类型转换，也就是说osal_msg_receive产生的是unint

21、8*类型，需要强制转换成afIncomingMSGPacket_t类型MSGpakt具体数据，最终是由osal_msg_send的参数决定的注注意意：事件与消息不同SYS_EVENT_MSG是事件，HEY_CHANGE则是消息事件是位权的，即events的每一位代表一个事件，所以OSAL的每一个tasks任务最多有16个事件，注意是每个tasks都有独立的16个事件SYS_EVENT_MSG的值为0 x8000所以用户自定义的事件要用除此之外的15个位消息则有很多，因为消息是以数值区分的，只要值不相同即可所以消息最多有65536个（两个字节）KEY_CHANGE，AF_INCOMING_MSG

22、_CMD均属于消息在ZComDef.h中系统消息都在此定义从0 xE00 xFC是留给用户的应用程序的，共29个消息此函数里有几个外部全局变量：tasksEventstasksCnttasksArrOSAL层的运行方式的，任务的调度，msg消息的传递，以及事件的响应其实Z-Stack已经把协议封装的很好了，要用到了API函数就那么几个，所以研究Zigbee初期的重点在OSAL运行流程的理解osal_start_system()函数里调用了函数大循环，所有的任务调度都在这里面实现在系统运行之前还要有一些初始化：硬件初始化UART，LED，KEY等，还有就是任务初始化C语言中的变量声明与定义是不同

23、的声明是表示此变量名存在，而定义则是给变量赋予具体的数据以上三变量均是在类似OSAL_SampleApp.c中声明或定义的然后在OSAL_tasks.h中又声明了他们为外部变量然后OSAL.c中包含了OSAL_tasks.h的头文件，所以才能在OSAL.c中正常的使用他们Osal runosalTimeUpdate()Hal_ProcessPoll()If(tasksEventsidx)HAL_ENTER _CRITICAL_SECTIONevents=(tasksArridx)(idx,events)HAL_EXIT_CRITICAL_SECTIONtasksEventsidx=events

24、是否If(+idx tasksCnt)是否更新Time硬件查询（keys）判断每个task的tasksEvents是否有事件存在taskEvents为uint16类型的数据，16位，因此每个tasks最多可以有16个内部事件每个tasks调度前必须关闭中断，进入绝对控制阶段tasksArr为函数指针数据，通过指定idx索引实现调用不同的函数，并且给被调用的函数传递了两个参数：idx，events退出绝对控制保存尚未处理的事件OS的tasks任务每次只处理一个事件，保证每个tasks不会占用太多CPU时间Osal runosalTimeUpdate()Hal_ProcessPoll()If(ta

25、sksEventsidx)HAL_ENTER _CRITICAL_SECTIONevents=(tasksArridx)(idx,events)HAL_EXIT_CRITICAL_SECTIONtasksEventsidx=events是否If(+idx tasksCnt)是否更新Time硬件查询（keys）判断每个task的tasksEvents是否有事件存在taskEvents为uint16类型的数据，16位，因此每个tasks最多可以有16个内部事件每个tasks调度前必须关闭中断，进入绝对控制阶段tasksArr为函数指针数据，通过指定idx索引实现调用不同的函数，并且给被调用的函数传

26、递了两个参数：idx，events退出绝对控制保存尚未处理的事件OS的tasks任务每次只处理一个事件，保证每个tasks不会占用太多CPU时间Key的回调函数，如果SendKey消息失败则会处理相应的KEY，在OnBoard文件中在某一个源文件中的某个函数里，通过函数指针的方式调用了此函数指针变量，这样就调用了这个回调函数，但是此回调函数并未在此文件中实现InitBoard中调用HalKeyConfig设置key为查询方式，且回调函数为OnBoard_KeyCallbackHalKeyConfig函数中将回调函数地址cback传给全局指针变量pHalKeyProcessFunctionafI

27、ncomingMSGPacket_t是一个接受消息的数据结构，用于声明消息变量，但此变量的具体值由osal_msg_receive（）函数决定MSGpkt由osal_msg_receive填充，注意此处，有一个强制类型转换，也就是说osal_msg_receive产生的是unint8*类型，事件是位权的，即events的每一位代表一个事件，所以OSAL的每一个tasks任务最多有16个事件，向注册过Key消息的TaskID发送KEY_CHANGE消息Key的回调函数，如果SendKey消息失败则会处理相应的KEY，在OnBoard文件中registeredKeysTaskID在 OnBoard

28、.c中的RegisterForKeys中赋值向注册过Key消息的TaskID发送KEY_CHANGE消息SampleApp_Init调用RegisterForKeys，Key只可以被一个任务注册，注册后，其他Task无法再注册按键服务registeredKeysTaskID在 OnBoard.c中的RegisterForKeys中赋值SampleApp_Init调用RegisterForKeys，Key只可以被一个任务注册，注册后，其他Task无法再注册按键服务SampleApp流程分析Z-Stack器件在上电时，会自动加入网络，如果用户不干涉也就是说，当协调器的器件上电时，会自动建立网络，而

29、router，跟endDevice会自动搜寻网络并加入所以不管是SampleApp还是别的应用程序均不用处理这部分此处注意，不要与绑定binding混淆绑定是将两个或多个器件关联在一起，不需要目标地址就可以成功的发送数据假如直接填写已知的目标短地址，不需要绑定，也可以发送数据的一般绑定才需要人工干预（按键等行为触法binding）另外，不管协调器，路由器，端点，他们的处理过程是要写成一样的，只是配置不同这一点就要求SampleApp_Process_Event包含不同器件类型的发送与接收SampleApp实例程序，用户部分并没有处理绑定匹配等操作，而是将所有器件假如一个群组Group，只要在这

30、个群组Group的器件成员就可以在未知对方ShortAddress的情况下发送、接收数据SW1按键按下后，向对方发送LED闪烁的信号，SW2按键按下后可以加入或者退出群组Group，只有加入群组后才能相互通信下面列出OS运行到SampleApp的流程，然后在描述为什么需要定义很多变量OSAL_RUNmacEventLoopOSAL_INITnwk_event_loopHal_ProcessEventAPS_event_loopZDApp_event_loopSampleApp_ProcessEventmacTaskInitnwk_initHal_InitAPS_InitZDApp_InitSa

31、mpleApp_InitSampeApp_Init设置初始状态为DEV_INIT注册应用程序的endpointSampleApp用到了按键，所以注册按键消息由于未使用绑定，未知目标短地址，所以加入群组只要是一个群组类的成员，都可以接收信息SampleApp_ProcessEvent因为是基于操作体统，所以任务中的每个事件的逻辑关系都是平等的，先后关系不是那么的强烈SampleApp_ProcessEventSYS_EVENT_MSGSAMPLEAPP_SEND_PERIODIC _MSG_EVTKEY_CHANGEAF_INCOMING_MSG_CMDZDO_STATE_CHANGESampl

32、eApp_HandleKeys()SampleApp_MessageMSGCB()osal_start_timerExSampleApp_SendPeriodicMessage()DEV_INITafRegisterRegisterForKeysaps_AddGroup消息接收端 处理过程按键1向对方发送闪烁的消息按键2，加入或退出此GroupSampleApp_ProcessEventSYS_EVENT_MSGSAMPLEAPP_SEND_PERIODIC _MSG_EVTKEY_CHANGEAF_INCOMING_MSG_CMDZDO_STATE_CHANGESampleApp_Handl

33、eKeys()SampleApp_MessageMSGCB()osal_start_timerExSampleApp_SendPeriodicMessage()族定义一个是周期性闪烁的命令另一个是按键出发的闪烁命令由于此应用中协调器，路由器，端点，三种又是消息发送的主体，也是消息接收的主体所以输入输出族是相同的输入族是表示要处理的接收到的消息而输出族，表示要发送相应的消息一个器件中，可以同时有输入输出族，也可以拥有其中一个在TI提供的实例程序基础之上进行修改，最简单的是SampleApp，不处理绑定，只需加入群组即可通信第二是GenericApp，这个是有绑定处理的也就是说，当协调器的器件上电

34、时，会自动建立网络，而router，跟endDevice会自动搜寻网络并加入另外，不管协调器，路由器，端点，他们的处理过程是要写成一样的，只是配置不同SampleApp实例程序，用户部分并没有处理绑定匹配等操作，而是将所有器件假如一个群组Group，只要在这个群组Group的器件成员SW1按键按下后，向对方发送LED闪烁的信号，SW2按键按下后可以加入或者退出群组Group，只有加入群组后才能相互通信OSAL_RUNmacEventLoopOSAL_INITnwk_event_loopHal_ProcessEventAPS_event_loopZDApp_event_loopSampleApp

35、_ProcessEventmacTaskInitnwk_initHal_InitAPS_InitZDApp_InitSampleApp_InitSampleApp_epDesc的填充周期闪烁的消息 发送端处理过程由于未使用绑定，未知目标短地址，所以加入群组因为是基于操作体统，所以任务中的每个事件的逻辑关系都是平等的，先后关系不是那么的强烈SampleApp_ProcessEventSYS_EVENT_MSGSAMPLEAPP_SEND_PERIODIC _MSG_EVTKEY_CHANGEAF_INCOMING_MSG_CMDZDO_STATE_CHANGESampleApp_HandleKe

36、ys()SampleApp_MessageMSGCB()osal_start_timerExSampleApp_SendPeriodicMessage()上电后，一旦器件的类型行程，就开始准备周期性向目标TaskID发送事件处理命令SampleApp_ProcessEventSYS_EVENT_MSGSAMPLEAPP_SEND_PERIODIC _MSG_EVTKEY_CHANGEAF_INCOMING_MSG_CMDZDO_STATE_CHANGESampleApp_HandleKeys()SampleApp_MessageMSGCB()osal_start_timerExSampleApp_SendPeriodicMessage()由于此应用中协调器，路由器，端点，三种又是消息发送的主体，也是消息接收的主体在TI提供的实例程序基础之上进行修改，最简单的是SampleApp，不处理绑定，只需加入群组即可通信最终调用数据发送的API函数周期闪烁的消息 发送端处理过程假如想发送更多的数据，只需再次处理buffer数据，添加更多的有用数据然后再在这里处理添加的数据上电后，一旦器件的类型行程，就开始准备周期性向目标TaskID发送事件处理命令最终调用数据发送的API函数