2A-ESP8266-SDK__Getting_Started_Guide__CN.pages

Size: px

Start display at page:

Download "2A-ESP8266-SDK__Getting_Started_Guide__CN.pages"

杖嚣陶
5 years ago
Views:

1 ESP8266 SDK 入门指南版本 3.1 版权 2018

2 关于本手册本文以 ESP-LAUNCHER 和 ESP-WROOM-02 为例例, 介绍 ESP8266 SDK 相关使用方法, 包括编译前的准备 SDK 的编译和固件的下载本手册结构如下 : 章标题内容第 1 章概述介绍 SDK 使用的整体流程, 并给出 ESP8266 HDK SDK FW 和工具集的简单介绍第 2 章硬件准备介绍 SDK 使用需要的硬件, 并给出开发板和模组两种方案第 3 章软件准备介绍 non-os 和 RTOS 两种版本的 SDK 及编译 SDK 和下载固件的相关工具第 4 章 Flash 布局介绍固件下载到 Flash 中的布局和地址, 区分 FOTA 和 non-fota 固件第 5 章编译 SDK 介绍如何使用编译工具来编译 SDK 第 6 章下载固件介绍如何使用下载工具来下载固件附录 A 配置 ISSI & MXIC Flash QIO 模式介绍对 ISSI & MXIC Flash 的支持和配置方式附录 B 学习资源介绍 ESP8266 相关的必读资料料, 必备资源和视频资源发布说明日期版本发布说明 V2.0 首次发布 V2.1 增加附录 A 中 MXIC Flash QIO 模式 ; 修改 112 字节的默认值为 V2.2 更更新节 V2.3 更更新节中百度下载链接 V2.4 更更新节 V2.5 增加附录 B 学习资源 V V2.7 增加附录 B.2 必备资源中 RTOS 和 non-os 常用功能的示例例代码的链接更更新章节 3.1 和 3.2; 更更新章节中 OVA 镜像文件的下载链接 ; 更更新章节 V2.8 更更新第 4 章, 增加 8 MB 和 16 MB flash 的说明

3 日期版本发布说明 V V3.0 更更新第 1 章中表 1-1; 更更新第 4 章中图 4-1 及下方参数描述 ; 更更新第 4 章中表 4-1 表 4-2 表 4-3 和表 4-4 更更新章节 4.1.1; 更更新第 4 章中表 4-1 V3.1 更更新章节中表 4-3

4 目录 1. 概述流程概览 ESP8266 HDK ESP8266 SDK Non-OS SDK RTOS SDK ESP8266 FW ESP8266 工具集编译器器固件下载工具串串口调试工具硬件准备开发板方案模组方案软件准备 Non-OS SDK RTOS SDK ESP8266 工具集编译器器固件下载工具 Flash 布局 Non-FOTA 布局说明下载地址 FOTA 布局说明... 14

5 下载地址编译 SDK 编译准备修改 SDK 文件加载 SDK 文件开始编译 ESP8266_NONOS_SDK_v0.9.5 及之后版本 ESP8266_NONOS_SDK_v0.9.4 及之前版本下载固件下载步骤查看打印信息 ESP8266 IOT Demo ESP8266 AT 射频初始化设置 ( 可选 ) RF InitConfig 选项 RF InitConfig 参数设置举例例 A. 附录配置 ISSI & MXIC Flash QIO 模式 B. 附录学习资源 B.1. 必读资料料 B.2. 必备资源 B.3. 视频资源... 30

! 1. 概述 1. 概述 1.1. 流程概览 SDK 的使用流程如图 1-1 所示 3. 2.

6 ! 1. 概述 1. 概述 1.1. 流程概览 SDK 的使用流程如图 1-1 所示 SDK ESP-WROOM Flash ESP-LAUNCHER ESP8266 SDK SDK ESP8266 FW ESP8266 HDK ESP8266 图 1-1 流程概览 1.2. ESP8266 HDK ESP8266 Hardware Development Kit (HDK) 包括芯片 ESP8266EX 模组 ESP- WROOM-02 和开发板 ESP-LAUNCHER 等用户可以使用乐鑫官方的 ESP-WROOM-02 或 ESP-LAUNCHER 下载编译好的固件如要使用其他集成 ESP8266EX 的开发板或者模组, 请使用相应厂商提供的开发固件如需购买 ESP-WROOM-02 或 ESP-LAUNCHER, 请访问乐鑫网上商店 : Espressif 1/31

7 1. 概述 1.3. ESP8266 SDK ESP8266 Software Development Kit (SDK) 是乐鑫为开发者提供的物联网 (IoT) 应用开发平台, 包括基础平台以及上层应用开发示例例, 如智能灯智能开关等 SDK 的基础平台按照是否基于操作系统可分为 :non-os 和 RTOS 两种版本 Non-OS SDK Non-OS SDK 是不不基于操作系统的 SDK, 提供 IOT_Demo 和 AT 的编译 Non-OS SDK 主要使用定时器器和回调函数的方式实现各个功能事件的嵌套, 达到特定条件下触发特定功能函数的目的 Non-OS SDK 使用 espconn 接口实现网络操作, 用户需要按照 espconn 接口的使用规则进行行软件开发 RTOS SDK RTOS SDK 基于 FreeRTOS, 在 Github 上开源 RTOS 版本 SDK 使用 FreeRTOS 系统, 引入 OS 多任务处理理的机制, 用户可以使用 FreeRTOS 的标准接口实现资源管理理循环操作任务内延时任务间信息传递和同步等面向任务流程的设计方式具体接口使用方法参考 FreeRTOS 官方网站的使用说明或者 USING THE FreeRTOS REAL TIME KERNEL A Practical Guide 介绍 RTOS 版本 SDK 的网络操作接口是标准 lwip API, 同时提供了了 BSD Socket API 接口的封装实现, 用户可以直接按照 Socket API 的使用方式来开发软件应用, 也可以直接编译运行行其他平台的标准 Socket 应用, 有效降低平台切换的学习成本 RTOS 版本 SDK 引入了了 cjson 库, 使用该库函数可以更更加方便便的实现对 JSON 数据包的解析 RTOS 版本兼容 non-os SDK 中的 Wi-Fi 接口 SmartConfig 接口 Sniffer 相关接口系统接口定时器器接口 FOTA 接口和外围驱动接口, 不不支持 AT 实现 1.4. ESP8266 FW ESP8266 Firmware (FW) 是一些可直接下载到 ESP8266 HDK 中的 BIN 文件, 用户可以选择下载 Firmware Over-The-Air(FOTA, 支持云端升级 ) 和 non-fota( 不不支持云端升级 ) 的 BIN 文件, 具体如表 1-1 所示表 1-1. ESP8266 FW 文件列列表是否必选说明 Non-FOTA FOTA esp_init_data_default.bin 必选初始化射频参数, 在 SDK 根目录中提供 Espressif 2/31

