diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/2.png b/docs/assets/img/getting_started_pics/establish_serial_connection/2.png index 386b8e4d..a92835cf 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/2.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/2.png differ diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/3.png b/docs/assets/img/getting_started_pics/establish_serial_connection/3.png index 0d43316e..136c804a 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/3.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/3.png differ diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/4.png b/docs/assets/img/getting_started_pics/establish_serial_connection/4.png index b855d6a1..a31185a6 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/4.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/4.png differ diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/5.png b/docs/assets/img/getting_started_pics/establish_serial_connection/5.png index 78cd3fbc..6f307dc7 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/5.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/5.png differ diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/6.png b/docs/assets/img/getting_started_pics/establish_serial_connection/6.png index 6d5b067f..533410d4 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/6.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/6.png differ diff --git a/docs/assets/img/getting_started_pics/establish_serial_connection/macOS_CP2104_dmg.png b/docs/assets/img/getting_started_pics/establish_serial_connection/macOS_CP2104_dmg.png index 5bff40d9..9be1f477 100644 Binary files a/docs/assets/img/getting_started_pics/establish_serial_connection/macOS_CP2104_dmg.png and b/docs/assets/img/getting_started_pics/establish_serial_connection/macOS_CP2104_dmg.png differ diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 968a66d1..69f38517 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,6 +1,6 @@ # M5Core Quick Start(macOS, Arudino) -!> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). +?> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). ## CONTENT diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 4c8e785b..5a7af652 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,6 +1,6 @@ # M5Core Quick Start(Windows, Arudino) -!> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). +?> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). ## CONTENT diff --git a/docs/en/related_documents/establish_serial_connection.md b/docs/en/related_documents/establish_serial_connection.md index fcbaff8e..ff6efe1a 100644 --- a/docs/en/related_documents/establish_serial_connection.md +++ b/docs/en/related_documents/establish_serial_connection.md @@ -10,47 +10,29 @@ **[Download the SiLabs CP2104 Driver](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** -**As the disk image SiLabsUSBDriverDisk.dmg is downloaded, mount it. Proceed according to the instructions OK.** +**After the disk image `SiLabsUSBDriverDisk.dmg` was downloaded, mount it.** -
- -
+**And install this USB driver following those screenshots.** -
- -
+ -
- -
+ -
- -
+ -
- -
+ -
- -
+ -
- -
+ -
- -
+ -
- -
+ -
- -
+ + + ### 2. Check port on MacOS @@ -70,23 +52,15 @@ **Choice the version of USB driver according to your windows version(Windows7/8/10).** -
- -
+ - + -
- -
+ -
- -
+ ### 2. Check port on Windows @@ -94,6 +68,4 @@ **Figures below show serial port for M5Stack Core board** -
- -
+ - + ### Step2. ESP32ボードサポート -ターミナルを開いて次のコマンドを実行します。(全文コピーして、ターミナルに貼り付けてッターン!) +Arduino IDEを起動し、メニューか`Arduino`->`Peferences`->`Settings` -```shell -mkdir -p ~/Documents/Arduino/hardware/espressif && \ -cd ~/Documents/Arduino/hardware/espressif && \ -git clone https://github.com/espressif/arduino-esp32.git esp32 && \ -cd esp32 && \ -git submodule update --init --recursive && \ -cd tools && \ -python get.py -``` + -デフォルトでスケッチが保存される場所は ~/Documents/Arduino です。もしArduino IDEの設定でスケッチブックの位置を変更している場合や、何か問題が発生したときは必要に応じて上記のコマンドを調整してください。 + -?> **Tip** もし下記のエラーが発生したら: `xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),` -`missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, ターミナルで`xcode-select --install`を実行し、Arduino IDEを再起動してみてください。 +このオプションに最新のESP32ボード管理URLを追加してください`Additional Boards Manager URLs: ` -?> **Tip** もし下記のエラーが発生したら: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol` `version (_ssl.c:590) when running python get.py`, 上記のコマンドの`python get.py`の行を`python3 get.py`に置き換えて実行し、Arduino IDEを再起動します。 +*最新の掲示板管理URLはこちら:"https://github.com/espressif/arduino-esp32/releases/download/1.0.1-rc1/package_esp32_dev_index.json"* + + + +確認後,選ぶ`Tools`->`Board:`->`Boards Manager...`,新しいポップアップダイアログで、入力して検索します`ESP32`,クリック`Install` + + + + ### Step3. M5Stack Libインストール @@ -55,13 +48,9 @@ Arduino IDEを起動し、メニューから`スケッチ`->`ライブラリを 検索ボックスに`m5stack`と入力して検索し、M5Stackのライブラリをインストールします。 -
- -
+ -
- -
+ ## 例題 @@ -71,43 +60,28 @@ USBケーブルをM5Stackに接続し、ボードとシリアルポートを選 Arduino IDEを起動し、メニューから`ツール -> ボード -> M5Stack-Core-ESP32`とボードを選択します。 -
- -
- 次に、メニューから`ツール -> シリアルポート -> /dev/cu.SLAB_USBtoUART` とシリアルポートを選択します。 -
- -
+ + ### 2. サンプルスケッチ サンプルスケッチを利用して、定番のHelloWorldを表示してみましょう。メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> HelloWorld`と選択します。 -
- -
+ コンパイルしてアップロード実行すると、M5Stackの画面に `Hello World!` と表示されます。 -
- -
+ ## ノート もしシリアルポートが見つからない場合は、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/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index b1ee70fb..8155feb3 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 @@ -1,8 +1,6 @@ # M5Core クイックスタート(Windows, Arudino) - - -?> **Tip** もしMacをお使いの方は[こちら](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)を参照してください。 +?> `USB driver`、`Git`、`Arduino IDE` をインストールしているか確認してください。 もしまだの場合は、 [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) と [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino)を参照してください。 ## コンテンツ @@ -14,47 +12,42 @@ 2. [例題](#例題) -?> **Tip** *もしM5Stack Libを更新したい場合はこちらの記事を参照してください。[Arduino IDEのM5Stackライブラリ更新方法](/ja/related_documents/upgrade_m5stack_lib).* - -?> **Note** *`USB driver`、`Git`、`Arduino IDE(Installation path: C:\Program Files\Arduino)` をインストールしているか確認してください。 もしまだの場合は、 [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) と [GitとArduino IDEのインストール方法](/ja/related_documents/how_to_install_git_and_arduino)を参照してください。もしあなたがすでにArduino IDEをデフォルトの`C:\Program Files\Arduino`以外にインストールしている場合は、デフォルトパスに再インストールしてください。* - ## 環境設定 ### Step1. arduino-ESP32サポートのダウンロード -次のバッチファイルをダウンロードして、実行してください。[download_arduino_esp32_support.bat](https://github.com/m5stack/m5-docs/tree/master/docs/assets/scripts/download_arduino_esp32_support.bat) -
- -
+Arduino IDEを起動し、メニューか`File`->`Peferences`->`Settings` + 以下のようにGitHubからリポジトリを取得します。(少し時間がかかります) -
- -
+ -
- -
+ +このオプションに最新のESP32ボード管理URLを追加してください`Additional Boards Manager URLs: ` + +*最新の掲示板管理URLはこちら:"https://github.com/espressif/arduino-esp32/releases/download/1.0.1-rc1/package_esp32_dev_index.json"* + + + +確認後,選ぶ`Tools`->`Board:`->`Boards Manager...`,新しいポップアップダイアログで、入力して検索します`ESP32`,クリック`Install` + + + + ### Step2. M5Stackライブラリのダウンロード Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> ライブラリを管理...`と選択します。開いたウィンドウの検索ボックスに`m5stack`と検索し、出てきたライブラリをインストールします。 -
- -
+ -
- -
+ !> **Note:** *以下のように表示された場合は、アップデートです。* -
- -
+ ## 例題 @@ -64,21 +57,15 @@ Arduino IDEを開いて`スケッチ -> ライブラリをインクルード -> Arduino IDEのメニューから`ツール`を選択し、ボードとボーレート、シリアルポートを次のように選択します。M5Stack-Core-ESP32、921600、COMx(シリアルポートの番号はお使いの環境によって変わります。) -
- -
+ メニューから`ファイル -> スケッチ例 -> M5Stack -> Basics -> FactoryTest`を選択します。 -
- -
+ コンパイル&アップロード実行します。 -
- -
+ ### 2. 新しいM5Stackのプログラム @@ -106,3 +93,5 @@ void loop() { ``` コンパイルしてアップロードすると、M5Stackの画面に"Hello World! M5Stack is running successfully!"とメッセージが表示されます。 + +?> *もしM5Stack Libを更新したい場合はこちらの記事を参照してください。[Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md index cbdecc5f..71d71d5e 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md @@ -4,6 +4,6 @@ ## 好きなプログラミング言語を以下から選んでください。 - | ----|--- -[Arduino](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) + | | +---|---|--- +[MacOS](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Windows](ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UiFlow(Blockly/MicroPython)](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/ja/related_documents/establish_serial_connection.md b/docs/ja/related_documents/establish_serial_connection.md index 807d2668..656a824a 100644 --- a/docs/ja/related_documents/establish_serial_connection.md +++ b/docs/ja/related_documents/establish_serial_connection.md @@ -1,6 +1,6 @@ # シリアル接続の確立方法 -**[MacOS](#for-macOS)**      **[Windows](#for-windows)** +**[MacOS](#acOS)**      **[Windows](#windows)** **このページでは、M5StackとPCとの間でシリアル接続を確立するための方法を説明します。** diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 24671571..f1dadc4a 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,7 +1,7 @@ # Core 上手指南(macOS, Arudino) -!> 在配置环境之前,先确保你已经安装了USB驱动,并且M5Core能通过串口与PC通信。 如果还没的话,看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection). +?> 在配置环境之前,先确保你已经安装了USB驱动,并且M5Core能通过串口与PC通信。 如果还没的话,看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection). ## 目录 @@ -31,13 +31,13 @@ -添加最新的ESP32版管理网址到`Additional Boards Manager URLs: `选项 +添加最新的ESP32板管理网址到`Additional Boards Manager URLs: `选项 *目前最新的板管理网址是这个:"https://github.com/espressif/arduino-esp32/releases/download/1.0.1-rc1/package_esp32_dev_index.json"* -都确定OK之后,选择选择`Tools`->`Board:`->`Boards Manager...`,在新弹出的对话框中,输入并搜索`ESP32`,点击`安装` +都确定OK之后,选择`Tools`->`Board:`->`Boards Manager...`,在新弹出的对话框中,输入并搜索`ESP32`,点击`安装` diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index ea3584a7..0838416a 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,6 +1,6 @@ # Core 上手指南(Windows, Arudino) -!> 建议你先确认安装了`USB驱动`和`Arduino IDE`。 如果还没的话,阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 +?> 建议你先确认安装了`USB驱动`和`Arduino IDE`。 如果还没的话,阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 ## 目录 @@ -15,8 +15,6 @@ ## 1. 配置环境 -#### (*仅仅只需两步就能完成安装,并开始开发M5Core啦*) - ### Step1. 下载Arduino-ESP32的支持包 打开Arduino IDE,选择`File`->`Peferences`->`Settings` diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md index 3803685c..5cde36bf 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md @@ -6,4 +6,4 @@ | | ---|---|--- -[MacOS](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Windows](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UiFlow(Blockly/MicroPython)](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) \ No newline at end of file +[MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Windows](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [UiFlow(Blockly/MicroPython)](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) \ No newline at end of file