1、 EspressifIoTSDK 使用手冊(cè) CONFIDENTIAL INTERNAL PUBLIC1 / 23Espressif SystemsJune 19, 2014StatusReleasedCurrent versionV0.8AuthorFei YuCompletion Date2014.8.14ReviewerJiangang WuCompletion Date2014.8.14 版本信息免責(zé)申明和版權(quán)公告本文中的信息，包括供參考的 URL 地址，如有變更，恕不另行。文檔“按現(xiàn)狀”提供，不負(fù)任何擔(dān)保責(zé)任，包括對(duì)適銷性、適用于特定用途或非侵權(quán)性的任何擔(dān)保，和任何提案、規(guī)格或樣品在他

2、處提到的任何擔(dān)保。本文檔不負(fù)任何責(zé)任，包括使用本文檔內(nèi)信息產(chǎn)生的任何專利權(quán)行為的責(zé)任。本文檔在此未以禁止反言或其他方式授予任何知識(shí)產(chǎn)權(quán)使用許可，不管是明示許可還是暗示許可。Wi-Fi 聯(lián)盟成員標(biāo)志歸 Wi-Fi 聯(lián)盟所有。文中提到的所有商標(biāo)名稱、商標(biāo)和注冊(cè)商標(biāo)均屬其各自所有者的財(cái)產(chǎn)，特此聲明。版權(quán)歸 2014 樂鑫信息技術(shù)有限公司所有。保留所有權(quán)利。2 / 23Espressif SystemsJune 19, 2014日期版本撰寫人審核人修改說明20Jiangang Wu初稿 20Jiangang Wu增加 sta+softAP 模式例子 2014.

3、2.70.3Jiangang Wu例子支持 WAN 接入20Han Liu例子支持系統(tǒng)升級(jí)， WAN 下更改用戶， AP 熱點(diǎn)獲取，數(shù)據(jù)加密傳輸 20Jiangang Wu去除例子，例子單獨(dú)介紹 20Fei Yu統(tǒng)一文檔格式 20Fei Yu支持云端升級(jí) 20Fei Yu增加新 flash tool 目錄版本信息2目錄3前言4虛擬機(jī)5虛擬機(jī)軟件5虛擬電腦5鏡像5導(dǎo)入5網(wǎng)絡(luò)8共享文件夾8界面10開發(fā)工具11編譯器11串口工具13USB 轉(zhuǎn)串口13SecureCRT14下載工具14XTCOM_UTI

4、L14ESP_FLASH_DOWNLOAD18NetAssist19Postman19Tomcat19SDK 軟件包20介紹20目錄結(jié)構(gòu)20編譯及燒錄方法21不支持云端升級(jí)21支持云端升級(jí).............. / 23Espressif SystemsJune 19, 2014 1. 前言本文主要介紹基于 ESP8266 物聯(lián)網(wǎng)模塊的 SDK 相關(guān)使用方法，包括虛擬機(jī)安 裝設(shè)

5、置、開發(fā)工具使用以及 SDK 軟件包架構(gòu)等。 4 / 23Espressif SystemsJune 19, 2014 2. 虛擬機(jī)基于ESP8266 物聯(lián)網(wǎng)模塊進(jìn)行二次開發(fā)所需的相關(guān)開發(fā)工具已安裝到虛擬機(jī)中，用戶只需安裝虛擬機(jī)軟件，并導(dǎo)入虛擬電腦，即可進(jìn)行開發(fā)。 2.1. 虛擬機(jī)軟件虛擬機(jī)采用 VirtualBox，下載地址為： /wiki/Downloads選擇相應(yīng)平臺(tái)下載安裝。2.2. 虛擬電腦2.2.1. 鏡 像虛擬電腦鏡像采用開放式虛擬化格式(*.ova)，文件為 ESP_IOT_SDK.ova，可以被其他虛擬機(jī)軟件導(dǎo)入使用。 2.2

6、.2. 導(dǎo) 入VirtualBox 默認(rèn)情況，會(huì)將虛擬電腦導(dǎo)入系統(tǒng)盤，隨著虛擬電腦的使用，會(huì)占用非常大的空間，建議設(shè)置虛擬電腦位置到非系統(tǒng)盤。 第一步：管理菜單下選擇全局設(shè)定第二步：選擇常規(guī)，設(shè)置默認(rèn)虛擬電腦位置，如：D:vm5 / 23Espressif SystemsJune 19, 2014 第三步：管理菜單下選擇導(dǎo)入虛擬電腦第四步：設(shè)置要導(dǎo)入的虛擬電腦路徑，如：D:vmESP_IOT_SDK.ova6 / 23Espressif SystemsJune 19, 2014 第五步：導(dǎo)入7 / 23Espressif SystemsJune 19, 2014 導(dǎo)入成功后會(huì)在 D:vmESP

