板级配置文件使用说明

更新时间：2018-09-18 10:14:14

名词解释
用途
如何配置及使用说明

• 1 board.json的语法描述

• 2 支持的type描述

• 3 芯片/模组的硬件资源对应表 esp32+developerkit

名词解释

• board.json 文件： 对于每一个 TinyEngine 应用，都有一个名为 board.json 的板级配置文件，用于描述对应的板级硬件配置，如 UART、I2C、GPIO、ADC 等的配置。

• board.json 语法：使用 json 字段描述，其中有 type，port 等硬件描述概念，对于每一款硬件(通常是芯片/模组/开发板)该配置文件均可能不同。

用途

不同的模组/芯片，各个端口和管脚的映射可能是不一样的，有的厂家或板型，会将 ESP32 的 PIN1，PIN2，PIN3，PIN4 映射成 UART1，而有的映射成 UART2，甚至有的会映射成 GPIO1，GPIO2，GPIO3，GPIO4。TinyEngine 的板型配置文件主要是将硬件（芯片）的物理端口映射成为统一的应用层逻辑端口。这样映射的好处是在替换不同的硬件或者芯片时，只需要替换 board.json 而不用修改应用程序或设备程序，从而便于应用的跨平台运行。

如何配置及使用说明

前面了解到 board.json 文件是用于跟硬件板级相关的配置的，那么该如何去配置其中的字段呢？ 是否每一种硬件版型该配置都不一样？以及在哪里打开及修改该文件呢？下面将针对以上几个问题介绍。

1 board.json 的语法描述

从 board.json 的后缀可以看出，其使用json语法进行描述。格式通常如下：

 {
 "objectid":{    
    "type":"GPIO",  
    "port":12,
    "dir":2,
    "pull":1
  }
  }

解释：

• objectid：定义了一个对象，后面大括号里面则描述了该对象的类型。 定义后可以在 JS 中直接使用。

• type: 描述了该对象的类型，可以是 TinyEngine 支持的硬件扩展类型，如 GPIO，I2C，ADC 等。

• port：描述了该对象的端口，这里需要根据实际硬件连接及芯片的PIN 脚映射关系来填写。

• dir, pull: 是 GPIO 类型特有的，用于描述 GPIO 输出输出及上拉下拉，其他如ADC类型则有sampling采样频率这种类型描述。

2 板级支持 “Type” 列表及相关属性描述

board.json 的 type 用于描述该对象是什么硬件端口类型，而每一种 type 也拥有不同的属性字段，如GPIO 与 ADC 的属性字段是不一样的，如下将介绍每一种type类型的属性。

3 芯片/模组的硬件资源对应表 esp32+developerkit

ESP32Devkitc 布局图

| PWM0 |IO5=channel0
IO17=channel1
IO4=channel2
IO16=channel3
| IO5 :port=5
IO17:port=17
IO4 :port=4
IO16:port=16 |
| WIFI | 内置 | 内置 |
| BT | 内置 | 内置 |
| WDG | 内置 | 内置 |
| SD | SD0(SD0) SD1(SD1) SD2(SD2) SD3(SD3) CMD(CMD) CLK(CLK) | |
| SPI | 待定 | 待定 |

DeveloperKit 硬件原理图（节选）

STM32 系列芯片的管脚 PIN 映射表

说明：适用于 Developerkit 及其他 STM32 系列芯片/模组

示例

{
  "rgbled.r": {
    "type": "GPIO",
    "port": 27,
    "dir": 3,
    "pull": 1
  },
  "rgbled.g": {
    "type": "GPIO",
    "port": 33,
    "dir": 3,
    "pull": 1
  },
  "rgbled.b": {
    "type": "GPIO",
    "port": 32,
    "dir": 3,
    "pull": 1
  },
  "touchkey.key0": {
    "type": "ADC",
    "port": 4,
    "sampling": 12000000
  },
  "touchkey.key1": {
    "type": "ADC",
    "port": 2,
    "sampling": 12000000
  },
  "spk.dac1": {
    "type": "DAC",
    "port": 1,
    "voltage": 255
  },
  "key": {
    "type": "GPIO",
    "port": 23,
    "dir": 2,
    "pull": 1
  },
  "gy30": {
    "type": "I2C",
    "port": 1,
    "address_width": 7,
    "freq": 100000,
    "mode": 1,
    "dev_addr": 70
  },
  "uart2": {
    "type": "UART",
    "port": 2,
    "data_width": 3,
    "baud_rate": 115200,
    "stop_bits": 0,
    "flow_control": 0,
    "parity_config": 0
  },
  "buzzer": {
    "type": "PWM",
    "port": 4,
    "freq": 5000,
    "duty": 50
  },
  "hxd019.sda": {
    "type": "GPIO",
    "port": 26,
    "dir": 3,
    "pull": 1
  },
  "hxd019.scl": {
    "type": "GPIO",
    "port": 25,
    "dir": 3,
    "pull": 1
  },
  "hxd019.busy": {
    "type": "GPIO",
    "port": 21,
    "dir": 1,
    "pull": 1
  }
}