Feature/manuals

README.md

@@ -48,11 +48,12 @@ This repository includes the following contents.
 
 ### Assemble board
 
-Coming soon...
+* See [Stack-chan RT ver. Assembly Manual (Japanese)](docs/assembly_ja.md)
 
 ### Flash firmware to M5Stack
 
-Coming soon...
+* 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)
 
 ## Contribution
 

README_ja.md

@@ -46,14 +46,15 @@
 
 ## 製作方法
 
-近日公開
-
 ### モジュールを組み立てる
 
-近日公開
+[ｽﾀｯｸﾁｬﾝ アールティver. 組み立てマニュアル](docs/assembly_ja.md)を参照ください。
 
 ### ファームウェアをM5Stackに書き込む
 
+* Windowsの場合：[Windows 11 のｽﾀｯｸﾁｬﾝ環境構築マニュアル（WSL2）](firmware/docs/getting-started-wsl2_ja.md)
+* MacOS/Linuxの場合：[環境構築（MacOS/Linux）マニュアル](./firmware/docs/getting-started_ja.md)
+
 ## コントリビューション
 
 機能追加のリクエスト/バグ報告は[issues](https://github.com/rt-net/stack-chan/issues)のページから投稿を受け付けています。

docs/assembly_ja.md

@@ -0,0 +1,220 @@
+# ｽﾀｯｸﾁｬﾝ アールティver. 組み立てマニュアル
+
+[ｽﾀｯｸﾁｬﾝ アールティver.](https://rt-net.jp/products/rt-stackchan/)の組み立て手順を説明します。
+
+## パーツ一覧
+
+ｽﾀｯｸﾁｬﾝの組み立てには以下のパーツを使用します。
+
+**『[ｽﾀｯｸﾁｬﾝ アールティver. 組立キット](https://www.rt-shop.jp/index.php?main_page=product_info&products_id=4188)』には、`M2.5x8`のネジが2本が同梱されています。これらのネジは組み立てのどのステップにも使用されません。誤って使用しないよう、ご注意ください。**
+
+<img src="images/assembly/parts_1.jpg" width="100%">
+<img src="images/assembly/parts_2.jpg" width="100%">
+<img src="images/assembly/parts_3.jpg" width="100%">
+<img src="images/assembly/parts_4.jpg" width="100%">
+<img src="images/assembly/parts_5.jpg" width="100%">
+<img src="images/assembly/parts_6.jpg" width="100%">
+<img src="images/assembly/parts_7.jpg" width="100%">
+
+### 使用パーツ
+
+1. M5Stack CoreS3
+2. 基板
+3. シェル
+4. 足(上)
+5. 足(下)
+6. サーボブラケット(前)
+7. サーボブラケット(後)
+8. サーボモータ１
+9. サーボモータ２
+10. TTLケーブル 2本
+11. バッテリーパック
+12. サーボホーン
+13. 六角穴付きタップネジ M2x5[mm] 4本
+
+### オプションパーツ
+
+14. 六角穴付きネジ M3x12[mm] 2本
+15. 六角穴付きネジ M3x14[mm] 2本
+
+### 不要パーツ
+
+16. 六角穴付きネジ M2.5x8[mm] 2本
+
+
+## 使用工具一覧
+
+- プラスドライバー PH1（M2.6ネジ用）
+- マイナスドライバー（先端幅5.5[mm]以下）
+- 六角レンチ 1.5[mm]（M2六角穴付きネジ用）
+- 【オプション】六角レンチ 2.5mm[mm]（M3六角穴付きネジ用）
+
+## 組み立て
+
+以下に示す順番通りに組み立ててください。
+
+### サーボモータの準備
+
+#### サーボモータの円形サーボホーンの角度調整
+
+##### サーボモータ１
+
+サーボモータ１本体の切り欠きに対し、円形サーボホーンの**2本の切り欠き**の位置が一致するように指で回転させてください。
+
+<img src="images/assembly/disk_horn_rotation_1.jpg" width="60%">
+
+##### サーボモータ２
+
+サーボモータ２本体の切り欠きに対し、円形サーボホーンの**1本の切り欠き**の角度が、画像のように90°になるように指で回転させてください。
+
+**サーボモータ１側と違い、円形サーボホーンの切り欠きが1本であることに注意してください。**
+
+<img src="images/assembly/disk_horn_rotation_2.jpg" width="60%">
+
+#### 円形サーボホーンとネジの取り外し
+
+サーボモータ１とサーボモータ２に取り付けられたタップネジ(M2.6x6)を取り外します。
+
+<img src="images/assembly/disassembling_screw.jpg" width="100%">
+
+取り外した2本のネジは、この後に使用するので取っておいてください。画像左側のパーツ（『not used』と書かれたパーツ）はｽﾀｯｸﾁｬﾝ アールティver.では使用しません。
+
+<img src="images/assembly/disassembling_servo.jpg" width="100%">
+
+### 胴体の組み立て
+
+サーボモータ１とサーボモータ２を画像の通りに接続します。
+
+サーボモータ１とサーボモータ２には、それぞれID1とID2が事前に割り振られており、M5Stackとの通信の際、ソフトウェア上での個体識別として用いています。目印として、ID1に青色、ID2には緑色のシールが貼られています。取り付けが逆にならないように注意してください。
+
+<img src="images/assembly/servo_wired.jpg" width="100%">
+
+胴体となる部分はサーボモータ１とサーボモータ２をサーボプラケットで固定します。ケーブルを挟まないように注意しつつ、サーボブラケット(前)とサーボブラケット(後)で挟み込みます。
+この際、サーボに「DYNAMIXEL XL330-M288-T」と書いてあるラベルが矢印方向に向くようにしてください。
+
+<img src="images/assembly/born_purge.jpg" width="100%">
+
+2つのサーボモータをサーボブラケットで挟んで固定します。
+
+<img src="images/assembly/born_base.jpg" width="100%">
+
+
+### 足の取り付け
+
+胴体にｽﾀｯｸﾁｬﾝの足を取り付けます。
+
+サーボモータ１の突起と足(上)の接合部の切り欠きの位置を合わせてグッと押して固定してください。突起と切り欠きの位置が正しく合っていない場合、押し込む際に突起が折れてしまう恐れがあります。慎重に確認してから押し込んでください。
+
+<p>
+    <img src="images/assembly/servo_protrusion_focus.jpg" width="35%"> <img src="images/assembly/feet_cutout.jpg" width="60%">
+</p>
+
+<img src="images/assembly/servo_and_feet_protrusions.jpg" width="100%">
+
+サーボモータ用のネジ（M2.6タップネジ）を締めて固定します。
+
+<img src="images/assembly/tightening_feet_screw.jpg" width="100%">
+
+ネジを奥まで締めたら、足(下)を取り付けます。
+
+<img src="images/assembly/feet_bottom_assembled.jpg" width="100%">
+
+足を取り付けると以下の画像のようになります。
+
+<img src="images/assembly/born_feet.jpg" width="100%">
+
+#### 足の分解方法
+
+足(上)に取り付けた足(下)は4箇所の窪みから取り外すことができます。1箇所ずつ、マイナスドライバーを窪みに差し込み、足(上)のフチを支点としたテコの原理で固定を外します。
+
+<img src="images/assembly/disassembling_feet.jpg" width="100%">
+
+### サーボホーンの取り付け
+
+サーボホーンを胴体に取り付けます。
+
+サーボモータ２とサーボホーンが共にギヤの形状となっている部分同士を取り付けます。足の取り付けの際と同様に突起と切り欠きの位置を合わせてグッと押し込んでください。
+
+<img src="images/assembly/servo_and_horn_protrusions.jpg" width="100%">
+
+突起の位置を合わせて接合したギヤ部分にM2.6タップネジを締めてください。
+
+<img src="images/assembly/tightening_horn_screw.jpg" width="100%">
+
+### バッテリーパックの取り付け
+
+バッテリーパックを胴体に取り付けます。
+バッテリーパックから出ている突起をサーボブラケット(後)に引っ掛けて固定します。
+
+<img src="images/assembly/born_backpack.jpg" width="100%">
+
+位置を合わせたら矢印方向にスライドしてください。
+
+<p>
+    <img src="images/assembly/born_backpack_attaching.jpg" width="50%"><img src="images/assembly/born_backpack_sliding.jpg" width="50%">
+</p>
+
+
+<img src="images/assembly/born_assembled.jpg" width="100%">
+
+### 外装の取り付け
+
+ｽﾀｯｸﾁｬﾝの外装となるシェルを取り付けます。
+
+シェルの天板内側にある突起とサーボホーンを取り付けます。バッテリーのコードとサーボモータのTTLケーブルを前に持ってきなからスライドして入れてください。
+
+<img src="images/assembly/born_shell.jpg" width="100%">
+
+突起によってｶﾁｯ！と手応えがあるまでスライドさせてください。
+
+<img src="images/assembly/born_slide_shell.jpg" width="100%">
+
+取り付けて反対側から見ると以下の画像のようになります。青色のラインはサーボホーンの輪郭です。
+
+<img src="images/assembly/born_shell_assembled.jpg" width="100%">
+
+### 基板の取り付け
+
+サーボモータに取り付けたTTLケーブルとバッテリーのケーブルを基板の指定した端子につなげます。
+
+**バッテリー端子の向きに気をつけてください。間違えると故障の原因となります。**
+
+<img src="images/assembly/cable_connecting.jpg" width="100%">
+
+画像の通り、基板に取り付けられた青と黒のコネクタが上になるように基板とシェルの穴の位置を合わせてネジ（M2タップネジ）を4つ締めて固定します。スライドスイッチが基板から突出しているため、シェルの側面にある穴に斜めに入れてネジの位置を合わせます。
+
+
+**ネジが導体（銀色の箇所）には触れないように注意してください。バッテリの端子が接続されているためショートする恐れがあります。**
+
+<p>
+    <img src="images/assembly/board_shell_attaching.jpg" width="50%"><img src="images/assembly/board_shell_assembling.jpg" width="50%">
+</p>
+
+基板まで取り付けると以下の画像のようになります。
+
+<img src="images/assembly/board_assembled.jpg" width="100%">
+
+### M5Stack CoreS3の取り付け
+
+M5Stack CoreS3を基板に対してピンの位置を合わせてグッと押し込んでください。
+
+<img src="images/assembly/m5_attaching.jpg" width="100%">
+
+無事に取り付けられたらｽﾀｯｸﾁｬﾝの組み立ては完了です。
+
+<img src="images/assembly/stack-chan_assembled.jpg" width="100%">
+
+
+### 【オプション】M5Stack CoreS3の固定
+
+M5Stack CoreS3をしっかり固定したい場合は、キットに付属している4本の六角穴付きネジ（六角ネジ）で固定します。ネジの長さは２種類あるため注意してください。
+
+バッテリーパックをサーボブラケット(後)から取り外し、バッテリーの端子も基板から外します。短いほうの六角ネジ2本をｽﾀｯｸﾁｬﾝの上側に、長いほうの六角ネジ2本を下側に取り付けます。4本のネジを締め終えたらバッテリーパックを再度取り付けます。
+
+<img src="images/assembly/back_screws.jpg" width="100%">
+
+<img src="images/assembly/assembling_back_screws.jpg" width="100%">
+
+**六角ネジを取り付ける際は、必ずバッテリーを外してから取り付けてください。ネジを基板上に落とすとショートして壊れる恐れがあります。**
+
+**必ず短い六角ネジを上側、長い六角ネジは下側に取り付けてください。間違えると液晶を壊す恐れがあります。**

firmware/docs/flashing-firmware.md

@@ -35,82 +35,6 @@ StackChan can change settings such as motor types and pin assignments from the m
 
 Additionally, you can specify the paths of other manifest files in a list format under the `"include"` key.
 
-### Configuration Example: the Stack-chan M5Bottom Kit
-
-This is an example configuration for running [Stack-chan Assembly Kit M5Bottom Version](https://mongonta.booth.pm/) distributed by Takao Akaki ([@mongonta0716](https://github.com/mongonta0716)) with the firmware in this repository. The M5Bottom version does not use a dedicated board, but connects to the M5Bottom port and servo.
-
-When using Port.A of M5Stack Core2:
-
-`manifest_local.json`
-
-```json
-{
-  // ...
-  "config": {
-    "driver": {
-      "type": "pwm",
-      "pwmPan": 33,
-      "pwmTilt": 32
-    }
-  }
-}
-```
-
-When using Port.C of M5Stack Core2:
-
-`manifest_local.json`
-
-```json
-{
-  // ...
-  "config": {
-    "driver": {
-      "type": "pwm",
-      "pwmPan": 13,
-      "pwmTilt": 14
-    }
-  }
-}
-```
-
-When using Port.C of M5Stack Basic:
-
-`manifest_local.json`
-
-```json
-{
-  // ...
-  "config": {
-    "driver": {
-      "type": "pwm",
-      "pwmPan": 16,
-      "pwmTilt": 17
-    }
-  }
-}
-```
-
-If Stack-chan is shaking her head left and right, the configuration has been successful.
-
-Reference: [About the firmware for Stack-chan M5Go Bottom version (Japanese)](https://raspberrypi.mongonta.com/softwares-for-stackchan/)
-
-### Configuration example: increase mod write space
-
-Moddable currently doesn't have an SD Card driver, so resources like audio and images are compiled and saved within the mod itself.
-However, if you have a lot of audio files, the mod may not be able to write beyond the default partition size of 4MB on the stack chan due to limitations.
-
-If you have a recent M5Stack with 16MB of Flash,
-you can include the [stackchan/manifest_8mb_flash.json](. /stackchan/manifest_8mb_flash.json) file
-to increase the size of the partition where the mod is saved.
-
-Simply add the following code to your manifest file:
-
-```json
-{
-  "include": [". /manifest_8mb_flash.json"]
-}
-```
-
 ## Writing the base program (hosts)
 
 As stated above, Stack-chan's firmware comprises a base program (host) and a user application (MOD).
@@ -119,15 +43,6 @@ The following commands are used to build and write a host.
 _No `sudo` required for the command._
 
 ```console
-# For M5Stack Basic/Gray/Fire
-$ npm run build
-$ npm run deploy
-
-# For M5Stack Core2
-$ npm run build --target=esp32/m5stack_core2
-$ npm run deploy --target=esp32/m5stack_core2
-
-# For M5Stack CoreS3
 $ npm run build --target=esp32/m5stack_cores3
 $ npm run deploy --target=esp32/m5stack_cores3
 ```
@@ -139,13 +54,6 @@ The program will be saved under the `$MODDABLE/build/` directory.
 You can debug the program using the following commands:
 
 ```
-# For M5Stack Basic/Gray/Fire
-$ npm run debug
-
-# For M5Stack Core2
-$ npm run debug --target=esp32/m5stack_core2
-
-# For M5Stack CoreS3
 $ npm run debug --target=esp32/m5stack_cores3
 ```
 
@@ -163,13 +71,6 @@ The following command is used to build and write a mod.
 _No `sudo` required for the command._
 
 ```console
-# For M5Stack Basic/Gray/Fire
-$ npm run mod [mod manifest file path]
-
-# For M5Stack Core2
-$ npm run mod --target=esp32/m5stack_core2 [mod manifest file path]
-
-# For M5Stack CoreS3
 $ npm run mod --target=esp32/m5stack_cores3 [mod manifest file path]
 ```
 
@@ -183,7 +84,7 @@ The M5Stack buttons will change Stack-chan's behavior as follows:
 **Example: Installing [`mods/look_around`](../mods/look_around/)**
 
 ```console
-$ npm run mod ./mods/look_around/manifest.json
+$ npm run mod --target=esp32/m5stack_cores3 ./mods/look_around/manifest.json
 
 > [email protected] mod
 > mcrun -d -m -p ${npm_config_target=esp32/m5stack} ${npm_argument} "./mods/look_around/manifest.json"