メインコンテンツまでスキップ

ファイルシステムと XIAO ESP32S3 Sense

このチュートリアルでは、XIAO ESP32S3 のファイルシステムの使用方法、特に Sense バージョン向けの microSD カードスロットの使い方に焦点を当てます。同時に、公式 ESP ファイルシステムである SPIFFS や、チップ内蔵の Flash などについても紹介します。

ヒント

このチュートリアルの microSD カードに関する部分は XIAO ESP32S3 Sense にのみ適用されます。それ以外の内容は ESP32-S3 チップに適用されるため、microSD カードを除き、XIAO ESP32S3 上でサンプルを実行できます。

Seeed Studio XIAO ESP32S3Seeed Studio XIAO ESP32S3 Sense
今すぐ入手 🖱️
今すぐ入手 🖱️

入門ガイド​

このチュートリアルでは microSD カードを使用するため、事前に Sense 拡張ボードを取り付け、microSD カードを準備しておく必要があります。

拡張ボードの取り付け（Sense 用）​

拡張ボードの取り付けはとても簡単です。拡張ボード上のコネクタを XIAO ESP32S3 上の B2B コネクタに合わせて、カチッと音がするまでしっかり押し込めば、取り付け完了です。

microSD カードの準備​

XIAO ESP32S3 Sense は最大 32GB までの microSD カードをサポートしています。そのため、XIAO 用に microSD カードを購入する場合は、この仕様を参考にしてください。また、microSD カードを使用する前に、microSD カードを FAT32 形式でフォーマットしてください。

フォーマット後、microSD カードを microSD カードスロットに挿入できます。挿入方向に注意し、金色の端子（ゴールドフィンガー）が内側を向くようにしてください。

ヒント

microSD カードがコンピュータでは認識されるのに ESP32S3 では認識されず、エラーが次のような表示になる場合：

[  7273][E][sd_diskio.cpp:200] sdCommand(): Card Failed! cmd: 0x00
[  7274][E][sd_diskio.cpp:759] sdcard_mount(): f_mount failed: (3) The physical drive cannot work
[  7588][E][sd_diskio.cpp:200] sdCommand(): Card Failed! cmd: 0x00
Card Mount Failed

次の手順を実行してください：

  • Windows Formatter を使用する

注意：

  • この処理にはクイックフォーマットよりもかなり長い時間がかかります。

  • これらのケースは、以前に別の用途で使用されていた microSD カードを再利用する場合に発生します（例：Linux OS が入っていた microSD カードを再利用する場合など）。

拡張ボードのカードスロット回路設計​

XIAO ESP32S3 Sense のカードスロットは ESP32-S3 の 4 本の GPIO を使用しており、その使用ピンの詳細は以下の表のとおりです。

ESP32-S3 GPIOmicroSD カードスロット
GPIO3CS
D8 / A8 / Qt7 / GPIO7SCK
D9 / A9 / Qt8 / GPIO8MISO
D10 / A10 / Qt9 / GPIO9MOSI

これはまた、拡張ボードの microSD カード機能を使用する場合、XIAO ESP32S3 の SPI 機能を同時に使用できないことも意味します。J3 のパッドを接続／カットすることで、microSD カード機能をオン／オフできます。

拡張ボードの SPI ピンを使用したい場合 / SD カードを無効にしたい場合拡張ボード上の SD カードを有効にしたい場合 / SPI ピンを無効にしたい場合
白い細い線に沿ってカットし、はんだパッドの接続を切ります。2 つのはんだパッドをはんだ付けして接続します。
ヒント

デフォルトでは、拡張ボードを取り付けると microSD カード機能が有効になります。

microSD カード内のファイルを編集する​

注意

このセクションは XIAO ESP32S3 Sense のみに適用されます。

Arduino IDE には、XIAO ESP32S3 を使用して microSD カード上のファイルを扱う方法を示すサンプルがいくつか用意されています。Arduino IDE で File > Examples > SD > SD_Test に移動するか、以下のコードをコピーしてください。

#include "FS.h"
#include "SD.h"
#include "SPI.h"

