ESP32シリーズのArduinoでの判定方法

概要

ESP32シリーズが増えましたので、コードからの判別方法を調べてみました。

調査方法

M5StickCのdefine宣言を調べる

現時点の情報です。最新情報はM5StickC非公式日本語リファレンスを確認してみてください。概要M5StickCをArduino IDEで開発する場合に、最初から定義されているdefineを調べてみました。defineの階層M5StickC...

lang-ship.com

2020.03.17

上記を参考にして、空のスケッチをボード変えつつビルドして、全defineを収集してからdiffを取って差分確認しました。

シリーズ判定方法

上記が定義されていました。ESP32-H2はまだ正式リリースされていませんでしたが、ソースの中にすでに判定用定義がありました。実際のコードを見てみるとCONFIG_IDF_TARGET_*で判定するのが良さそうでした。

#if CONFIG_IDF_TARGET_ESP32
  // ESP32
#elif CONFIG_IDF_TARGET_ESP32S2
  // ESP32-S2
#elif CONFIG_IDF_TARGET_ESP32S3
  // ESP32-S3
#elif CONFIG_IDF_TARGET_ESP32C3
  // ESP32-C3
#elif CONFIG_IDF_TARGET_ESP32H2
  // ESP32-H2
#else
  // Other
#endif

上記のようなコードになると思います。

#if CONFIG_IDF_TARGET_ESP32
  // ESP32
#elif CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
  // ESP32-S2 & S3
#elif CONFIG_IDF_TARGET_ESP32C3
  // ESP32-C3
#elif CONFIG_IDF_TARGET_ESP32H2
  // ESP32-H2
#endif

条件は||で複数を同時に処理することもできます。

コア数

上記がプロセッサーとコア数の一覧です。ESP32だけESP-SOLO-1という、シングルコアがありますがArduinoではサポートされておらず、ほぼ利用されていないのでデュアルコアを使う事が多いと思います。

SOC_CPU_CORES_NUMで判定するのが無難ですが、シングルコアの場合だけ特殊処理をする場合にはCONFIG_FREERTOS_UNICOREを使うことが多いようです。

#ifdef CONFIG_FREERTOS_UNICORE
// Single
#endif

#ifndef CONFIG_FREERTOS_UNICORE
// Dual
#endif

#if !CONFIG_FREERTOS_UNICORE
// Dual
#endif

#if SOC_CPU_CORES_NUM > 1
// Dual
#else
// Single
#endif

PSRAM

PSRAMは無効化していると、非搭載のボードと同じくなにも宣言されていないようです。

#if CONFIG_SPIRAM_SUPPORT || CONFIG_SPIRAM
    // PSRAM
#endif

3種類ありますが、内部では上記の処理が使われていました。ArduinoだとBOARD_HAS_PSRAMが宣言されていないと、残り2つを消してしまうのですが、CONFIG系はESP-IDF系の設定なのでなるべく大本の設定であるCONFIG_SPIRAMなどを使ったほうがいいと思います。

ボード名

Arduinoではboards.txtにボード定義があり、そこで定義されている名前を取得することができます。

pico32.name=ESP32 PICO-D4
pico32.build.variant=pico32
pico32.build.board=ESP32_PICO

ちょっと特徴的な名前でわかりやすいESP32 PICO-D4で説明したいと思います。上記の設定の場合には以下の定義が使えます。

#define ARDUINO_BOARD "ESP32_PICO"
#define ARDUINO_ESP32_PICO 1
#define ARDUINO_VARIANT "pico32"

pico32.nameの値はArduino IDEの選択肢に現れるだけで内部では利用していません。pico32.build.boardの値がARDUINO_BOARDに定義され、ARDUINO_${pico32.build.board}のような名前でも定義されます。pico32.build.variantはARDUINO_VARIANTで定義されていますね。ログに出力する場合には文字列の方がよいのですが、判定で利用するのはARDUINO_ESP32_PICOの部分となります。

• https://lang-ship.com/blog/files/define/

ちょっと数が多いので、上記に最新のboards.txtから一覧を表示するページを作りました。

上記はM5Stackの定義となります。こちらはZIPファイルでしか配布していないので、boards.txtだけ取り出すのが難しいので自動化していません。

#ifdef ARDUINO_M5Stack_Core_ESP32
// M5Stack BASIC
#elif ARDUINO_M5STACK_FIRE
// M5Stack Fire
#else
// Other
#endif

などと判定を行います。

#include <M5Unified.h>

void setup() {
  auto cfg = M5.config();
  M5.begin(cfg);

  String name;
  switch (M5.getBoard())
  {
#if defined (CONFIG_IDF_TARGET_ESP32C3)
    case m5::board_t::board_M5StampC3:
      name = "StampC3";
      break;
    case m5::board_t::board_M5StampC3U:
      name = "StampC3U";
      break;
#else
    case m5::board_t::board_M5Stack:
      name = "Stack";
      break;
    case m5::board_t::board_M5StackCore2:
      name = "StackCore2";
      break;
    case m5::board_t::board_M5StickC:
      name = "StickC";
      break;
    case m5::board_t::board_M5StickCPlus:
      name = "StickCPlus";
      break;
    case m5::board_t::board_M5StackCoreInk:
      name = "CoreInk";
      break;
    case m5::board_t::board_M5Paper:
      name = "Paper";
      break;
    case m5::board_t::board_M5Tough:
      name = "Tough";
      break;
    case m5::board_t::board_M5Station:
      name = "Station";
      break;
    case m5::board_t::board_M5Atom:
      name = "ATOM";
      break;
    case m5::board_t::board_M5AtomPsram:
      name = "ATOM PSRAM";
      break;
    case m5::board_t::board_M5AtomU:
      name = "ATOM U";
      break;
    case m5::board_t::board_M5TimerCam:
      name = "TimerCamera";
      break;
    case m5::board_t::board_M5StampPico:
      name = "StampPico";
      break;
#endif
    default:
      name = "Who am I ?";
      break;
  }
}

void loop() {
}

ただし、M5Unifiedライブラリを使っているのであればボード定義ではなく、実際の端末からボード特定をすることができますので、こちらの機能を利用したほうがよいと思います。

• https://github.com/m5stack/M5Unified/blob/master/examples/Basic/HowToUse/HowToUse.ino

上記のスケッチ例が参考になります。

まとめ

都度調べてしまうので、定期的に更新するページとして残しておきたいと思います。