7、_IOT_SDK 目錄下生成如下文件：2.2.3. 網(wǎng) 絡(luò)為了使虛擬電腦能訪問到 ESP8266 模塊，需要使虛擬電腦和 ESP8266 在同一網(wǎng)段。使用虛擬電腦前，請(qǐng)先根據(jù)宿主機(jī)選擇相應(yīng)網(wǎng)卡。 在 VirtualBox 軟件界面點(diǎn)擊設(shè)置，進(jìn)入網(wǎng)絡(luò)設(shè)置頁面。界面名稱選擇主機(jī)電腦連接路由器的真實(shí)網(wǎng)卡。2.2.4. 共享文件夾使用虛擬電腦前，請(qǐng)先設(shè)置宿主機(jī)內(nèi)的文件夾共享給虛擬電腦使用，例如： 新建一個(gè)“share”文件夾，專用于與虛擬電腦映射，宿主機(jī)可通過將資料拷到 此文件夾中，與虛擬機(jī)共享，具體如下： 8 / 23Espressif SystemsJune 19, 2014 設(shè)置成功后，在虛擬電

8、腦內(nèi)映射網(wǎng)絡(luò)驅(qū)動(dòng)器，如下圖：其中驅(qū)動(dòng)器號(hào)設(shè)置為 D:，share 為在 VirtualBox 中設(shè)置的共享文件夾名稱。默 認(rèn)情況下，虛擬電腦內(nèi)已設(shè)置好共享文件夾。 映射成功后，在虛擬電腦內(nèi)“我的電腦”中就會(huì)出現(xiàn)該網(wǎng)絡(luò)驅(qū)動(dòng)器，如下圖。 將 SDK 軟件工程及其他資料放在該盤下，與宿主機(jī)進(jìn)行共享。9 / 23Espressif SystemsJune 19, 2014 2.2.5. 界 面導(dǎo)入成功，并設(shè)置完網(wǎng)絡(luò)后，即可進(jìn)入系統(tǒng)。10 / 23Espressif SystemsJune 19, 2014 3. 開發(fā)工具虛擬電腦內(nèi)默認(rèn)安裝了開發(fā)所需的軟件，包括編譯器、下載軟件和一些調(diào)試軟件，用戶可根據(jù)

9、需要自行安裝其他軟件。3.1. 編譯器雙擊桌面圖標(biāo)即可打開編譯環(huán)境，編譯器相關(guān)參數(shù)已配置，工程路 徑已設(shè)置為 d:esp_iot_sdkapp，請(qǐng)先按照 2.2.4 節(jié)的方法設(shè)置好共享文件夾，雙擊后會(huì)出現(xiàn)如下三個(gè)窗口： 1、2、11 / 23Espressif SystemsJune 19, 2014 3、其中 1 和 2 是編譯器 license 窗口，不用理會(huì)。3 是編譯窗口，當(dāng)用戶修改代 碼后，只需在該窗口執(zhí)行相關(guān)命令，可生成下載所需的 bin 文件。 12 / 23Espressif SystemsJune 19, 2014 3.2. 串口工具ESP8266 母板采用串口與電腦通訊，可

10、以將串口接入虛擬電腦，利用虛擬電腦內(nèi)的工具軟件與 ESP8266 進(jìn)行通訊。使用前請(qǐng)先安裝驅(qū)動(dòng)。 3.2.1. USB 轉(zhuǎn)串口市面上有多種 USB 轉(zhuǎn)串口線，本文中使用的是采用 FT232R 的串口線，在菜單中將連接到主機(jī)的 USB 轉(zhuǎn)串口設(shè)備分配給虛擬電腦，即可將 USB 轉(zhuǎn)串口線連接到虛擬電腦。 在虛擬電腦內(nèi)可設(shè)置 USB 轉(zhuǎn)串口的串，建議設(shè)置為串口 6。13 / 23Espressif SystemsJune 19, 2014 可以采用虛擬電腦內(nèi)的驅(qū)動(dòng)精靈安裝其他型號(hào)的 USB 轉(zhuǎn)串口線驅(qū)動(dòng)。3.2.2. SecureCRTESP8266 模塊采用 74880 波特率，需要在 Secur