void listDir(fs::FS &fs, const char * dirname, uint8_t levels){
    Serial.printf("Listing directory: %s\n", dirname);

    File root = fs.open(dirname);
    if(!root){
        Serial.println("Failed to open directory");
        return;
    }
    if(!root.isDirectory()){
        Serial.println("Not a directory");
        return;
    }

    File file = root.openNextFile();
    while(file){
        if(file.isDirectory()){
            Serial.print("  DIR : ");
            Serial.println(file.name());
            if(levels){
                listDir(fs, file.path(), levels -1);
            }
        } else {
            Serial.print("  FILE: ");
            Serial.print(file.name());
            Serial.print("  SIZE: ");
            Serial.println(file.size());
        }
        file = root.openNextFile();
    }
}

void createDir(fs::FS &fs, const char * path){
    Serial.printf("Creating Dir: %s\n", path);
    if(fs.mkdir(path)){
        Serial.println("Dir created");
    } else {
        Serial.println("mkdir failed");
    }
}

void removeDir(fs::FS &fs, const char * path){
    Serial.printf("Removing Dir: %s\n", path);
    if(fs.rmdir(path)){
        Serial.println("Dir removed");
    } else {
        Serial.println("rmdir failed");
    }
}

void readFile(fs::FS &fs, const char * path){
    Serial.printf("Reading file: %s\n", path);

    File file = fs.open(path);
    if(!file){
        Serial.println("Failed to open file for reading");
        return;
    }

    Serial.print("Read from file: ");
    while(file.available()){
        Serial.write(file.read());
    }
    file.close();
}

void writeFile(fs::FS &fs, const char * path, const char * message){
    Serial.printf("Writing file: %s\n", path);

    File file = fs.open(path, FILE_WRITE);
    if(!file){
        Serial.println("Failed to open file for writing");
        return;
    }
    if(file.print(message)){
        Serial.println("File written");
    } else {
        Serial.println("Write failed");
    }
    file.close();
}

void appendFile(fs::FS &fs, const char * path, const char * message){
    Serial.printf("Appending to file: %s\n", path);

    File file = fs.open(path, FILE_APPEND);
    if(!file){
        Serial.println("Failed to open file for appending");
        return;
    }
    if(file.print(message)){
        Serial.println("Message appended");
    } else {
        Serial.println("Append failed");
    }
    file.close();
}

void renameFile(fs::FS &fs, const char * path1, const char * path2){
    Serial.printf("Renaming file %s to %s\n", path1, path2);
    if (fs.rename(path1, path2)) {
        Serial.println("File renamed");
    } else {
        Serial.println("Rename failed");
    }
}

void deleteFile(fs::FS &fs, const char * path){
    Serial.printf("Deleting file: %s\n", path);
    if(fs.remove(path)){
        Serial.println("File deleted");
    } else {
        Serial.println("Delete failed");
    }
}

void testFileIO(fs::FS &fs, const char * path){
    File file = fs.open(path);
    static uint8_t buf[512];
    size_t len = 0;
    uint32_t start = millis();
    uint32_t end = start;
    if(file){
        len = file.size();
        size_t flen = len;
        start = millis();
        while(len){
            size_t toRead = len;
            if(toRead > 512){
                toRead = 512;
            }
            file.read(buf, toRead);
            len -= toRead;
        }
        end = millis() - start;
        Serial.printf("%u bytes read for %u ms\n", flen, end);
        file.close();
    } else {
        Serial.println("Failed to open file for reading");
    }


    file = fs.open(path, FILE_WRITE);
    if(!file){
        Serial.println("Failed to open file for writing");
        return;
    }

    size_t i;
    start = millis();
    for(i=0; i<2048; i++){
        file.write(buf, 512);
    }
    end = millis() - start;
    Serial.printf("%u bytes written for %u ms\n", 2048 * 512, end);
    file.close();
}

