開発​/WeMos D1

Flash ROMを読み書きするツール

esptool.pyは，ESP8266ボードに実装されているSPI Flash ROMを読んだりfirmwareを書いたりすることが出来るPythonで動作するツール。

Pythonが使える環境であれば，pipコマンドでインストール出来る。

> pip install esptool

インストールできたか確認してみる。

> esptool
esptool.py v4.8.1
usage: esptool [-h]
               [--chip {auto,esp8266,esp32,esp32s2,esp32s3beta2,esp32s3,esp32c3,esp32c6beta,esp32h2beta1,esp32h2beta2,esp32c2,esp32c6,esp32c61,esp32c5,esp32c5beta3,esp32h2,esp32p4}]
               [--port PORT] [--baud BAUD] [--port-filter PORT_FILTER]
               [--before {default_reset,usb_reset,no_reset,no_reset_no_sync}]
               [--after {hard_reset,soft_reset,no_reset,no_reset_stub}] [--no-stub] [--trace]
               [--override-vddsdio [{1.8V,1.9V,OFF}]] [--connect-attempts CONNECT_ATTEMPTS]
               {load_ram,dump_mem,read_mem,write_mem,write_flash,run,image_info,make_image,elf2image,read_mac,chip_id,flash_id,read_flash_status,write_flash_status,read_flash,verify_flash,erase_flash,erase_region,read_flash_sfdp,merge_bin,get_security_info,version}
               ...

esptool.py v4.8.1 - Espressif chips ROM Bootloader Utility
 :
 :

と表示されればインストールできている。

esptoolでボードの情報を確認する。

> esptool flash_id

搭載しているFlash ROMのサイズなんかが確認出来る。

ヘルプ表示されないオプションとして以下がある。

--flash_freq(-ff)

SPI Flash frequency: 40m, 26m, 20m, 80m

--flash_size(-fs)

SPI Flash size：1MB, 2MB, 4MB, 8MB, 16MB, 256KB, 512KB, 2MB-c1, 4MB-c1

--flash_mode(-fm)

SPI Flash mode：qio, qout, dio, dout

firmwareをバックアップする

Flash ROMが4MB（32Mbit）の場合は，以下のようにしてバックアップ出来る。

> esptool -c esp8266 -p COMx -b 115200 read_flash 0x0000 0x400000 esp8266_backup4M.bin

もし，バックアップしたfirmwareに戻したいときは以下のようにする。

> esptool -c esp8266 -p COMx -b 115200 write_flash 0x0000 esp8266_backup4M.bin

バックアップしていない場合でfirmwareを戻す

firmwareを前もってバックアップしていなかった場合，AI-Thinker社またはEspressif社で提供されているATコマンドのfirmwareをダウンロードして，WeMos D1互換/D1 miniボードのFlash ROMに書き込むことで，ATコマンドが使える状態に戻すことが出来る。

Espressif社のfirmwareは，ここのGitHubからv2.2.1やv3.0.6なんかをダウンロードする。
ダウンロードしたファイルを任意のディレクトリに解凍する。

bin\atディレクトリに2種類のMemory Map（512+512，1024+1024）のfirmwareが用意されている。

v2.2.1: SDK version:2.2.1, AT version:1.6.2.0
v3.0.6: SDK version:3.0.6, AT version:1.7.6.0

購入したWeMos D1互換/D1 miniボードだと，SDK v2.2.1の512+512，1024+1024のどちらののATコマンドfirmwareでも動作した。

SDK v3.0以降のバージョンも提供されているが，WeMos D1互換/D1 miniボードに使われているESP-12Fではビルド済みオブジェクトではうまく動作しなかった。v3.0以降だとFlash ROM領域がPartition定義され，実際のFlash ROMのサイズと合っていないと正常に動作しない。ビルド済みのものは2MBのFlash ROMようにビルドされているため，4MBのWeMos D1互換/D1 miniボードでは動かないのだと思う。
しょうがないので自分で4MB用にビルドし直してesp8266_nonos_sdk-3.0.6yu.zip，Flash ROMに書き込んだらうまく動作した。