11、eCRT 中進(jìn)行設(shè)置。3.3. 下載工具3.3.1. XTCOM_UTIL雙擊桌面 即可打開下載工具，將編譯生成的*.bin 文件下載到 ESP8266 母板的 SPI Flash 中。 母板上跳線設(shè)置為 MTDO：0，GPIO0：0，GPIO2：1，可進(jìn)入下載模式。操作步驟如下： 第一步：設(shè)置串口第二步：選擇相應(yīng)的串，并打開14 / 23Espressif SystemsJune 19, 2014 第三步：連接第四步：下載鏡像 bin 文件第五步：選擇需要燒入 flash 的 bin 文件并下載。15 / 23Espressif SystemsJune 19, 2014 注意：對(duì)于不同的 b

12、in 文件，對(duì)應(yīng)的 Program Address Offset 并不一致。例如， eagle.app.v6.flash.bin 文件，對(duì)應(yīng)的 Program Address Offset 為 0x0000。具體可見本文檔“4.2 目錄結(jié)構(gòu)”中的 bin 目錄說明。 第六步：重新連接 第五步操作完成后，需要使 ESP8266 母板重新上電。關(guān)閉串口，并重復(fù)第二、 三兩步。 第六步： 選擇下一個(gè)需要燒入 flash 的 bin 文件并下載。 例如， eagle.app.v6.irom0text.bin 文件。 注意：對(duì)于 eagle.app.v6.irom0text.bin 文件，對(duì)應(yīng)的 Pro

13、gram Address為 0x40000。具體可見本文檔“4.2 目錄結(jié)構(gòu)”中的 bin 目錄說明。第七步：關(guān)閉串口 Offset16 / 23Espressif SystemsJune 19, 2014 下載完成后，可利用 SecureCRT 查看打印信息。 母板上跳線設(shè)置為 MTDO：0，GPIO0：1，GPIO2：1，可進(jìn)入運(yùn)行模式。注意：進(jìn)行跳線操作時(shí)，請(qǐng)斷電操作。 17 / 23Espressif SystemsJune 19, 2014 3.3.2. ESP_FLASH_DOWNLOADEspressif 另提供工具“ESP_FLASH_DOWNLOAD”實(shí)現(xiàn)多個(gè) bin 文件的

14、一鍵燒錄，將編譯生成的多個(gè)*.bin 文件一次性下載到 ESP8266 母板的 SPI Flash 中。 “ESP_FLASH_DOWNLOAD”說明如下：（1）（2）燒錄文件勾選區(qū)，選擇要燒錄的 bin 文件，以及設(shè)置對(duì)應(yīng)的燒錄地址； SPI FLASH CONFIG 區(qū)，配置 spi flash 的屬性，按鍵 CombineBin 將上述勾選了的 bin 文件合成一個(gè)targe.bin，按鍵 Default 將 SPI FLASH 的配置恢復(fù)默認(rèn)值。 （3）Mac Address，燒錄時(shí)可以獲得 ESP8266 的 MAC 地址。母板上跳線設(shè)置為 MTDO：0，GPIO0：0，GPIO2：

15、1，進(jìn)入下載模式。操作步 18 / 23Espressif SystemsJune 19, 2014 驟如下：1） 選擇需要燒錄的 bin 文件 - 填寫燒錄地址 - 勾選需要燒錄的選項(xiàng)。 2） 設(shè)置 COM 口和波特率。 3） 點(diǎn)擊“START”開始下載。 4） 下載完成后，將母板斷電，修改跳線為運(yùn)行模式，上電正常運(yùn)行。 母板上跳線設(shè)置為 MTDO：0，GPIO0：1，GPIO2：1，可進(jìn)入運(yùn)行模式。注意：進(jìn)行跳線操作時(shí)，請(qǐng)斷電操作。 3.4. NetAssist網(wǎng)絡(luò)調(diào)試助手工具，用于調(diào)試 TCP、UDP。3.5. PostmanChrome 插件，用于調(diào)試 REST 架構(gòu) web serv