void setup(){
    Serial.begin(115200);
    while(!Serial);
    if(!SD.begin(21)){
        Serial.println("Card Mount Failed");
        return;
    }
    uint8_t cardType = SD.cardType();

    if(cardType == CARD_NONE){
        Serial.println("No SD card attached");
        return;
    }

    Serial.print("SD Card Type: ");
    if(cardType == CARD_MMC){
        Serial.println("MMC");
    } else if(cardType == CARD_SD){
        Serial.println("SDSC");
    } else if(cardType == CARD_SDHC){
        Serial.println("SDHC");
    } else {
        Serial.println("UNKNOWN");
    }

    uint64_t cardSize = SD.cardSize() / (1024 * 1024);
    Serial.printf("SD Card Size: %lluMB\n", cardSize);

    listDir(SD, "/", 0);
    createDir(SD, "/mydir");
    listDir(SD, "/", 0);
    removeDir(SD, "/mydir");
    listDir(SD, "/", 2);
    writeFile(SD, "/hello.txt", "Hello ");
    appendFile(SD, "/hello.txt", "World!\n");
    readFile(SD, "/hello.txt");
    deleteFile(SD, "/foo.txt");
    renameFile(SD, "/hello.txt", "/foo.txt");
    readFile(SD, "/foo.txt");
    testFileIO(SD, "/test.txt");
    Serial.printf("Total space: %lluMB\n", SD.totalBytes() / (1024 * 1024));
    Serial.printf("Used space: %lluMB\n", SD.usedBytes() / (1024 * 1024));
}

void loop(){

}
注意

サンプルプログラムはそのままでは使用できないため、動作を保証するにはプログラムを少し修正する必要があります。修正内容は、Setup() 関数内の元のコードを SD.begin() から SD.begin(21) に変更することです。初期化のためのピン番号を指定します。

プログラムを XIAO ESP32S3 Sense に書き込み、シリアルモニタを開くと、ファイルの作成プロセスと書き込みプロセスが表示されます。また、microSD を USB に変換して、コンピュータから新しく作成されたファイルと内容にアクセスすることもできます。

プログラムの注釈​

まず、次のライブラリをインクルードする必要があります。ファイルを扱うための FS.h、microSD カードとインターフェースするための SD.h、そして SPI 通信プロトコルを使用するための SPI.h です。

  1. setup() 内では、次の行で SD.begin(21) を使って microSD カードを初期化します。ここでは SD.begin() に CS ピンであるパラメータを渡す必要があります。拡張ボードの microSD カード設計では、CS ピンは GPIO 21 に接続されています。Round Display for XIAO を使用している場合は、渡すパラメータは D2 にする必要があります。

  2. 次の行では、シリアルモニタに microSD カードの種類を出力します。

uint8_t cardType = SD.cardType();

if(cardType == CARD_NONE){
    Serial.println("No SD card attached");
    return;
}

Serial.print("SD Card Type: ");
if(cardType == CARD_MMC){
    Serial.println("MMC");
} else if(cardType == CARD_SD){
    Serial.println("SDSC");
} else if(cardType == CARD_SDHC){
    Serial.println("SDHC");
} else {
    Serial.println("UNKNOWN");
}
  1. cardSize() メソッドを呼び出すことで、microSD カードの容量を取得できます。
uint64_t cardSize = SD.cardSize() / (1024 * 1024);
Serial.printf("SD Card Size: %lluMB\n", cardSize);

このサンプルでは、microSD カード上のファイルを扱うための複数の関数を提供しています。

  1. listDir() 関数は SD カード上のディレクトリを一覧表示します。この関数は引数として、ファイルシステム（SD）、メインディレクトリ名、およびディレクトリ内をどの階層までたどるかを受け取ります。

    この関数を呼び出す例を次に示します。/ は microSD カードのルートディレクトリに対応します。

listDir(SD, "/", 0);
  1. createDir() 関数は新しいディレクトリを作成します。引数として SD ファイルシステムとディレクトリ名のパスを渡します。例えば、次のコマンドはルートに mydir という新しいディレクトリを作成します。
createDir(SD, "/mydir");
  1. microSD カードからディレクトリを削除するには、removeDir() 関数を使用し、引数として SD ファイルシステムとディレクトリ名のパスを渡します。
removeDir(SD, "/mydir");
  1. readFile() 関数はファイルの内容を読み取り、その内容をシリアルモニタに出力します。前述の関数と同様に、引数として SD ファイルシステムとファイルパスを渡します。例えば、次の行は hello.txt ファイルの内容を読み取ります。
