From 5a933ff4e71f789ce965e757ffab8d938488fb29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A1=A9=E5=85=A5=E5=AD=94=E7=AB=A0?= Date: Thu, 21 Mar 2019 19:22:50 +0800 Subject: [PATCH] update some docs ja --- docs/ja/core/face_kit.md | 12 ++++- .../faces/gameboy_burn_a_nes_game.md | 36 ++++++++++--- docs/ja/unit/makey.md | 50 ++++++++++++------- docs/ja/unit/pir.md | 28 +++++++---- 4 files changed, 86 insertions(+), 40 deletions(-) diff --git a/docs/ja/core/face_kit.md b/docs/ja/core/face_kit.md index cdbb9ca2..971eeee9 100644 --- a/docs/ja/core/face_kit.md +++ b/docs/ja/core/face_kit.md @@ -4,9 +4,9 @@ ## 概要 -**FACES Kit** は M5Core GRAY、電卓キーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ(DuPont線、ストラップ、M3ネジなど)で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/base/face_base)のページで詳細を確認できます。 +**FACES Kit** は M5Core GRAY、電卓キーボード, FACESベース, FACESチャージャー、そしていくつかのアクセサリ(デュポン線、ストラップ、M3ネジなど)で構成されたキットです。 現在、ファンクショナルキーボードはGameBoy、 電卓、 QWERTYの3つがあります。今後、さらに別のキーボードがFACESキットに追加される予定です。Arduino IDEまたはMicroPythonを使用してプログラムすることができます。異なるアプリケーションに対し、それぞれ対応したキーボードをFACESベースにスタックして、利用することができます。[FACES Base](ja/base/face_base)のページで詳細を確認できます。 -*それぞれのキーボードには、**MEGA328**チップが統合されており、ボタンを押した時に対応した値(**16進フォーマット**)がキーボードからM5Coreに送信されます。それぞれI2Cを使って通信しており、各キーボードのI2Cアドレスは**0x08**です。* +*それぞれのキーボードには、**MEGA328**チップが統合されており、ボタンを押した時に対応した値(**16進フォーマット**)がキーボードからM5Coreに送信されます。それぞれI2Cを使って通信しており、各キーボードからM5Coreにアクセスする際に使用するするI2Cアドレスは**0x08**です。* ***注意:*** *もし自分でFACES Kitの工場出荷時のファームウェアを書き込みたい場合は、[公式サイト](https://m5stack.com/download)から M5Burnerをダウンロードしてください。FACESとPCをUSB Type-Cケーブルで接続し、M5Burnerを使って書き込みを行います。* @@ -62,6 +62,14 @@ +### 関連リンク + +- **[サンプルコード](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/FACES)** + +- **[MEGA328Pファームウェア](https://github.com/m5stack/FACES-Firmware)** + +- **[購入リンク](https://www.aliexpress.com/item/M5Stack-NEW-Offer-ESP32-Open-Source-Faces-Pocket-Computer-with-Keyboard-Gameboy-Calculator-for-Micropython-Arduino/32843973578.html)** + ### ノート *FACES Kitの中には[Gray](ja/core/gray)コアが同梱されています。FACESではその他のコアも利用可能です。各コアの主な仕様は以下の表の通りです。* diff --git a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md index 615fc5a1..19cb5d3f 100644 --- a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,8 +1,6 @@ # NESゲーム クイックスタート (Windows向け) {docsify-ignore-all} - - -*このページでは、NESゲームを遊ぶために必要なソフトウェアの書き込み方法を紹介します。* +*このページでは、FACESとGameboy keyを利用して、NESゲームを遊ぶために必要なソフトウェアの書き込み方法を紹介します。* ## コンテンツ @@ -12,25 +10,48 @@ 3. [デバイスのリセット](#デバイスのリセット) -## Dァームウェアのダウンロード +## ファームウェアのダウンロード ゲームボーイエミュレータのファイル `firmware.zip` を [Github](https://github.com/m5stack/M5Stack-nesemu) からダウンロードして解凍します。 - + +### Windows +### Mac + + ## ゲームファイルの書き込み -[ここ](https://www.espressif.com/en/support/download/other-tools)からフラッシュ書き込みツール(Flash Download Tools (ESP8266 & ESP32) v3.6.5)をダウンロード、実行し、`ESP32 DownloadTool` を選択、書き込む4つのファイルを指定します。そして、図の(Step2 シリアルポート選択)、(Step3 Erase消去)、(Step4 書き込み)を実行します。 +### Windows + +[ここ](https://www.espressif.com/en/support/download/other-tools)から最新のフラッシュ書き込みツール(Flash Download Tools (ESP8266 & ESP32) v3.6.5)をダウンロード、実行し、`ESP32 DownloadTool` を選択、書き込む4つのファイルを指定します。そして、図の(Step2 シリアルポート選択)、(Step3 Erase消去)、(Step4 書き込み)を実行します。 - +### Mac + +### (1) esptoolをインストール + +`ターミナル`を開いて、`pip install esptool`のコマンドを実行します。 + + + +#### (2) ファームウェアの書き込み + +`ターミナル`を開いて、`firmware.zip`のある場所に移動し、以下のコマンドを実行します。 + +```sh +unzip firmware.zip +cd firmware +esptool.py erase_flash +sh flash.sh +``` ## デバイスのリセット @@ -38,5 +59,4 @@ FACESをリセットして再起動したら、赤い帽子のヒゲおじさん - ?> Tip **もし他のゲームで遊びたい場合は、`ゲームファイル`(.nes)を書き換えてください。** diff --git a/docs/ja/unit/makey.md b/docs/ja/unit/makey.md index 59f1ea76..51729f3f 100644 --- a/docs/ja/unit/makey.md +++ b/docs/ja/unit/makey.md @@ -4,35 +4,55 @@ *** -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      :electric_plug:**[回路図](#回路図)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**      :electric_plug:**[回路図](#回路図)**      🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html)** ## 概要 -**MAKEY**ユニットはATmega328Pを内蔵し、自由に使用可能な16のIOピンを備えています。I2Cでコントロール可能です。I2Cアドレスは**0x51**です。 +**MAKEY**ユニットはATmega328Pを内蔵し、自由に使用可能な16のIOピンを備えています。I2Cでコントロール可能です。GroveポートAで接続し、I2Cアドレスは**0x51**です。 + +*注意事項:** + +1)ユニットのブザーで鳴らす場合 + +ユニットのGNDホールに接続したデュポン線の端を左手に持ちます。 + +もうひとつ別のデュポン線の端を右手に持ちます。右手のデュポン線をユニットのトーンホールに触れさせると、MAKEYから対応する音が鳴ります。 + +2)M5Coreのスピーカーで鳴らす場合 + +**GroveポートA**でM5Coreにユニットを接続し、こちらの[サンプルコード](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version)を書き込みます。 + +あとはMakeyで鳴らすのと同じで、ユニットのGNDホールに接続したデュポン線の端を左手に持ちます。 + +もうひとつ別のデュポン線の端を右手に持ちます。右手のデュポン線をユニットのトーンホールに触れさせると、M5Coreから対応する音が鳴ります。 ## 特徴 - ATmega328P 内蔵 -- 16 Keys Fruit Piano(PD0-7 & PB0-5) -- 1x NeoPixel pin(PC2) -- 1x Buzzer pin(PC3) - ブザー内蔵 -- Grove インターフェース -- GROVE接口,支持[UIFlow](http://flow.m5stack.com)编程,[Arduino](http://www.arduino.cc)编程 +- GROVEインターフェース、プログラミングサポート [UIFlow](http://flow.m5stack.com)、[Arduino](http://www.arduino.cc) - LEGO 互換ホール ## アプリケーション -- フルーツピアノ -- Adafruitのライブラリを用いたRGB アプリケーション +- フルートピアノ +- Adafruitのライブラリを用いたRGBアプリケーション +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + +- **[モジュール内のMEGA328ファームウェア](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)** + ## サンプルコード ### 1. Arduino IDE -*以下のコードは不完全です(説明のためだけに). 完全なコードが必要な場合は、ここをクリックしてください[サンプルコード](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino).* +*以下はソースコードの一部です。完全なソースコードは[こちら](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino)。* ```arduino #include @@ -58,7 +78,7 @@ while (Wire.available()) { ### 2. UIFlow -*特定のルーチンについてはここをクリックしてください[サンプルコード](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/UIFlow).* +*以下はソースコードの一部です。完全なソースコードは[こちら](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/UIFlow)。* @@ -74,11 +94,3 @@ while (Wire.available()) { - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** - -- **[モジュール内のMEGA328ファームウェア](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)** \ No newline at end of file diff --git a/docs/ja/unit/pir.md b/docs/ja/unit/pir.md index 0bb739dd..feddf976 100644 --- a/docs/ja/unit/pir.md +++ b/docs/ja/unit/pir.md @@ -4,23 +4,35 @@ *** -:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** +:memo:**[概要](#概要)**      :octocat:**[サンプルコード](#サンプルコード)**       :electric_plug:**[回路図](#回路図)**       🛒**[購入リンク](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html)** ## 概要 -**PIR**ユニットは人間の動き(モーション)を検出する事が可能です。 +**PIR**ユニットは人間の動き(モーション)を検出する事が可能な赤外線センサーユニットです。誰かが通りすぎたかどうかを検知します。赤外線の変化を検知すると一定時間(ディレイタイムの間)HIGHを出力します。検知し続けている間はHIGHのままですが、人が離れたらLOWを出力します。 + +**Grove port B**でM5Coreと通信します。 ## 特徴 - 測定可能距離 150cm -- サポート[UIFlow](http://flow.m5stack.com)プログラミング, [Arduino](http://www.arduino.cc)プログラミング +- ディレイタイム: 2s +- 検知範囲: < 100° +- 待機電流: < 60uA +- 動作温度: -20 - 80 °C +- GROVEインターフェース、サポートプログラミング[UIFlow](http://flow.m5stack.com)、[Arduino](http://www.arduino.cc) - LEGO 互換ホール +## 関連リンク + +- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[フォーラム](http://forum.m5stack.com/)** + ## サンプルコード ### 1. Arduino IDE -*以下のコードは不完全です(説明のためだけに). 完全なコードが必要な場合は、ここをクリックしてください[サンプルコード](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/Arduino).* +*以下のソースコードは一部です。完全なソースコードは[こちら](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/Arduino)。* ```arduino #include @@ -36,7 +48,7 @@ M5.update(); ### 2. UIFlow -*特定のルーチンについてはここをクリックしてください[サンプルコード](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow).* +*以下のソースコードは一部です。完全なソースコードは[こちら](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow)。* @@ -50,9 +62,3 @@ M5.update(); M5Core(GROVEインターフェースB)GPIO36GPIO265VGND 人体赤外線誘導Unit赤外線検知ピン 5VGND - -## 関連リンク - -- **[公式ビデオ](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** - -- **[フォーラム](http://forum.m5stack.com/)** \ No newline at end of file