From f2f9d4e5bf35794cc34261d52beeef010ed29a91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A1=A9=E5=85=A5=E5=AD=94=E7=AB=A0?= Date: Tue, 19 Feb 2019 19:30:32 +0800 Subject: [PATCH] update m5stick quick start docs --- docs/ja/README.md | 2 +- ...5stack_core_get_started_Arduino_Windows.md | 2 +- .../m5stick/m5stick_quick_start.md | 14 +-- .../m5stick_quick_start_with_arduino_MacOS.md | 97 +++++++++++++++++++ ...5stick_quick_start_with_arduino_Windows.md | 79 +++++++++++++++ .../m5stick_quick_start_with_uiflow.md | 2 +- ...5stick_quick_start_with_arduino_Windows.md | 4 +- 7 files changed, 185 insertions(+), 15 deletions(-) create mode 100644 docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md create mode 100644 docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md diff --git a/docs/ja/README.md b/docs/ja/README.md index 32d7e3e6..e395ec0c 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -106,7 +106,7 @@   -[![unit_weight.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_weight_01.png)](ja/unit/weight) +[![unit_weight.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_weight_01.png)](ja/unit/weight)         [![unit_trace.png](http://m5-docs.oss-cn-shenzhen.aliyuncs.com/assets/img/product_pics/homepage_picture/unit/unit_trace_01.png)](ja/unit/trace)   diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 585e040f..e659712c 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -44,7 +44,7 @@ Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> -!> **Note:** *以下のように表示された場合は、アップデートです。* +!> **Note:** *以下のように表示された場合は、アップデートします。* diff --git a/docs/ja/quick_start/m5stick/m5stick_quick_start.md b/docs/ja/quick_start/m5stick/m5stick_quick_start.md index 680440bd..aa4d04b7 100644 --- a/docs/ja/quick_start/m5stick/m5stick_quick_start.md +++ b/docs/ja/quick_start/m5stick/m5stick_quick_start.md @@ -1,13 +1,7 @@ # M5Stick クイックスタート {docsify-ignore-all} -**好きなプログラミング言語を以下から選んでください。** +**好きなプログラミングスタイルを以下から選んでください。** - | ----|--- -[Arduino](ja/quick_start/m5stick/m5stick_quick_start_with_arduino) | [UiFlow(Blockly/MicroPython)](ja/quick_start/m5stick/m5stick_quick_start_with_uiflow) - - - - - - + | | +---|---|--- +[Arduino-MacOS](ja/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS) | [Arduino-Windows](ja/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows) | [UiFlow](ja/quick_start/m5stick/m5stick_quick_start_with_uiflow) diff --git a/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md new file mode 100644 index 00000000..81bf94cb --- /dev/null +++ b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_MacOS.md @@ -0,0 +1,97 @@ +# M5Stick クイックスタート(macOS, Arudino) {docsify-ignore-all} + +?> *環境設定の前に、シリアルドライバがインストールされているか確認いてください。もしまだの場合は[シリアル接続の確立方法](ja/related_documents/establish_serial_connection)を参照してください。* + +## テキストチュートリアル + +1. [環境設定](#環境設定) + + - Step1. [Arduino IDEインストール](#step1-arduino-ideインストール) + + - Step2. [ESP32ボードサポート](#step2-esp32ボードサポート) + + - Step3. [M5Stack ライブラリインストール](#step3-m5stack-libインストール) + + - Step4. [U8g2 ライブラリインストール](#step4-u8g2-libインストール) + +2. [例題](#例題) + +## 環境設定 + +### Step1. `Arduino IDE`インストール + +最初にArduino IDEをインストールします。ダウンロードアドレスは https://www.arduino.cc/en/Main/Software です。 + + + +### Step2. ESP32ボードサポート + +Arduino IDEを起動し、メニューから、`Arduino`->`Peferences`->`Settings`と選択します。 + + + + + +最新のESP32ボードマネージャにURLを追加してください。`Additional Boards Manager URLs: ` + +*最新のボードマネージャURLはこちら："https://dl.espressif.com/dl/package_esp32_index.json"* + + + +確認後、`Tools`->`Board:`->`Boards Manager...`を選び、新しいポップアップダイアログで、`ESP32`と入力して検索します。そして`Install`をクリックします。 + + + + + +### Step3. M5Stack Libインストール + +Arduino IDEを起動し、メニューから`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...`を選択します。 + +検索ボックスに`m5stack`と入力して検索し、M5Stackのライブラリをインストールします。 + + + + + +### Step4. U8g2 Libインストール + +まずArduino IDEを開き、`Sketch`->`Include Library`->`Manage Libraries...`の順に選択します。検索窓で`U8g2`を検索し、インストールします。 + + + +## 例題 + +USBケーブルをM5Stickに接続し、ボードとシリアルポートを選択します。そしてサンプルプログラムをコンパイルし、アップロードしてみましょう。 + +### 1. ボードとシリアルポートを選択 + +Arduino IDEを起動し、メニューから`ツール -> ボード -> M5Stack-Core-ESP32`とボードを選択します。 + +次に、メニューから`ツール -> シリアルポート -> /dev/cu.SLAB_USBtoUART` とシリアルポートを選択します。 + + + +### 2. サンプルスケッチ + +サンプルスケッチを利用して、定番のHelloWorldを表示してみましょう。メニューから`ファイル -> スケッチ例 -> M5Stack -> Stick -> FactoryTest`と選択します。 + + + +**コンパイルしてアップロード実行すると、M5Stickの画面に `Hello World! Exist` と表示されます。** + +## ノート + +もしシリアルポートが見つからない場合は、Macの`システム環境設定 -> セキュリティとプライバシー`を開いてブロックされているアプリを許可してください。それでもダメな場合は、再度シリアルドライバをインストールしてください。 + + + + + + + +?> **Tip** **もしmacOSのパーミッションについてもっと詳しい情報が知りたい方は、次のリンクを参照してください。** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html + +## ビデオチュートリアル + + \ No newline at end of file diff --git a/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md new file mode 100644 index 00000000..69a12211 --- /dev/null +++ b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md @@ -0,0 +1,79 @@ +# M5Stick クイックスタート(Windows, Arudino) {docsify-ignore-all} + +?> `USB driver`、`Git`、`Arduino IDE` をインストールしているか確認してください。 もしまだの場合は、 [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) と [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino)を参照してください。 + +## コンテンツ + +1. [環境設定](#環境設定) + + - [Step1. arduino-ESP32サポートのダウンロード](#step1-arduino-esp32サポートのダウンロード) + + - [Step2. M5Stackライブラリのダウンロード](#step2-m5stackライブラリのダウンロード) + + - [Step3. U8g2 ライブラリインストール](#step3-u8g2-libインストール) + +2. [例題](#例題) + +## 環境設定 + +### Step1. arduino-ESP32サポートのダウンロード + +Arduino IDEを起動し、メニューから`File`->`Peferences`->`Settings`と選択します。 + +以下のようにGitHubからリポジトリを取得します。（少し時間がかかります） + + + + + +最新のESP32ボード管理URLを追加してください`Additional Boards Manager URLs: ` + +*最新のボードマネージャURLはこちら："https://dl.espressif.com/dl/package_esp32_index.json"* + + + +`Tools`->`Board:`->`Boards Manager...`を選択し、新しいポップアップダイアログで、`ESP32`と入力して検索します。`Install`をクリックします。 + + + + + +### Step2. M5Stackライブラリのダウンロード + +Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> ライブラリを管理...`と選択します。開いたウィンドウの検索ボックスに`m5stack`と検索し、出てきたライブラリをインストールします。 + + + + + +!> **Note:** *以下のように表示された場合は、アップデートします。* + + + +### Step3. U8g2 Libインストール + +まずArduino IDEを開き、`Sketch`->`Include Library`->`Manage Libraries...`の順に選択します。検索窓で`U8g2`を検索し、インストールします。 + + + +## 例題 + +このセクションではArduinoでプログラムができるかを確認します。最初に[MPU9250付きのM5Stick](https://img.alicdn.com/imgextra/i4/136588748/O1CN012EUdFpJIthEANlx_!!136588748.jpg)とPCをUSBケーブルで接続してください。そしてM5Stickが接続されているシリアルポートを選択し、サンプルプログラムを実行してみましょう。 + +### 1. `FactoryTest.ino`サンプルスケッチ実行 + +Arduino IDEのメニューから`ツール`を選択し、ボードとボーレート、シリアルポートを次のように選択します。M5Stack-Core-ESP32、921600、COMx（シリアルポートの番号はお使いの環境によって変わります。) + + + +メニューから`ファイル -> スケッチ例 -> M5Stack -> Stick -> FactoryTest`を選択します。 + + + +コンパイル＆アップロード実行します。 + + + +**M5Stick画面に"Hello World! Exist"とメッセージが表示されます。** + +?> *もしM5Stack Libを更新したい場合はこちらの記事を参照してください。[Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/ja/quick_start/m5stick/m5stick_quick_start_with_uiflow.md b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_uiflow.md index 5fdc8d61..eb189e89 100644 --- a/docs/ja/quick_start/m5stick/m5stick_quick_start_with_uiflow.md +++ b/docs/ja/quick_start/m5stick/m5stick_quick_start_with_uiflow.md @@ -36,7 +36,7 @@ 初回起動する際、デフォルトで設定ページが表示されます。OLEDスクリーンに**AP名(SSID)**と**WiFi設定アドレス(192.168.4.1)**が表示されます。 -PCまたはスマホを利用して、表示されているAPへ接続します。接続が成功したら、ブラウザからWiFi設定アドレスにアクセスします。そして普段使用しているネットワークのSSIDとパスワードを入力後、`Save`をクリックし、接続が成功するのを待ちます。 +PCまたはスマホを利用して、表示されているAPへ接続します。接続が成功したら、ブラウザからWiFi設定アドレスにアクセスします。そして普段使用しているネットワークのSSIDとパスワードを入力して保存の後、接続が成功するのを待ちます。 diff --git a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md index 01a4dd45..28e6a4cc 100644 --- a/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md +++ b/docs/zh_CN/quick_start/m5stick/m5stick_quick_start_with_arduino_Windows.md @@ -10,7 +10,7 @@ - [Step2. 安装Arduino-M5Stack库](#Step2-安装Arduino-M5Stack库) - - [Step4. 安装U8g2库](#Step4-安装U8g2库) + - [Step3. 安装U8g2库](#Step3-安装U8g2库) 2. [示例](#示例) @@ -50,7 +50,7 @@ -### Step4. 安装U8g2库 +### Step3. 安装U8g2库 如果您还没安装`U8g2`库的话，打开Arduino IDE，并点击`Sketch`->`Include Library`->`Manage Libraries...`，搜索`U8g2`进行安装。