readFile(SD, "/hello.txt")
  1. ファイルに内容を書き込むには、writeFile() 関数を使用できます。引数として、SD ファイルシステム、ファイルパス、メッセージを渡します。次の行は hello.txt ファイルに Hello と書き込みます。
writeFile(SD, "/hello.txt", "Hello ");
  1. 同様に、appendFile() 関数を使用して、既存の内容を上書きせずにファイルに内容を追記できます。次の行は hello.txt ファイルにメッセージ World!\n を追記します。\n は、次にファイルに何かを書き込むときに、新しい行に書き込まれることを意味します。
appendFile(SD, "/hello.txt", "World!\n");
  1. renameFile() 関数を使用してファイル名を変更できます。引数として、SD ファイルシステム、元のファイル名、新しいファイル名を渡します。次の行は hello.txt ファイルの名前を foo.txt に変更します。
renameFile(SD, "/hello.txt", "/foo.txt");
  1. deleteFile() 関数を使用してファイルを削除します。引数として、SD ファイルシステムと削除したいファイルのファイルパスを渡します。次の行は microSD カードから foo.txt ファイルを削除します。
deleteFile(SD, "/foo.txt");
  1. testFileIO() 関数は、ファイルの内容を読み取るのにどれくらい時間がかかるかを示します。次の関数は test.txt ファイルをテストします。
testFileIO(SD, "/test.txt");

ガスデータロギングに基づく MicroSD カードアプリケーション​

注意

このセクションは XIAO ESP32S3 Sense のみに適用されます。

このプロジェクトでは、XIAO ESP32S3 Sense を使用して、タイムスタンプ付きデータを TF カードに記録する方法を示します。例として、Multichannel Gas Sensor からの温度測定値を 10 分ごとに記録します。XIAO ESP32S3 は各測定の間はディープスリープモードになり、ネットワークタイムプロトコル（NTP）を使用して日付と時刻を取得します。

このプロジェクトを完成させるには、事前に以下のハードウェアを用意する必要があります。

Seeed Studio XIAO ESP32S3 SenseSeeed Studio Expansion Base for XIAO with Grove OLEDGrove - Multichannel Gas Sensor v2
今すぐ入手 🖱️
今すぐ入手 🖱️
今すぐ入手 🖱️

ソフトウェアとしては、事前に Arduino IDE 用に以下のライブラリをインストールする必要があります。

  • Taranais によってフォークされた NTPClient ライブラリ
ライブラリをダウンロード

  • Multichannel Gas Sensor ライブラリ
ライブラリをダウンロード

以下が完成したサンプルプログラムです。プログラムではネットワークを利用した時刻合わせを行う必要があるため、プログラム内の WiFi 名とパスワードをあなたのものに変更してください。

#include "FS.h"
#include "SD.h"
#include <SPI.h>

//multichannel gas libraries
#include <Multichannel_Gas_GMXXX.h>
#include <Wire.h>

// Libraries to get time from NTP Server
#include <NTPClient.h>
#include <WiFiUdp.h>

#include "WiFi.h"

// Define deep sleep options
uint64_t uS_TO_S_FACTOR = 1000000;  // Conversion factor for micro seconds to seconds
// Sleep for 10 minutes = 600 seconds
uint64_t TIME_TO_SLEEP = 600;

// Replace with your network credentials
const char* ssid     = "REPLACE_WITH_YOUR_SSID";
const char* password = "REPLACE_WITH_YOUR_PASSWORD";

// Define CS pin for the SD card module
#define SD_CS 21

// Save reading number on RTC memory
RTC_DATA_ATTR int readingID = 0;

String dataMessage;

// Gas Sensor variables
int NO2_val, C2H5CH_val, VOC_val, CO_val;
GAS_GMXXX<TwoWire> gas;

// Define NTP Client to get time
WiFiUDP ntpUDP;
NTPClient timeClient(ntpUDP);

// Variables to save date and time
String formattedDate;
String dayStamp;
String timeStamp;

