diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/burn_flow_firmware.gif b/docs/assets/img/getting_started_pics/how_to_burn_firmware/burn_flow_firmware.gif new file mode 100644 index 00000000..a0e66492 Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/burn_flow_firmware.gif differ diff --git a/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.gif b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.gif new file mode 100644 index 00000000..5c848ccd Binary files /dev/null and b/docs/assets/img/getting_started_pics/how_to_burn_firmware/download_M5Burner.gif differ diff --git a/docs/assets/img/product_pics/bases/lan_04.png b/docs/assets/img/product_pics/bases/lan_04.png new file mode 100644 index 00000000..22f36654 Binary files /dev/null and b/docs/assets/img/product_pics/bases/lan_04.png differ diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md index 2ae5daba..d976b887 100644 --- a/docs/en/product_documents.md +++ b/docs/en/product_documents.md @@ -2,7 +2,7 @@ [中文](zh_CN/product_documents) | English | [日本語](ja/product_documents) -*The `Quick Start` section of each product is placed in the corresponding product document.* +?> The `Quick Start` section of each product is placed in the corresponding product document. @@ -42,7 +42,7 @@ | | | | | :------------------: |:------------------:| :--------------------:| -| [LEGO-CABLE](en/product_documents/accessories/cables/accessory_lego_cable) | [FRAME](en/product_documents/accessories/frame) | / | +| [LEGO-CABLE](en/product_documents/accessories/cables/lego_cable) | [FRAME](en/product_documents/accessories/frame) | / | diff --git a/docs/en/product_documents/accessories/cables/accessory_lego_cable.md b/docs/en/product_documents/accessories/cables/accessory_lego_cable.md deleted file mode 100644 index 25f333b3..00000000 --- a/docs/en/product_documents/accessories/cables/accessory_lego_cable.md +++ /dev/null @@ -1,3 +0,0 @@ -# LEGO Cable - -## (coming soom...) \ No newline at end of file diff --git a/docs/en/product_documents/accessories/cables/lego_cable.md b/docs/en/product_documents/accessories/cables/lego_cable.md new file mode 100644 index 00000000..30730b7b --- /dev/null +++ b/docs/en/product_documents/accessories/cables/lego_cable.md @@ -0,0 +1,20 @@ +# LEGO Cable + +[中文](/zh_CN/product_documents/accessories/lego_cable) | English | [日本語](ja/product_documents/accessories/lego_cable) + +## DESCRIPTION + +LEGO Cableis designed for connecting GRVOE interface and LEGO, particularly, using for connecting M5Core and LEGO. + +## FEATURES + +- 3 specifications: 10cm, 20cm, 30cm + +## DOCUMENTS + + +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** + +
+ lego_cable_01 +
\ No newline at end of file diff --git a/docs/en/product_documents/accessories/frame.md b/docs/en/product_documents/accessories/frame.md index 1b12b531..cb85c18b 100644 --- a/docs/en/product_documents/accessories/frame.md +++ b/docs/en/product_documents/accessories/frame.md @@ -1,3 +1,24 @@ # Frame -## (coming soom...) \ No newline at end of file +[中文](zh_CN/product_documents/accessories/frame) | English | [日本語](ja/product_documents/accessories/frame) + +## DESCRIPTION + +Frameis designed as a fixed frame for M5Core. + +## DOCUMENTS + +- [Purchase](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) + +
+ frame_01 +
+
+ frame_02 +
+
+ frame_03 +
+
+ frame_04 +
\ No newline at end of file diff --git a/docs/en/product_documents/bases/lan_base.md b/docs/en/product_documents/bases/lan_base.md index cf111f10..19a497de 100644 --- a/docs/en/product_documents/bases/lan_base.md +++ b/docs/en/product_documents/bases/lan_base.md @@ -1,3 +1,58 @@ -# LAN +# LAN Base -## (coming soon...) \ No newline at end of file +[中文](/en/product_documents/bases/lan_base) | English| [日本語](ja/product_documents/bases/lan_base) + +## DESCRIPTION + +LAN Base is base built in W5500 chip which designed for meeting the demand of wired network. If your project only can access network through network cable, LAN Base is fit. + +In addition, if you want to communicate with LAN through RS485, we also supply a adapter for converting TLL to RS485. + +## PinMap + +**W5500** + +| W5500 | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO26 | +| RST | GPIO13 | +| INTn | GPIO34 | + + +**M-Bus** + +
+ M_BUS +
+ +## FEATURES + +- Input Supply Voltage: 9-24V +- HT3.96 port for supporting RS485 +- Easy to fixed on the wall + + +## DOCUMENTS + +- **[Schematic](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** +- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500)** +- **[M5GO IOT Starter Kit Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
\ No newline at end of file diff --git a/docs/en/product_documents/units/unit_esp32cam.md b/docs/en/product_documents/units/unit_esp32cam.md index af4a8cbd..73cfe30b 100644 --- a/docs/en/product_documents/units/unit_esp32cam.md +++ b/docs/en/product_documents/units/unit_esp32cam.md @@ -55,9 +55,9 @@ The ESP32Cam equips the ESP32 with everything necessary to program, run and deve - [ESP32Cam purchase (AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)
- +
- +
diff --git a/docs/en/related_documents/how_to_burn_firmware.md b/docs/en/related_documents/how_to_burn_firmware.md index 255fe4ce..251b8791 100644 --- a/docs/en/related_documents/how_to_burn_firmware.md +++ b/docs/en/related_documents/how_to_burn_firmware.md @@ -12,39 +12,28 @@ ### 1. Download M5Burner -For downloading M5Burner, visit the [offical website](http://www.m5stack.com) please. +For downloading M5Burner, visit the [M5Stack Website](http://www.m5stack.com) please.
- Screenshot of coverpage +
### 2. Burn the firmware Unzip the M5Burner tool which you donwloaded for official website just now, then double click `M5Burner.exe`. -
- Screenshot of coverpage -
+**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps. Choice a right firmware, click `Erase` and then click `Burn`.** - -**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps.** +?> **Tip** **a.** If you want to program with [M5Flow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com)), select `M5Flow-vx.x`(/`M5Cloud-vx.x.x`) option(the lastest version). **b.** If you own a ESP32CAM (/ M5CAMERA), select `M5Cam-vx.x (/M5Cam-psram)` option
- Screenshot of coverpage +
!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](/en/related_documents/establish_serial_connection) and reinstall the USB driver. -**a. Choice a right firmware** - -a. select `M5Flow-vx.x` option(the lastest version), if you want to program with [M5Flow](http://flow.m5stack.com) - -b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA) - -**b. Click `Erase`** -
- Screenshot of coverpage + Screenshot of coverpage
*If M5Burner shows the information `Hard resetting via RTS pin...` below, it means chip has been erased successfully.* @@ -53,12 +42,6 @@ b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA) Screenshot of coverpage -**c. Click `Burn`** - -
- Screenshot of coverpage -
- *If M5Burner shows the information `Leaving... Staying in bootloader.` below, it means chip has been burnt successfully.*
diff --git a/docs/ja/product_documents.md b/docs/ja/product_documents.md index 51bd5ecb..544941d2 100644 --- a/docs/ja/product_documents.md +++ b/docs/ja/product_documents.md @@ -44,8 +44,8 @@ | | | | |:---:|:---:|:---:| -| [LEGO-CABLE](ja/product_documents/accessories/cables/accessory_lego_cable) | [FRAME](ja/product_documents/accessories/frame) | [Headers Socket](ja/product_documents/accessories/headers_socket) | -| [GROVE-CABLE](ja/product_documents/accessories/cables/accessory_grove_cable) | [USB-TTL UART Serial Adapter](ja/product_documents/accessories/usb_uart_adapter) | / | +| [LEGO-CABLE](ja/product_documents/accessories/cables/lego_cable) | [FRAME](ja/product_documents/accessories/frame) | [Headers Socket](ja/product_documents/accessories/headers_socket) | +| [GROVE-CABLE](ja/product_documents/accessories/cables/grove_cable) | [USB-TTL UART Serial Adapter](ja/product_documents/accessories/usb_uart_adapter) | / | diff --git a/docs/ja/product_documents/accessories/cables/accessory_grove_cable.md b/docs/ja/product_documents/accessories/cables/grove_cable.md similarity index 100% rename from docs/ja/product_documents/accessories/cables/accessory_grove_cable.md rename to docs/ja/product_documents/accessories/cables/grove_cable.md diff --git a/docs/ja/product_documents/accessories/cables/accessory_lego_cable.md b/docs/ja/product_documents/accessories/cables/lego_cable.md similarity index 74% rename from docs/ja/product_documents/accessories/cables/accessory_lego_cable.md rename to docs/ja/product_documents/accessories/cables/lego_cable.md index 099ed60d..ae0d9f8e 100644 --- a/docs/ja/product_documents/accessories/cables/accessory_lego_cable.md +++ b/docs/ja/product_documents/accessories/cables/lego_cable.md @@ -1,5 +1,7 @@ # LEGO-CABLE +[中文](zh_CN/product_documents/accessories/lego_cable) | [English](en/product_documents/accessories/lego_cable) | 日本語 + ## 概要 (近日公開...) diff --git a/docs/ja/product_documents/accessories/frame.md b/docs/ja/product_documents/accessories/frame.md index 7195d5d8..5651a60b 100644 --- a/docs/ja/product_documents/accessories/frame.md +++ b/docs/ja/product_documents/accessories/frame.md @@ -1,5 +1,7 @@ # FRAME +[中文](zh_CN/product_documents/accessories/frame) | [English](en/product_documents/accessories/frame) | 日本語 + ## 概要 (近日公開...) diff --git a/docs/ja/product_documents/bases/lan_base.md b/docs/ja/product_documents/bases/lan_base.md index 4db1113c..c9869d2f 100644 --- a/docs/ja/product_documents/bases/lan_base.md +++ b/docs/ja/product_documents/bases/lan_base.md @@ -1,5 +1,7 @@ # LAN ベース +[中文](zh_CN/product_documents/bases/lan_base) | [English](/en/product_documents/bases/lan_base) | 日本語 + ## 概要 **LAN**ベースはI2Cとユーザ定義の6ピンポートによってイーサネット通信が可能なベースです。 @@ -32,7 +34,7 @@ M5Stackの無線通信が遅かったり、無線ネットワークに繋がら - [M5Stack](https://m5stack.com) - **サンプルコード** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) + - [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) - **データシート** - [W5500](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Shields/W5500_datasheet_v1.0.2_1.pdf) diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index dbb2e7e7..fef8b17f 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -2,7 +2,7 @@ 中文 | [English](/en/product_documents) | [日本語](ja/product_documents) -*每个产品的`快速上手(Quick Start)`部分都放置在了该产品的介绍文档里。* +?> 每个产品的`快速上手(Quick Start)`部分都放置在了该产品的介绍文档里。 @@ -41,7 +41,7 @@ | | | | | :------------------: |:------------------:| :--------------------:| -| [LEGO-CABLE](zh_CN/product_documents/accessories/cables/accessory_lego_cable) | [FRAME](zh_CN/product_documents/accessories/frame) | / | +| [LEGO-CABLE](zh_CN/product_documents/accessories/cables/lego_cable) | [FRAME](zh_CN/product_documents/accessories/frame) | / | diff --git a/docs/zh_CN/product_documents/accessories/cables/accessory_lego_cable.md b/docs/zh_CN/product_documents/accessories/cables/accessory_lego_cable.md deleted file mode 100644 index a8c8ee4b..00000000 --- a/docs/zh_CN/product_documents/accessories/cables/accessory_lego_cable.md +++ /dev/null @@ -1,3 +0,0 @@ -# LEGO Cable - -## (敬请期待...) \ No newline at end of file diff --git a/docs/zh_CN/product_documents/accessories/cables/lego_cable.md b/docs/zh_CN/product_documents/accessories/cables/lego_cable.md new file mode 100644 index 00000000..4130883b --- /dev/null +++ b/docs/zh_CN/product_documents/accessories/cables/lego_cable.md @@ -0,0 +1,20 @@ +# LEGO Cable + +中文 | [English](en/product_documents/accessories/lego_cable) | [日本語](ja/product_documents/accessories/lego_cable) + +## 描述 + +LEGO Cable专门设计用来连接GRVE接口和乐高机器人组件，特别是用来连接M5Core与乐高机器人组件。 + +## 特性 + +- 3种规格: 10cm, 20cm, 30cm + +## 相关链接 + + +- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** + +
+ lego_cable_01 +
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/accessories/frame.md b/docs/zh_CN/product_documents/accessories/frame.md index 228e57db..19858573 100644 --- a/docs/zh_CN/product_documents/accessories/frame.md +++ b/docs/zh_CN/product_documents/accessories/frame.md @@ -1,3 +1,24 @@ # Frame - 5x5的M5外框 -## (敬请期待...) \ No newline at end of file +中文 | [English](en/product_documents/accessories/frame) | [日本語](ja/product_documents/accessories/frame) + +## 描述 + +Frame专门设计用来做M5Core的固定框架。 + +## 相关链接 + +- [购买链接](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) + +
+ frame_01 +
+
+ frame_02 +
+
+ frame_03 +
+
+ frame_04 +
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/bases/lan_base.md b/docs/zh_CN/product_documents/bases/lan_base.md index cf111f10..5b5240e9 100644 --- a/docs/zh_CN/product_documents/bases/lan_base.md +++ b/docs/zh_CN/product_documents/bases/lan_base.md @@ -1,3 +1,60 @@ -# LAN +# LAN底座 -## (coming soon...) \ No newline at end of file +中文 | [English](/en/product_documents/bases/lan_base) | [日本語](ja/product_documents/bases/lan_base) + +## 描述 + +LAN底座是集成了以太网芯片W5500的底座，目的是提供给有让M5Core接入有线网络需求的用户。因为M5Core集成了无线WIFI，能接收无线热点的网络，可是没有网络接口，如果你需要让M5Core接入有线网络来工作的话，这个LAN底座正好合适，而且LAN底座还配备了磁铁和滑动杆，方便你装置LAN和M5Core到壁面上。 + +另外LAN底座还有橙色HT3.96端子，这个接口还没有电气连接，它连接不同Pin脚的时候，可以实现对应的Pin拓展。如果你需要这个接口变成RS485的拓展接口的话，那么使用配套的排针和TLL转RS485功能小板子焊接到LAN底座上面，即可实现RS485接口，从而可以通过这个HT3.96端子，通过RS485协议控制M5Core的整个功能。 + +如果TLL转RS485的功能小板子与LAN底板结合的话，小板子上的串口引脚将与LAN底板的GPIO1、GPIO3(UART0)连接。 + +## 管脚映射 + +**W5500以太网芯片** + +| W5500 | ESP32 Chip | +| :----------: |:------------: | +| MOSI | GPIO23 | +| MISO | GPIO19 | +| CLK | GPIO18 | +| CS | GPIO26 | +| RST | GPIO13 | +| INTn | GPIO34 | + + +**M-Bus** + +
+ M_BUS +
+ +## 特性 + +- 允许9-24V范围的电源输入 +- 3.96规格端子，可以自定义引脚 +- 易于固件到墙上，方便装配 + + +## 相关链接 + +- **[原理图](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** +- [例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) +- **[M5GO IOT Starter Kit购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/units/unit_esp32cam.md b/docs/zh_CN/product_documents/units/unit_esp32cam.md index 349011c2..c6ccf4e8 100644 --- a/docs/zh_CN/product_documents/units/unit_esp32cam.md +++ b/docs/zh_CN/product_documents/units/unit_esp32cam.md @@ -50,9 +50,9 @@ - [购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html)
- +
- +
diff --git a/docs/zh_CN/related_documents/how_to_burn_firmware.md b/docs/zh_CN/related_documents/how_to_burn_firmware.md index 36919028..d6c7c2ff 100644 --- a/docs/zh_CN/related_documents/how_to_burn_firmware.md +++ b/docs/zh_CN/related_documents/how_to_burn_firmware.md @@ -22,42 +22,27 @@ 解压刚刚下载的M5Burner压缩包, 然后双击`M5Burner.exe`. -
- Screenshot of coverpage -
+**选择板子正与PC相连的`串口号`和`921600 波特率`, 选择合适的固件文件, 点击`Erase`, 然后等擦除固件完成，点击`Burn`** - -**选择板子正与PC相连的`串口号`和`921600 波特率` .** +?> **Tip** **a.** 如果你想通过[M5Flow](http://flow.m5stack.com)(/[M5Cloud](http://cloud.m5stack.com))来编程的话，请选择最新的`M5Flow-vx.x`(/`M5Cloud-vx.x.x`) **b.** 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)`
- Screenshot of coverpage +
!> **注意** 如何M5Burner的串口号选项框没有显示任何的`COMx`号或者只显示`COM1`, 这时候你需要参考这篇文档[建立串口通信](related_documents/establish_serial_connection)来重新安装USB驱动. -**a. 选择合适的固件文件** - -a. 如果你想通过[M5Flow](http://flow.m5stack.com)来编程的话，请选择最新的`M5Flow-vx.x` - -b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` - -**b. 点击`Erase`** -
- Screenshot of coverpage + Screenshot of coverpage
+ *如果M5Burner打印出这样的信息的话`Hard resetting via RTS pin...`，这就表明你擦除固件成功了.*
Screenshot of coverpage
-**c. 点击`Burn`** - -
- Screenshot of coverpage -
*如果M5Burner打印出这样的信息的话`Leaving... Staying in bootloader.`，这就表明你烧录固件成功了.*