原廠參考2a-espressif iot sdk使用手冊_v0

1、EspressifIoTSDK 使用手冊 ERNAL PUBLIC1 / 2E r s f Sy tJ n 11SusReleasedCurrent verV0.8AuthorFei YuCompletion Date2014.8.14ReviewerJiangang WuCompletion Date2014.8.14版本信息申本文中的信息，包括供參考的 URL 地址，變更，恕不另行通知。文檔“按現(xiàn)狀”提供，不負任何擔(dān)保責(zé)任，包括對適銷性、適用于特定用途或非性的任何擔(dān)保，和任何提案、規(guī)格或樣品在他處提到的任何擔(dān)保。本文檔不負任何責(zé)任，包括使用本文檔內(nèi)信息產(chǎn)生的任何專利權(quán)行為的責(zé)任。本文檔在此

2、未以反言或其他方式授予任何知識使用，不管是明示還是暗示。Wi-Fi成員標志歸 Wi-Fi所有。文中提到的所有商標名稱、商標和商標均屬其各自所有者的，特此。歸 2014所有。保留所利。/ 2Er s f Sy tJ n 11日版本寫審 人改 明2013.12.240.1Jiangang Wu初稿2014.1.150.2Jiangang Wu增加 sta+softAP 模式例子2014.2.70.3Jiangang Wu例子支持 WAN 接入2014.3.200.4Han Liu例子支持系統(tǒng)升級， WAN 下更改用戶， AP 熱點獲取，數(shù)據(jù)加密傳輸2014.5.140.5Jiangang Wu去除

3、例子，例子單獨介紹2014.6.190.6Fei Yu文檔格式2014.7.100.7Fei Yu支持云端升級2014.8.140.8Fei Yu增加新 flash tool目錄版本信息2目錄3前言4虛擬機51.2.2.1.2.2.2.2.1.2.2.2.2.2.3.2.2.4.2.2.5.3.3.1.3.2.3.2.1.3.2.2.3.3.3.3.1.3.3.2.3.4.3.5.3.6.4.4.1.4.2.4.3.4.3.1.4.3.2.虛擬機.5虛擬電腦5鏡像5導(dǎo)入5網(wǎng)絡(luò)8共享文件夾8界面10開發(fā)工具11編譯器11串口工具13USB 轉(zhuǎn)串口13SecureCRT14工具14_UTIL14E

4、SP_FLASH_DOWNLOAD18NetAssist19tman19Tomcat19包20SDK介紹20目錄結(jié)構(gòu)20編譯及燒錄方法21不支持云端升級21支持云端升級22/ 2E r s f Sy tJ n 11言1.本文主要介紹基于 ESP8266 物聯(lián)網(wǎng)模塊的 SDK 相關(guān)使用方法，包括虛擬機安裝設(shè)置、開發(fā)工具使用以及 SDK包架構(gòu)等。4 / 2Er s f Sy tJ n 112. 虛擬機基于ESP8266 物聯(lián)網(wǎng)模塊進行二次開發(fā)所需的相關(guān)開發(fā)工具已安裝到虛擬機中，用戶只需安裝虛擬機，并導(dǎo)入虛擬電腦，即可進行開發(fā)。2.1.擬機軟虛擬機采用 VirtualBox，地址為：選擇相應(yīng)安裝。2

5、.2.擬2.2.1.虛擬電腦鏡像采用開放式虛擬化格式(*.ova)，文件為 ESP_IOT_SDK.ova，可以被其他虛擬機導(dǎo)入使用。2.2.2. 導(dǎo)入VirtualBox 默認情況，會將虛擬電腦導(dǎo)入系統(tǒng)盤，隨著虛擬電腦的使用，會占用非常大的空間，建議設(shè)置虛擬電腦位置到非系統(tǒng)盤。第一步：管理菜單下選擇全局設(shè)定第二步：選擇常規(guī)，設(shè)置默認虛擬電腦位置，如：D:vm/ 2E r s f Sy tJ n 11第三步：管理菜單下選擇導(dǎo)入虛擬電腦第四步：設(shè)置要導(dǎo)入的虛擬電腦路徑，如：D:vmESP_IOT_SDK.ova/ 2E r s f Sy tJ n11第五步：導(dǎo)入/ 2E r s f Sy tJ

6、n 11導(dǎo)入成功后會在 D:vmESP_IOT_SDK 目錄下生成如下文件：2.2.3.為了使虛擬電腦能到 ESP8266 模塊，需要使虛擬電腦和 ESP8266 在同一網(wǎng)段。使用虛擬電腦前，請先根據(jù)宿主機選擇相應(yīng)網(wǎng)卡。在 VirtualBox界面點擊設(shè)置，進入網(wǎng)絡(luò)設(shè)置頁面。界面名稱選擇主機電腦連接路由器的真實網(wǎng)卡。2.2.4. 共夾使用虛擬電腦前，請先設(shè)置宿主機內(nèi)的文件夾共享給虛擬電腦使用，例如：新建一個“share”文件夾，于與虛擬電腦，宿主機可通過將資料拷到此文件夾中，與虛擬機共享，具體如下：8 / 2E r s f Sy tJ n 11設(shè)置成功后，在虛擬電腦內(nèi)網(wǎng)絡(luò)驅(qū)動器，如下圖：其中驅(qū)