void setup() {
  // Start serial communication for debugging purposes
  Serial.begin(115200);

  // Connect to Wi-Fi network with SSID and password
  Serial.print("Connecting to ");
  Serial.println(ssid);
  WiFi.begin(ssid, password);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("");
  Serial.println("WiFi connected.");

  // Initialize a NTPClient to get time
  timeClient.begin();
  // Set offset time in seconds to adjust for your timezone, for example:
  // GMT +1 = 3600
  // GMT +8 = 28800
  // GMT -1 = -3600
  // GMT 0 = 0
  timeClient.setTimeOffset(3600);

  // Initialize SD card
  SD.begin(SD_CS);
  if(!SD.begin(SD_CS)) {
    Serial.println("Card Mount Failed");
    return;
  }
  uint8_t cardType = SD.cardType();
  if(cardType == CARD_NONE) {
    Serial.println("No SD card attached");
    return;
  }
  Serial.println("Initializing SD card...");
  if (!SD.begin(SD_CS)) {
    Serial.println("ERROR - SD card initialization failed!");
    return;    // init failed
  }

  // If the data.txt file doesn't exist
  // Create a file on the SD card and write the data labels
  File file = SD.open("/data.txt");
  if(!file) {
    Serial.println("File doens't exist");
    Serial.println("Creating file...");
    writeFile(SD, "/data.txt", "Reading ID, Date, Hour, NO2, C2H5CH, VOC, CO \r\n");
  }
  else {
    Serial.println("File already exists");
  }
  file.close();

  // Start the gas sensor
  gas.begin(Wire, 0x08); // use the hardware I2C

  getReadings();
  getTimeStamp();
  logSDCard();

  // Increment readingID on every new reading
  readingID++;

  // Start deep sleep
  Serial.println("DONE! Going to sleep now.");

  // Enable Timer wake_up
  esp_sleep_enable_timer_wakeup(TIME_TO_SLEEP * uS_TO_S_FACTOR);
  esp_deep_sleep_start();
}

void loop() {
  // The ESP32 will be in deep sleep
  // it never reaches the loop()
}

// Function to get temperature
void getReadings(){
  // GM102B NO2 sensor ppm
  NO2_val = gas.getGM102B();
  // GM302B C2H5CH sensor ppm
  C2H5CH_val = gas.getGM302B();
  // GM502B VOC sensor
  VOC_val = gas.getGM502B();
  // GM702B CO sensor
  CO_val = gas.getGM702B();

  Serial.print("NO2 Value is: ");
  Serial.println(NO2_val);

  Serial.print("C2H5CH Value is: ");
  Serial.println(C2H5CH_val);

  Serial.print("VOC Value is: ");
  Serial.println(VOC_val);

  Serial.print("CO Value is: ");
  Serial.println(CO_val);
}

// Function to get date and time from NTPClient
void getTimeStamp() {
  while(!timeClient.update()) {
    timeClient.forceUpdate();
  }
  // The formattedDate comes with the following format:
  // 2018-05-28T16:00:13Z
  // We need to extract date and time
  formattedDate = timeClient.getFormattedDate();
  Serial.println(formattedDate);

  // Extract date
  int splitT = formattedDate.indexOf("T");
  dayStamp = formattedDate.substring(0, splitT);
  Serial.println(dayStamp);
  // Extract time
  timeStamp = formattedDate.substring(splitT+1, formattedDate.length()-1);
  Serial.println(timeStamp);
}

// Write the sensor readings on the SD card
void logSDCard() {
  dataMessage = String(readingID) + "," + String(dayStamp) + "," + String(timeStamp) + "," +
                String(NO2_val) + "," + String(C2H5CH_val) + "," + String(VOC_val) + "," +
                String(CO_val) + "\r\n";
  Serial.print("Save data: ");
  Serial.println(dataMessage);
  appendFile(SD, "/data.txt", dataMessage.c_str());
}

// Write to the SD card (DON'T MODIFY THIS FUNCTION)
void writeFile(fs::FS &fs, const char * path, const char * message) {
  Serial.printf("Writing file: %s\n", path);

  File file = fs.open(path, FILE_WRITE);
  if(!file) {
    Serial.println("Failed to open file for writing");
    return;
  }
  if(file.print(message)) {
    Serial.println("File written");
  } else {
    Serial.println("Write failed");
  }
  file.close();
}

