diff --git a/_static/getting_started_pics/arduino_logo.png b/_static/getting_started_pics/arduino_logo.png new file mode 100644 index 00000000..f17f5dff Binary files /dev/null and b/_static/getting_started_pics/arduino_logo.png differ diff --git a/_static/getting_started_pics/m5camera.jpg b/_static/getting_started_pics/m5camera.jpg new file mode 100644 index 00000000..7ab0a5b4 Binary files /dev/null and b/_static/getting_started_pics/m5camera.jpg differ diff --git a/_static/getting_started_pics/m5go.jpg b/_static/getting_started_pics/m5go.jpg new file mode 100644 index 00000000..4db2c2e8 Binary files /dev/null and b/_static/getting_started_pics/m5go.jpg differ diff --git a/_static/getting_started_pics/m5stack_core.png b/_static/getting_started_pics/m5stack_core.png new file mode 100644 index 00000000..5b4f451d Binary files /dev/null and b/_static/getting_started_pics/m5stack_core.png differ diff --git a/_static/getting_started_pics/micropython_logo.png b/_static/getting_started_pics/micropython_logo.png new file mode 100644 index 00000000..7af4d6b9 Binary files /dev/null and b/_static/getting_started_pics/micropython_logo.png differ diff --git a/_static/m5-arduino.png b/_static/m5-arduino.png index 231b3d2e..5b4f451d 100644 Binary files a/_static/m5-arduino.png and b/_static/m5-arduino.png differ diff --git a/_static/product_pics/units/M5GO_Unit_moisture.jpg b/_static/product_pics/units/M5GO_Unit_moisture.jpg new file mode 100644 index 00000000..5f47f320 Binary files /dev/null and b/_static/product_pics/units/M5GO_Unit_moisture.jpg differ diff --git a/_static/product_pics/units/UTB8IUiJCiaMiuJk43PTq6ySmXXaX.jpg b/_static/product_pics/units/UTB8IUiJCiaMiuJk43PTq6ySmXXaX.jpg new file mode 100644 index 00000000..8f734206 Binary files /dev/null and b/_static/product_pics/units/UTB8IUiJCiaMiuJk43PTq6ySmXXaX.jpg differ diff --git a/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_ch.md b/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_ch.md deleted file mode 100644 index e439102b..00000000 --- a/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_ch.md +++ /dev/null @@ -1,132 +0,0 @@ -# M5Stack-Core-Arduino —— Getting Started - - -## 一、安装 USB 驱动 - -点击以下链接，下载 M5Stack-Core 的 USB 转串口驱动 - -https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers - -下载完之后，解压，根据系统位数，双击对应可执行文件 - -(Windows 32位，执行 CP210xVCPInstaller_x68.exe；Windows 64位，执行 CP210xVCPInstaller_x64.exe；) - -*判断驱动安装是否成功：* -如果安装成功，在插入 M5Stack 主控之后，设备管理器如下图所示出现，Silicon Labs 的 CP21x 系列串口端口号 -(我的电脑当前串口号是 COM3) - -![image](screenshots/my_com.png) - - -## 二、开发环境 -## **Windows** -### 1、安装 Arduino IDE - -*下载地址* -https://www.arduino.cc/en/Main/Software - -![image](screenshots/arduino_cc_package.png) - - -如下图所示修改 Arduino 路径为 D:\Program Files - -![image](screenshots/select_arduino_install_path.png) - - -此时，Arduino 的安装路径为 D:\Program Files\Arduino - -![image](screenshots/arduino_path.png) - - -### 2、下载 ESP32 相关支持包 - -（我的 Arduino 当前路径是 D:\Program Files\arduino） - -进入 Arduino 安装路径的 hareware 文件夹，按住 Shift 键的同时，右键选择“在此处打开命令窗口” - - -在打开的 Windows 终端 CMD 中输入如下命令 - -> * 创建 espressif 目录，并切换到此目录下 - -mkdir espressif && cd espressif - -![image](screenshots/mkdir_espressif.png) - - -> * 将 esp32 idf clone 在文件夹 esp32 下 - -git clone --recursive https://github.com/espressif/arduino-esp32.git esp32 - -![image](screenshots/download_idf.png) - - - -### 3、下载 ESP32 编译链 tools - -进入此路径 D:\Program Files\arduino\hardware\espressif\esp32\tools -选中并双击执行 get.exe 文件 - -![image](screenshots/select_get_exe_file.png) - -![image](screenshots/download_xtensa_tools.png) - - -### 4、Arduino IDE 中下载 M5Stack 的库 - -打开 Arduino IDE 之后，选择“项目”->“加载库”->“管理库...”，搜索“M5Stack”并点击“安装” - -![image](screenshots/select_arduino_lib.png) - -![image](screenshots/download_m5stack_lib.png) - - -## 三、示例 - -USB 线连接 M5Stack 主控，选择串口和一个示例程序，compile and upload - -### 1、打开一个示例程序，如打开 FactoryTest.ino - -![image](screenshots/select_demo.png) - - - -确认连接板子名称、串口波特率和当前串口号分别：M5Stack-Core-ESP32、921600、COM3(当前电脑串口号) - -![image](screenshots/select_board_and_com.png) - - -编译运行成功之后，串口监视窗口显示如下 - - -![image](screenshots/FactoryTest_result.png) - -### 2、新建一个 M5Stack 程序 - -打开 Arduino IDE 之后，新建 .ino 文件，并保存为 my_test.ino - -将如下代码拷贝进文件中。 - -```cpp -#include - -// the setup routine runs once when M5Stack starts up -void setup(){tack - - // Initialize the M5Stack object - M5.begin(); - - // LCD display - M5.Lcd.print("Hello World!"); - M5.Lcd.print("M5Stack is running successfully!"); -} - -// the loop routine runs over and over again forever -void loop() { - -} -``` - -点击编译运行，此时 M5Stack 显示器显示 "Hello World!" "M5Stack is running successfully!" - - diff --git a/en/get-started/get-started-ESP32CAM.rst b/en/get-started/get-started-ESP32CAM.rst index 0b67f5fa..c54306d5 100644 --- a/en/get-started/get-started-ESP32CAM.rst +++ b/en/get-started/get-started-ESP32CAM.rst @@ -25,6 +25,6 @@ without any code after you power it. Now, A WebCam you achieved successfully ! -*Note:* +.. note:: -ESP32CAM AP only can connect with one device at a time. + ESP32CAM AP only can connect with one device at a time. diff --git a/en/get-started/get-started-StepMotor.rst b/en/get-started/get-started-StepMotor.rst index 26e6a7f1..600d9aa8 100644 --- a/en/get-started/get-started-StepMotor.rst +++ b/en/get-started/get-started-StepMotor.rst @@ -43,4 +43,5 @@ Click ``Upload Local File`` for adding two necessary files ``motor.py``, ``i2c_b utime.sleep(3) stepmotor_0.StepMotor_XYZ(0, 0, 0, 500) -*Note: When step motor is running, supply it with 12V power.* +.. note:: + When step motor is running, supply it with 12V power.* diff --git a/en/get-started/how_to_burn_firmware_en.rst b/en/get-started/how_to_burn_firmware_en.rst index ed02efd8..8a90b96c 100644 --- a/en/get-started/how_to_burn_firmware_en.rst +++ b/en/get-started/how_to_burn_firmware_en.rst @@ -31,9 +31,9 @@ the ``Baud`` which is 921600 following below steps. .. image:: ../../_static/getting_started_pics/burn_firmware_02.png -**Note:** -^^^^^^^^^^^ -If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article `establish_serial_connection`_ and reinstall the USB driver. +.. note:: + + If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article `establish_serial_connection`_ and reinstall the USB driver. .. _establish_serial_connection: establish_serial_connection.html @@ -66,12 +66,11 @@ below, it means chip has been burnt successfully.. .. image:: ../../_static/getting_started_pics/burn_firmware_05.png -3. Then reset your board +3. Reset your board :::::::::::::::::::::::::: -**Note:** -^^^^^^^^^^^ +.. note:: -* If M5Burner means be busy after clicking ``Burn``, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully. + * If M5Burner means be busy after clicking ``Burn``, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully. -* If the burning procedure has been interrupted(like M5Burner has been closed suddenly...), it's better to burn your board again. + * If the burning procedure has been interrupted(like M5Burner has been closed suddenly...), it's better to burn your board again. diff --git a/en/get-started/index.rst b/en/get-started/index.rst index 91575cc9..4ff53d69 100644 --- a/en/get-started/index.rst +++ b/en/get-started/index.rst @@ -28,30 +28,27 @@ At the first time, you need to burn the specific firmware file(.bin) to your boa If you have one of ESP32 development boards listed below, click the corresponding one to start your development. ============================ ============================ ============================ -|Core with Arduino|_ |Core with Micropython|_ |M5GO|_ +|M5Stack Core|_ |M5GO|_ |M5CAMERA|_ ---------------------------- ---------------------------- ---------------------------- -`Core with Arduino`_ `Core with Micropython`_ `M5GO`_ +`M5Stack Core`_ `M5GO`_ `M5CAMERA`_ ---------------------------- ---------------------------- ---------------------------- -|ESP32CAM|_ |M5Stack STEPMOTOR Module|_ |M5Bala|_ +|M5CAMERA|_ |M5Stack STEPMOTOR|_ |M5Bala|_ ---------------------------- ---------------------------- ---------------------------- -`ESP32CAM`_ `M5Stack STEPMOTOR Module`_ `M5Bala`_ +`M5CAMERA`_ `M5Stack STEPMOTOR`_ `M5Bala`_ ============================ ============================ ============================ -.. |Core with Arduino| image:: ../../_static/pics/m5-arduino.jpg -.. _Core with Arduino: M5Stack_Core_Get_Started_Arduino_Windows_en.html +.. |M5Stack Core| image:: ../../_static/getting_started_pics/m5stack_core.png +.. _M5Stack Core: m5stack_core_get_started.html -.. |Core with Micropython| image:: ../../_static/pics/m5-micropython.jpg -.. _Core with Micropython: M5Stack_Core_Get_Started_MicroPython_Windows_en.html +.. |M5GO| image:: ../../_static/getting_started_pics/m5go.jpg +.. _M5GO: m5stack_core_get_started_MicroPython_Windows.html -.. |M5GO| image:: ../../_static/pics/M5GO.jpg -.. _M5GO: M5Stack_Core_Get_Started_MicroPython_Windows_en.html +.. |M5CAMERA| image:: ../../_static/getting_started_pics/m5camera.jpg +.. _M5CAMERA: get-started-ESP32CAM.html -.. |ESP32CAM| image:: ../../_static/pics/ESP32CAM.jpg -.. _ESP32CAM: get-started-ESP32CAM.html - -.. |M5Stack STEPMOTOR Module| image:: ../../_static/pics/m5-stepmotor.jpg -.. _M5Stack STEPMOTOR Module: get-started-StepMotor.html +.. |M5Stack STEPMOTOR| image:: ../../_static/pics/m5-stepmotor.jpg +.. _M5Stack STEPMOTOR: get-started-StepMotor.html .. |M5Bala| image:: ../../_static/pics/M5Bala.jpg .. _M5Bala: get-started-M5Bala.html diff --git a/en/get-started/m5stack_core_get_started.md b/en/get-started/m5stack_core_get_started.md new file mode 100644 index 00000000..42ec66e5 --- /dev/null +++ b/en/get-started/m5stack_core_get_started.md @@ -0,0 +1,3 @@ +# M5Stack Core Get Started + +### Pick up your OS below diff --git a/en/get-started/m5stack_core_get_started.rst b/en/get-started/m5stack_core_get_started.rst new file mode 100644 index 00000000..1d4b66ca --- /dev/null +++ b/en/get-started/m5stack_core_get_started.rst @@ -0,0 +1,19 @@ +M5Stack Core Get Started +============================================== + +Pick up your programming mode below for getting started +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +============================ ============================ ============================ +|Arduino|_ |Blockly|_ |MicroPython|_ +---------------------------- ---------------------------- ---------------------------- +`Arduino`_ `Blockly`_ `MicroPython`_ +============================ ============================ ============================ + +.. |Arduino| image:: ../../_static/getting_started_pics/arduino_logo.png +.. |Blockly| image:: ../../_static/getting_started_pics/programming_mode_blockly.png +.. |MicroPython| image:: ../../_static/getting_started_pics/micropython_logo.png + +.. _Arduino: m5stack_core_get_started_Arduino_MacOS.html +.. _Blockly: m5Stack_core_get_started_MicroPython_MacOS.html +.. _MicroPython: m5Stack_core_get_started_MicroPython_MacOS.html diff --git a/en/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.md b/en/get-started/m5stack_core_get_started_Arduino_MacOS.md similarity index 100% rename from en/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.md rename to en/get-started/m5stack_core_get_started_Arduino_MacOS.md diff --git a/en/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst b/en/get-started/m5stack_core_get_started_Arduino_MacOS.rst similarity index 75% rename from en/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst rename to en/get-started/m5stack_core_get_started_Arduino_MacOS.rst index a4423d2a..15acd482 100644 --- a/en/get-started/M5Stack_Core_Get_Started_Arduino_Mac_en.rst +++ b/en/get-started/m5stack_core_get_started_Arduino_MacOS.rst @@ -1,6 +1,11 @@ M5Stack-Core Get Started(MacOS, Arduino) ======================================== +.. note:: + If your OS is Windows, please click `here`_. + +.. _here: m5stack_core_get_started_Arduino_Windows.html + CONTENT ~~~~~~~ @@ -17,9 +22,11 @@ CONTENT Setting Environment ~~~~~~~~~~~~~~~~~~~ -*Before setting the development environment, we suggest you confirm -whether the USB driver was installed. If not, please visit this link -``establish serial connection``.* TODO: add a link +.. note:: + + Before setting the development environment, we suggest you confirm whether the USB driver was installed. If not, please visit this link `establish serial connection`_. + +.. _establish_serial_connection: establish_serial_connection.html 1. Install ``Arduino IDE`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -55,15 +62,13 @@ and navigating through the menu to "Arduino" > "Preferences" > "Sketchbook location". Adjust the command above accordingly if necessary! -**Note:** If you get the error below: -``xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun``, -install the command line dev tools by typing ``xcode-select --install`` -into the terminal and hit enter. once installed try the command above -again and restart the Arduino IDE. +.. note:: -If you get the error: -``IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:590) when running python get.py``, -try ``python3`` instead of ``python`` and restart the Arduino IDE. + * If you get the error below: ``xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools),`` + ``missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun``, install the command line dev tools by typing ``xcode-select --install`` into the terminal and hit enter. once installed try the command above again and restart the Arduino IDE. + + * If you get the error: ``IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol`` + ``version (_ssl.c:590) when running python get.py``, try ``python3`` instead of ``python`` and restart the Arduino IDE. 3. Install M5Stack Library ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -123,6 +128,7 @@ does not appear. If this is the case, after you connect the M5 open .. image:: ../../_static/getting_started_pics/m5stack_core/macOS_security_and_privacy_02.png -***If you want to read more the permission about the CP2104 USB driver, -visit the below link please.*** -\*\*\*https://developer.apple.com/library/archive/technotes/tn2459/\_index.html\*\*\* +.. note:: + + **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** + https://developer.apple.com/library/archive/technotes/tn2459/\_index.html diff --git a/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.md b/en/get-started/m5stack_core_get_started_Arduino_Windows.md similarity index 100% rename from en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.md rename to en/get-started/m5stack_core_get_started_Arduino_Windows.md diff --git a/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst b/en/get-started/m5stack_core_get_started_Arduino_Windows.rst similarity index 86% rename from en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst rename to en/get-started/m5stack_core_get_started_Arduino_Windows.rst index 908ac087..20a4c389 100644 --- a/en/get-started/M5Stack_Core_Get_Started_Arduino_Windows_en.rst +++ b/en/get-started/m5stack_core_get_started_Arduino_Windows.rst @@ -1,5 +1,10 @@ M5Stack-Core Get Started(Windows, Arduino) -========================================== +=========================================== + +.. note:: + If your OS is MacOS, please click `here`_. + +.. _here: m5stack_core_get_started_Arduino_MacOS.html CONTENT ~~~~~~~ @@ -16,19 +21,21 @@ CONTENT 2. `Example <#example>`__ -**Note:** -^^^^^^^^^^^ +.. note:: -If you want to upgrade the M5Stack Lib, please view this article `upgrade M5Stack Lib`_ + If you want to upgrade the M5Stack Lib, please view this article `upgrade M5Stack Lib`_ .. _upgrade M5Stack Lib: upgrade_m5stack_lib.html + Setting Environment ~~~~~~~~~~~~~~~~~~~ -Before setting the development environment, we suggest you confirm -whether the USB driver has installed. If not, please visit this link -``establish serial connection``. +.. note:: + + Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link `establish_serial_connection`_. + +.. _establish_serial_connection: establish_serial_connection.html 1. Install ``Arduino IDE`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/en/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.md b/en/get-started/m5stack_core_get_started_MicroPython_Windows.md similarity index 100% rename from en/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.md rename to en/get-started/m5stack_core_get_started_MicroPython_Windows.md diff --git a/en/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.rst b/en/get-started/m5stack_core_get_started_MicroPython_Windows.rst similarity index 100% rename from en/get-started/M5Stack_Core_Get_Started_MicroPython_Windows_en.rst rename to en/get-started/m5stack_core_get_started_MicroPython_Windows.rst diff --git a/en/index.rst b/en/index.rst index f81b1e58..aae6ac94 100644 --- a/en/index.rst +++ b/en/index.rst @@ -10,7 +10,8 @@ Welcom to M5Stack Documents! .. image:: ../_static/m5stack.png -`The green arrows designate "more info" links leading to advanced sections about the described task.` +.. note:: + `The green arrows designate "more info" links leading to advanced sections about the described task.` M5Stack is a series of stackable boards. We devote ourselves to develop this boards for lower development threshold and creating things more quickly. diff --git a/en/product-documents/units/m5go_unit_earth.rst b/en/product-documents/units/m5go_unit_earth.rst index 4fcefc0d..29a10eb2 100644 --- a/en/product-documents/units/m5go_unit_earth.rst +++ b/en/product-documents/units/m5go_unit_earth.rst @@ -23,3 +23,5 @@ DOCUMENTS - GitHub + `Arduino GitHub `__ + +.. image:: ../../../_static/product_pics/units/M5GO_Unit_moisture.jpg