[zigbee][z-Stack]协议栈简介及工作流程

什么是zigbee协议栈？

协议栈是协议的具体实现形式，通俗点来理解就是协议栈是协议和用户之间的一个缺口，开发人员通过使用协议栈来使用这个协议的，进而实现无线数据收发。

ZigBee的协议分为两部分，IEEE 802.15.4定义了PHY（物理层）和MAC（介质访问层）技术规范；ZigBee联盟定义了NWK（网络层）　APS（应用程序支持子层）　APL（应用层）技术规范。

ZigBee协议栈就是将各个层定义的协议都集合在一起，以函数的形式实现，并给用户提供API（应用层），用户可以直接调用。
无线网络协议层

如何使用zigbee协议栈？

协议栈是协议的实现，可以理解为代码，函数库，供上层应用调用，协议栈底下的层与应用是相互独立的。商业的协议栈就是给你写好了底层的代码，符合协议标准，提过给你一个功能模块给你调用。

我们需要关心的是我们的应用逻辑，数据从哪里到哪里，怎么存储，处理；还有系统里的设备之间的听信顺序什么的，当你的应用需要数据通信时，调用组网函数给你组建你想要的网络；当你想从一个设备发数据到另一个设备时，调用无线数据发送函数；当然，接收端就调用接收函数；当你的设备没事干的时候你就调用睡眠函数；要干活的时候就调用唤醒函数。

所以当你做具体应用时，不需要关心协议栈是怎么写的，里面的每条代码是什么意思。除非你要做协议研究。每个厂商的协议栈有区别，也就是函数名称和参数可能有区别，这个要看具体的例子、说明文档。

举个例子，用户实现一个简单的无线数据通信时的一般步骤：

    1、组网：调用协议栈的组网函数、加入网络函数，实现网络的建立与节点的加入。

    2、发送：发送节点调用协议栈的无线数据发送函数，实现无线数据发送。

    3、接收：接收节点调用协议栈的无线数据接收函数，实现无线数据接收。

是不是看上去很简单啊，其实协议栈很多都封装好了，下面我们大概看看无线发送函数：

afStatus_t AF_DataRequest(afAddrType_t *dstAddr,
                          endPointDesc_t *srcEP,
                          uint16 cID,
                          uint16 len,  //发送数据的长度
                          uint8 *buf,  //指向存放发送数据的缓冲区的指针
                          uint8 *transID,
                          uint8 options,
                          uint8 radiuis)

用户调用该函数即可实现数据的无线数据的发送，此函数中有8个参数，用户需要将每个参数的含义理解以后，才能熟练使用该函数进行无线数据通信的目的。现在只讲其中最重要的两个参数，其它参数不需要死记硬背，以后用多了自然就记住了。

至于调用该函数后，如何初始化硬件进行数据发送等工作，用户不需要关心， ZigBee协议栈己经将所需要的工作做好了，我们只需要调用相应的API函数即可，而不必关心具体实现细节。

z-Stack工作流程

下载z-Stack 提取码：qta9

打开工程：

ZStack2.5.1a\Projects\zstack\Samples\SampleApp\CC2530DB\SampleApp.eww

建议大家复制工程到非中文目录，因为有些开发环境对中文路径的支持不友好；还有就是不要把文件放的太深层目录下，目录太长，打开工程是IAR会关闭；（如果使用 IAR 打开工程停止响应或关闭，说明你路径太长， IAR 不识别，把路径改短或移上几层目录即可解决）

App：应用层目录，这是用户创建各种不同工程的区域，在这个目录中包含了应用层的内容和这个项目的主要内容。

HAL：硬件层目录，包含有与硬件相关的配置和驱动及操作函数。

MAC：MAC层目录，包含了MAC层的参数配置文件及其MAC的LIB库的函数接口文件。

MT：实现通过串口可控制各层，并与各层进行直接交互

NWK：网络层目录，包含网络层配置参数文件网络层库的函数接口文件及APS层库的函数接口。

OSAL：协议栈的操作系统。

Profile：Application framework应用框架层目录，包含AF层处理函数文件。应用框架层是应用程序APS层的无线数据接口。

Security：安全层目录，包含安全层处理函数，比如加密函数等

Services：地址处理函数目录，包括地址模式的定义及地址处理函数。

Tools：工程配置目录，包括空间划分及Z-Stack相关配置信息。