7、動器號設(shè)置為 D:，share 為在 VirtualBox 中設(shè)置的共享文件夾名稱。默認情況下，虛擬電腦內(nèi)已設(shè)置好共享文件夾。成功后，在虛擬電腦內(nèi)“電腦”中就會出現(xiàn)該網(wǎng)絡(luò)驅(qū)動器，如下圖。將 SDK工程及其他資料放在該盤下，與宿主機進行共享。9 / 2E r s f Sy tJ n 112.2.5. 界導(dǎo)入成功，并設(shè)置完網(wǎng)絡(luò)后，系統(tǒng)。1 /Er s f Sy tJ n 113. 開發(fā)具虛擬電腦內(nèi)默認安裝了開發(fā)所需的，包括編譯器、一些調(diào)試，用戶可根據(jù)需要自行安裝其他。3.1. 編譯雙擊桌面圖標即可打開編譯環(huán)境，編譯器相關(guān)參數(shù)已配置，工程路徑已設(shè)置為 d:esp_iot_sdkapp，請先按照 2.

8、2.4 節(jié)的方法設(shè)置好共享文件夾，雙擊后會出現(xiàn)如下三個窗口：1、2、11 /E r s f Sy tJ n 113、其中 1 和 2 是編譯器 license 窗口，不用理會。3 是編譯窗口，當(dāng)用戶修改代碼后，只需在該窗口執(zhí)行相關(guān)命令，可生成所需的 bin 文件。1 /E r s f Sy tJ n 113.2.口工ESP8266 母板采用串口與電腦通訊，可以將串口接入虛擬電腦，利用虛擬電腦內(nèi)的工具與 ESP8266 進行通訊。使用前請先安裝驅(qū)動。3.2.1. USB市面上有多種 USB 轉(zhuǎn)串口線，本文中使用的是采用 FT232R 的串口線，在菜單中將連接到主機的 USB 轉(zhuǎn)串口設(shè)備分配給虛擬

9、電腦，即可將 USB 轉(zhuǎn)串口線連接到虛擬電腦。在虛擬電腦內(nèi)可設(shè)置 USB 轉(zhuǎn)串口的串，建議設(shè)置為串口 6。1 /E r s f Sy tJ n 11可以采用虛擬電腦內(nèi)的驅(qū)動精靈安裝其他型號的 USB 轉(zhuǎn)串口線驅(qū)動。3.2.2. SecureCRTESP8266 模塊采用 74880 波特率，需要在 SecureCRT 中進行設(shè)置。3.3.工3.3.1._UTIL雙擊桌面即可打開工具，將編譯生成的*.bin文件到ESP8266 母板的 SPI Flash 中。母板上跳線設(shè)置為 MTDO：0，GPIO0：0，GPIO2：1，可進入作步驟如下：模式。操第一步：設(shè)置串口第二步：選擇相應(yīng)的串，并打開1

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

11、h 的 bin 文件并 eagle.app.v6.irom0text.bin 文件。例如， 注意：對于 eagle.app.v6.irom0text.bin 文件，對應(yīng)的 Program Address Offset為 0 x40000。具體可見本文檔“4.2 目錄結(jié)構(gòu)”中的 bin 目錄說明。第七步：關(guān)閉串口1 /E r s f Sy tJ n 11完成后，可利用 SecureCRT 查看打印信息。母板上跳線設(shè)置為 MTDO：0，GPIO0：1，GPIO2：1，可進入運行模式。注意：進行跳線操作時，請斷電操作。1 /E r s f Sy tJ n 113.3.2. ESP_FLASH_DOW

12、NLOADEspressif 另提供工具“ESP_FLASH_DOWNLOAD”實現(xiàn)多個 bin 文件的一鍵燒錄，將編譯生成的多個*.bin 文件到 ESP8266 母板的 SPI Flash 中?！癊SP_FLASH_DOWNLOAD”說明如下：（1）（2）燒錄文件勾選區(qū)，選擇要燒錄的 bin 文件，以及設(shè)置對應(yīng)的燒錄地址；SPI FLASH CONFIG 區(qū)，配置 spi flash 的屬性，按鍵 CombineBin 將上述勾選了的 bin 文件認值。一個targe.bin，按鍵 Default 將 SPI FLASH 的配置恢復(fù)默（3）Mac Address，燒錄時可以獲得 ESP82

