ESP-IDF 環境のセットアップ (Debian 10)

はじめに

ESP32 マイコンの開発環境としてマイコンメーカ Espressif Systems が提供する ESP-IDF 環境を用いる. 以下では Debian 10 に ESP-IDF 環境を構築する.

公式ドキュメント: <URL:https://docs.espressif.com/projects/esp-idf/en/latest/get-started/linux-setup.html>

必要なパッケージをインストールする. 公式ドキュメントに書かれているパッケージや, ITOC の公開しているドキュメントに書かれているパッケージを全部インストールする. なお, python-libusb1 をインストールしておかないと OpenOcd が動かないので, それも追加する. Debian の python のデフォルトは ver.2 であるが, 2020/03 現在, python2 のサポートが切れているため, python3 をインストールする.

$ sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools python3-serial python3-click python3-cryptography python3-future python3-pyparsing python3-pyelftools python3-libusb1 cmake ninja-build ccache

python3 をデフォルトにする.

$ sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10

作業用のディレクトリを作成する. ホームディレクトリ以下に esp ディレクトリを作る.

$ mkdir ~/esp

$ cd ~/esp

ESP-IDF は GitHub で公開されている. それを git clone する. --recursive をつけることでサブモジュールも全てインストールする (--recursive をつけないと環境構築に失敗する). インストールされるサブモジュールは標準出力に表示される.

$ git clone --recursive https://github.com/espressif/esp-idf.git

  ... (メッセージは略) ...

git clone することでカレントディレクトリ (~/esp) 以下に esp-idf ディレクトリが作成される. そのディレクトリ以下にセットアップツールが存在するので, それを実行する. メッセージを見ると, 最新の xtensa-esp32-elf のダウンロードと, そのインストールが実行されていることがわかる.

$ cd ~/esp/esp-idf/

$ ./install.sh

  Installing ESP-IDF tools
  Installing tools: xtensa-esp32-elf, xtensa-esp32s2-elf, esp32ulp-elf, openocd-esp32
  Installing xtensa-esp32-elf@esp-2019r2-8.2.0
  Downloading xtensa-esp32-elf-gcc8_2_0-esp-2019r2-linux-amd64.tar.gz to /home/sugiyama/.espressif/dist/xtensa-esp32-elf-gcc8_2_0-esp-2019r2-linux-amd64.tar.gz.tmp
  Done
  Extracting /home/sugiyama/.espressif/dist/xtensa-esp32-elf-gcc8_2_0-esp-2019r2-linux-amd64.tar.gz to /home/sugiyama/.espressif/tools/xtensa-esp32-elf/esp-2019r2-8.2.0

  ...(中略)...

  All done! You can now run:
    . ./export.sh

環境設定を行う. 上記のメッセージのように, export.sh を実行すれば良い. 実行時メッセージにあるように環境変数が追加される.

$ . ./export.sh 

  Adding ESP-IDF tools to PATH...
  Checking if Python packages are up to date...
  Python requirements from /home/sugiyama/esp/esp-idf/requirements.txt are satisfied.
  Added the following directories to PATH:
    /home/sugiyama/esp/esp-idf/components/esptool_py/esptool
    /home/sugiyama/esp/esp-idf/components/espcoredump
    /home/sugiyama/esp/esp-idf/components/partition_table/
    /home/sugiyama/.espressif/tools/xtensa-esp32-elf/esp-2019r2-8.2.0/xtensa-esp32-elf/bin
    /home/sugiyama/.espressif/tools/xtensa-esp32s2-elf/esp-2019r2-8.2.0/xtensa-esp32s2-elf/bin
    /home/sugiyama/.espressif/tools/esp32ulp-elf/2.28.51.20170517/esp32ulp-elf-binutils/bin
    /home/sugiyama/.espressif/tools/openocd-esp32/v0.10.0-esp32-20190708/openocd-esp32/bin
    /home/sugiyama/.espressif/python_env/idf4.1_py2.7_env/bin
    /home/sugiyama/esp/esp-idf/tools
  Done! You can now compile ESP-IDF projects.
  Go to the project directory and run:

    idf.py build