// Append data to the SD card (DON'T MODIFY THIS FUNCTION)
void appendFile(fs::FS &fs, const char * path, const char * message) {
  Serial.printf("Appending to file: %s\n", path);

  File file = fs.open(path, FILE_APPEND);
  if(!file) {
    Serial.println("Failed to open file for appending");
    return;
  }
  if(file.print(message)) {
    Serial.println("Message appended");
  } else {
    Serial.println("Append failed");
  }
  file.close();
}

プログラムをコンパイルして書き込み、シリアルポートモニタを開きます。プログラムが正常に動作していれば、シリアルモニタから次のようなメッセージが出力されます。

必要なときにいつでも microSD カードを取り外し、カードリーダーを介して保存されたセンサーデータにアクセスできます。

注記

テストを容易にするため、ここでは 1 分ごとにデータを保存する効果を示していますが、実際に提供しているサンプルコードでは 10 分ごとに 1 回データを保存します。

注意

このプロジェクトについては、次の点に注意してください。

  1. Multichannel Gas Sensor は、取得した値が正確になるまでウォームアップの時間が必要です。そのため、最初に記録された数セットのデータは、誤差が大きい場合は破棄してよいと考えられます。
  2. このサンプルではディープスリープ機能を使用しているため、シリアルモニタは保存情報を 1 回だけ出力します。これは、ウェイクアップ後にリセットされたのと同等であり、次のデバッグ情報を見るには Arduino のシリアルポートを再度開く必要があるということです。ただし、カードに問題がなければ、センサーデータは設定した時刻どおりに収集されるので安心してください。

プログラムの注釈​

この例では、XIAO ESP32S3 は各読み取りの間にディープスリープモードになります。ディープスリープモードでは、すべてのコードを setup() 関数内に記述する必要があります。これは、XIAO ESP32S3 が loop() に到達することはないためです。

この例では、マイクロ秒から秒への変換係数を使用しているため、TIME_TO_SLEEP 変数でスリープ時間を秒単位で設定できます。この場合、XIAO ESP32S3 を 10 分（600 秒）スリープするように設定しています。XIAO ESP32S3 を別の時間だけスリープさせたい場合は、ディープスリープさせたい秒数を TIME_TO_SLEEP 変数に入力するだけです。

// Define deep sleep options
uint64_t uS_TO_S_FACTOR = 1000000; // Conversion factor for micro seconds to seconds
// Sleep for 10 minutes = 600 seconds
uint64_t TIME_TO_SLEEP = 600;

次に、microSD カードの CS ピンを定義します。この例では GPIO 21 に設定されています。

#define SD_CS 21

読み取り ID を保持するために readingID という変数を作成します。これは、読み取り値を整理するための方法です。ディープスリープ中に変数の値を保存するには、RTC メモリに保存できます。RTC メモリにデータを保存するには、変数定義の前に RTC_DATA_ATTR を追加するだけです。

microSD カードに保存するデータを保持するための String 変数を作成します。

次の 2 行は、NTP サーバーから日付と時刻を要求する NTPClient を定義します。

WiFiUDP ntpUDP;
NTPClient timeClient(ntpUDP);

次に、Setup() 関数内で NTP クライアントを初期化し、NTP サーバーから日付と時刻を取得します。タイムゾーンに合わせて時刻を調整するには、setTimeOffset(<time>) メソッドを使用できます。

すべての初期化が完了したら、測定値とタイムスタンプを取得し、それらをすべて microSD カードに記録できます。

コードをより理解しやすくするために、次の関数を作成しました。

  • getReadings(): Multichannel Gas Sensor からガス値を読み取ります。
  • getTimeStamp(): NTP サーバーから日付と時刻を取得します。
  • logSDcard(): 上記のデータを microSD カードに記録します。

最後に、ESP32 がディープスリープを開始します。

esp_sleep_enable_timer_wakeup(TIME_TO_SLEEP * uS_TO_S_FACTOR);
esp_deep_sleep_start();

これら 2 つの関数を組み合わせて使用することをお勧めします。ウェイクアップ時間を設定したら、XIAO ができるだけ早くディープスリープモードに入れるようにしてください。

