Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 6.78 KB

File metadata and controls

118 lines (80 loc) · 6.78 KB

スタックチャン(Stack-chan)

ファームウェアのビルド Discordサーバへの招待

English

stackchan

スタックチャンはM5Stackで作られた、JavaScriptで動くオープンソースのスーパーカワイイロボットです。

このリポジトリは、M5StackChan CoreS3を標準構成とするファームウェア、ユーザーアプリケーション(MOD)、ブラウザー上の開発ツール、ケース、回路図を提供します。

始め方

初めてスタックチャンを使う場合は、組み立て済みのM5StackChanを用意し、Webツールから始めるのが簡単です。

1. M5StackChanを用意する

M5StackChan AIデスクトップロボット(K151)単体で始められます。 ジョイスティックコントローラーは任意です。

2. ファームウェアを書き込む

M5StackChanをデータ通信対応のUSBケーブルでPCへ接続し、ChromeまたはEdgeでWebファームウェア書き込みを開きます。 機種には「M5StackChan CoreS3」を選択してください。 Moddable SDKやESP-IDFのセットアップは不要です。

Important

このリポジトリのファームウェアを書き込むと、M5Stackの工場出荷ファームウェアは置き換えられます。 元へ戻す場合は、M5Stack公式ドキュメントの復元手順に従ってM5Burnerを使用してください。

Webファームウェア書き込みの画面

3. MODを試す

公開MODやミニアプリはMOD Galleryから探せます。 試したいMODを選び、シミュレーターで試すか実機へ書き込めます。 ブロックで作られたサンプルは、そのままブロックエディタで開いて変更できます。

MOD Galleryの画面

Webツール

スタックチャン Webツールを使うと、セットアップ、設定、MOD制作をブラウザーから進められます。

スタックチャン Webツールのトップ画面

ツール 用途
ファームウェア書き込み 対応するM5StackへUSB経由でファームウェアを書き込む
設定 BLE経由でWi-Fiや本体設定を変更する
MOD Gallery 公開済みのMODを探し、試し、実機へ書き込む
ブロックエディタ BlocklyでMODを作り、シミュレーターや実機で動かす
Shape顔エディタ 目と口を配置してカスタムFaceを作る
シミュレーター WebAssembly版ファームウェアと3DモデルでMODを試す
MediaPipe BLE追従 カメラで捉えた顔と手の動きをBLEで送る

ブロックエディタの画面

対応ハードウェア

配布ファームウェアは、M5Stack、M5Stack Core2、M5Stack CoreS3、M5StackChan CoreS3に対応します。 標準構成と実機リリース検証の対象はM5StackChan CoreS3です。

Stack-chan RTとタカオ版Core2 + SG90向けのファームウェアは、ソースからビルドできます。 機種ごとのコマンドと制約はファームウェアの説明を参照してください。

自作する場合は、ケースで必要な部品と組み立て方を確認してください。 基板情報は回路図で確認できます。

リポジトリの構成

  • firmware: ホストファームウェア、モジュール、MOD、開発スクリプト
  • web: ファームウェア書き込み、設定、エディタ、Gallery、シミュレーター
  • case: 3Dプリント用のケースデータ
  • schematics: 回路図と基板レイアウト
  • docs: ロードマップ、仕様、運用文書、リリースノート

開発

コントリビューション

機能追加の提案、バグ報告、Pull Requestを歓迎します。 コントリビューションガイドを確認するか、Issueを作成してください。

開発を資金面で支援する場合は、GitHub Sponsorsを利用できます。

ライセンス

このリポジトリ配下のリソースはApache License 2.0のもとで配布されています。 LICENSEを確認してください。

BibTeX

@misc{stackchan,
  author       = {Shinya Ishikawa and the Stack-chan community},
  title        = {Stack-chan: A JavaScript-driven Super-kawaii Robot},
  year         = {2021},
  howpublished = {\url{https://github.com/stack-chan/stack-chan}},
  note         = {Open-source hardware and software.},
}