以下のようにして書き込んだ。

v2.2.1 4MB(512KB+512KB)

> esptool -c esp8266 -p COMx -b 115200 write_flash -fs 4MB -fm dio 0x00000 boot_v1.7.bin 0x01000 at\512+512\user1.1024.new.2.bin 0x7e000 blank.bin 0x3fc000 esp_init_data_default_v08.bin 0x3fe000 blank.bin

v2.2.1 4MB-c1(1024KB+1024KB)

> esptool -c esp8266 -p COMx -b 115200 write_flash -fs 4MB-c1 -fm dio 0x00000 boot_v1.7.bin 0x01000 at\1024+1024\user1.2048.new.5.bin 0xfe000 blank.bin 0x3fc000 esp_init_data_default_v08.bin 0x3fe000 blank.bin

v3.0.6 4MB-c1(1024KB+1024KB) 自前ビルド

> esptool -c esp8266 -p COMx -b 115200 write_flash -fs 4MB-c1 -fm dio 0x00000 boot_v1.7.bin 0x01000 at\1024+1024\user1.4096.new.6.bin 0xfe000 blank.bin 0x3fc000 esp_init_data_default_v08.bin 0x3fe000 blank.bin

esp_init_data_default_v08.binには，WLANのSTA/APモードそれぞれのMAC AddressとSSID，RF出力設定値が入っているようだ。
本来これらの設定はボード事に設定しなくてはいけないので，前もってATコマンドを使って確認した設定値を使う必要があると思う・・・

Ai-Thinker社からリリースされているfirmwareはAiThinker_ESP8266_20160615_1.5.4をダウンロードして，任意のディレクトリに解凍する。

SDK version:1.5.4, AT version:1.1.0

とEspressif社のものより古いバージョンみたいだ。

> esptool -c esp8266 -p COMx -b 115200 write_flash -fs 4MB -fm dio 0x00000 AiThinker_ESP8266_DIO_32M_32M_20160615_V1.5.4.bin

ハードウェアパッケージのインストール

ハードウェアパッケージをインストールする方法は，Arduino IDEのボードマネージャーを使用する方法と，パッケージを直接ダウンロードして配置する方法とがある。

• Arduino IDEのボードマネージャーを使用する場合
  Arduino IDEを起動し，ファイル>環境設定>追加のボードマネージャーに，

  http://arduino.esp8266.com/stable/package_esp8266com_index.json

  を追加する。
  
  ツール>ボード>ボードマネージャーからesp8266 by ESP8266 Communityを選んで，最新バージョンをインストールする。
  
  インストールが終了したら，Arduino IDEを再起動する。
  

• パッケージをダウンロードしてインストールする場合
  https://github.com/wemos/Arduino_D1.gitが消滅？しているので，代わりに別のサイトからダウンロードする。
  

  > cd <arduino IDEインストール>\hardware
  > md esp8266com
  > cd esp8266com
  > git clone https://github.com/esp8266/Arduino.git esp8266

  
  これで，以下のようなディレクトリ構成になる。

     ─┬ Arduino
       └─┬ hardware
           └─┬ esp8266com
               └─┬ esp8266
                   ├── bootloaders
                   ├── cores
                   ├── doc
                   ├── libraries
                   ├── package
                   ├── tests
                   ├── tools
                   ├── variants
                   ├── platform.txt
                   ├── programmers.txt
                   ├── README.md
                   ├── boards.txt
                   ├── LICENSE

  バイナリツールをダウンロード（要Python2.7）
  

  > cd esp8266/tools
  > python get.py

  Arduino IDEを再起動する。
  

ボードの設定

上記のようにしてハードウェアパッケージがインストールできたら，Wemos D1（ESP8266）互換ボードを使用するのに以下のようにボードの選択・設定をした。

• ボード
  WeMos D1 R2&miniを選択した。
  