シリアルペリフェラルインターフェースフラッシュファイルシステム（SPIFFS）​

注意

このセクションは XIAO ESP32C3、XIAO ESP32S3、または XIAO ESP32S3 Sense に適用されますが、このセクションは Arduino IDE 2.X をサポートしていません。

ESP32 には Serial Peripheral Interface Flash File System（SPIFFS）が含まれています。SPIFFS は、ESP32 のフラッシュメモリのように SPI バスで接続されたフラッシュチップを持つマイクロコントローラ向けに作成された軽量ファイルシステムです。この記事では、Arduino IDE 用プラグインを使用して、ESP32 のファイルシステムにファイルを簡単にアップロードする方法を紹介します。

SPIFFS を使用すると、コンピュータの通常のファイルシステムと同様にフラッシュメモリへアクセスできますが、より単純で制限があります。ファイルの読み取り、書き込み、クローズ、削除が可能です。この記事執筆時点では、SPIFFS はディレクトリをサポートしていないため、すべてがフラットな構造で保存されます。

XIAO ESP32 で SPIFFS を使用すると、特に次のような用途に便利です。

  • 設定を含む構成ファイルの作成
  • データを永続的に保存
  • microSD カードを使用する代わりに、少量のデータを保存するファイルを作成
  • Web サーバーを構築するための HTML および CSS ファイルの保存
  • 画像、図、アイコンの保存

Arduino ESP32 Filesystem Uploader のインストール​

Arduino IDE 上で自分でコードを書けば、ESP32 のファイルシステムにファイルを作成・保存・書き込みできます。しかしこの方法はあまり実用的ではありません。というのも、ファイルの内容を Arduino スケッチ内にすべて入力しなければならないからです。

幸いなことに、Arduino IDE 用のプラグインがあり、コンピュータ上のフォルダから ESP32 のファイルシステムにファイルを直接アップロードできます。これにより、ファイルを扱う作業が非常に簡単になります。では、インストールしてみましょう。

注記

注：この記事執筆時点では、ESP32 Filesystem Uploader プラグインは Arduino 2.0 ではサポートされていません。

Windows​

ステップ 1. releases ページ にアクセスし、ESP32FS-1.1.zip ファイルをクリックしてダウンロードします。

ステップ 2. Sketchbook の場所を確認します。Arduino IDE で File > Preferences に進み、Sketchbook の場所を確認します。私の場合は次のパスです：C:\Users\mengd\Documents\Arduino。

ステップ 3. Sketchbook の場所に移動し、tools フォルダを作成します。

ステップ 4. ダウンロードした .zip フォルダを解凍します。開いて、ESP32FS フォルダを前のステップで作成した tools フォルダにコピーします。次のようなフォルダ構成になっているはずです。

<Sketchbook-location>/tools/ESP32FS/tool/esp32fs.jar

ステップ 5. 最後に、Arduino IDE を再起動します。

プラグインが正しくインストールされたか確認するには、Arduino IDE を開きます。XIAO ESP32S3 または XIAO ESP32C3 を選択し、Tools に進んで ESP32 Sketch Data Upload オプションがあるか確認します。

MacOS​

ステップ 1. releases ページ にアクセスし、ESP32FS-1.1.zip ファイルをクリックしてダウンロードします。

ステップ 2. ファイルを展開します。

ステップ 3. /Documents/Arduino/ に tools というフォルダを作成します。

ステップ 4. 展開した ESP32FS フォルダを tools ディレクトリにコピーします。次のようなフォルダ構成になっているはずです。

~Documents/Arduino/tools/ESP32FS/tool/esp32fs.jar

ステップ 5. 最後に、Arduino IDE を再起動します。

プラグインが正しくインストールされたか確認するには、Arduino IDE を開きます。XIAO ESP32S3 または XIAO ESP32C3 を選択し、Tools に進んで ESP32 Sketch Data Upload オプションがあるか確認します。

Filesystem Uploader を使ったファイルのアップロード​

ESP32 のファイルシステムにファイルをアップロードするには、次の手順に従ってください。