export.sh によってどのように環境変数が変化したかは, 例えば env コマンドで確かめられる. PATH (コマンドサーチパス) に ESP-IDF 関連のディレクトリが多数追加され, 新たに IDF_TOOLS_EXPORT_CMD と IDF_TOOLS_INSTALL_CMD という 2 つの環境変数が新たに 2 つ設定されている.

$ env

  (中略)

  PATH=/home/sugiyama/esp/esp-idf/components/esptool_py/esptool:/home/sugiyama/esp/esp-idf/components/espcoredump:/home/sugiyama/esp/esp-idf/components/partition_table/:/home/sugiyama/.espressif/tools/xtensa-esp32-elf/esp-2019r2-8.2.0/xtensa-esp32-elf/bin:/home/sugiyama/.espressif/tools/xtensa-esp32s2-elf/esp-2019r2-8.2.0/xtensa-esp32s2-elf/bin:/home/sugiyama/.espressif/tools/esp32ulp-elf/2.28.51.20170517/esp32ulp-elf-binutils/bin:/home/sugiyama/.espressif/tools/openocd-esp32/v0.10.0-esp32-20190708/openocd-esp32/bin:/home/sugiyama/.espressif/python_env/idf4.1_py2.7_env/bin:/home/sugiyama/esp/esp-idf/tools:/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
  IDF_TOOLS_EXPORT_CMD=/home/sugiyama/esp/esp-idf/export.sh
  IDF_TOOLS_INSTALL_CMD=/home/sugiyama/esp/esp-idf/install.sh

毎回, ESP-IDF を使う前に export.sh を実行するのは面倒なので, ~/.bashrc に追加しておくとよい.

$ vi ~/.bashrc

  (末尾に追加)

  #ESP-IDF
  . $HOME/esp/esp-idf/export.sh

確認のために別のターミナルを立ちあげ, env コマンドを実行せよ. PATH や IDF_TOOLS_EXPORT_CMD, IDF_TOOLS_INSTALL_CMD が設定されていることが確かめられる.

USB-Serial の設定

USB ケーブルで ESP32 マイコンと PC を接続してみよ.

新たに追加した ESP32 マイコンは USB-Serial デバイスとして認識される. デバイス名は /dev/ttyUSB* や /dev/tty.<USB-Serialの型番> となることが一般的である (Linux では外部デバイスもすべてファイル(/dev/ 以下)として認識される).

ls コマンドで /dev/tty* として存在するデバイス名を調べ, tty.USB* と付くもの, もしくは tty.<USB-Serial の型番> を探す.

$ ls /dev/tty*

  ...(略)...

以下では /dev/ttyUSB0 が ESP32 マイコンを表すデバイス名とする. デバイスのパーミッションを ls -l コマンドで確認すると, ユーザとグループのみに write パーミッションが出ている.

$ ls -l /dev/ttyUSB0

  crw-rw---- 1 root dialout 188, 0 12月 14 15:46 /dev/ttyUSB0

上記の ls -l コマンドの実行結果より, dialout グループに自分のユーザを追加しないと, 作成したプログラムをマイコンに書き込むことができないことがわかる. dialout グループに自分のユーザを登録する場合は usermod コマンドを使うのが簡単である. なお, オプションの "-a" は追加, "-G <グループ名>" は追加するグループを意味する.

# usermod -a -G dialout <自分のユーザ名>

動作確認

最初の第 1 歩は Hello World である. サンプルがあるのでそれを流用する.

$ cd ~/esp

$ cp -r esp-idf/examples/get-started/hello_world .

$ cd hello_world

make すると config 画面が表示されるが, 確認するのはシリアルポートの設定だけである. デフォルトで /dev/ttyUSB0 なので, 特に変更の必要はない.

$ make

プログラムの書き込みとモニタを一度に実行する. 終了は Ctrl-] である. Hello World が定期的に表示されていれば OK.

$ make falsh monitor