13、66 的 MAC 地址。母板上跳線設(shè)置為 MTDO：0，GPIO0：0，GPIO2：1，進入模式。操作步1 /E r s f Sy tJ n 11驟如下：選擇需要燒錄的 bin 文件 - 填寫燒錄地址 - 勾選需要燒錄的選項。設(shè)置 COM 口和波特率。3） 點擊“START”開始。4）完成后，將母板斷電，修改跳線為運行模式，上電正常運行。母板上跳線設(shè)置為 MTDO：0，GPIO0：1，GPIO2：1，可進入運行模式。注意：進行跳線操作時，請斷電操作。3.4. NetAssist網(wǎng)絡(luò)調(diào)試助手工具，用于調(diào)試 TCP、UDP。3.5.tmanChrome 插件，用于調(diào)試 REST 架構(gòu) web se

14、rvice。3.6. TomcatWeb 應(yīng)用服務(wù)器，用于存放升級文件。1 /E r s f Sy tJ n 11包4. SDK4.1. 介紹在虛擬電腦中，SDK包默認存于網(wǎng)絡(luò)驅(qū)動器 D 盤根目錄，編譯器 xtensa工作目錄已指向 d:esp_iot_sdkapp。4.2.錄 構(gòu)包中包含了進行二次開發(fā)所需的頭文件、庫文件以及其他編譯所需SDK的文件。目錄結(jié)構(gòu)如下圖：具體說明：1、 app 目錄為用戶工作主目錄，包含 user 和 include 兩個子目錄，用戶源代碼及頭文件均需存放在這兩個目錄內(nèi)。可參考 ex步驟 4 說明。les 中的示例，詳見2、 bin 目錄為到 Flash 的 bi

15、n 文件，其中 at 文件夾內(nèi)為支持 AT+指令的bin 文件，upgrade 文件夾內(nèi)為支持云端升級的 bin 文件。/E r s f Sy tJ n 113、4、 exs 目錄為 SDK 相關(guān)說明文檔；les 目錄為SDK 例程，使用時只需將IoT_Demo 目錄下的user、include目錄以及 Makefile 文件拷貝到 app 目錄下；5、 include 目錄為 SDK 自文件，包含了用戶可使用的相關(guān) API 函數(shù)及其他定義，用戶不需修改；6、 ld 目錄為 SDK時所需文件，用戶不需修改；7、 lib 目錄為 SDK 編譯所需庫文件；8、 tools 目錄為生成 bin 文件

16、所需工具，用戶不需修改。4.3. 編譯及燒錄方法編譯時，請注意將 esp_iot_sdkexles 的子目錄內(nèi)的 user、include 目錄以及 Makefile 文件拷貝到 esp_iot_sdkapp 目錄下。燒錄方式請參考“3.3工具”，需注意，每次完成一個 bin 到 flash 中，都需要關(guān)閉串口，再重新打開串口，連接，進入下一個 bin 的燒錄過程。4.3.1. 不支esp_iot_sdk_v0.7 及以前的版本，不支持云端升級。編譯方式如下：打開編譯器 xtensa，已默認指向待編譯路徑 d:esp_iot_sdkapp 。輸入 make 命令，回車。根據(jù) makefile

17、生成.output 文件夾，存放 lib 及obj 文件。輸入 gen_misc.bat，回車。即可生成相應(yīng) bin 文件。bin 文件說明如下：1）bl.bin，由 Espressif 提供，燒錄到 0 x7E000 地址；eagle.app.v6.flash.bin，如上編譯生成，燒錄到 0 x0000 地址；master_device_key.bin，向 Espressif 服務(wù)器申請，燒錄到 0 x3E000 地址；eagle.app.v6.irom0text.bin，如上編譯生成，燒錄到 0 x40000 地址；1 /E r s f Sy tJ n 115）esp_init_data

18、_default.bin，由 Espressif 提供燒錄到 0 x7c000 地址注意，射頻相關(guān)參數(shù)的初始值，1） bl.bin 不是每次都需燒錄，僅當(dāng) sdk 升級版本或需要擦除 WIFI 配置參數(shù)時進行燒錄；master_device_key.bin 不是每次都需燒錄，僅當(dāng)?shù)谝淮螌懭牖蛐枰膍aster_device_key 時燒錄；一般情況，僅需燒錄 eagle.app.v6.flash.bin- eagle.app.v6.irom0text.bin 兩個 bin 即可。4.3.2.esp_iot_sdk_v0.8 及之后的版本，支持云端升級。同時也兼容之前的編譯及燒錄方式，對于 esp_iot_sdk_v0.8 及之后的，如無需云端升級功能，仍可采用 4.3.1 不支持云端升級 中的編譯及燒錄方法。具體的云端升級功能說明，請參見文檔“云端升級實現(xiàn)方案”。編譯方式如下：打開編譯器，先編譯 user1.bin，執(zhí)行指令 make APP=1執(zhí)行 gen_misc_plus