16、ice。3.6. TomcatWeb 應(yīng)用服務(wù)器，用于存放升級(jí)文件。19 / 23Espressif SystemsJune 19, 2014 4. SDK 軟件包4.1. 介紹在虛擬電腦中，SDK 軟件包默認(rèn)存于網(wǎng)絡(luò)驅(qū)動(dòng)器 D 盤根目錄，編譯器 xtensa工作目錄已指向 d:esp_iot_sdkapp。 4.2. 目錄結(jié)構(gòu)SDK 軟件包中包含了進(jìn)行二次開發(fā)所需的頭文件、庫文件以及其他編譯所需的文件。目錄結(jié)構(gòu)如下圖： 具體說明：1、 app 目錄為用戶工作主目錄，包含 user 和 include 兩個(gè)子目錄，用戶源代碼及頭文件均需存放在這兩個(gè)目錄內(nèi)?？蓞⒖?examples 中的示例，詳

17、見步驟 4 說明。 2、 bin 目錄為下載到 Flash 的 bin 文件，其中 at 文件夾內(nèi)為支持 AT+指令的 bin 文件，upgrade 文件夾內(nèi)為支持云端升級(jí)的 bin 文件。 20 / 23Espressif SystemsJune 19, 2014 3、 documents 目錄為 SDK 相關(guān)說明文檔； 4、 examples 目錄為SDK 例程，使用時(shí)只需將IoT_Demo 目錄下的user、include 目錄以及 Makefile 文件拷貝到 app 目錄下； 5、 include 目錄為 SDK 自帶頭文件，包含了用戶可使用的相關(guān) API 函數(shù)及其他定義，用戶不需修

18、改； 6、 ld 目錄為 SDK 軟件鏈接時(shí)所需文件，用戶不需修改；7、 lib 目錄為 SDK 編譯所需庫文件； 8、 tools 目錄為生成 bin 文件所需工具，用戶不需修改。 4.3. 編譯及燒錄方法編譯時(shí)，請(qǐng)注意將 esp_iot_sdkexamples 的子目錄內(nèi)的 user、include 目錄以及 Makefile 文件拷貝到 esp_iot_sdkapp 目錄下。 燒錄方式請(qǐng)參考“3.3 下載工具”，需注意，每次完成下載一個(gè) bin 到 flash 中， 都需要關(guān)閉串口，再重新打開串口，連接，進(jìn)入下一個(gè) bin 的燒錄過程。 4.3.1. 不支持云端升級(jí)esp_iot_sdk

19、_v0.7 及以前的版本，不支持云端升級(jí)。編譯方式如下： 1） 打開編譯器 xtensa，已默認(rèn)指向待編譯路徑 d:esp_iot_sdkapp 。 2） 輸入 make 命令，回車。根據(jù) makefile 生成.output 文件夾，存放 lib 及obj 文件。 3） 輸入 gen_misc.bat，回車。即可生成相應(yīng) bin 文件。 bin 文件說明如下： 1）blank.bin， 由 Espressif 提 供 ， 燒 錄 到 0x7E000 地 址 ； 2） eagle.app.v6.flash.bin，如上編譯生成，燒錄到 0x0000 地址； 3） master_device_k

20、ey.bin，向 Espressif 服務(wù)器申請(qǐng)，燒錄到 0x3E000 地址； 4）eagle.app.v6.irom0text.bin，如上編譯生成，燒錄到 0x40000 地址； 21 / 23Espressif SystemsJune 19, 2014 5）esp_init_data_default.bin，由 Espressif 提供，存儲(chǔ)射頻相關(guān)參數(shù)的初始值，燒錄到 0x7c000 地址 注意， 1） blank.bin 不是每次都需燒錄，僅當(dāng) sdk 升級(jí)版本或需要擦除 WIFI 配置參 數(shù)時(shí)進(jìn)行燒錄； 2） master_device_key.bin 不是每次都需燒錄，僅當(dāng)?shù)谝?/p>

21、次寫入或需要更改 master_device_key 時(shí)燒錄； 3） 一般情況，僅需燒錄 eagle.app.v6.flash.bin- eagle.app.v6.irom0text.bin 兩個(gè) bin 即可。 4.3.2. 支持云端升級(jí)esp_iot_sdk_v0.8 及之后的軟件版本，支持云端升級(jí)。同時(shí)也兼容之前的編譯及燒錄方式，對(duì)于 esp_iot_sdk_v0.8 及之后的軟件，如無需云端升級(jí)功能，仍可采用 4.3.1 不支持云端升級(jí) 中的編譯及燒錄方法。 具體的云端升級(jí)功能說明，請(qǐng)參見文檔“云端升級(jí)實(shí)現(xiàn)方案”。 編譯方式如下：1) 打開編譯器，先編譯 user1.bin，執(zhí)行指令 make APP=12) 執(zhí)行 gen_