ZStack API解读3

应用框架（AF）

应用框架层是应用道APS层的OTA数据接口。此层也接收数据消息的终端多路复用器。AF为应用提供以下功能：

·                    终端（Endpoint）管理

·                    发送和接收数据

哈哈，这里的函数应该就是我们经常要用到的函数了。

终端管理

每个设备都是Zigbee中的节点，每个节点有长地址和短地址，短地址被其他设备用来发送数据。每个节点又241个终端（0保留，1-240可分配给应用）。每个终端可以独立设置地址；当设备发送数据时必须指定目标设备的短地址和接收终端。一个应用必须注册一个或多个终端用来接收或者发送数据。

简单描述符-SimpLEDescriptionFormat_t

每个终端都必须有一个Zigbee简单描述。这些描述对Zigbee网络刻画了这个终端，其他设备可以询问这个终端以知道这个设备的类型。

typedef struct

{

 byte         EndPoint;

 uint16       AppProfId;

 uint16       AppDeviceId;

 byte         AppDevVer:4;

 byte         Reserved:4;            // AF_V1_SUPPORT uses for AppFlags:4.

 byte         AppNumInClusters;

  cId_t        *pAppInClusterList;

 byte         AppNumOutClusters;

 cId_t        *pAppOutClusterList;

} SimpleDescriptionFormat_t;

EndPoint – 终端号：1-240 这是节点的子地址，用来接收数据

AppProfId – 定义了这个终端上支持的Profile ID（剖面ID），ID最好遵循由ZigBee联盟的分配。

AppDeviceId –终端支持的设备ID，ID最好遵循ZigBee联盟的分配。

AppDevVer –此终端上设备执行的设备描述的版本：0x00为Version 1.0.

Reserved – 保留

AppNumInClusters – 终端支持的输入簇数目

pAppInClusterList – 指向输入Cluster ID列表的指针

AppNumOutClusters – 终端支持的输出簇数目

pAppOutClusterList – 指向输出Cluster ID列表的指针

终端描述符-endPointDesc_t

节点中的每一个终端都必须有一个终端描述符

typedef struct

{

  byte endPoint;

  byte *task_id; // Pointer to location of the Application task ID.

  SimpleDescriptionFormat_t*simpleDesc;

  afNetworkLatencyReq_tlatencyReq;

} endPointDesc_t;

task_id-任务ID指针，当接收到消息时，此任务ID将指示消息传递目的。接收到的消息是以OSAL消息形式包装的，将发送到一个任务

simpleDesc  -指向这个终端的ZigBee简单描述

latencyReq -必须用noLatencyReqs来填充

afStatus_t afRegister( endPointDesc_t *epDesc);

为设备注册一个新的终端

epDesc     -指向终端描述符

返回值：afStatus_t  -若成功则返回ZSuccess，否则返回ZComDef.h中定义的错误

epList_t *afRegisterExtended( endPointDesc_t*epDesc, pDescCB descFn );

在上面函数功能的基础上增加了回调函数，当终端的简单描述符被查询时将调用此回调函数。这样应有就可以动态改变简单描述符而不用RAM/ROM来储存描述符了。

descFn     -回调函数指针。相关函数必须为简单描述符分配足够的空间，填充简单描述符，然后返回指向简单描述符的指针，调用者将释放为描述符分配空间。

epList     -指向终端列表元件的指针，如果失败则为NULL

endPointDesc_t *afFindEndPointDesc( byte endPoint);

从一个终端找到终端描述符

endPoint   -要寻找的终端描述符的终端号

endPointDesc_t -指向终端描述符的指针，若失败则为NULL

byte afFindSimpleDesc( SimpleDescriptionFormat_t**ppDesc, byte EP );

从一个终端找到终端描述符。若返回值非零则必须调用osal_mem_free()来释放描述符的内存占用。

ppDesc  -指向指向简单描述符的指针。

EP –终端简单描述符需要

uint8 afGetMatch( uint8 ep );

默认情况下，设备将响应ZDO匹配描述符请求。用这个函数来获得ZDO匹配描述符应答的设置。

ep  -用来获得ZDO匹配描述符响应行为的终端

返回值：TRUE-允许响应，FALSE-不允许或者终端未找到

uint8 afSetMatch( uint8 ep, uint8 action );

默认情况下，设备将响应ZDO匹配描述符。可以用这个函数来改变这个行为，比如ep为1，action为FALSE，ZDO将不响应终端1的ZDO匹配面述符请求。

ep  -用来获得ZDO匹配描述符响应行为的终端

action -TRUE-允许响应，FALSE-不允许或者终端未找到

返回值：TRUE-成功，FALSE-失败或者终端未找到

byte afNumEndPoints( void );

查找已注册的终端数目，返回此设备上已注册的终端数目，包括终端0

void afEndPoints( byte *epBuf, byte skipZDO );

返回包含已注册的终端的一个数组。

epBuf –指向存放终端的数组，每个终端占一个字节  

skipZDO -设置为TRUE，则不包含ZDO终端（终端0）

发送数据

afStatus_t AF_DataRequest( afAddrType_t *dstAddr,endPointDesc_t *srcEP,

               uint16 cID, uint16 len, uint8 *buf, uint8 *transID,

              uint8 options, uint8 radius );

dstAddr -目标地址指针。

   afAddrNotPresent   由反射器（邦定源，也即路由器或者协调器）指定

   afAddrGroup    发送到组

   afAddrBroADCast发送广播消息

   afAddr16Bit    直接发送到节点（单播）

srcEP      -发送终端的终端描述符指针

cID    -簇ID，cluster ID如同消息ID，并且在剖面（profile）中各不相同

len    -要发送的字节数

buf    -指向要发送的数据缓存的指针

transID -事务序列号指针。如果消息缓存发送，这个函数将增加这个数字

options   -发送选项，可以由下面一项，或几项相或得到

   AF_ACK_REQUEST 0x10 要求APS应答，这是应用层的应答，支在直接发送（单播）时使用。

   AF_DISCV_ROUTE 0x20 总要包含这个选项

   AF_SKIP_ROUTING 0x80设置这个选项将导致设备跳过路由而直接发送消息。终点设备将不向其父亲发送消息。在直接发送（单播）和广播消息时很好用。

radius – 最大的跳数，用默认值AF_DEFAULT_RADIUS

afStatus_t – 成功则为ZSuccess(defined in ZComDef.h). 否则Errors（defined in ZComDef.h）

uint8 afDataReqMTU( afDataReqMTU_t* fields );

找出基于输入参数的最大可发送字节数，返回能发送的最大字节数

fields     -要发送的消息类型参数

    typedefstruct

    {

       uint8             kvp;

      APSDE_DataReqMTU_t aps;

    }afDataReqMTU_t;

    kvp –设为false.

    typedefstruct

    {

       uint8secure;

    }APSDE_DataReqMTU_t;

    aps.secure –设为false.如果在一个安全网络中此位将自动设置.