From 57c536e728273bb6ee2146d627c414177fbf3146 Mon Sep 17 00:00:00 2001 From: LiHuashen <854410664@qq.com> Date: Thu, 28 Feb 2019 19:28:01 +0800 Subject: [PATCH] updated faq (english version) --- docs/en/faq.md | 36 +++++++++++++++- .../m5stack_core_get_started_MicroPython.md | 8 ++-- .../m5stack_core_get_started_MicroPython.md | 41 ++++++++----------- docs/zh_CN/faq.md | 12 +++--- ...5stack_core_get_started_Arduino_Windows.md | 26 ++++++------ .../m5stack_core_get_started_MicroPython.md | 6 ++- 6 files changed, 80 insertions(+), 49 deletions(-) diff --git a/docs/en/faq.md b/docs/en/faq.md index 50e13a1a..d43d28a4 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -1,5 +1,39 @@ # FAQ {docsify-ignore-all} +**[Core](#Core)**      **[Unit](#Unit)** +## Core -## (coming soon...) \ No newline at end of file +- **Q1: What's the difference between those Cores?** + + The main difference between these Cores is the internal hardware configuration and kit matching. From the basic version to the upgraded version, the attitude sensor MPU9250 is added and the RAM and FLASH are increased. For details, please visit [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_zh_CN.md)。 + + + + + +- **Q2: How to turn off the speaker function of M5Core？** + + Add the following statement to functioin Setup(){} + + ```arduino + dacWrite(M5STACKFIRE_SPEAKER_PIN, 0); + ``` + +- **Q3: Some modules cannot be downloaded after stacking with M5Core, such as USB module and M5Core stacking.** + + Probably after the stack, the pins GPIO0 and M5Core on the M5-Bus bus are not very well connected. + + In this case, when downloading the program, GPIO0 should always remain low, but because the contact is not good, GPIO0 can not remain low all the time, so the download fails. + + **Solution:** Manually let GPIO0 connect to GND during the download process to ensure that it is pulled low enough。 + +- **Q4: After the [M5GO bottom](en/base/m5go_bottom) is stacked with the M5Core, the M5Core cannot be turned on, but the base battery in this M5GO bottom is fully charged.** + + It may be that after the stacking, the BATTERY of the lower left corner of the M5-Bus bus on the base is not well connected to the M5Core. This is caused by the deviation of the welding position during production. After the bus pin welding position is slightly biased, it is easy to see that the BATTERY pin is not in good contact with the M5Core. + + **Solution:** Re-soldering the M5-Bus bus header, the pin header must be strictly aligned with the pad position. + + \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index fb7c46bc..4eab92f3 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -112,8 +112,10 @@ Now, run it and enjoy your musical work! **UIFlow Tutorial** - + -**Getting started with UIFlow (Mac & Linux) (This video is a little outdated now)** + - \ No newline at end of file + \ No newline at end of file diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md index c4ab6fb6..ebe2041e 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -6,9 +6,7 @@ M5Stackを起動したらすぐに `UPLOAD` ボタンを連打します。以下の画面に遷移しなかった場合は、M5Stack本体横の赤いリセットスイッチを押して、再起動してやり直してください。 -
- -
+ ?> **Note** *最初の起動では何もしないと、デモプログラムに遷移します。Wi-Fiの設定が完了していると自動的にWi-FiのAPに接続しにいきます。Wi-Fiを再設定したい場合は、`SETUP`ボタンを押してください。* @@ -24,17 +22,15 @@ M5Stackを起動したらすぐに `UPLOAD` ボタンを連打します。以下 1. M5Stackに表示されている二次元コードをあなたのスマートフォンやタブレットPCで読み取ってプログラムを始めることができます。もしPCでプログラムをする場合は、ブラウザで次のURLを入力してください。 `flow.m5stack.com` -
- -
+ + 2. UIFlowを利用するためには、お持ちのM5Stackをペアリングする必要があります。 最初にUIFlowの画面の右上にある歯車の設定を開きます。`APIKEY` の欄にM5Stack本体に表示されているAPIKEYを入力します。(写真の場合は `9C6469`) 入力が終わったら`SAVE`をクリックします。 -
- -
+ + 正しいAPIKEYが入力されるとUIFlowはあなたのM5Stackと接続します。 @@ -46,17 +42,14 @@ M5Stackを起動したらすぐに `UPLOAD` ボタンを連打します。以下 4種類のUI要素が用意されており、UIFlow内のUIエディタにドラッグすることで利用できます。試しにいくつかUIオブジェクトを配置して`実行(Run)`をクリックしてみましょう。 -
- -
+ ### b. Blocklyでプログラミング `Emoji`クラスの中にある`Set emoji map in0`ブロックをドラッグしてブロックエディタに配置し、`実行(Run)`をクリックしてみましょう。 -
- -
+ + *このデモのソースコード: https://github.com/m5stack/M5-ProductExampleCodes/blob/master/Core/M5_draw_heart.m5f* @@ -78,9 +71,7 @@ btnC = M5Button(name='ButtonC', text='ButtonC', visibility=False) lcd.print("Hello M5Stack") ``` -
- -
+ M5Stackの画面に`Hello M5Stack`と表示されます。 @@ -90,9 +81,7 @@ M5Stackを用いればたった数分でミュージックプレイヤーを作 `loop`、`music`、`timer`から下図のブロックをブロックエディタに配置します。 -
- -
+ 実行すると音楽がなります！ @@ -100,7 +89,7 @@ M5Stackを用いればたった数分でミュージックプレイヤーを作 ## 完成 -?> **Note** *M5StackへのWorkShop等のお問い合わせはこちらまで→ * +?> **Note** *UIFlowでのプログラミングについて知りたい場合は、[UIFlowのチュートリアルドキュメント](https://m5stack.github.io/UIFlow_doc/ja/index.html)を読んでください。* ## ビデオチュートリアル @@ -110,8 +99,10 @@ M5Stackを用いればたった数分でミュージックプレイヤーを作 **UIFlowチュートリアル** - + -**UIFlow (Mac & Linux) 初めの一歩（この動画は少し内容が古いです）** + - \ No newline at end of file + \ No newline at end of file diff --git a/docs/zh_CN/faq.md b/docs/zh_CN/faq.md index 30ccb07c..004a39f7 100644 --- a/docs/zh_CN/faq.md +++ b/docs/zh_CN/faq.md @@ -1,6 +1,8 @@ # 常见问题解答 {docsify-ignore-all} -**[主控](#主控)**      **[模块](#模块)**      **[底座](#底座)**      **[单元](#单元)** +**[主控](#主控)**      **[单元](#单元)** + + ## 主控 @@ -20,10 +22,6 @@ dacWrite(M5STACKFIRE_SPEAKER_PIN, 0); ``` -- **Q2: ESP32 有哪些特殊的 GPIO 管脚需要注意？** - - ESP32 有 34 个 GPIO 管脚，其中 GPIO 34-39 仅用作输入，不能作为输出，其他的既可以作为输入又可以作为输出管脚。 - - **Q3: 有些模块与 M5Core 堆叠之后不能下载程序，比如 USB 模块与 M5Core 堆叠** 可能是堆叠之后，M5-Bus 总线上的引脚 GPIO0 与 M5Core 接触不太好。这种情况下，在下载程序的时候，GPIO0 理应会一直保持低电平的，可是因为接触不好，GPIO0 不能一直保持低电平，所以下载失败。 @@ -46,6 +44,10 @@ +- **Q6: ESP32 有哪些特殊的 GPIO 管脚需要注意？** + + ESP32 有 34 个 GPIO 管脚，其中 GPIO 34-39 仅用作输入，不能作为输出，其他的既可以作为输入又可以作为输出管脚。 + ## 单元 - **Q1: M5Stack 的多款摄像头 Unit 之间有什么区别？** 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 406dd4c1..a65a4376 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) {docsify-ignore-all} -?> 建议你先确认安装了`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)。 ## 目录 @@ -23,13 +23,13 @@ -复制下面最新的ESP32板管理网址到 `Additional Boards Manager URLs: `中 +复制下面最新的 ESP32 板管理网址到 `Additional Boards Manager URLs: `中 *目前最新的板管理网址是这个：https://dl.espressif.com/dl/package_esp32_index.json* -选择`Tools`->`Board:`->`Boards Manager...`，在新弹出的对话框中，输入并搜索`ESP32`，点击`安装` +选择 `Tools`->`Board:`->`Boards Manager...`，在新弹出的对话框中，输入并搜索 `ESP32`，点击`安装` @@ -37,28 +37,28 @@ ### Step2. 安装Arduino-M5Stack库 -打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` -搜索`M5Stack`并安装，如下图所示。 +打开 Arduino IDE, 然后选择 `Sketch`->`Include Library`->`Manage Libraries...` +搜索 `M5Stack` 并安装，如下图所示。 -!> *如果显示下图这样，表示你需要升级Arduino-M5Stack库* +!> *如果显示下图这样，表示您需要升级Arduino-M5Stack库* ## 示例 -这部分是为了验证现在你是否能通过Arduino IDE对M5Core编程。 +这部分是为了验证现在您是否能通过 Arduino IDE 对 M5Core 编程。 -现在，用USB线连接M5Core和PC，然后打开Arduino IDE，并选择正确的串口号。这个串口号其实就是连接M5Core的串口号，注意不要选错啦。 +现在，用 USB 线连接 M5Core 和 PC ，然后打开 Arduino IDE，并选择正确的串口号。这个串口号其实就是连接 M5Core 的串口号，注意不要选错啦。 -选择一个example例程，然后上传运行试试。 +选择一个 example 例程，然后上传运行试试。 ### 1. 运行一个示例程序，比如`FactoryTest.ino` -选择你板子的名字，波特率和串口号： M5Stack-Core-ESP32, 921600, COM4(你看，像我现在与M5Core相连的串口就是`COM4`，所以我应该选择`COM4`) +选择您板子的名字，波特率和串口号： M5Stack-Core-ESP32, 921600, COM4 ( 像我现在与 M5Core 相连的串口就是 `COM4`，所以我应该选择 `COM4` ) @@ -72,9 +72,9 @@ ### 2. 自己尝试新建一个M5Stack程序 -打开Arduino IDE，然后新建一个`.ino`后缀的文件，并且重命名它为`my_test.ino` +打开 Arduino IDE，然后新建一个 `.ino` 后缀的文件，并且重命名它为 `my_test.ino` -复制以下代码到my_test.ino文件中 +复制以下代码到 my_test.ino 文件中 ```arduino #include @@ -98,4 +98,4 @@ void loop() { 编译并上传这个程序，如果成功后，就会看到屏幕上显示"Hello World!" "M5Stack is running successfully!"啦！ -?> *如果你想升级Arduino-M5Stack库的话，请移步阅读这篇文档[如何升级Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib).* \ No newline at end of file +?> *如果您想升级Arduino-M5Stack库的话，请移步阅读这篇文档[如何升级Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md index d08ac524..d97490ea 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -102,9 +102,11 @@ lcd.print("Hello M5Stack") -**UIFlow的快速指南(Mac&Linux)** +**UIFlow的快速指南** - + + + ## 最后