From fb993e0cd0a6149746c0ddef28f18f55ffcfa09c Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Wed, 15 Jan 2025 17:28:48 +0900 Subject: [PATCH 1/8] =?UTF-8?q?web-flash=E7=94=A8=E3=81=AE=E3=83=95?= =?UTF-8?q?=E3=82=A1=E3=83=BC=E3=83=A0=E3=82=A6=E3=82=A7=E3=82=A2=E3=83=93?= =?UTF-8?q?=E3=83=AB=E3=83=89=E6=99=82=E3=81=ABPSRAM=E3=82=92=E7=84=A1?= =?UTF-8?q?=E5=8A=B9=E5=8C=96=E3=81=99=E3=82=8B=E5=87=A6=E7=90=86=E3=82=92?= =?UTF-8?q?=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/bundle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/bundle.yml b/.github/workflows/bundle.yml index cee8df6..b3068d0 100644 --- a/.github/workflows/bundle.yml +++ b/.github/workflows/bundle.yml @@ -28,7 +28,7 @@ jobs: uses: ./.github/actions/setup - name: Bundle if: steps.diff_check.outputs.diff_detected || steps.cache.outputs.cache-hit != 'true' - run: source $HOME/.local/share/xs-dev-export.sh && npm run bundle + run: source $HOME/.local/share/xs-dev-export.sh && sh ./setting_scripts/unset_psram.sh && npm run bundle working-directory: ./firmware - name: Upload Firmware Bundle if: steps.diff_check.outputs.diff_detected || steps.cache.outputs.cache-hit != 'true' From 5898a1671b53943375027f39e130b15803010c9a Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Wed, 15 Jan 2025 17:31:21 +0900 Subject: [PATCH 2/8] =?UTF-8?q?=E8=8B=B1=E8=AA=9E=E7=89=88=E3=81=AEREADME.?= =?UTF-8?q?md=E3=81=AB=E3=82=82web-flash=E3=83=9A=E3=83=BC=E3=82=B8?= =?UTF-8?q?=E3=81=AEURL=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2011a47..b79bd00 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ This repository includes the following contents. * For Windows: [(WSL2) Windows 11 Stack-chan Environment Setup Manual (Japanese)](firmware/docs/getting-started-wsl2_ja.md) * For MacOS/Linux: [Getting Started (MacOS/Linux)](./firmware/docs/getting-started.md) * For Web: Follow the steps below (Reference: [Tried Flashing a Program to Stack-chan via Web Browser (Japanese)](https://rt-net.jp/humanoid/archives/5907)): - 1. Access the web-flash page from your PC. + 1. Access the [web-flah page](https://rt-net.github.io/stack-chan/web/flash/) from your PC. 2. Connect Stack-chan to the PC using a cable. 3. Select `M5Stack CoreS3`. 4. Press the `Flash Stack-chan firmware [・＿・]` button. From 8afe235bd25477c95a9dff8b86c04ebbaea9c053 Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 11:29:06 +0900 Subject: [PATCH 3/8] =?UTF-8?q?=E3=83=90=E3=83=BC=E3=82=B8=E3=83=A7?= =?UTF-8?q?=E3=83=B3=E6=83=85=E5=A0=B1=E3=82=92=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware/package-lock.json | 4 ++-- firmware/package.json | 2 +- web/flash/manifest_esp32_m5stack_cores3.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/firmware/package-lock.json b/firmware/package-lock.json index 2d5e3ce..7610db4 100644 --- a/firmware/package-lock.json +++ b/firmware/package-lock.json @@ -1,12 +1,12 @@ { "name": "stack-chan", - "version": "0.2.1", + "version": "2.1.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "stack-chan", - "version": "0.2.1", + "version": "2.1.1", "license": "Apache-2.0", "devDependencies": { "@ffmpeg/core": "^0.11.0", diff --git a/firmware/package.json b/firmware/package.json index b32faf3..6545d15 100644 --- a/firmware/package.json +++ b/firmware/package.json @@ -1,6 +1,6 @@ { "name": "stack-chan", - "version": "0.2.1", + "version": "2.1.1", "description": "A firmware of M5Stack Stack-chan module", "main": "stackchan/main.ts", "scripts": { diff --git a/web/flash/manifest_esp32_m5stack_cores3.json b/web/flash/manifest_esp32_m5stack_cores3.json index a4b9bc4..72c3749 100644 --- a/web/flash/manifest_esp32_m5stack_cores3.json +++ b/web/flash/manifest_esp32_m5stack_cores3.json @@ -1,6 +1,6 @@ { "name": "Stack-chan", - "version": "1.0.0", + "version": "2.1.1", "builds": [ { "chipFamily": "ESP32-S3", From 17aa49138cfd139031499b0f8a0641e26fc8c4bd Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 11:44:39 +0900 Subject: [PATCH 4/8] =?UTF-8?q?web-flash=E3=81=AB=E3=83=AA=E3=82=BB?= =?UTF-8?q?=E3=83=83=E3=83=88=E3=83=9C=E3=82=BF=E3=83=B3=E3=82=92=E6=8A=BC?= =?UTF-8?q?=E3=81=99=E6=89=8B=E9=A0=86=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +++-- README_ja.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b79bd00..5d2d87a 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,9 @@ This repository includes the following contents. * For Web: Follow the steps below (Reference: [Tried Flashing a Program to Stack-chan via Web Browser (Japanese)](https://rt-net.jp/humanoid/archives/5907)): 1. Access the [web-flah page](https://rt-net.github.io/stack-chan/web/flash/) from your PC. 2. Connect Stack-chan to the PC using a cable. - 3. Select `M5Stack CoreS3`. - 4. Press the `Flash Stack-chan firmware [・＿・]` button. + 3. Hold the reset button on the bottom of the M5Stack for 3 seconds to switch to BOOT mode (a green light will appear near the reset button). + 4. Select `M5Stack CoreS3`. + 5. Press the `Flash Stack-chan firmware [・＿・]` button. ## Contribution diff --git a/README_ja.md b/README_ja.md index 81eaafa..fdd8890 100644 --- a/README_ja.md +++ b/README_ja.md @@ -57,8 +57,9 @@ * Webの場合：以下の手順を実行（参考：[Webブラウザからｽﾀｯｸﾁｬﾝにプログラムを書き込んでみた](https://rt-net.jp/humanoid/archives/5907)） 1. PCから[web-flahページ](https://rt-net.github.io/stack-chan/web/flash/)にアクセス 2. ｽﾀｯｸﾁｬﾝとPCをケーブルで接続 - 3. `M5Stack CoreS3`を選択 - 4. `Flash Stack-chan firmware [・＿・]`ボタンを押下 + 3. M5Stackの下部にあるリセットボタンを3秒以上押し続けてBOOTモードに切替（切り替わるとリセットボタン付近が緑色に光ります） + 4. `M5Stack CoreS3`を選択 + 5. `Flash Stack-chan firmware [・＿・]`ボタンを押下 ## コントリビューション From 471931879f1d3046977d1fed564c9929a5a7241a Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 13:33:55 +0900 Subject: [PATCH 5/8] =?UTF-8?q?=E8=A8=AD=E5=AE=9A=E3=82=B9=E3=82=AF?= =?UTF-8?q?=E3=83=AA=E3=83=97=E3=83=88=E3=81=AE=E3=82=B3=E3=83=A1=E3=83=B3?= =?UTF-8?q?=E3=83=88=E3=82=92=E6=97=A5=E6=9C=AC=E8=AA=9E=E3=81=8B=E3=82=89?= =?UTF-8?q?=E8=8B=B1=E8=AA=9E=E3=81=AB=E5=A4=89=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware/setting_scripts/set_xs-dev_env.sh | 12 ++++++------ firmware/setting_scripts/unset_psram.sh | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/firmware/setting_scripts/set_xs-dev_env.sh b/firmware/setting_scripts/set_xs-dev_env.sh index 26663b1..2377efc 100755 --- a/firmware/setting_scripts/set_xs-dev_env.sh +++ b/firmware/setting_scripts/set_xs-dev_env.sh @@ -1,12 +1,12 @@ #!/bin/sh -# 追記するコマンドを設定 +# Define the command to append XS_DEV_SH="source ~/.local/share/xs-dev-export.sh" -# 現在のシェルを取得 +# Get the current shell CURRENT_SHELL=$(basename "$SHELL") -# 設定ファイルを決定 +# Determine the configuration file if [ "$CURRENT_SHELL" = "bash" ]; then CONFIG_FILE="$HOME/.bashrc" elif [ "$CURRENT_SHELL" = "zsh" ]; then @@ -16,17 +16,17 @@ else exit 1 fi -# 設定ファイルが存在しない場合は作成 +# Create the configuration file if it doesn't exist if [ ! -f "$CONFIG_FILE" ]; then touch "$CONFIG_FILE" echo "# Created $CONFIG_FILE for $CURRENT_SHELL settings" >> "$CONFIG_FILE" echo "$CONFIG_FILE was created." fi -# ファイルに追記 +# Append the command to the file if grep -Fxq "$XS_DEV_SH" "$CONFIG_FILE"; then echo "The string '$XS_DEV_SH' already exists in $CONFIG_FILE. No changes made." else echo "$XS_DEV_SH" >> "$CONFIG_FILE" echo "The string '$XS_DEV_SH' has been added to $CONFIG_FILE." -fi \ No newline at end of file +fi diff --git a/firmware/setting_scripts/unset_psram.sh b/firmware/setting_scripts/unset_psram.sh index df038c5..143d3b7 100755 --- a/firmware/setting_scripts/unset_psram.sh +++ b/firmware/setting_scripts/unset_psram.sh @@ -1,16 +1,16 @@ #!/bin/sh -# 設定ファイルパスを取得 +# Get the path to the configuration file SDKCONFIG="$HOME/.local/share/moddable/build/devices/esp32/targets/m5stack_cores3/sdkconfig/sdkconfig.defaults" -# macOS と Linux の sed コマンドの互換性を考慮 +# Ensure compatibility between macOS and Linux sed command if [ "$(uname)" = "Darwin" ]; then - # macOS 用 + # macOS sed -i '' 's/CONFIG_SPIRAM=y/CONFIG_SPIRAM=n/' "$SDKCONFIG" else - # Linux 用 + # Linux sed -i 's/CONFIG_SPIRAM=y/CONFIG_SPIRAM=n/' "$SDKCONFIG" fi -# 結果を表示 +# Display the result cat "$SDKCONFIG" From 9dbcb1fc1b7a4242efa47f9c9496298c153c957c Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 15:27:18 +0900 Subject: [PATCH 6/8] =?UTF-8?q?=E8=A8=AD=E5=AE=9A=E3=82=B9=E3=82=AF?= =?UTF-8?q?=E3=83=AA=E3=83=97=E3=83=88=E3=82=92=E5=AE=9F=E8=A1=8C=E5=BE=8C?= =?UTF-8?q?=E3=81=AB=E3=82=BF=E3=83=BC=E3=83=9F=E3=83=8A=E3=83=AB=E3=82=BB?= =?UTF-8?q?=E3=83=83=E3=82=B7=E3=83=A7=E3=83=B3=E3=82=92=E5=86=8D=E8=B5=B7?= =?UTF-8?q?=E5=8B=95=E3=81=99=E3=82=8B=E3=82=88=E3=81=86=E3=81=AB=E6=89=8B?= =?UTF-8?q?=E9=A0=86=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware/docs/getting-started-wsl2_ja.md | 6 ++++++ firmware/docs/getting-started.md | 4 +++- firmware/docs/getting-started_ja.md | 7 ++++++- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/firmware/docs/getting-started-wsl2_ja.md b/firmware/docs/getting-started-wsl2_ja.md index 3d729f6..97e83a4 100644 --- a/firmware/docs/getting-started-wsl2_ja.md +++ b/firmware/docs/getting-started-wsl2_ja.md @@ -249,6 +249,12 @@ $ ./setting_scripts/set_xs-dev_env.sh ### 構築した環境の確認 +Ubuntuを度再起動（Ubuntuのウインドウを閉じてから再度開く）し、以下の`cd`コマンドで作業フォルダを移動してください。 + +```bash +$ cd stack-chan/firmware` +``` + #### Moddableの環境確認 以下のコマンドでModdableの環境のテストをします。 diff --git a/firmware/docs/getting-started.md b/firmware/docs/getting-started.md index fbac210..b5022eb 100644 --- a/firmware/docs/getting-started.md +++ b/firmware/docs/getting-started.md @@ -90,7 +90,9 @@ By completing these steps, your shell environment will be configured correctly f ## Test the environment -You can test your environment with the `npm run doctor` command. +You can test your environment with the `npm run doctor` command. +This command needs to be executed from the `stack-chan/firmware` directory. + If the installation is successful, 4.9.5 will be displayed as the version of Moddable SDK as shown below, and esp32 will be displayed in Supported target devices. ```console diff --git a/firmware/docs/getting-started_ja.md b/firmware/docs/getting-started_ja.md index 9ea2c58..69bb719 100644 --- a/firmware/docs/getting-started_ja.md +++ b/firmware/docs/getting-started_ja.md @@ -75,17 +75,22 @@ xs-dev（CLI）でうまくセットアップできない場合はこちらを $ ./setting_scripts/unset_psram.sh ``` -次のコマンドを実行し、Shellの設定ファイルに`source ~/.local/share/xs-dev-export.sh`を追加します。これにより、Shellの起動時に環境変数を設定されます。 +次のコマンドを実行し、Shellの設定ファイルに`source ~/.local/share/xs-dev-export.sh`を追加します。これにより、Shellの起動時に環境変数が設定されます。 ```console $ ./setting_scripts/set_xs-dev_env.sh ``` +ここまで完了したら、ターミナルを再起動してください。 + ## 環境のテスト `npm run doctor`コマンドで環境のテストができます。 +コマンドは、`stack-chan/firmware`配下で実行する必要があります。 + インストールに成功していれば次のようにModdable SDKのバージョンとして4.9.5が表示され、Supported target devicesにesp32が表示されます。 + ```console $ npm run doctor From a2d5642406ebfb6fe487ec07f2e90e7b182c9e6f Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 15:28:12 +0900 Subject: [PATCH 7/8] =?UTF-8?q?WSL2=E3=81=AE=E3=83=9E=E3=83=8B=E3=83=A5?= =?UTF-8?q?=E3=82=A2=E3=83=AB=E3=81=A7=E3=80=81=E3=81=84=E3=81=8D=E3=81=AA?= =?UTF-8?q?=E3=82=8A=E3=82=BF=E3=83=BC=E3=83=9F=E3=83=8A=E3=83=AB=E3=81=A8?= =?UTF-8?q?=E3=81=84=E3=81=86=E5=8D=98=E8=AA=9E=E3=81=8C=E5=87=BA=E3=81=A6?= =?UTF-8?q?=E3=81=84=E3=82=8B=E3=81=AE=E3=81=A7Ubuntu=E3=81=AB=E5=A4=89?= =?UTF-8?q?=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware/docs/getting-started-wsl2_ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/firmware/docs/getting-started-wsl2_ja.md b/firmware/docs/getting-started-wsl2_ja.md index 97e83a4..93fd753 100644 --- a/firmware/docs/getting-started-wsl2_ja.md +++ b/firmware/docs/getting-started-wsl2_ja.md @@ -143,7 +143,7 @@ $ curl https://get.volta.sh | bash -インストールに成功すると`success: Setup complete. Open a new terminal to start using Volta!`と表示され、新しいターミナルを開始するように促されます。 +インストールに成功すると`success: Setup complete. Open a new terminal to start using Volta!`と表示され、Ubuntuを再起動するように促されます。 Ubuntuのウインドウを閉じ、Windows11のスタートメニューからUbuntuを再起動してください。 From f489e50403933539b8516ac2d19c41648480d950 Mon Sep 17 00:00:00 2001 From: KuraZuzu Date: Thu, 16 Jan 2025 16:04:36 +0900 Subject: [PATCH 8/8] =?UTF-8?q?Volta=E3=82=A4=E3=83=B3=E3=82=B9=E3=83=88?= =?UTF-8?q?=E3=83=BC=E3=83=AB=E5=BE=8C=E3=81=AE=E3=82=BF=E3=83=BC=E3=83=9F?= =?UTF-8?q?=E3=83=8A=E3=83=AB=E5=86=8D=E8=B5=B7=E5=8B=95=E3=81=AB=E9=96=A2?= =?UTF-8?q?=E3=81=99=E3=82=8B=E6=96=87=E7=AB=A0=E3=82=92=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware/docs/getting-started-wsl2_ja.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/firmware/docs/getting-started-wsl2_ja.md b/firmware/docs/getting-started-wsl2_ja.md index 93fd753..a3b58fb 100644 --- a/firmware/docs/getting-started-wsl2_ja.md +++ b/firmware/docs/getting-started-wsl2_ja.md @@ -143,9 +143,7 @@ $ curl https://get.volta.sh | bash -インストールに成功すると`success: Setup complete. Open a new terminal to start using Volta!`と表示され、Ubuntuを再起動するように促されます。 - -Ubuntuのウインドウを閉じ、Windows11のスタートメニューからUbuntuを再起動してください。 +インストールに成功すると`success: Setup complete. Open a new terminal to start using Volta!`と表示され、新しいターミナルを開くように指示されますが、環境を反映するには、Ubuntuのウインドウを閉じ、Windows11のスタートメニューからUbuntuを再起動してください。 ### `Volta`から`Node.js`と`npm`をインストール