changed "product_documents.md" for a new style

2026-05-20 10:23:01 -07:00 · 2018-12-10 17:26:56 +08:00
parent 21d14bf345
commit 1dfb893d1b
2 changed files with 87 additions and 81 deletions
@@ -1,29 +1,57 @@
 # Product Documents

-[中文](zh_CN/product_documents) | English | [日本語](ja/product_documents)
-
-?> The `Quick Start` section of each product is placed in the corresponding product document.
-
 <img src='assets/img/product_pics/1.jpg'> <img src='assets/img/product_pics/cores.png'>

-| M5Core        | MiniCore      |
+|M5Core |  |  |
+|:---|:---|:---|
+|[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_gray)|[![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_fire)|
+|[BASIC](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)|[GRAY](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_gray)|[FIRE](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_fire)|
+
+MiniCore |  |  | |
+---|---|---|---
+[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/minicore_stick)||||
+[M5Stick]()
+
+|Kit |  |
+|:---|:---|
+|[![](https://img-blog.csdnimg.cn/20181210155134684.png)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5go_iot_starter_kit)|[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/face_kit)|
+|[M5GO Starter Kit]()|[FACES Kit]()|
+
+<img src='assets/img/product_pics/2.jpg'> <img src='assets/img/product_pics/module.png'>
+
+|Communication Modules |  |  | |
+|:---|:---|:---|:---|
+|[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/m5core_basic)||
+|[GPS]()|[LORA]()|[SIM800/GPRS/GSM]()|[COMMU]()|
+
+|Accessry Modules |  |  |
+|:---|:---|:---|
+|[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/minicore_stick)|[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/minicore_stick)|||
+|[BATTERY]()|[PROTO]()|
+
+|Controlling Modules |  |  |
+|:---|:---|:---|
+|[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/minicore_stick)|[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](https://m5stack.github.io/m5-docs/#/en/product_documents/m5stack-core/minicore_stick)|||
+|[STEPMOTOR]()|[SERVO]()|
+
+<!-- | M5Core        | MiniCore      |
 | :----------:  |:------------: |
-| [BASIC](/en/product_documents/m5stack-core/m5core_basic)         | [Stick](/en/product_documents/m5stack-core/minicore_stick)         |
-| [GRAY](/en/product_documents/m5stack-core/m5core_gray)          | /            |
-| [WHITE(M5GO Main Board)](/en/product_documents/m5stack-core/m5core_white)          | /            |
-| [FIRE](/en/product_documents/m5stack-core/m5core_fire)          | /            |
-| [FACES Kit](/en/product_documents/m5stack-core/face_kit)          | /            |
-| [M5GO IOT Kit](/en/product_documents/m5stack-core/m5go_iot_starter_kit)          | /            |
+| [BASIC](en/product_documents/m5stack-core/m5core_basic)         | [Stick](en/product_documents/m5stack-core/minicore_stick)         |
+| [GRAY](en/product_documents/m5stack-core/m5core_gray)          | /            |
+| [WHITE(M5GO Main Board)](en/product_documents/m5stack-core/m5core_white)          | /            |
+| [FIRE](en/product_documents/m5stack-core/m5core_fire)          | /            |
+| [FACES Kit](en/product_documents/m5stack-core/face_kit)          | /            |
+| [M5GO IOT Kit](en/product_documents/m5stack-core/m5go_iot_starter_kit)          | /            |


 <img src='assets/img/product_pics/2.jpg'> <img src='assets/img/product_pics/module.png'>

 | Wireless Modules      | Accessory Modules  | Controlling Modules   |
 | :------------------:  |:------------------:| :--------------------:|
-| [GPS](/en/product_documents/modules/module_gps) | [PROTO](/en/product_documents/modules/module_proto) | [STEPMOTOR](/en/product_documents/modules/module_stepmotor)|
-| [LORA](/en/product_documents/modules/module_lora)                  | [BATTERY](/en/product_documents/modules/module_battery)            | [SERVO](/en/product_documents/modules/module_servo)                     |
-| [SIM800/GPRS/GSM](/en/product_documents/modules/module_sim800)                  | [BTC](/en/product_documents/modules/module_btc)                | [COMMU](/en/product_documents/modules/module_commu)                    |
-| [LoRaWAN](/en/product_documents/modules/module_lorawan)       | [PLUS](/en/product_documents/modules/module_plus)                  | /                    |
+| [GPS](en/product_documents/modules/module_gps) | [PROTO](en/product_documents/modules/module_proto) | [STEPMOTOR](en/product_documents/modules/module_stepmotor)|
+| [LORA](en/product_documents/modules/module_lora)                  | [BATTERY](en/product_documents/modules/module_battery)            | [SERVO](en/product_documents/modules/module_servo)                     |
+| [SIM800/GPRS/GSM](en/product_documents/modules/module_sim800)                  | [BTC](en/product_documents/modules/module_btc)                | [COMMU](en/product_documents/modules/module_commu)                    |
+| [LoRaWAN](en/product_documents/modules/module_lorawan)       | [PLUS](en/product_documents/modules/module_plus)                  | /                    |
 | /                     | /                  | /                     |
 | /                     | /                  | /                     |
 | /                     | /                  | /                     |
@@ -34,9 +62,9 @@

 |      |   |    |
 | :------------------:  |:------------------:| :--------------------:|
-| [M5GO-Base](/en/product_documents/bases/m5go_base)      | [PLC-Base](/en/product_documents/modules/module_plc)  | [FACE-Base](/en/product_documents/bases/face_base)   |
-| [LAN](/en/product_documents/bases/lan_base)      | /  | /   |
-| [Node-Base](/en/product_documents/bases/node_base)      | /  | /   |
+| [M5GO-Base](en/product_documents/bases/m5go_base)      | [PLC-Base](en/product_documents/modules/module_plc)  | [FACE-Base](en/product_documents/bases/face_base)   |
+| [LAN](en/product_documents/bases/lan_base)      | /  | /   |
+| [Node-Base](en/product_documents/bases/node_base)      | /  | /   |

 <img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/accessory.png'>

@@ -48,31 +76,31 @@

 | Input/Sensing Class   | Output/Controlling Class  | Interface Class   |
 | :-------------------: |:------------------------: | :----------------:|
-| [ENV](/en/product_documents/units/unit_env)                   | [RGB](/en/product_documents/units/unit_rgb)                       | [HUB](/en/product_documents/units/unit_hub)               |
-| [IR](/en/product_documents/units/unit_ir)                    | [RELAY](/en/product_documents/units/unit_relay)                         | [3.96PORT](/en/product_documents/units/unit_396port)          |
-| [PIR](/en/product_documents/units/unit_pir)                   | [NeoPixel](/en/product_documents/units/unit_neopixel)                         | /                 |
-| [ANGLE](/en/product_documents/units/unit_angle)                   | /                         | /                  |
-| [EARTH/Moisture](/en/product_documents/units/unit_earth)        | /                         | /                 |
-| [LIGHT](/en/product_documents/units/unit_light)                 | /                         | /                 |
-| [MAKEY](/en/product_documents/units/unit_makey)                   | /                         | /                 |
-| [BUTTON](/en/product_documents/units/unit_button)                   | /                         | /                 |
-| [Dual-BUTTON](/en/product_documents/units/unit_dual_button)                   | /                         | /                 |
-| [JOYSTICK](/en/product_documents/units/unit_joystick)                   | /                         | /                 |
-| [THERMAL](/en/product_documents/units/unit_thermal)                   | /                         | /                 |
-| [ADC](/en/product_documents/units/unit_adc)                   | /                         | /                 |
-| [DAC](/en/product_documents/units/unit_dac)                   | /                         | /                 |
-| [Color Sensor](/en/product_documents/units/unit_color_sensor)                   | /                         | /                 |
-| [ToF](/en/product_documents/units/unit_tof)                   | /                         | /                 |
-| [ESP32Cam](/en/product_documents/units/unit_esp32cam)                   | /                         | /                 |
-| [M5Camera](/en/product_documents/units/unit_m5camera)                   | /                         | /                 |
-| [NCIR](/en/product_documents/units/unit_ncir)                           | /                         | /                 |
+| [ENV](en/product_documents/units/unit_env)                   | [RGB](en/product_documents/units/unit_rgb)                       | [HUB](en/product_documents/units/unit_hub)               |
+| [IR](en/product_documents/units/unit_ir)                    | [RELAY](en/product_documents/units/unit_relay)                         | [3.96PORT](en/product_documents/units/unit_396port)          |
+| [PIR](en/product_documents/units/unit_pir)                   | [NeoPixel](en/product_documents/units/unit_neopixel)                         | /                 |
+| [ANGLE](en/product_documents/units/unit_angle)                   | /                         | /                  |
+| [EARTH/Moisture](en/product_documents/units/unit_earth)        | /                         | /                 |
+| [LIGHT](en/product_documents/units/unit_light)                 | /                         | /                 |
+| [MAKEY](en/product_documents/units/unit_makey)                   | /                         | /                 |
+| [BUTTON](en/product_documents/units/unit_button)                   | /                         | /                 |
+| [Dual-BUTTON](en/product_documents/units/unit_dual_button)                   | /                         | /                 |
+| [JOYSTICK](en/product_documents/units/unit_joystick)                   | /                         | /                 |
+| [THERMAL](en/product_documents/units/unit_thermal)                   | /                         | /                 |
+| [ADC](en/product_documents/units/unit_adc)                   | /                         | /                 |
+| [DAC](en/product_documents/units/unit_dac)                   | /                         | /                 |
+| [Color Sensor](en/product_documents/units/unit_color_sensor)                   | /                         | /                 |
+| [ToF](en/product_documents/units/unit_tof)                   | /                         | /                 |
+| [ESP32Cam](en/product_documents/units/unit_esp32cam)                   | /                         | /                 |
+| [M5Camera](en/product_documents/units/unit_m5camera)                   | /                         | /                 |
+| [NCIR](en/product_documents/units/unit_ncir)                           | /                         | /                 |

 <img src='assets/img/product_pics/4.jpg'> <img src='assets/img/product_pics/application.png'>

 |       |   |   |
 | :------------------:  |:------------------:| :--------------------:|
-| [BALA](/en/product_documents/applications/application_bala)      | [LidarBot](/en/product_documents/applications/application_lidarbot)  | /   |
+| [BALA](en/product_documents/applications/application_bala)      | [LidarBot](en/product_documents/applications/application_lidarbot)  | /   |

 <img src='assets/img/product_pics/6.jpg'> <img src='assets/img/product_pics/tool.png'>

-* [M5Stack USB Downloader](/en/product_documents/tools/tool_usb_downloader)
+* [M5Stack USB Downloader](en/product_documents/tools/tool_usb_downloader) -->
@@ -41,80 +41,58 @@ M5.Lcd.fillScreen(BLUE)
 | --- | --- |
 | color | 颜色值 |

-
-
 * * *

-<!--
-### <mark>lcd.drawPixel(x, y [,color])</mark>
+### <mark>M5.Lcd.drawPixel(int16_t x, int16_t y, uint16_t color);</mark>
 **例程**
-```python
-lcd.drawPixel(22,22,lcd.RED)
+```c++
+M5.Lcd.drawPixel(20, 40);
 ```
-**在位置(x,y)处画点。**
+**在位置(x,y)处画color颜色的点。**

 *如果函数的color值没给出，则使用当前的背景颜色。*

-| 参数 | 描述 |
-| --- | --- |
-| color | 颜色值 |
-
-
-
 * * *

-### <mark>lcd.drawLine(x, y, x1, y1 [,color])</mark>
+### <mark>M5.Lcd.drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);</mark>
 **例程**
-```python
-lcd.drawLine(0,0,12,12,lcd.WHITE)
+```c++
+M5.Lcd.drawLine(0,0,12,12,BLUE);
 ```
-**以指定的颜色从点(x,y)到点(x1,y1)画直线。**
+**以指定的颜色color从点(x0,y0)到点(x1,y1)画直线。**

 *如果函数的color值没给出，则使用当前的背景颜色。*

-| 参数 | 描述 |
-| --- | --- |
-| color | 颜色值 |
-
-
 * * *

-### <mark>lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color])</mark>
+### <mark>M5.Lcd.drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);</mark>

 **例程**
-```python
-lcd.drawTriangle(22,22,69,98,51,22,lcd.RED)
+```c++
+M5.Lcd.drawTriangle(22,22,69,98,51,22,BLUE);
 ```

-**以指定颜色画三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。**
+**以指定颜色color画三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。**

 *如果函数的color值没给出，则使用当前的背景颜色。*

-| 参数 | 描述 |
-| --- | --- |
-| color | 颜色值 |
-
 * * *

-### <mark>lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color])</mark>
+### <mark>M5.Lcd.fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);</mark>

 **例程**
-```python
-lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED)
+```c++
+M5.Lcd.fillTriangle(122, 122, 169, 198, 151, 182, BLUE);
 ```
 **以指定颜色画<mark>填充形式</mark>的三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。**

 *如果函数的color值没给出，则使用当前的背景颜色。*

-| 参数 | 描述 |
-| --- | --- |
-| color | 颜色值 |
-

 * * *
-### <mark>lcd.drawRect(x, y, w, h, [,color])</mark>
+<!-- ### <mark>lcd.drawRect(x, y, w, h, [,color])</mark>
 **例程**
-```python
+```c++
 lcd.drawRect(180, 12, 122, 10, lcd.BLUE)
 ```
 **以指定颜色画矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height。**
@@ -134,7 +112,7 @@ lcd.drawRect(180, 12, 122, 10, lcd.BLUE)

 ### <mark>lcd.drawRoundRect(x, y, w, h, r [,color])</mark>
 **例程**
-```python
+```c++
 lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE)
 ```
 **以指定颜色画<mark>圆角</mark>矩形，其中矩形左上角坐标为(x,y)，宽高分别为width和height，圆角半径为r。**
@@ -154,7 +132,7 @@ lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE)
 * * *
 ### <mark>lcd.print(‘text’, [x, y])</mark>
 **例程**
-```python
+```c++
 lcd.print('this is a print text function', 80, 80)
 ```
 **在(x,y)处开始打印文本(字符串)text。**
@@ -169,7 +147,7 @@ lcd.print('this is a print text function', 80, 80)
 ### <mark>lcd.clear([color])</mark>

 **例程**
-```python
+```c++
 lcd.clear()
 ```

@@ -180,7 +158,7 @@ lcd.clear()

 ### Usage

-```python
+```c++
 from machine import SPI, Pin
 from display import LCD