ステップ 6. Arduino スケッチを作成して保存します。デモ用として、空のスケッチを保存してもかまいません。

ステップ 7. 次に、スケッチフォルダを開きます。Sketch > Show Sketch Folder に進みます。スケッチが保存されているフォルダが開くはずです。

ステップ 8. そのフォルダ内に data という新しいフォルダを作成します。

ステップ 9. data フォルダ内に、ESP32 のファイルシステムに保存したいファイルを配置します。例として、test_example という名前で、いくつかのテキストを含む .txt ファイルを作成します。

ステップ 10. その後、ファイルをアップロードするには、Arduino IDE で Tools > ESP32 Sketch Data Upload に進むだけです。

注意

アップローダーは、ファイルシステムにすでに保存されているものをすべて上書きします。

SPIFFS Image Uploaded というメッセージが表示されたら、ファイルは正常に ESP32 のファイルシステムにアップロードされています。

アップローダーのテスト​

では、そのファイルが実際に ESP32 のファイルシステムに保存されたかどうかを確認してみましょう。次のコードを ESP32 ボードに書き込むだけです。

#include "SPIFFS.h"

void setup() {
  Serial.begin(115200);
  while(!Serial);

  if(!SPIFFS.begin(true)){
    Serial.println("An Error has occurred while mounting SPIFFS");
    return;
  }

  File file = SPIFFS.open("/test_example.txt");
  if(!file){
    Serial.println("Failed to open file for reading");
    return;
  }

  Serial.println("File Content:");
  while(file.available()){
    Serial.write(file.read());
  }
  file.close();

}

void loop() {

}

アップロード後、ボーレートを 115200 に設定してシリアルモニタを開きます。シリアルモニタ上に .txt ファイルの内容が表示されるはずです。

フラッシュデータストレージ​

注意

このセクションは、XIAO ESP32C3、XIAO ESP32S3、または XIAO ESP32S3 Sense に適用されます。

開発ボードを使用する際、多くの人はチップ上のフラッシュメモリを使って重要なデータを保存したいと考えるでしょう。そのためには、開発ボードに異常が発生した場合でもデータが失われないことを保証するストレージ方式が必要です。

このチュートリアルでは、XIAO ESP32 のフラッシュメモリに重要なデータを保存する 2 つの異なるストレージ方法について紹介します。

  1. 最初のガイドでは、Preferences.h ライブラリを使用して ESP32 のフラッシュメモリにデータを永続的に保存する方法を示します。フラッシュメモリに保持されたデータは、リセットや電源断後も保持されます。Preferences.h ライブラリを使用すると、ネットワーク認証情報、API キー、しきい値、さらには GPIO の最後の状態などのデータを保存するのに便利です。フラッシュメモリへのデータの保存と読み出し方法を学びます。

  2. 2 つ目のガイドでは、XIAO ESP32C3 の EEPROM とは何か、そしてそれが何に役立つのかを説明します。また、EEPROM への書き込みと読み出し方法を紹介し、学んだ概念を実践に移すためのプロジェクト例を構築します。

このセクションは XIAO ESP32C3 向けに作成されており、新しい XIAO ESP32S3 と完全な互換性があります。そのため、ここにあるルーチンをそのまま使用でき、ここでは改めて説明しません。

トラブルシューティング​

引用・参考文献​

この記事は、ESP32 上のファイルシステムに関する Random Nerd Tutorials の内容を参考にし、Seeed Studio XIAO ESP32S3 Sense 上で検証したものです。

Random Nerd Tutorials の著者の皆様の多大なご尽力に心より感謝いたします。

以下は元記事への参照リンクです。ESP32 のファイルシステムについてさらに詳しく知りたい方は、ぜひ以下の元記事リンクをご覧ください。

ESP32 開発ボードの使用に関する詳細情報については、Random Nerd Tutorials の公式ウェブサイトをお読みください。

技術サポートと製品ディスカッション​

弊社製品をお選びいただきありがとうございます。私たちは、製品をできるだけスムーズにご利用いただけるよう、さまざまなサポートを提供しています。お好みやニーズに応じて選べる、複数のコミュニケーションチャネルをご用意しています。

Loading Comments...