ESP32でWebサーバーを利用したOTA(Over the Air)アップデートをテストする
ちょっと忙しくなってしまい更新が途絶えてしまいましたが、、
ESP32のスケッチをオンラインでアップデートしたいという要件が出てきましたのでちょっと検討。
今回のターゲットはESP32はArduino core for the ESP32で動かしているので、ESP-IDFではなくArduinoで用意します。
普通のOTAはESP32がwifiのAPとなってOTAの流し込みを受け付ける様ですが、お手軽ではありますがこの方法だと少々セキュリティに難があり。
認証もアイパスだけではちょっと・・・
という訳で、どこかにプログラムの配布サーバーを作り、コンパイル済のバイナリをESP32にダウンロードさせて書き込もうという感じです。
とりあえず方針を決める
- ESP32側にプログラムを直接送り込むのはセキュリティ的にNGなので管理しているサーバーからダウンロードさせて書き込む様にする
- ESP32はwifi経由でインターネットに接続
- どこかにWebサーバーを作り、コンパイル済バイナリをダウンロードできる様にしておく
ダウンロードさせるサーバーアドレスはFQDNでいいのかとか、OTAに必要なパーティションタイプとか色々クリアしなければいけない課題もありそうですが、、、
ひとまずEspressifのgitを検索してみると、まんま使えそうなexamplesを発見。
GitHub:espressif / arduino-esp32 : OTA Firmware Upgrade for Arduino
どうやら「HttpsOTAUpdate」というライブラリで比較的簡単にできそうですね。
わりと新しめなのか、SSL対応という優れもの。
ひとまずサンプルをもとにやってみる事に。
パーティションテーブルの変更
OTAを使うにはプログラム領域が二つ無くてはいけません。
また、プログラムもOTA処理分だけ余計に乗せなくてはいけませんので、デフォルトでは少々容量が足りなくなる恐れがあります。
このためパーティションテーブルを変更して、ちょっとプログラム領域のサイズを増やしておきます。
VSCode/PlatformIOを使って作業を行いますので、「platformio.ini」に以下の設定を追加。
「min_spiffs.csv」は、以下の様な構成になっている様でした。
Name | Type | SubType | Offset | Size |
---|---|---|---|---|
nvs | data | nvs | 0x9000 | 0x5000 |
otadata | data | ota | 0xe000 | 0x2000 |
app0 | app | ota_0 | 0x10000 | 0x1E0000 |
app1 | app | ota_1 | 0x1F0000 | 0x1E0000 |
spiffs | data | spiffs | 0x3D0000 | 0x30000 |
GitHub:espressif/arduino-esp32/tools/partitions/min_spiffs.csv
デフォルトは二つあるアプリケーション領域のサイズがそれぞれ1.5MB程度でしたが、spiffs領域を小さくしたこのプロファイルは1.9MBほどのアプリケーション領域が確保できる様です。
この様に、必要があればアプリケーションのサイズや用途に合わせて調整して下さい。
さて、では次にテストスケッチを用意します。
先にESP32に書き込んでおくスケッチ
テストですしサンプルをガッツリ使わせていただきます。
このサンプルはマイコンが起動すると勝手にAPに接続しにいって、接続できたら目的のファイルをダウンロードし、そのままマイコンに書き込む動作をする様ですね。
URLは設置する予定のURLを。
今回使うSSL証明書はLet’sEncryptのものですので、CA認証局の証明書の箇所にはLet’sEncryptのCA証明書を記載します。
まぁこれでいいでしょう。
ssidとpasswordの箇所は、ご自宅のwifiのAPに接続できる様に設定して下さい。
ササっとこれをESP32に流し込みまして・・・
ダウンロードして反映させるスケッチ
今度は用意するWebサーバーに設置しておく新しいプログラムを作成します。
処理内容は、前述のスケッチが動作し、ダウンロードして正しく反映されたらシリアルモニタにSuccessed.って出させる事に。
wifiとかも起動しなくても良いのですが、面倒ですのでこれでいいでしょう。
これをコンパイルだけして、ESP32には転送しません。
VSCode/PlatformIOで作ったバイナリは、プロジェクトのルート以下の.pioフォルダの下の方に作成されます。
.pio\build\nodemcu-32s-ota\firmware.bin
この「firmware.bin」を「esp32_ota_update_test.bin」にリネームして取っておきます。
Webサーバーを立ててバイナリイメージを置いておく
わざわざ新しくWebサーバーを立てるのも面倒ですので、このブログのサーバーに置いてしまいます。
WordPressを動かしていますがまぁいいでしょう。
ダウンロードできる様にしておけばいいだけですので・・・
SSL証明書も乗ってますのでファイルアップロードするだけで手間も省けて都合が良いかも。
さてダウンロードさせるスケッチですので、前述の「ダウンロードして反映させるスケッチ」をコンパイルして出来たバイナリをサーバーに設置しておきます。
WordPressで.binファイルとかアップロードできませんので、直接アップロードしてしまうま。
念のため、ブラウザでアクセスしてダウンロードできる状態かどうかを確認してください。
検証
どうやら正しくファームウェアが書き込まれた様です。