• CPU周波数
  80MHzが標準クロックだが，O.C.で160MHzでも動作する場合があるらしい。
  80MHzを選択した。
  
• Flashサイズ
  4M(FS:2MB OTA:~1019KB)を選択してみた。
  この設定の場合，プログラムなどに使えるFlash ROMのサイズは1019KBに制限され（OTA対応にしているので実際は2048KBを使う），残りの2MBはSPIFFS（SPI Flash File System）としてファイルシステムとして使用する。
  4M(FS:3MB OTA:~512KB)を選択すると，プログラム用に512KBに制限され（OTA対応にしているので実際は1024KBを使う），残りの3MBはファイルシステムとして使用する設定になる。
  
• アップロードスピード
  921600bpsを選択する。うまくいかない場合は，115200bpsにする。
  
• LWIP Variant
  Networkスタックの機能を選択する。
  TCPのMSSを設定できるようだ。Higher Bandwidh(MSS=1460, IPv6=off)を選択した。
  Lower Memoryに設定するとMSS=536, IPv6=offになる。
  no featuresにすると以下の設定（RAM使用がセーブできる）になる。
  
  • IP Forwarding/NATを使わない。
    
  • AutoIP(192.254.x.x)を使わない。
    
  • IPフラグメンテーションと再構成なし。
    
  • Selective ACKなし。
    
  • listen backlogなし。
    
• シリアルポート
  PCに認識されたCOMxポートを選択する。
  

他の設定はそのまま。

ArduinoOTA

Arduino IDEを使ってESP8266のボード用のプログラムを作成して書き込む場合，PCとボードをUSB（仮想COMポート）で接続して，bootloaderの機能を使ってプログラムの書き込みを行う。

プログラム作成時はこれで問題無いが，機器として設置した後にそのプログラムを更新しようとすると，設置しているところからボードを外してきて，PCとUSBで接続して・・・，と作業が面倒になってしまう。

こんな時，ESP8266ボードの無線LANを使ってPCと接続しプログラムを更新する事が出来れば，手間も少なくなり便利になる。

このような機能をOTA（Over The Air）と呼んでいるようで，市販の機器だと大抵はこのような機能が実装されている。

Arduino IDEでボードマネージャーを使ってESP8266ボードを使えるようにしていると，OTA用のライブラリ（ArduinoOTAなど）もインストールされている。OTAを利用するサンプルプログラムが用意される。

ArduinoOTAは以下の手順でプログラムを更新する。

• ESP8266ボードのユーザープログラムのOTA機能で，無線LANに接続する。
  
• Arduino IDEから無線LANを使ってプログラムを送信する。
  
• ボードで無線LANを使ってプログラムを受信して，Flash ROMの空きエリアにプログラムを書き込む。
  このためOTA対応にすると，プログラムサイズの2倍のFlash ROMが必要となる。
  空きエリアに書き込んだOTA対応プログラムを起動するようにReset Vectorを設定する。
• ボードをResetする。
• OTA対応プログラムが，プログラムをFlash ROMの先頭に移動する。
  
• ボードをResetする。
  
• ユーザープログラムが再度起動する。
  

このような仕組みなので，更新するプログラムは常にOTA対応コードを実装しておく必要がある。
また，更新プログラムをダウンロードして一時保存するためのFlash ROMスペースを確保しておく必要がある。これは，Arduino IDEのボードマネージャーでの設定でサイズを設定できる。

ArduinoOTAの機能設定は以下のようになっている。

• Port番号の設定
  デフォルトのPortは8266番。
  
• アップロードする時のESP8266ボードのホスト名の設定
  デフォルトは，ESP8266のチップIDになる。
  
• アップロード時のパスワード設定
  
• アップロード開始・終了・アップロード中・エラー時のコールバック関数の指定
  

OTA対応のLED点滅プログラムの例
おなじみのLED点滅プログラムをOTA対応にしてみた。

Blink.ino

- | ! - | | - | ! | | | | | | ! - | | - ! | | | !

