Skip to content

getting-started_ja.md

Latest commit

 

History

History
122 lines (86 loc) · 6 KB

getting-started_ja.md

File metadata and controls

122 lines (86 loc) · 6 KB
Raw

環境構築（MacOS/Linux）マニュアル

English

ｽﾀｯｸﾁｬﾝはWindows11、MacOS、Linuxで開発ができます。Windows 11の場合はWSL2を使った環境構築手順を参照してください。ここでは、MacOS/Linuxでの開発環境の方法を示します。

開発に必要なもの

  • ホストPC
    • Linux(Ubuntu22.04 or Ubuntu24.04)でテスト済み
    • MacOS(Sonoma 14 Appleシリコン)でテスト済み
  • ｽﾀｯｸﾁｬﾝ アールティver. または その互換品
  • USB type-Cケーブル
  • 事前にインストールしておくアプリ
    • cmake
    • git
    • Node.js
      • Node.js 20以降が必要です。v22.8.xでの動作を確認しています。
      • cherrup_ble_liteのmodは新しいNode.jsに対応していないため、作業時は別途Node.js 18の環境を使用してください。
    • Python3.12で動作確認ができています。(macOSはbrewでインストールするのではなくhttps://www.python.orgからダウンロードしインストールしてください。)
    • xcode-select(macOSのみ)

ｽﾀｯｸﾁｬﾝリポジトリのクローンとnodeのmoduleのインストール

$ git clone https://github.com/rt-net/stack-chan.git
$ cd stack-chan/firmware
$ npm install

ModdableSDKのセットアップ

ホストPCでModdableSDKと ESP-IDFをインストールします。 次の2通りの方法があります。

  • xs-dev（CLI）を使う（推奨）
  • 手動でセットアップする

xs-dev（CLI）を使う（推奨）

ｽﾀｯｸﾁｬﾝはセットアップ手順をnpmスクリプト化しています。 stack-chan/firmwareディレクトリで次のコマンドを実行します。

Linux/Ubuntuでは、システムパッケージのインストールが必要な場合に各セットアップコマンド内でパスワードの入力が要求されます。

$ npm run setup
$ npm run setup -- --device=esp32

macOSの場合は、npm run setup -- --device=esp32のインストールの時、xcode-selectのバージョンが古いと"Error: Command failed with exit code 1: python3 -m pip install pyserial"で止まることがあります。その場合は、xcode-selectを手動で削除してから再度xcode-select(xcord-select –install)をインストールしてください。 xcode-selectの削除は"sudo rm -rf /Library/Developer/CommandLineTools"でできます。
リポジトリ内のセットアップスクリプトでModdable SDK 4.9.5とESP-IDF v5.3を固定した上で、xs-devを使ってツールと依存パッケージのセットアップを自動化しています。これにより、互換性のない新しいESP-IDFが選択されることを防ぎます。

手動でセットアップする

公式サイトの手順（英語）に従ってModdableSDKとESP-IDFをインストールします。 xs-dev（CLI）でうまくセットアップできない場合はこちらを行ってください。

  • ｽﾀｯｸﾁｬﾝ アールティver.では、Moddable SDK 4.9.5、ESP-IDF 5.3.0 での動作を想定しています。
  • intel macはModdable SDK 4.7.0 + ESP-IDF 5.1.0 python3.9.0で動作することは確認しています。intel macで使用するにはfirmware/scripts/setup.jsのMODDABLE_VERSIONを4.7.0、ESP_IDF_VERSIONをv5.1に変更することでインストールできますがサポート対象外になります。

PSRAMと環境変数のセットアップ

次のコマンドを実行して、PSRAMの設定をします。

$ ./setting_scripts/unset_psram.sh

次のコマンドを実行し、Shellの設定ファイルにsource ~/.local/share/xs-dev-export.shを追加します。これにより、Shellの起動時に環境変数が設定されます。

$ ./setting_scripts/set_xs-dev_env.sh

ここまで完了したら、ターミナルを再起動してください。

環境のテスト

npm run doctorコマンドで環境のテストができます。 コマンドは、stack-chan/firmware配下で実行する必要があります。

インストールに成功していれば次のようにModdable SDKのバージョンとして4.9.5が表示され、Supported target devicesにesp32が表示されます。

$ npm run doctor

> stack-chan@0.2.1 doctor
> echo stack-chan environment info: && git rev-parse HEAD && git rev-parse --show-toplevel && xs-dev doctor

stack-chan environment info:
55d005ac9f0764a4ebc561b7d0a2a29a66ee5199
/home/ubuntu/stack-chan
xs-dev environment info:
  CLI Version                1.12.1
  OS                         Linux
  Arch                       x64
  Shell                      /bin/bash
  NodeJS Version             v22.8.0 (/home/ubuntu/.nvm/versions/node/22.8.0/bin/node)
  Python Version             3.12.3 (/usr/bin/python)
  Moddable SDK Version       4.9.5 (/home/ubuntu/.local/share/moddable)
  Supported target devices   lin, esp32
  ESP32 IDF Directory        /home/ubuntu/.local/share/esp32/esp-idf

grep CONFIG_SPIRAM= $MODDABLE/build/devices/esp32/targets/m5stack_cores3/sdkconfig/sdkconfig.defaultsコマンドでM5Stack CoreS3のPARAMの設定を確認できます。 設定が完了していれば、CONFIG_SPIRAM=nと出力されます。

$ grep CONFIG_SPIRAM= $MODDABLE/build/devices/esp32/targets/m5stack_cores3/sdkconfig/sdkconfig.defaults
CONFIG_SPIRAM=n

次のステップ