ZDO：ZDO目录

ZMac：MAC层目录，包括MAC层参数配置及MAC层LIB库函数回调处理函数。

ZMain：主函数目录，包括入口函数及硬件配置文件。

Output：输出文件目录，由IAR IDE自动生成

看到工程中有这么多的文件夹和文件，先不要害怕，带着疑问做实验就行，做的多了就明白了。

用户自己添加的应用任务程序在 Zstack 中的调用过程：

main()---> osal_init_system()---> osalInitTasks()---> SampleApp_Init()

打开ZMain.c找到main函数

int main( void )
{
	osal_int_disable( INTS_ALL ); //关闭所有中断
	HAL_BOARD_INIT(); //初始化系统时钟
	zmain_vdd_check(); //检查芯片电压是否正常
	InitBoard( OB_COLD ); //初始化 I/O ， LED 、 Timer 等
	HalDriverInit(); //初始化芯片各硬件模块
	osal_nv_init( NULL ); //初始化 Flash 存储器
	ZMacInit(); //初始化 MAC 层
	zmain_ext_addr(); //确定 IEEE 64 位地址
	zgInit(); //初始化非易失变量
	#ifndef NONWK
	// Since the AF isn't a task, call it's initialization routine
	afInit();
	#endif
	osal_init_system(); //初始化操作系统
	osal_int_enable( INTS_ALL ); //使能全部中断
	InitBoard( OB_READY ); //最终板载初始化
	zmain_dev_info(); //显示设备信息
	#ifdef LCD_SUPPORTED
	zmain_lcd_init(); //初始化 LCD
	#endif
	#ifdef WDT_IN_PM1
	/* If WDT is used, this is a good place to enable it. */
	WatchDogEnable( WDTIMX );
	#endif
	osal_start_system();// No Return from here 执行操作系统，进去后不会返回
	return 0; // Shouldn't get here.
} // main()

看了上面的代码后，可能感觉很多函数不认识。没关系刚开始大概了解流程即可， main 函数先执行初始化工作，包括硬件、网络层、任务等的初始化。然后执行 osal_start_system(); 操作系统。进去后可不会回来了。

在这里，我们重点了解 2 个函数：

        初始化操作系统 osal_init_system();
        运行操作系统 osal_start_system();

先来看osal_init_system();系统初始化函数，进入函数。如果用IAR看代码可在函数名上单击右键——go to definition of…，便可以进入函数。发现里面有6个初始化函数，这里我们只关心 osalInitTasks();任务初始化函数，继续由该函数进入。

void osalInitTasks( void )
{
	uint8 taskID = 0;
	// 分配内存，返回指向缓冲区的指针
	tasksEvents = (uint16 *)osal_mem_alloc( sizeof( uint16 ) * tasksCnt);
	// 设置所分配的内存空间单元值为 0
	osal_memset( tasksEvents, 0, (sizeof( uint16 ) * tasksCnt));
	// 任务优先级由高向低依次排列，高优先级对应 taskID 的值反而小
	macTaskInit( taskID++ ); //macTaskInit(0) ，用户不需考虑
	nwk_init( taskID++ ); //nwk_init(1)，用户不需考虑
	Hal_Init( taskID++ ); //Hal_Init(2) ，用户需考虑
	#if defined( MT_TASK ) //如果定义 MT_TASK 则调用 MT_TaskInit（）
	MT_TaskInit( taskID++ );
	#endif
	APS_Init( taskID++ ); //APS_Init(3) ，用户不需考虑
	#if defined ( ZIGBEE_FRAGMENTATION )
	APSF_Init( taskID++ );
	#endif
	ZDApp_Init( taskID++ ); //ZDApp_Init(4) ，用户需考虑
	#if defined ( ZIGBEE_FREQ_AGILITY ) || defined ( ZIGBEE_PANID_CONFLICT )
	ZDNwkMgr_Init( taskID++ );
	#endif
	//用户创建的任务
	SampleApp_Init( taskID ); // SampleApp_Init _Init(5)，用户需考虑。重要!
}

函数对 taskID 进行初始化，每初始化一个， taskID++。大家看到了注释后面有些写着用户需要考虑，有些则写着用户不需考虑。没错，需要考虑的用户可以根据自己的硬件平台或者其他设置，而写着不需考虑的也是不能修改的。TI 公司协议栈已完成。SampleApp_Init()是我们 应 用 协 议 栈 例 程 的 必 要 函 数 ， 用 户 通 常 在 这 里 初 始 化 自 己 的 东 西 。至 此 ，osal_init_system();大概了解完毕。

