【经验】多协议无线SoC EFR32MG的ZigBee开发之Token使用教程

EFR32MG系列是SILICON LABS公司针对多协议推出的无线SoC，单芯片可以支持Sub-G、蓝牙、Thread和Zigbee多种协议。Token是用来存储非易失性数据的即掉电后也能保存，由于在EFR32MG芯片中没有eeprom，所以实际上它们是直接存储在flash上，用flash作为虚拟eeprom（simulated eeprom）的用法。本文档指导大家如何在EmberZNet PRO应用程序中自定义Token来存储非易失性数据。关于Token的概念，请参考“EFR32MG的ZigBee开发之Token概念解析”。本文是针对使用SimEEv1/v2的模拟EEPROM，而不是NVM3。

1，使用自定义token需要创建一个自定义的token头文件（xxx.h）名字可以随意取，头文件需要包含下面的内容，这样系统才能知道你是在定义自己的token，这个头文件将包含到工程中，而且对所有工程文件都是可见的。

/**

* Custom Application Tokens

*/

// (第一部分)定义token的名字

#ifdef DEFINETYPES

//（第二部分）这里定义所有token用到的类型

#endif //DEFINETYPES

#ifdef DEFINETOKENS

//（第三部分）这里用来定义token的储存信息

#endif //DEFINETOKENS

注意：在头文件中顶部不需要：

#ifndef HEADER_FILE

#define HEADER_FILE

这很重要，因为此头文件会被包含多次以用于不同目的。

2，先定义token的名字，也就是在上一步建的头文件中的第一部分定义token的名字，如下：

//定义token的名字

#define CREATOR_DEVICE_INSTALL_DATA (0x000A)

#define CREATOR_HOURLY_TEMPERATURES (0x000B)

#define CREATOR_LIFETIME_HEAT_CYCLES (0x000C)

定义名字时都必须以CREATOR_开头后面接自定义token的名字，如上面INSTALL_DATA就是token的名字。后面的16位字节就是这个token的唯一表示码（token key），最高位（第16bit）为系统token（stack token与manufacturing token）保留，所以我们定义的的token key一定要小于0x8000，也就是说这个token key我们可以自己定，只要不大于0x8000并且没有重复就可以了，上面的例子使用了0x000A-0x000C来作为token key。

3，定义token使用的类型，如果token是一个特殊的类型如结构体（假如DEVICE_INSTALL_DATA是结构体），那么你就要在这里定义它（在第二部分#ifdef DEFINETYPES与#endif //DEFINETYPES之间）如下：

#ifdef DEFINETYPES

// Include or define any typedef for tokens here

typedef struct {

int8u install_date[11] /** YYYY-mm-dd + NULL */

int8u room_number; /** The room where this device is installed */

} InstallationData_t;

#endif //DEFINETYPES

定义了一个InstallationData_t的结构体，这个将作为token DEVICE_INSTALL_DATA的类型。

4，定义token的存储信息，上面已经定义3个token，这里就要定义这三个token要存储的内容（第三部分#ifdef DEFINETOKENS与#endif //DEFINETOKENS之间），如下：

#ifdef DEFINETOKENS

// Define the actual token storage information here

DEFINE_BASIC_TOKEN(DEVICE_INSTALL_DATA,

InstallationData_t,

{0, {0}})

DEFINE_INDEXED_TOKEN(HOURLY_TEMPERATURES, int16u, 24, {0})

DEFINE_COUNTER_TOKEN(LIFETIME_HEAT_CYCLES, int32u, 0)

#endif //DEFINETOKENS

定义了DEVICE_INSTALL_DATA为普通类型的token，它的数据类型为InstallationData_t，初始值全为0；定义了HOURLY_TEMPERATURES为indexed token，它是一个16位无符号数数组，长度为24，初始值全为0；定义了LIFETIME_HEAT_CYCLES为一个counter token为32位无符号数据类型，初始值为0。

5，将头文件包含的工程里,

在EmberZnet Version: 6.4.1.0版本中，有直接包含用户token头文件的选框，在include的选项里如下图：

如果是之前的版本可能没有custom token header的选项卡，也可以直接从上面的code,header file,include paths and libraries选项卡包含进来：

经过以上步骤，就可以使用自定义的token了，如下：

basic  token DEVICE_INSTALL_DATA的读写：

InstallationData_t data;

// Read the stored token data

halCommonGetToken(&data, TOKEN_DEVICE_INSTALL_DATA);

// Set the local copy of the data to new values

data.room_number = < user input data >；

MEMCOPY(data.install_date, < user input data>, 0, sizeof(data.install_date));

// Update the stored token data with the new values

halCommonSetToken(TOKEN_DEVICE_INSTALL_DATA, &data);

indexed token HOURLY_TEMPERATURES的读写：

int16s getCurrentTargetTemperature(int8u hour) {

int16s temperatureThisHour = 0; /** Stores the temperature for return */

if (hour < 24) {

halCommonGetIndexedToken(&temperatureThisHour,

TOKEN_HOURLY_TEMPERATURES, hour);

}

return temperatureThisHour;

}

void setTargetTemperature(int8u hour, int16s targetTemperature) {

int16s temperatureThisHour = 0; /** Stores the temperature for return */

if (hour < 24) {

halCommonSetIndexedToken(TOKEN_HOURLY_TEMPERATURE, hour,&temperatureThisHour);

}

}

counter token LIFETIME_HEAT_CYCLES的用法：

void requestHeatCycle(void) {

/// < application logic to initiate heat cycle >

halCommonIncrementCounterToken(TOKEN_LIFETIME_HEAT_CYCLES);

}

int32u totalHeatCycles(void) {

int32u heatCycles;

halCommonGetToken(&heatCycles, TOKEN_LIFETIME_HEAT_CYCLES);

return heatCycles;

}

上面对各类型的token用法都举了例，注意的是在使用token时，token名都使用了TOKEN_加token名，而不是直接用token名。最后需要注意的是token是基于flash的sim-eeprom来保存数据的，因为flash的擦写次数有限（相比于真正的eeprom），因此尽量避免频繁地去写token。