6. Zigbee应用程序框架开发指南 - 应用程序框架Callback接口

1 Zigbee应用程序框架开发指南 - 概述

2 Zigbee应用程序框架开发指南 - 应用程序框架结构

3 Zigbee应用程序框架开发指南 - 应用程序框架目录结构

4 Zigbee应用程序框架开发指南 - 生成应用程序配置文件

5 Zigbee应用程序框架开发指南 - 应用程序框架API

6 Zigbee应用程序框架开发指南 - 应用程序框架Callback接口

7 Zigbee应用程序框架开发指南 - 时间处理

8 Zigbee应用程序框架开发指南 - 事件

9 Zigbee应用程序框架开发指南 - 属性管理

10 Zigbee应用程序框架开发指南 - 命令处理和生成

11 Zigbee应用程序框架开发指南 - 命令行接口（CLI）

12 Zigbee应用程序框架开发指南 - 调试打印接口

13 Zigbee应用程序框架开发指南 - 多网络支持

14 Zigbee应用程序框架开发指南 - 睡眠设备

15 Zigbee应用程序框架开发指南 - 应用程序框架插件

16 Zigbee应用程序框架开发指南 - 扩展ZigBee Cluster Library (ZCL)

17 Zigbee应用程序框架开发指南 - 使用Ember AppBuilder设计应用程序

18 Zigbee应用程序框架开发指南 - 应用框架V6

6 应用程序框架Callback接口

Zigbee应用程序框架回调用于将所有客户代码从Zigbee应用程序框架中移除。如果您的任何应用程序代码需要放到Zigbee应用程序框架中，Silicon Labs认为这是Zigbee应用程序框架的一个缺陷，因为这意味着缺少一个满足您的应用程序需求的回调。在这种情况下，请通过https://www.silabs.com/support的联系人支持链接提交case。

通常，当回调被调用时，Zigbee应用程序框架会首先向应用程序代码发出一些传入消息或请求一些应用程序数据。在回调API中，一些回调返回一个布尔值，指示消息已被处理，不应该进行进一步处理。如果您正在执行的操作与Zigbee应用程序框架对特定消息的处理相冲突，则返回TRUE以指示消息已完成。这确保了Zigbee应用程序框架不会干扰您对消息的处理。

6.1 回调生成

AppBuilder能够为您生成一个存根回调文件。默认情况下，如果AppBuilder发现该文件已经存在于生成目录中，则选择不生成回调存根文件。您必须明确地告诉应用程序重写现有文件。

当您将来重新生成文件时，AppBuilder会询问您是否想要覆盖所生成的回调文件，从而保护您的回调文件不被覆盖。默认情况下，AppBuilder不会覆盖以前创建的任何回调文件。如果您选择覆盖文件，AppBuilder会将以前的版本备份到文件<appname>_callback.bak。

注意:你可以在任何你想要的地方实现你的回调;它们不需要在生成的回调文件中实现。但是，如果在不同的位置实现它们，请将它们从生成的回调文件中清除，这样链接器就不会报错回调函数的重复定义。

6.2 Cluster无关的回调

为了便于使用，回调接口在AppBuilder GUI中划分为多个部分。第一部分，与Cluster无关的回调，由位于tool/appbuilder/callback .xml文档中描述的回调组成。这些回调已经被手动插入到Zigbee应用程序框架代码中，这些代码位于客户希望接收关于Zigbee应用程序框架功能的信息的位置。

所有全局命令都属于这个类别。Zigbee应用程序框架包含全局命令的处理代码。如果任何全局命令回调返回TRUE，这表明该命令已由应用程序处理，不应该进行进一步的命令处理。如果回调返回FALSE，则Zigbee应用程序框架将继续正常处理该命令。

示例：
预命令接收回调(emberAfPreCommandReceivedCallback(EmberAfClusterCommand* cmd, boolean isInterpan)在接收到ZCL命令但尚未被Zigbee应用程序框架的命令处理代码处理之后调用。该命令被解析为一个有用的struct EmberAfClusterCommand，它提供了一种简单的方法来访问关于该命令的相关数据，包括它的EmberApsFrame、消息类型、源、缓冲区、长度以及该命令的任何相关标志。此回调还返回一个布尔值，指示是否已处理该命令。如果回调返回TRUE，则假定应用程序已经处理了该命令，并且没有采取进一步的操作。

6.3 特殊Cluster命令处理回调

与cluster相关的回调由Zigbee应用程序框架生成，以允许接收来自空中的预先解析的命令。通常，ZCL命令和特定于cluster的回调之间存在一对一的关系。

特定于cluster的命令回调都返回一个布尔值。这个返回值允许您使包含在应用程序框架中的命令处理不工作。如果您实现一个特定于cluster的命令回调，并且它返回一个值TRUE到Zigbee应用程序框架，该框架就会假定该命令已经在框架之外处理过，并且任何需要的命令或默认响应都已经发送了。如果特定于cluster的命令返回FALSE，则框架假设应用程序代码不理解该命令，并发送一个状态为“unsupported cluster command”的默认响应。

6.3.1 命令回调上下文

所有与命令相关的回调都是从emberIncomingMessageHandler上下文中调用的。这意味着在该上下文中对应用程序可用的Ember api也可以在处理回调的命令中使用。这些API被列出在位于stack/include/message.h的堆栈API文件中。命令回调中可用的堆栈api被列出在位于stack/include/message.h的堆栈消息头中，包括:

emberGetLastHopLqi()
emberGetLastHopRssi()
emberGetSender()
emberGetSenderEui64()
emberGetBindingIndex()
emberSendReply() (for incoming APS retried unicasts only)
emberSetReplyBinding()
emberNoteSendersBinding()

6.3.2 在命令回调中处理数组

任何包含参数数组的ZigBee消息都作为指向数组开头的int8u*指针传递。即使框架知道数组中的参数可能是另一种类型(比如int16u或int32u)，也会执行此操作，因为框架可能在其上运行的各种处理器上存在字节对齐问题。实现回调的开发人员必须解析数组并对其元素进行适当的转换。

6.3.3 全局命令回调

ZigBee全局命令也包含在ZigBee应用程序框架回调接口中。这些回调可以用来接收对全局命令的响应。例如，如果您的设备向另一个设备发送一个全局读属性命令，它可以通过实现emberAfReadAttributesResponseCallback来处理命令响应。

6.2 回调流程

图2显示了如何处理应用程序框架的emberIncomingMessageHandler实现接收到的消息，并通过框架代码流向实现回调的应用程序。

图2接收消息流程

一旦传入消息被确定为传入全局命令，它就被传递给全局命令处理进行处理，如图3所示。

图3 全局命令处理

否则，如果发现它是特定于Cluster的命令，则将其传递给特定于Cluster的命令处理，如图4所示。

图4 特殊Cluster命令处理

6.3 回调引用

注意，这个文档中包含的回调引用已经被删除，取而代之的是文档120-3023-000中提供的引用，Zigbee应用程序框架API引用。该文档中包含的引用是直接从头文件生成的，因此比本文档中提供的引用更新得更快。