getting-started_ja.md

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

English

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

• Windows 11 のｽﾀｯｸﾁｬﾝ環境構築マニュアル（WSL2）

開発に必要なもの

• ホストPC
  • Linux(Ubuntu22.04)でテスト済み
• ｽﾀｯｸﾁｬﾝ アールティver. または その互換品
• USB type-Cケーブル
• git
• Node.js
  • v20.11.0でテスト済み

ｽﾀｯｸﾁｬﾝリポジトリのクローン

--recursiveオプションをつけて本リポジトリをクローンします。

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

ModdableSDKのセットアップ

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

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

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

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

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

内部でxs-devを使ってModdableSDKやESP-IDFのセットアップを自動化しています。

手動でセットアップする

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

ｽﾀｯｸﾁｬﾝ アールティver.では、Moddable SDK 4.1 での動作を想定しています。

環境のテスト

npm run doctorコマンドで環境のテストができます。 インストールに成功していれば次のようにModdable SDKのバージョンとして4.1が表示され、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/kurasawa/Projects/stack-chan
xs-dev environment info:
  CLI Version                0.28.1
  OS                         Linux
  Arch                       x64
  Shell                      /bin/bash
  NodeJS Version             v20.11.0 (/home/ubuntu/.volta/tools/image/node/20.11.0/bin/node)
  Python Version             3.10.12 (/home/ubuntu/.rye/shims/python)
  Moddable SDK Version       4.1 (/home/ubuntu/.local/share/moddable)
  Supported target devices   lin, esp32
  ESP32 IDF Directory        /home/ubuntu/.local/share/esp32/esp-idf

次のステップ

• プログラムのビルドと書き込み