8 1. 概述文件列列表是否必选说明 Non-FOTA FOTA blank.bin 必选初始化系统参数, 在 SDK 根目录中提供 eagle.flash.bin 必选主程序, 编译代码生成 eagle.irom0text.bin 必选主程序, 编译代码生成 boot.bin 必选 Bootloader, 在 SDK 根目录中提供 user1.bin 初次使用必选主程序, 编译代码生成 user2.bin 升级时使用主程序, 编译代码生成关于 SDK 的内容介绍, 请参考第 3 章软件准备关于 SDK 的编译, 请参考第 5 章编译 SDK 关于 BIN 文件在 Flash 中的地址, 请参考第 4 章 Flash 布局 1.5. ESP8266 工具集编译器器编译 ESP8266 SDK 需要使用 Linux 操作系统, 若使用 Windows 操作系统, 建议使用 VirtualBox 作为 ESP8266 虚拟机为了了简化编译操作, 乐鑫已将编译 SDK 所需要的工具安装到虚拟机中用户只需安装虚拟机, 并导入 ESP8266 编译器器 (OVA 镜像文件 ) 即可直接编译 ESP8266 SDK 固件下载工具 ESP8266 DOWNLOAD TOOL 工具是由乐鑫官方开发的固件下载工具, 用户可根据实际的编译方式和 Flash 的容量量, 将多个 BIN 文件一键下载到 ESP8266 母板 ( 开发板或者模组 ) 的 SPI Flash 中串串口调试工具串串口调试工具可以通过标准 RS-232 端口直接与 ESP8266 建立通信对于不不带有物理理串串口的 PC, 可以使用 USB 转串串口模块来虚拟出一个串串口设备用户可以直接在串串口终端输入命令和实时查看相关打印信息建议使用 CoolTerm(Windows 和 Mac 系统 ) 和 Minicom(Linux 系统 ) 作为串串口调试工具 Espressif 3/31

2. 硬件准备硬件准备 2. 用户可以选择使用如表 2-1 所示的两种方案中的任意一种表 2-1.

USB 转 TTL 串串口模块推荐 FT232R 1 根 USB 数据线 6 根杜邦线 1 套焊接工具