接下来看第二个函数 osal_start_system();运行操作系统。同样用go to definition 的方法进入该函数。

void osal_start_system( void )
{
	#if !defined ( ZBIT ) && !defined ( UBIT )
	for(;;) // Forever Loop
	#endif
	{
		uint8 idx = 0;
		osalTimeUpdate(); //扫描哪个事件被触发了，然后置相应的标志位
		Hal_ProcessPoll(); //轮询 TIMER 与 UART
		do {
		if (tasksEvents[idx]) // Task is highest priority that is ready.
		{
			break; //得到待处理的最高优先级任务索引号 idx
		}
		} while (++idx < tasksCnt);
		if (idx < tasksCnt)
		{
			uint16 events;
			halIntState_t intState;
			HAL_ENTER_CRITICAL_SECTION(intState);// 进入临界区,保护
			events = tasksEvents[idx]; //提取需要处理的任务中的事件
			tasksEvents[idx] = 0; //清除本次任务的事件
			HAL_EXIT_CRITICAL_SECTION(intState); // 退出临界区
			events = (tasksArr[idx])( idx, events );//通过指针调用任务处理函数，关键
			HAL_ENTER_CRITICAL_SECTION(intState); //进入临界区
			tasksEvents[idx] |= events; // 保存未处理的事件 Add back unprocessed events
			to the current task.
			HAL_EXIT_CRITICAL_SECTION(intState); // 退出临界区
		}
		#if defined( POWER_SAVING )
		else // Complete pass through all task events with no activity?
		{
			osal_pwrmgr_powerconserve(); // Put the processor/system into sleep
		}
	#endif
	}
}

看一下 events = tasksEvents[idx]; 进入 tasksEvents[idx]数组定义，发现恰好是osalInitTasks()函数里面分配空间初始化过的 tasksEvents。而且 taskID 一一对应。这就是初始化与调用的关系。taskID 把任务联系起来了。

SampleApp_Init()用户应用任务初始化函数

void SampleApp_Init( uint8 task_id )
{
	SampleApp_TaskID = task_id;//osal 分配的任务 ID 随着用户添加任务的增多而改变
	SampleApp_NwkState = DEV_INIT; //设备状态设定为 ZDO 层中定义的初始化状态
	/*初始化应用设备的网络类型，设备类型的改变都要产生一个事件—ZDO_STATE_CHANGE，从字
	面理解为 ZDO 状态发生了改变。所以在设备初始化的时候一定要把它初始化为什么状态都没
	有。那么它就要去检测整个环境，看是否能重新建立或者加入存在的网络。但是有一种情况
	例外，就是当 NV_RESTORE 被设置的候（ NV_RESTORE 是把信息保存在非易失存储器中），那么
	当设备断电或者某种意外重启时，由于网络状态存储在非易失存储器中，那么此时就只需要
	恢复其网络状态，而不需要重新建立或者加入网络了.这里需要设置 NV_RESTORE 宏定义。*/
	SampleApp_TransID = 0; //消息发送 ID（多消息时有顺序之分）
	#if defined ( BUILD_ALL_DEVICES )
	if ( readCoordinatorJumper() )
	zgDeviceLogicalType = ZG_DEVICETYPE_COORDINATOR;
	else
	zgDeviceLogicalType = ZG_DEVICETYPE_ROUTER;
	#endif // BUILD_ALL_DEVICES
	//该段的意思是，如果设置了 HOLD_AUTO_START 宏定义，将会在启动芯片的时候会暂停启动
	流程，只有外部触发以后才会启动芯片。其实就是需要一个按钮触发它的启动流程。
	#if defined ( HOLD_AUTO_START )
	ZDOInitDevice(0);
	#endif
	//设置发送数据的方式和目的地址寻址模式
	//发送模式:广播发送
	SampleApp_Periodic_DstAddr.addrMode = (afAddrMode_t)AddrBroadcast; //广播
	SampleApp_Periodic_DstAddr.endPoint = SAMPLEAPP_ENDPOINT; //指定端点号
	SampleApp_Periodic_DstAddr.addr.shortAddr = 0xFFFF;//指定目的网络地址为广播地址
	//发送模式:组播发送 Setup for the flash command's destination address - Group 1
	SampleApp_Flash_DstAddr.addrMode = (afAddrMode_t)afAddrGroup; //组寻址
	SampleApp_Flash_DstAddr.endPoint = SAMPLEAPP_ENDPOINT; //指定端点号
	SampleApp_Flash_DstAddr.addr.shortAddr = SAMPLEAPP_FLASH_GROUP; //组号 0x0001
	//定义本设备用来通信的 APS 层端点描述符
	SampleApp_epDesc.endPoint = SAMPLEAPP_ENDPOINT;
	SampleApp_epDesc.task_id = &SampleApp_TaskID; //SampleApp 描述符的任务 ID
	SampleApp_epDesc.simpleDesc //SampleApp 简单描述符
	= (SimpleDescriptionFormat_t *)&SampleApp_SimpleDesc;
	SampleApp_epDesc.latencyReq = noLatencyReqs; //延时策略
	//向 AF 层登记描述符, 登记 endpoint description 到 AF,要对该应用进行初始化并在 AF
	/*进行登记，告诉应用层有这么一个 EP 已经开通可以使用，那么下层要是有关于该应用的信
	息或者应用要对下层做哪些操作，就自动得到下层的配合*/
	afRegister( &SampleApp_epDesc );
	// 登记所有的按键事件
	RegisterForKeys( SampleApp_TaskID );
	// By default, all devices start out in Group 1
	SampleApp_Group.ID = 0x0001; //组号
	osal_memcpy( SampleApp_Group.name, "Group 1", 7 ); //设定组名
	aps_AddGroup( SAMPLEAPP_ENDPOINT, &SampleApp_Group ); //把该组登记添加到 APS 中
	#if defined ( LCD_SUPPORTED )
	HalLcdWriteString( "SampleApp", HAL_LCD_LINE_1 ); //如果支持 LCD，显示提示信息
	#endif
}

