[ESP32]遠隔でシステム更新する方法(OTAWebUpdater)

ESP32

遠隔でシステム更新する方法

はじめに

ESP32のシステムを更新する場合、PCとESP32をmicroUSBで接続してシリアル接続を使用するのが一般的ですが、遠隔でシステム更新するための機能も備わっています。

OTAとは

The OTA update mechanism allows a device to update itself based on data received while the normal firmware is running (for example, over Wi-Fi or Bluetooth.)

https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/ota.html#ota-process-overview

プログラミングガイドによると、「OTA アップデート メカニズムを使用すると、通常のファームウェアの実行中に (Wi-Fi や Bluetooth 経由などで) 受信したデータに基づいてデバイス自体をアップデートできます。」とあり、Wi-Fi や Bluetooth 経由でシステム更新できるようです。

本記事では、Wifi接続でのシステム更新について取り上げています。
今回は、HTMLサーバを立ててビルドしたファイルをアップロードする方法です。
Arduino IDE から更新する方法はこちら。

開発環境

OS : Windows 11 Pro
ESP32:ESP-WROOM-32
統合開発環境 : Arduino IDE 2.1.0
使用ライブラリ:なし

作業内容

スケッチ作成

「ファイル」→「スケッチ例」→「AruduioOTA」→「OTAWebUpdater」を選択して、スケッチを作成します。

「OTAWebUpdater」というフォルダを作り、「OTAWebUpdater.ino」というファイルを作成して、下記スケッチをコピーしても大丈夫です。

配置例

「C:\Users\xxxxx\OneDrive\ドキュメント\Arduino\OTAWebUpdater」

<<OTAWebUpdater.ino>>

#include <WiFi.h>
#include <WiFiClient.h>
#include <WebServer.h>
#include <ESPmDNS.h>
#include <Update.h>

const char* host = "esp32";
const char* ssid = "xxxxxxxx";
const char* password = "xxxxxxxx";

WebServer server(80);

/*
 * Login page
 */

const char* loginIndex =
 "<form name='loginForm'>"
    "<table width='20%' bgcolor='A09F9F' align='center'>"
        "<tr>"
            "<td colspan=2>"
                "<center><font size=4><b>ESP32 Login Page</b></font></center>"
                "<br>"
            "</td>"
            "<br>"
            "<br>"
        "</tr>"
        "<tr>"
             "<td>Username:</td>"
             "<td><input type='text' size=25 name='userid'><br></td>"
        "</tr>"
        "<br>"
        "<br>"
        "<tr>"
            "<td>Password:</td>"
            "<td><input type='Password' size=25 name='pwd'><br></td>"
            "<br>"
            "<br>"
        "</tr>"
        "<tr>"
            "<td><input type='submit' onclick='check(this.form)' value='Login'></td>"
        "</tr>"
    "</table>"
"</form>"
"<script>"
    "function check(form)"
    "{"
    "if(form.userid.value=='admin' && form.pwd.value=='admin')"
    "{"
    "window.open('/serverIndex')"
    "}"
    "else"
    "{"
    " alert('Error Password or Username')/*displays error message*/"
    "}"
    "}"
"</script>";

/*
 * Server Index Page
 */

const char* serverIndex =
"<script src='https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js'></script>"
"<form method='POST' action='#' enctype='multipart/form-data' id='upload_form'>"
   "<input type='file' name='update'>"
        "<input type='submit' value='Update'>"
    "</form>"
 "<div id='prg'>progress: 0%</div>"
 "<script>"
  "$('form').submit(function(e){"
  "e.preventDefault();"
  "var form = $('#upload_form')[0];"
  "var data = new FormData(form);"
  " $.ajax({"
  "url: '/update',"
  "type: 'POST',"
  "data: data,"
  "contentType: false,"
  "processData:false,"
  "xhr: function() {"
  "var xhr = new window.XMLHttpRequest();"
  "xhr.upload.addEventListener('progress', function(evt) {"
  "if (evt.lengthComputable) {"
  "var per = evt.loaded / evt.total;"
  "$('#prg').html('progress: ' + Math.round(per*100) + '%');"
  "}"
  "}, false);"
  "return xhr;"
  "},"
  "success:function(d, s) {"
  "console.log('success!')"
 "},"
 "error: function (a, b, c) {"
 "}"
 "});"
 "});"
 "</script>";