将开发板置为下载模式步骤结果如右图所示将电源开关 (Power GPIO0 Control

拨到内 USB-UART 侧将 ESP-LAUNCHER 开发板置为下载模式注意 USB-serial

9 2. 硬件准备硬件准备 2. 用户可以选择使用如表 2-1 所示的两种方案中的任意一种表 2-1. 硬件准备开发板方案模组方案 1个 ESP-WROOM-02 1 个 ESP-LAUNCHER 1 个 USB 转 TTL 串串口模块推荐 FT232R 1 根 USB 数据线 6 根杜邦线 1 套焊接工具或者预装 Windows 系统的 PC 机注意 ESP8266 Wi-Fi 模块需要保证 3.3V 电源和最少 500 ma 的电流 2.1. 开发板方案 1. 用 USB 数据线将 PC 机与 ESP-LAUNCHER 的 USB-UART 接口相连 2. 将开发板置为下载模式步骤结果如右图所示将电源开关 (Power GPIO0 Control Switch) 拨到外侧 Chip Switch 1 将 GPIO0 开关 (GPIO0 Control) 拨到内 USB-UART 侧将 ESP-LAUNCHER 开发板置为下载模式注意 USB-serial Cable ESP-LAUNCHER 上的 J82 跳针需要用跳线帽短接否则无法下载 1 Power Switch J82 3. 将 USB 转 TTL 串串口模块与 PC 机连接 Espressif /31 4

10 2. 硬件准备说明请安装正确的可被 PC 识别的 USB 转 TTL 串串口模块驱动 4. 将电源开关 (Power Switch) 拨到内侧给开发板上电 5. 将芯片开关 (Chip Switch) 拨到外侧给芯片上电 6. 通过下载工具 (ESP8266 DOWNLOAD TOOL) 将固件下载到 Flash 中说明关于如何下载固件请参考第 4 章 Flash 布局和第 6 章下载固件 7. 下载完毕后将 GPIO0 开关 (GPIO0 Control) 拨到外侧将 ESP-LAUNCHER 开发板置为工作模式 8. 使用芯片开关 (Chip Switch) 给芯片重新上电芯片初始化时会从 Flash 中读取程序运行行更更多 ESP-LAUNCHER 的硬件信息请参考 ESP8266 系统描述 2.2. 模组方案 1. 参考表 2-2 将 ESP-WROOM-02 的管脚引出表 2-2. ESP-WROOM-02 的管脚管脚名称管脚状态 EN 上拉 3V3 3.3V 供电 (VDD) IO15 下拉 IO0 实物图 UART 下载模式下拉 FLASH 启动模式悬空/上拉 GND GND RXD UART 下载的接收端 TXD UART 下载的发送端悬空/上拉 Espressif /31 5

2. 硬件准备 2. 按照图 2-1 用杜邦线将 ESP-WROOM-02 和 USB 转 TTL 串串口模块连接 ESP-WROOM-02 3V3 EN USB TTL 3V3 RXD TXD PC TXD RXD GND GND IO15 IO0!! 图 2-1. ESP-WROOM-02 下载模式 3. 将 USB 转 TTL 串串口模块与 PC 机连接 4.

11 2. 硬件准备 2. 按照图 2-1 用杜邦线将 ESP-WROOM-02 和 USB 转 TTL 串串口模块连接 ESP-WROOM-02 3V3 EN USB TTL 3V3 RXD TXD PC TXD RXD GND GND IO15 IO0!! 图 2-1. ESP-WROOM-02 下载模式 3. 将 USB 转 TTL 串串口模块与 PC 机连接 4. 通过下载软件 (ESP8266 DOWNLOAD TOOL) 将固件下载到 Flash 中关于如何下载固件, 请参考第 4 章 Flash 布局和第 6 章下载固件 5. 下载完毕后将 ESP-WROOM-02 切换为工作模式将 IO0 悬空或者上拉 6. 重新上电, 芯片初始化时会从 Flash 中读取程序运行行 IO0 管脚为内置高电平更更多关于 ESP-WROOM-02 的硬件信息, 请参考 ESP8266 系统描述和 ESP-WROOM-02 技术规格表 Espressif 6/31

3. 软件准备 3. 软件准备 3.1. Non-OS SDK 请在如下路路径下载 non-os SDK( 包括应用示例例 ): http://www.espressif.com/en/support/download/sdks-demos Non-OS SDK 软件包中的内容如图 3-1 所示 3.2. RTOS SDK 图 3-1.

12 3. 软件准备 3. 软件准备 3.1. Non-OS SDK 请在如下路路径下载 non-os SDK( 包括应用示例例 ): Non-OS SDK 软件包中的内容如图 3-1 所示 3.2. RTOS SDK 图 3-1. Non-OS SDK 内容 bin: 编译生成的 BIN 文件, 可直接下载到 Flash 中 documents:sdk 相关的文档或链接 driver_lib: 外设驱动的库文件, 如 :UART I2C 和 GPIO 等 examples: 可供用户二次开发的示例例代码, 如 IoT Demo 等 include:sdk 自带头文件, 包含了了用户可使用的相关 API 函数及其他宏定义, 用户无需修改 ld: 链接时所需的脚本文件, 若无特殊需求, 用户无需修改 lib:sdk 提供的库文件 tools: 编译 BIN 文件所需的工具, 用户无需修改用户可以在如下路路径下载 SDK 及其应用示例例 (ESP8266_IOT_PLATFORM) RTOS SDK Espressif 7/31

13 ESP8266_IOT_PLATFORM RTOS SDK 软件包中的内容如图 3-2 所示 3. 软件准备图 3-2. RTOS SDK 内容 bin: 编译生成的 BIN 文件, 可直接下载到 Flash 中 documents:sdk 相关的文档或链接 driver_lib: 乐鑫官方提供的驱动示例例代码 examples: 可供用户二次开发的示例例代码 - openssl_demo: 乐鑫官方提供的 OpenSSL 接口功能示例例代码 - project_template: 乐鑫官方提供的工程模板示例例代码 - smart_config: 乐鑫官方提供的 SmartConfig 功能示例例代码 - spiffs_test: 乐鑫官方提供的 SPIFFS 文件系统功能示例例代码 - websocket_demo: 乐鑫官方提供的 WebSocket 功能示例例代码 include:sdk 自带头文件, 包含了了用户可使用的相关 API 函数及其他宏定义, 用户无需修改 ld: 链接时所需的脚本文件, 如无特殊需求, 用户无需修改 lib:sdk 提供的库文件 third_party: 乐鑫开放源代码的第三方库, 当前包含 freertos JSON lwip, mbedtls nopoll OpenSSL SPIFFS 和 SSL tools: 编译 BIN 文件所需的工具, 用户无需修改 Espressif 8/31

3. 软件准备 3.3. ESP8266 工具集 3.3.1. 编译器器请在如下链接中下载 VirtualBox:https://www.virtualbox.

com/fb/esp8266_gcc.zip 步骤结果 1. 进入 Windows 系统安装虚拟机双击 VirtualBox-5.0.16-105871- Win.

14 3. 软件准备 3.3. ESP8266 工具集编译器器请在如下链接中下载 VirtualBox: 请根据主机配置选择合适的 VirtualBox 版本请在如下链接中下载编译器器 ESP8266_lubuntu_ ova: 步骤结果 1. 进入 Windows 系统安装虚拟机双击 VirtualBox Win.exe 文件并按照提示安装虚拟机 VirtualBox 有不不同的版本, 本手册以 Windows V 版本为例例双击 Oracle VM VirtualBox.exe 运行行虚拟机程序, 系统显示如右图所示主菜单提示 : ESP8266 虚拟机会占用较大空间, 请预留留足够的空间 2. 导入虚拟机镜像文件 Espressif 9/31

$如 :C: \ESP8266_lubuntu_20141021.ova, 单击 Next 单击 Import 确认导入 3.$ $设置虚拟机共享文件夹新建 D:\VM\share 文件夹在主菜单中选择 Machine > Settings > Shared Folders,$

15 3. 软件准备步骤结果在主菜单中选择 File > Import Appliance, 系统显示如右图所示对话框选择需要导入的镜像文件, 如 :C: \ESP8266_lubuntu_ ova, 单击 Next 单击 Import 确认导入 3. 设置虚拟机共享文件夹新建 D:\VM\share 文件夹在主菜单中选择 Machine > Settings > Shared Folders, 系统显示如右图所示对话框在 Machine Folders 中选择虚拟机的共享文件夹如 :D:\VM\share 4. 运行行虚拟机 Espressif 10/31

16 3. 软件准备步骤结果导入成功后,VirtualBox 主菜单显示名为 ESP8266_lubuntu 的虚拟机, 如右图所示双击 ESP8266_lubuntu 或单击 Start 运行行虚拟机系统显示 ESP8266 虚拟机, 如右图所示若系统显示如下图所示锁定对话框, 请输入解锁密码 :espressif 固件下载工具请在如下链接下载 ESP8266 DOWNLOAD TOOL: Espressif 11/31

17 4. Flash 布局 4. Flash 布局本章分别介绍 non-fota 与 FOTA 固件在不不同容量量 Flash 中的布局用户可以根据实际情况修改 Flash 布局如图 4-1 所示 Non-FOTA eagle.flash.bin eagle.irom0text.bin RF_CAL RF FOTA 1 2 user1.bin user2.bin Boot RF_CAL RF 图 4-1. Flash 布局图关于 ESP8266 的固件请参考 1.3 ESP8266 FW 系统程序 : 用于存放运行行系统必要的固件用户数据 : 当有多余的 Flash 空间用于用户数据区时, 空闲区域均可用于存放用户数据用户可在其中任意空闲位置设置用户参数区, 建议至少为用户参数区预留留 12 KB 空间 RF_CAL 参数 : 用于系统自动保存校准后的 RF 参数默认 RF 参数 : 将 esp_int_data_default.bin 下载至该区, 用于保存默认的参数信息 Espressif 12/31

4. Flash 布局系统参数 : 用于保存系统参数信息 Boot 信息 : 位于 FOTA 固件的分区 1, 存放 Boot 文件 Flash 中每扇区为 4 KB 具体下载地址请参考 4.1.2 下载地址和 4.2.2 下载地址 4.1. Non-FOTA 4.1.1. 布局说明用户可以通过修改 ESP8266_NONOS_SDK/ld/eagle.app.v6.

18 4. Flash 布局系统参数 : 用于保存系统参数信息 Boot 信息 : 位于 FOTA 固件的分区 1, 存放 Boot 文件 Flash 中每扇区为 4 KB 具体下载地址请参考下载地址和下载地址 4.1. Non-FOTA 布局说明用户可以通过修改 ESP8266_NONOS_SDK/ld/eagle.app.v6.ld 文件来改变 eagle.irom0text.bin 的上限值, 即修改文件中 irom0_0_seg 参数的 len 字段, 如图 4-2 中红色标示不不同版本 SDK 中 irom0.text 文件的地址也不不同用户必须查阅 eagle.app.v6.ld 文件, 确保将 eagle.irom0.text.bin 下载到正确的地址图 4-2 中蓝色标示即为 eagle.irom0.text.bin 的地址图 4-2. irom0.text 的地址不不同的 Flash 容量量,len 的值和修改后 eagle.irom0text.bin 的存储上限值如表 4-1 所示表 4-1. Non-FOTA Flash 布局 ( 单位 :KB) Flash 容量量 eagle.flash.bin eagle.irom0text.bin 用户数据 len RF_CAL 参数默认 RF 参数系统参数 x5C xBC xC xC xC * xC Espressif 13/31

19 4. Flash 布局 ESP8266 目前系统程序区最大支持 1024 KB 下载地址 Non-FOTA 固件的下载地址如表 4-2 所示表 4-2. Non-FOTA 的下载地址 ( 单位 :KB) BIN 各个 Flash 容量量对应的下载地址 *1024 blank.bin 0x7B000 0xFB000 0x1FB000 0x3FB000 0x7FB000 0xFFB000 esp_init_data_default.bin 0x7C000 0xFC000 0x1FC000 0x3FC000 0x7FC000 0xFFC000 blank.bin 0x7E000 0xFE000 0x1FE000 0x3FE000 0x7FE000 0xFFE000 eagle.flash.bin eagle.irom0text.bin 0x x10000 一般烧录, 请使用工具 ESP Flash Download Tool, 建议按照烧录地址从低到高按顺序排列列烧录如需烧录 8 MB 或者 16 MB 的大容量量 Flash, 请使用工具 esptool 4.2. FOTA 布局说明 FOTA 的固件布局如表 4-3 所示表 4-3. FOTA Flash 布局 ( 单位 :KB) Flash 容量量 boot user1.bin user2.bin RF_CAL 参数默认 RF 参数系统参数用户数据 ( 分区 1 = 512) ( 分区 1 = 1024) ( 分区 1 = 512) ( 分区 1 = 1024) Espressif 14/31

20 4. Flash 布局 Flash 容量量 boot user1.bin user2.bin RF_CAL 参数默认 RF 参数系统参数用户数据 8192( 分区 1 = 1024) ( 分区 1 = 1024) 下载地址 FOTA 固件的下载地址如表 4-4 所示表 4-4. FOTA 的下载地址 ( 单位 :KB) 各个 Flash 容量量对应的下载地址 BIN 文件 blank.bin 0x7B000 0xFB000 0x1FB000 0x3FB000 0x7FB000 0xFFB000 esp_init_data _default.bin 0x7C000 0xFC000 0x1FC000 0x3FC000 0x7FC000 0xFFC000 blank.bin 0x7E000 0xFE000 0x1FE000 0x3FE000 0x7FE000 0xFFE000 boot.bin user1.bin 0x x01000 user2.bin 0x x x x x x x x 一般烧录, 请使用工具 ESP Flash Download Tool, 建议按照烧录地址从低到高按顺序排列列烧录如需烧录 8 MB 或者 16 MB 的大容量量 Flash, 请使用工具 esptool 支持 FOTA 的固件无需下载 user2.bin, 用户可以从云端服务器器升级固件详细的 FOTA 功能说明, 请参考文档 ESP8266 云端升级指南 Espressif 15/31

21 5. 编译 SDK 5. 编译 SDK 本章使用 ESP8266_NONOS_SDK/examples/IoT_Demo 中的内容为例例介绍如何编译 SDK IoT_Demo 提供 Smart Light Smart Plug 和 Sensor 三种设备, 在 examples/iot_demo/include/ user_config.h 中定义, 请每次只使能一种设备调试, 默认为 Smart Light 5.1. 编译准备修改 SDK 文件若选择下载 FOTA 固件, 则需要修改 SDK 文件 1. 进入 Windows 系统 2. 根据不不同的 Flash 布局修改 ESP8266_NONOS_SDK/examples/IoT_Demo/include 中的文件 user_light.h 和 user_plug.h 需要修改 #define PRIV_PARAM_START_SEC user_esp_platform.h 需要修改 #define ESP_PARAM_START_SEC 修改的值如表 5-1 所示默认值 (512) 表 5-1. 修改 include 文件中的字段 ( 单位 :KB) 修改后的值 ( ) ( ) ( ) ( ) ( ) ( ) 0x3C - 0x7C 0x7C 0xFC 0x7C 0xFC 0xFC 0xFC 0x3D - 0x7D 0x7D 0xFD 0x7D 0xFD 0xFD 0xFD Espressif 16/31

$复制待编译文件至虚拟机共享目录步骤结果复制 ESP8266_NONOS_SDK 文件夹到虚拟机共享目录, 如 :D:\VM\share 目录将 IoT_Demo 文件夹复制到 D: \VM\share\ESP8266_NONOS_SDK 目录下, 如右图所示 4.$ 加载共享目录步骤结果执行行./mount.

22 5. 编译 SDK 若 Flash 容量量为 512 KB, 则不不需要修改 SDK 文件加载 SDK 文件 1. 进入 Linux 系统 2. 运行行虚拟机桌面上的终端工具 LXTerminal 3. 复制待编译文件至虚拟机共享目录步骤结果复制 ESP8266_NONOS_SDK 文件夹到虚拟机共享目录, 如 :D:\VM\share 目录将 IoT_Demo 文件夹复制到 D: \VM\share\ESP8266_NONOS_SDK 目录下, 如右图所示 4. 加载共享目录步骤结果执行行./mount.sh 根据提示输入密码 :espressif 系统完成共享文件加载在虚拟机中进入共享目录 ESP8266_NONOS_SDK 下查看文件内容, 确认共享目录是否加载成功 - 若加载成功目录如右图所示 - 若加载不不成功, 目录为空, 则需要再次执行行本步骤注意 : 若用户使用 RTOS SDK, 请继续执行行步骤 5; 若使用 non-os SDK, 请跳过步骤 5 5. 设置路路径变量量, 指向 SDK 和 BIN 文件 export SDK_PATH=~/Share/ESP8266_RTOS_SDK export BIN_PATH=~/Share/ESP8266_RTOS_SDK/bin Espressif 17/31

23 ! 5. 编译 SDK 用户可以将其添加在.bashrc 文件中, 否则每次重启编译器器都需要重复步骤开始编译 ESP8266_NONOS_SDK_v0.9.5 及之后版本 1. 在终端切换到 /Share/ESP8266_NONOS_SDK/IoT_Demo 目录 cd /home/esp8266/share/esp8266_nonos_sdk/iot_demo./gen_misc.sh 系统显示如下提示信息 gen_misc.sh version Please follow below steps(1-5) to generate specific bin(s): 2. 如图 5-1 所示, 按系统提示根据实际情况选择相应选项 N Y N Y STEP 1: choose boot version (0=boot_v1.1, 1=boot_v1.2+, 2=none) enter(0/1/2, default 2) N 2 Y 1 0 STEP 2: choose bin generate (0=eagle.flash.bin+eagle.irom0text.bin, 1=user1.bin, 2=user2.bin) enter (0/1/2, default 0) STEP 3: choose spi speed (0=20MHz, 1=26.7MHz, 2=40MHz, 3=80MHz) enter (0/1/2/3, default 2) STEP 4: choose spi mode (0=QIO, 1=QOUT, 2=DIO, 3=DOUT) enter (0/1/2/3, default 0) STEP 5: choose spi size and map 0= 512KB( 256KB+ 256KB) enter (0/2/3/4/5/6, default 0) 图 5-1. 编译 SDK Espressif 18/31

24 5. 编译 SDK 颜色标示部分为示例例选项, 请按照实际需求选择关于 FOTA 和 non-fota 的 BIN 文件, 请参考 1.4 ESP8266 FW 步骤 5 中的选项 5 和 6 仅 sdk_v boot flash download tool_v1.2 及之后的版本支持编译生成 user1.bin 后, 先运行行 make clean 清除上次编译生成的临时文件后, 再编译生成 user2.bin 关于步骤 5 中的 Flash 布局, 请参考第 4 章 Flash 布局 3. 编译成功后系统显示生成的 BIN 文件及其下载到 Flash 中的地址, 如下所示 Generate user new.3.bin successfully in folder bin/upgrade. boot.bin >0x00000 user new.3.bin--->0xsupport boot_v1.2 and !!! 用户可以进入 /home/esp8266/share/esp8266_nonos_sdk/bin 目录检查生成的 BIN 文件 ESP8266_NONOS_SDK_v0.9.4 及之前版本对于 ESP8266_NONOS_SDK_v0.9.4 及之前版本软件,FOTA 的编译步骤如下 1. 执行行./gen_misc_plus.sh 1, 在 /ESP8266_NONOS_SDK/bin/upgrade 路路径下生成 user1.bin 2. 执行行 make clean 清除之前的编译信息 3. 执行行./gen_misc_plus.sh 2, 在 /ESP8266_NONOS_SDK/bin/upgrade 路路径下生成 user2.bin ESP8266_NONOS_SDK_v0.7 及以前的版本为 non-fota Espressif 19/31

25 6. 下载固件 6. 下载固件 6.1. 下载步骤 1. 进入 Windows 系统 2. 双击 ESP_DOWNLOAD_TOOL.exe 打开 Flash 工具图 6-1. ESP8266 DOWNLOAD TOOL SPIDownload SPIDownload HSPIDownload RFConfig MutiDownload 适用于 SPI Flash 的下载适用于 HSPI Flash 的下载射频初始化设置适用于多个母板的下载 Espressif 20/31

26 6. 下载固件 3. 在 Download Path Config 区域内双击选择需要下载的 BIN 文件, 在 ADDR 内设置相应的下载地址 4. 配置 SPIDownload 相关选项下载文件与地址根据 SPI Flash 的容量量及实际的使用需求而不不同, 具体信息可参考第 4 章 Flash 布局表 6-1. SPIDownload 配置说明配置项配置说明 SPI FLASH CONFIG CrystalFreq 根据实际选用的晶振型号选择晶振频率 CombineBin 将勾选的 BIN 文件合成一个 target.bin, 下载地址为 0x0000 Default 将 SPI Flash 的配置恢复到默认值 SPI SPEED 选择 SPI Flash 的读写速度, 最大值为 80 MHz SPI MODE 根据实际使用的 Flash 选择对应的模式如果 Flash 采用 Dual SPI, 选择 DIO 或 DOUT; 如果 Flash 采用 Quad SPI, 选择 QIO 或 QOUT 注意 : 若用户使用 ISSI Flash, 请参考附录 - 配置 ISSI & MXIC Flash QIO 模式根据实际编译的配置对应选择的 Flash 大小 FLASH SIZE 16Mbit-C1 是的情况 ;32Mbit-C1 是的情况不不建议勾选 SpiAutoSet, 推荐用户根据实际情况对 Flash 进行行手动配置 SpiAutoSet DoNotChgBin 用户如果了了勾选 SpiAutoSet, 下载工具将会按照默认的 Flash map 下载,16 Mbit 和 32 Mbit 的 Flash map 会被设置为 512 Kbyte Kbyte 用户可勾选 DoNotChgBin,Flash 的运行行频率, 方式和布局会以用户编译时的配置选项为准如果不不勾选该选项,Flash 的运行行频率, 方式和布局会以下载工具最终的配置为准 Download Panel START STOP MAC Address COM PORT 点击 START 开始下载当下载结束后, 左边绿色状态显示完成点击 STOP 停止下载下载成功后, 系统会显示 ESP8266 STA 和 ESP8266 AP 的 MAC 地址选择 ESP8266 实际连入的 COM 端口 BAUDRATE 选择下载的波特率, 默认为 Espressif 21/31

27 6. 下载固件 6.2. 查看打印信息 5. 下载完成后, 在 ESP-LAUNCHER 开发板上将 GPIO0 Control 拨到外侧, 并重新上电, 可进入运行行模式下载固件后, 可以使用串串口调试工具查看终端打印信息用户需要配置串串口调试工具的以下选项表 6-2. 串串口调试配置配置项协议类型端口号波特率配置说明串串口根据实际连入的设备所在的端口号设置设备运行行时的波特率, 与设备晶振有关 ( 晶振 24 MHz) ( 晶振 26 MHz) ( 晶振 40 MHz) ESP8266 AT 示例例默认支持波特率, 用户不不可修改 ESP8266 IOT_Demo 及其他示例例默认为波特率, 用户可以修改数据位 8 校验流控无无 ESP8266 IOT Demo 若下载 ESP8266 IOT Demo 固件, 在运行行模式下, 系统显示如下初始化信息, 如 SDK 的版本信息等, 并在最后显示 finish 字样, 代表固件正常运行行 SDK version:x.x.x(e67da894) IOT VERSION = v1.0.5t45772(a) reset reason: 0 PWM version : mode : sta(18:fe:34:a4:8c:a3) + softap(1a:fe:34:a4:8c:a3) add if0 add if1 dhcp server start:(ip: ,mask: ,gw: ) bcn 100 finish Espressif 22/31

28 ! 6. 下载固件 ESP8266 AT 若下载 ESP8266 AT 固件或者使用开发板或模组中默认的固件, 在运行行模式下, 系统的打印信息末尾显示 Ready 字样在终端输入指令 AT, 系统显示 OK, 代表固件正常运行行因 AT 固件强制设置波特率为 , 与 ESP8266 默认的波特率不不符, 因此系统初始化的信息会显示为乱码, 只要最后显示 Ready 字样, 均为正常情况关于 AT 指令, 请参考 ESP8266 AT 指令集 6.3. 射频初始化设置 ( 可选 ) 在下载之前, 用户可以进入 RF InitConfig 页签修改射频初始化设置, 生成的 esp_init_data_setting.bin 可代替 esp_init_data_default.bin 下载到 Flash 中射频初始化设置包括 RF InitConfig 选项设置和 RF InitConfig 数据设置两部分图 6-2. ESP8266 DOWNLOAD TOOL RF InitConfig Espressif 23/31

29 6. 下载固件 RF InitConfig 选项 RF InitConfig 选项如图 6-2 的上半部分, 配置说明如表 6-3 所示表 6-3. RF InitConfig 选项设置配置项 TxTargetPowerConfig 配置说明用户无需配置, 会根据 LowPowerMode 中的配置项而变化根据实际情况进行行低功耗模式的配置 LowPowerEn: 开启低功耗模式, 为每个速率设定统一的功耗值 LowPowerMode PowerLimtEn: 限定输出功率的最大值 BackOffEn: 为每个速率的功率设置统一的避退阶数 LowPowerEn 和 PowerLimtEn 不不能同时配置根据实际选用的晶振型号选择晶振频率 CrystalFreq 若在下载时选择了了不不同的选项, 会覆盖该设置根据实际情况进行行 TOUT 管脚的配置, 建议保持默认设置 TOUT_ADC_EN: 在 TOUT 管脚接外部电路路的情况下, 使用芯片内部的 ADC 端口测量量外部电压值 (0V ~ 1V) TOUT PinConf TOUT_VDD_EN: 在 TOUT 管脚悬空的情况下, 通过 uint16 system_get_vdd33(void) 测量量 VDD33 的电压值注意 : TOUT_ADC_EN 和 TOUT_VDD_EN 不不能同时配置选择 TOUT_ADC_EN 时, 需要填写真实的 VDD3P3 管脚 3 和 4 上的电源电压 SetFreqEnable: 手动设置频偏值 FreqOffset - PracticalFreqOffset: 选择 SetFreqEnable 时, 该选项有效 AutoCalEn: 自动调整频偏值用户可选择射频的初始化行行为 : LoadRFCalParam: 初始化时射频数据直接从 Flash 读取, 不不作任何校准, 耗时约 2 ms, 初始电流最小 RFInt mode TxPwrCtrl in init: 初始化时仅做 Tx Power 校准, 其他从 Flash 读取, 耗时约 20 ms, 初始电流较小 FullRFCal in RFInit: 初始化时进行行全部的校准, 耗时约 200 ms, 初始电流较大 RF InitConfig 参数 RF InitConfig 参数如图 6-2 的下半部分, 参数说明如表 6-4 所示 Espressif 24/31

30 ! 6. 下载固件表 6-4. RF InitConfig 参数设置配置项 A B C 配置说明代表 esp_init_data_setting.bin (0 ~ 127 字节 ) 文件中的字节, 如 A = 0 代表 esp_init_data_setting.bin 文件中的 0 字节配置项的名称, 标示为 Reserved 不不能修改配置项的名称, 标示为 Reserved 不不能修改 D 配置项的数据类型包括无符号数 (unsigned) 和有符号数 (signed) E 配置项的十六进制值注意 : 请勿修改标识为 Reserved 的参数下面介绍如何修改 112 ~ 114 字节的参数, 初始设置如图 6-3 所示图 ~ 114 字节参数修改 RF 初始化参数 114 字节用于控制 ESP8266 上电时 RF 的初始化, 参数设置如表 6-5 所示 ESP8266_NONOS_SDK_V1.5.3 和 ESP8266_RTOS_SDK_V1.3.0 及之后版本支持表 6-5. 修改 RF 初始化参数配置项配置说明 114 字节 = 0 RF 初始化仅做 VDD33 校准, 耗时约 2 ms, 初始电流最小 114 字节 = 字节默认值为 1 RF 初始化做 VDD33 和 TX power CAL, 耗时约 18 ms, 初始电流较小 114 字节 = 2 同 114 字节 = 字节 = 3 RF 初始化进行行全部 RF CAL, 耗时约 200 ms, 初始电流较大 Espressif 25/31

31 6. 下载固件修改频偏 112 字节和 113 字节是与频偏相关的参数, 参数设置如表 6-6 所示 ESP8266_NONOS_SDK_V1.4.0 和 ESP8266_RTOS_SDK_V1.3.0 及之后版本支持表 6-6. 修改频偏参数配置项配置说明 112 字节, 默认值为 0 拥有 112 字节的最高优先级 bit 0 bit 0 = 0 : 不不修改频偏 bit 0 = 1 : 修改频偏值为 0 表示 bbpll 为 168 M, 可修改正或负频偏 bit 1 此功能可能影响数字外设的正常工作, 不不建议使用值为 1 表示 bbpll 为 160 M, 可修改正频偏 {bit 3,bit 2} 值为 0 表示内部自测且跟踪修改频偏, 初始修改频偏为 0; 值为 1 表示强制修改频偏为 113 字节的值, 不不再跟踪修改频偏 ; 值为 2 表示内部自测且跟踪修改频偏, 初始修改频偏为 113 字节的值 113 字节, 默认值为字节是强制修改频偏时的频偏数据, 或者跟踪修改频偏时的初始频偏数据, 数据类型为 sign int8, 单位为 8 khz 设置举例例 112 字节和 113 字节需要根据客户的具体需求设置, 举例例如下 1. 只在常温下工作的模组, 不不需要修改频偏可设置 112 字节 = 0,113 字节 = 0 2. 只在常温下工作的模组, 不不需要内部自测且跟踪修改频偏, 但是本身频偏较大, 可使用强制修改频偏假设常温时本身频偏为 +160 khz, 可设置 112 字节 = 0x07,113 字节 = ( /8) = 236 = 0xEC 假设常温时本身频偏为 -160 khz, 可设置 112 字节 = 0x05,113 字节 = 160/8 = 20 = 0x14 但此功能可能影响数字外设的正常工作, 必须经过大量量的应用测试, 不不建议使用 Espressif 26/31

32 6. 下载固件 3. 工作温度在 -40 度到 125 度之间变化, 类似彩灯的应用, 需要内部自测且跟踪修改频偏, 但是常温时本身频偏较小, 不不需要设置初始频偏可设置 112 字节 = 0x03,113 字节 = 0 4. 工作温度在 -40 度到 125 度之间变化, 类似彩灯的应用, 需要内部自测且跟踪修改频偏, 但是常温时本身频偏较大, 需要设置初始频偏假设常温时本身频偏为 +160 khz, 可设置 112 字节 = 0x0B,113 字节 = ( /8) = 236 = 0xEC 假设常温时本身频偏为 -160 khz, 可设置 112 字节 = 0x09,113 字节 = 160/8 = 20 = 0x14 但此功能可能影响数字外设的正常工作, 必须经过大量量的应用测试, 不不建议使用一般建议客户参考上述例例三的设置设置完成后, 点击 GenInitBin 按键, 生成 esp_init_data_setting.bin 用户也可以点击 Default 按键恢复默认值, 或点击 LoadInitBin 按键, 选择导入一个 BIN 文件进行行参数配置 Espressif 27/31

33 附录 A A. 附录配置 ISSI & MXIC Flash QIO 模式注意 : 下载时, 务必选择 DIO 或 DOUT 模式, 否则会报错, 此时无需修改 BIN 文件因 ISSI Flash 和 MXIC Flash 状态寄存器器的特殊性, 如需使用 ISSI Flash 和 MXIC Flash 的 QIO 模式, 则需要修改 blank.bin 的前 2 个字节, 如表 A-1 所示当 ESP8266 启动时会检查 blank.bin 的前 2 个字节, 自动切换为 QIO 模式读 ISSI_FLASH 或 MXIC_FLASH blank.bin 文件的结构如下 strcut boot_hdr{ char user_bin:2; //low_bit char boot_status:1; char to_qio:1; char reverse:4; char version:5; //low bit char test_pass_flag:1; char test_start_flag:1; char enhance_boot_flag:1; } 表 A-1. blank.bin 配置项配置项配置说明不不使用二级 boot 修改 to_qio 为 0 修改 use_bin 为 0,to_qio 为 0 修改 version 为当前 boot 版本使用二级 boot 举例例 : 如使用二级 boot_v1.5.bin, 修改 blank.bin 的前两个字节 FF FF 为 F4 E5 Espressif 28/32

34 附录 B B. 附录学习资源 B.1. 必读资料料 ESP8266 技术规格表说明 : 该手册介绍了了 ESP8266 产品参数, 概述了了 ESP8266( 特点协议技术参数和应用 ) 管脚的布局和定义描述 ESP8266 上的功能模块和协议 ( 包括 CPU 闪存和存储时钟射频 Wi-Fi 和低功耗管理理 ) 描述 ESP8266 上所集成的外设接口电气参数和封装信息 ESP8266 硬件资源说明 : 该压缩包的内容主要是硬件原理理图, 包括板和模组的制造规范, 物料料清单和原理理图 ESP8266 Non-OS SDK IoT_Demo 指南说明 : 该文档针对智能插座, 智能灯, 智能传感器器对 IoT Demo 做了了详解, 以及 curl 工具的使用, 和局域网功能和广域网功能的介绍 ESP8266 RTOS SDK 编程指南说明 : 该手册提供 ESP8266_RTOS_SDK 的编程示例例, 包括熟悉 EAP8266 基础示例例, 网络协议示例例, 和一些高级示例例 ESP8266 AT 指令使用示例例说明 : 该手册介绍几种常见的 Espressif AT 指令使用示例例, 包括单链接 TCP Client UDP 传输透传多链接 TCP Service 等 ESP8266 AT 指令集说明 : 该手册提供了了 ESP8266_NONOS_SDK 的 AT 指令说明, 包括烧录 AT 固件自定义 AT 命令基本 AT 指令 Wi-Fi 相关的 AT 指令和 TCP/IP 相关的 AT 指令等 ESP8266 Non-OS SDK API 参考说明 : 该手册提供了了 ESP8266_NONOS_SDK 的 API 说明, 包括对 ESP8266_NONOS_SDK 的概述应用程序接口 TCP/UDP 接口 Mesh 接口应用相关接口结构体与宏定义外设驱动接口等 ESP8266 RTOS SDK API 参考说明 : 该手册提供了了 ESP8266_RTOS_SDK 的 API 说明, 包括对 ESP8266_RTOS_SDK Wi-Fi Boot 等一系列列接口函数 Espressif 29/31

35 附录 B 常见问题 B.2. 必备资源 ESP8266 SDK 说明 : 该页面提供了了 ESP8266 所有版本 SDK RTOS 示例例代码说明 : 该页面提供了了常用功能的示例例代码 Non-OS 示例例代码说明 : 该页面提供了了常用功能的示例例代码 ESP8266 工具说明 : 该页面提供了了 ESP8266 Flash 下载工具以及 ESP8266 性能评估工具 ESP8266 APK ESP8266 认证测试指南 ESP8266 官方论坛 ESP8266 资源合集 B.3. 视频资源 ESP8266 开发板使用教程 ESP8266 Non-OS SDK 编译教程 Espressif 30/31

36 乐鑫 IOT 团队免责申明和版权公告本文中的信息, 包括供参考的 URL 地址, 如有变更更, 恕不不另行行通知文档按现状提供, 不不负任何担保责任, 包括对适销性适用于特定用途或非侵权性的任何担保, 和任何提案规格或样品在他处提到的任何担保本文档不不负任何责任, 包括使用本文档内信息产生的侵犯任何专利利权行行为的责任本文档在此未以禁止反言或其他方式授予任何知识产权使用许可, 不不管是明示许可还是暗示许可 Wi-Fi 联盟成员标志归 Wi-Fi 联盟所有蓝牙标志是 Bluetooth SIG 的注册商标文中提到的所有商标名称商标和注册商标均属其各自所有者的财产, 特此声明版权归 2018 乐鑫所有保留留所有权利利

BT&BLE_Coexistence_Demo__CN.pages

BT&BLE_Coexistence_Demo__CN.pages ESP32 BT&BLE 双模蓝牙共存说明版本 1.0 版权 2018 关于本手册本文档为 ESP32 BT&BLE 双模蓝牙共存说明发布说明日期版本发布说明 V1.0 首次发布文档变更更通知用户可通过乐鑫官网订阅技术文档变更更的电子邮件通知证书下载用户可通过乐鑫官网下载产品证书目录 1. BT&BLE 共存结构图... 1 2. 流程说明... 2 2.1. 初始化流程...