// LED blink // OTAで更新できるようにする #include <ESP8266WiFi.h> #include <ArduinoOTA.h> const char* ssid = "xxxxxx"; // 無線LAN APのSSID const char* password = "xxxxxxxxxxx"; // 無線LAN APのPassword void setup() { WiFi.mode(WIFI_STA); // インフラストラクチャーモードに設定 WiFi.begin(ssid, password); // 無線LANのAPに接続する while (WiFi.status() != WL_CONNECTED) { // 接続出来るまで待つ delay(100); } ArduinoOTA.setHostname("ESP8266_OTA"); // set OTA hostname ArduinoOTA.setPasswordHash("yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"); // set OTA password (setPasswodHash():md5, setPassword():plane text) ArduinoOTA.begin(); // start OTA pinMode(LED_BUILTIN, OUTPUT); // LEDポート：出力 } void loop() { ArduinoOTA.handle(); // OTA処理（プログラム書き換え） // LEDを1秒毎に点滅 digitalWrite(LED_BUILTIN, LOW); delay(1000); digitalWrite(LED_BUILTIN, HIGH); delay(1000); }

Arduino IDEを再起動すると，ボードのシリアルポートの設定に無線LANでアクセスできるように設定できる。

これで，プログラムを変更してプログラムの更新をする時に，無線LANを使って更新ができるようになって便利になった。

WatchDog Timerの注意

ESP8266のボードには内蔵WDT（WatchDog Timer）がある。

これは，プログラムが暴走した時などに強制的にResetをかける機能で，ハードウェアで実装されている。*3

Arduino IDEを使う場合，frameworkの以下のタイミングでWDTのタイマーがリセットされるようだ。

• loop()の終了・再呼出時
  
• delay()の実行時
  
• yield()の実行時
  

WDTが6秒に相当するカウント値を超えてしまうとCPUを強制的にリセットするので，loop()内で時間がかかる処理や長時間の入力待ちなんかがある場合は，適当な箇所にdelay(0)やyield()を入れて，WatchDogタイマーをリセットするようにする。
ただし，delayMicroseconds()ではWDTを叩かないので，この目的には使用できない。

WDTはハードウェアで実装されているのだが，動作しないようにすることは可能。
I/Oアドレス0x60000900を0にすると，WDTの動作を停止することが出来ると思われる。

無線LANを使って接続する

WebREPLを使用すると無線LANで通信できる。
作成したプログラムをボードにアップロードしたりダウンロードしたり出来る。

上記のシリアルポートで接続して，

>>> import webrepl_setup

とする。いくつか質問されるので，Eと任意のPassを設定して，Yでリブートする。
一度ボードをResetして，さらに

>>> import network
>>> sta = network.WLAN(network.STA_IF)
>>> sta.active(True)
>>> sta.scan()
>>> sta.connect('<SSID>', '<PASS>')
>>> while not sta.isconnected() :
    time.sleep(0.1)
>>> conf = sta.ifconfig()
>>> print(conf)

これでボードのIP Addressがわかる。

PCにWebREPLコンソールをインストールする。

> git clone https://github.com/micropython/webrepl.git

webreplディレクトリにあるwebrepl.htmlをダブルクリックする。ws://<IP Address>:8266と入れて，Connectボタンを押す。
これで無線LANで接続して，操作することが出来る。

ボードがResetした後に自動的にWLAN接続できるようにboot.pyを書き込んでおく。

import network import webrepl import utime sta = network.WLAN(network.STA_IF) sta.active(True) sta.connect('<SSID>', '<PASS>') start_time = utime.time() while utime.time() - start_time < 10: if sta.isconnected(): print("connect") webrepl.start() break else: print("Timeout") sta.active(False) ap = network.WLAN(network.AP_IF) ap.active(True) webrepl.start()

WebREPLコンソールの右にあるsend a fileでboot.pyを指定してsend to deviceボタンで書き込む。
これで，最初からWLAN接続できるようになった。