/*
 * setup function
 */
void setup(void) {
  Serial.begin(115200);

  // Connect to WiFi network
  WiFi.begin(ssid, password);
  Serial.println("");

  // Wait for connection
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("");
  Serial.print("Connected to ");
  Serial.println(ssid);
  Serial.print("IP address: ");
  Serial.println(WiFi.localIP());

  /*use mdns for host name resolution*/
  if (!MDNS.begin(host)) { //http://esp32.local
    Serial.println("Error setting up MDNS responder!");
    while (1) {
      delay(1000);
    }
  }
  Serial.println("mDNS responder started");
  /*return index page which is stored in serverIndex */
  server.on("/", HTTP_GET, []() {
    server.sendHeader("Connection", "close");
    server.send(200, "text/html", loginIndex);
  });
  server.on("/serverIndex", HTTP_GET, []() {
    server.sendHeader("Connection", "close");
    server.send(200, "text/html", serverIndex);
  });
  /*handling uploading firmware file */
  server.on("/update", HTTP_POST, []() {
    server.sendHeader("Connection", "close");
    server.send(200, "text/plain", (Update.hasError()) ? "FAIL" : "OK");
    ESP.restart();
  }, []() {
    HTTPUpload& upload = server.upload();
    if (upload.status == UPLOAD_FILE_START) {
      Serial.printf("Update: %s\n", upload.filename.c_str());
      if (!Update.begin(UPDATE_SIZE_UNKNOWN)) { //start with max available size
        Update.printError(Serial);
      }
    } else if (upload.status == UPLOAD_FILE_WRITE) {
      /* flashing firmware to ESP*/
      if (Update.write(upload.buf, upload.currentSize) != upload.currentSize) {
        Update.printError(Serial);
      }
    } else if (upload.status == UPLOAD_FILE_END) {
      if (Update.end(true)) { //true to set the size to the current progress
        Serial.printf("Update Success: %u\nRebooting...\n", upload.totalSize);
      } else {
        Update.printError(Serial);
      }
    }
  });
  server.begin();
}

void loop(void) {
  server.handleClient();
  delay(1);
}

8行目と9行目の[ssid]と[password]の内容はご自身の環境に変更してください。

const char* ssid = "xxxxxxxx";
const char* password = "xxxxxxxx";

動作確認

起動してWifi接続に成功すると、取得したIPアドレスと「mDNS responder started」と表示されます。

本スケッチでは、ホスト名をつけているため、WEBブラウザで「http://esp32.local」にアクセスしてみます。もし上手くいかない場合は、「http://IPアドレス」でアクセスしてください。

下図のようにアクセスできれば、UsernameとPasswordの欄にどちらも「admin」を入力して、Loginボタンを押下します。

すると、アップロード画面へ遷移します。

次は実際にアップロードが成功するか確認してみます。

先ほどのスケッチの129行目に以下のコードを追加します。

Serial.println("OTAWebUpdater 成功!!");

次に「スケッチ」→「コンパイル済みバイナリをエクスポート」を選択してアップロードするバイナリファイルを作成します。

「スケッチ」→「スケッチフォルダを表示」を選択して、フォルダを表示すると「build」というフォルダが作成されていると思います。

中に入っていくと、このようにバイナリファイルが作成されています。

実際にアップロードするファイルは、赤枠で囲んだ「OTAWebUpdater.ino.bin」というファイルです。

先ほどのWEBブラウザから「ファイル選択」で上記のバイナリファイルを選択し、「Update」ボタンを押下すると、アップデートが開始され完了すると自動的に再起動されます。

シリアルモニタに先ほど追加したコードが反映されていれば成功です。

おわりに

開発環境があるネットワーク上にESP32が動作している場合は、前回記事の「BasicOTA」で遠隔アップデートできますが、開発環境とは違うネットワーク上にあるESP32をアップデートする場合は、この方法が活用できると思います。

また、複数の同じシステムで動作するESP32を作成する時も、便利かもしれませんね。

ただし、「BasicOTA」と同じでプログラムミスによって起動後すぐにリセットがかかるような場合はこれでは対応できませんので注意です。

コメント

タイトルとURLをコピーしました