「Firmware written successfully. To reboot device, call API ESP.restart() or PUSH restart button on device」の文字がシリアルモニタに出力されました。
ではご指示の通り、ESP32をリセットして再起動してみます。

シリアルモニタに「Firmware Upgrade Successed.」の出力があるので、書き換え後のファームになっている事が確認できます。
わりと簡単ではありますが、ちょっと周辺ライブラリのサイズが大きいですね。
これだけの内容で600kbちょっとの容量がありますので、OTAを使う場合にはパーティションサイズの調整は必須かもしれません。
ひとまずはこんな感じで。
あとはこのサンプルをちょこっと書き足してアイツに追加してやるんですが、、、
完全リモートで操作する事を想定していますので、ファームアップデート後の自動リセットなんかも書いておいた方が良さそうですね。
恒久的にアップデートをさせる予定なら、SSLのCA証明書の更新も盛り込んでやらないと何年かしたら使えなくなってしまうま。
こういう周辺のケアは案外めんどくさいですぬぇ
以上、サンプルを使った簡単なテストでした。
ディスカッション
コメント一覧
工兵. PV2さま
貴重な情報をありがとうございます!
ここ数日私も自動アップデートを実装しようと奮闘しているのですが、なぜかSSL認証がうまく通りません。何かSSL証明書を取得するときに注意すること等ございますでしょうか?
私のSSL取得方法は、目的のファイルが表示されているページで F12 を押して Securityタブの中にある View certificate ボタンから取得しています。
↓↓シリアルモニタの内容です↓↓
Starting OTA
Please Wait it takes some time …
E (1342) esp-tls: mbedtls_ssl_handshake returned -0x2700
E (1344) esp-tls: Failed to open new connection
E (1344) TRANS_SSL: Failed to open a new connection
E (1345) HTTP_CLIENT: Connection failed, sock < 0
E (1349) esp_https_ota: Failed to open HTTP connection: ESP_ERR_HTTP_CONNECT
E (1356) esp_https_ota: Failed to establish HTTP connection
Http Event Disconnected
Http Event Disconnected
Firmware Upgrade Fail
コメントありがとうございます。
ここのところちょっと時間が取れず確認できないのですが、TLS1.2の問題かもしれませんね
ESP32のライブラリを最新のものにすると出来たりするかもしか。
コメントいただきありがとうございました。
ライブラリは残念ながら最新でした。
ただ、掲載いただいているサンプルスケッチが載っているGithubをよく見るとArduino-Esp32のOTAの説明の中に認証を無効にするパラメータが載っていました。
https://github.com/espressif/arduino-esp32/tree/master/libraries/Update/examples/HTTPS_OTA_Update
このコマンドにサンプルスケッチでは使われていない3つ目のパラメータが有ったようで、ここをfalseにすることで自動ファームウエア更新が動きだしました。まずはこれで運用をはじめてみます。
HttpsOTA.begin(const char * url, const char * server_certificate, bool skip_cert_common_name_check)