SampleApp_ProcessEvent() 用户应用任务的事件处理函数

uint16 SampleApp_ProcessEvent( uint8 task_id, uint16 events )
{
	afIncomingMSGPacket_t *MSGpkt;
	(void)task_id; // Intentionally unreferenced parameter
	if ( events & SYS_EVENT_MSG ) //接收系统消息再进行判断
	{
		//接收属于本应用任务SampleApp的消息，以SampleApp_TaskID标记
		MSGpkt = (afIncomingMSGPacket_t *)osal_msg_receive( SampleApp_TaskID );
		while ( MSGpkt )
		{
			switch ( MSGpkt->hdr.event )
			{
				// Received when a key is pressed
				case KEY_CHANGE://按键事件
					SampleApp_HandleKeys( ((keyChange_t *)MSGpkt)->state, ((keyChange_t
					*)MSGpkt)->keys );
					break;
				// Received when a messages is received (OTA) for this endpoint
				case AF_INCOMING_MSG_CMD: //接收数据事件,调用函数 AF_DataRequest()接收数据
					SampleApp_MessageMSGCB( MSGpkt ); //调用回调函数对收到的数据进行处理
					break;
				// Received whenever the device changes state in the network
				case ZDO_STATE_CHANGE: //只要网络状态发生改变，就通过ZDO_STATE_CHANGE事件通知所有的任务。同时完成对协调器，路由器，终端的设置
					SampleApp_NwkState = (devStates_t)(MSGpkt->hdr.status);
					//if ( (SampleApp_NwkState == DEV_ZB_COORD) //实验中协调器只接收数据所以取消发送事件
					if ( (SampleApp_NwkState == DEV_ROUTER) || (SampleApp_NwkState ==
					DEV_END_DEVICE) )
					{
						//这个定时器只是为发送周期信息开启的，设备启动初始化后从这里开始触发第一个周期信息的发送，然后周而复始下去。
						osal_start_timerEx( SampleApp_TaskID,
						SAMPLEAPP_SEND_PERIODIC_MSG_EVT,
						SAMPLEAPP_SEND_PERIODIC_MSG_TIMEOUT );
					}
					else
					{
						// Device is no longer in the network
					}
					break;
					
				default:
					break;
			}
			// Release the memory //事件处理完了，释放消息占用的内存
			osal_msg_deallocate( (uint8 *)MSGpkt );
			//指针指向下一个放在缓冲区的待处理的事件，返回 while ( MSGpkt )重新处理事件，
			直到缓冲区没有等待处理事件为止
			MSGpkt = (afIncomingMSGPacket_t *)osal_msg_receive( SampleApp_TaskID );
		}
		// return unprocessed events //返回未处理的事件
		return (events ^ SYS_EVENT_MSG);
	}
	// Send a message out - This event is generated by a timer
	// (setup in SampleApp_Init()).
	if ( events & SAMPLEAPP_SEND_PERIODIC_MSG_EVT )
	{
		/*处理周期性事件，利用 SampleApp_SendPeriodicMessage()处理完当前的周期性事件，
		然后启动定时器开启下一个周期性事情，这样一种循环下去，也即是上面说的周期性事件了，
		可以做为传感器定时采集、上传任务*/
		SampleApp_SendPeriodicMessage();
		// Setup to send message again in normal period (+ a little jitter)
		osal_start_timerEx(SampleApp_TaskID,SAMPLEAPP_SEND_PERIODIC_MSG_EVT,
		(SAMPLEAPP_SEND_PERIODIC_MSG_TIMEOUT + (osal_rand() & 0x00FF)) );
		// return unprocessed events 返回未处理的事件
		return (events ^ SAMPLEAPP_SEND_PERIODIC_MSG_EVT);
	}
	// Discard unknown events
	return 0;
}

分析接收数据函数 SampleApp_MessageMSGCB

//接收数据，参数为接收到的数据
void SampleApp_MessageMSGCB( afIncomingMSGPacket_t *pkt )
{
	uint16 flashTime;
	byte buf[3];
	switch ( pkt->clusterId ) //判断簇 ID
	{
		case SAMPLEAPP_PERIODIC_CLUSTERID: //收到广播数据
		osal_memset(buf, 0 , 3);
		osal_memcpy(buf, pkt->cmd.Data, 2); //复制数据到缓冲区中
		if(buf[0]=='D' && buf[1]=='1') //判断收到的数据是否为“ D1”
		{
			HalLedBlink(HAL_LED_1, 0, 50, 500); //如果是则 Led1 间隔 500ms 闪烁
			#if defined(ZDO_COORDINATOR) //协调器收到"D1"后,返回"D1"给终端，让终端 Led1 也闪烁
			SampleApp_SendPeriodicMessage();
			#endif
			}
			else
			{
				HalLedSet(HAL_LED_1, HAL_LED_MODE_ON);
			}
			break;
		case SAMPLEAPP_FLASH_CLUSTERID: //收到组播数据
			flashTime = BUILD_UINT16(pkt->cmd.Data[1], pkt->cmd.Data[2] );
			HalLedBlink( HAL_LED_4, 4, 50, (flashTime / 4) );
			break;
	}
}

分析发送周期信息 SampleApp_SendPeriodicMessage()

void SampleApp_SendPeriodicMessage( void )
{
   byte SendData[3]="D1";
   // 调用 AF_DataRequest 将数据无线广播出去
   if( AF_DataRequest( &SampleApp_Periodic_DstAddr, &SampleApp_epDesc,
   SAMPLEAPP_PERIODIC_CLUSTERID,
   2,
   SendData,
   &SampleApp_TransID,
   AF_DISCV_ROUTE,
   AF_DEFAULT_RADIUS ) == afStatus_SUCCESS )
   {
   }
   else
   {
   		HalLedSet(HAL_LED_1, HAL_LED_MODE_ON);
   		// Error occurred in request to send.
   }
}

AF_DataRequest 发送函数

AF_DataRequest( &SampleApp_Periodic_DstAddr, //发送目的地址＋端点地址和传送模式
&SampleApp_epDesc, //源(答复或确认)终端的描述（比如操作系统中任务 ID 等）源 EP
SAMPLEAPP_PERIODIC_CLUSTERID, //被 Profile 指定的有效的集群号
2, // 发送数据长度
SendData,// 发送数据缓冲区
&SampleApp_TransID, // 任务 ID 号
AF_DISCV_ROUTE, // 有效位掩码的发送选项
AF_DEFAULT_RADIUS ) //传送跳数，通常设置为 AF_DEFAULT_RADIUS

内容很多但非常重要，最好尽力理解后再去做，会容易很多。

end.