diff --git a/.gitignore b/.gitignore index 836a4ebb..09e3aea9 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ node_modules ._* .cache .DS_Store +*.mp4 diff --git a/docs/assets/img/m5stack_case/units/TempHumiMeter_01.png b/docs/assets/img/m5stack_case/units/TempHumiMeter_01.png new file mode 100644 index 00000000..fa906423 Binary files /dev/null and b/docs/assets/img/m5stack_case/units/TempHumiMeter_01.png differ diff --git a/docs/assets/img/product_pics/core/basic/basic_06.JPG b/docs/assets/img/product_pics/core/basic/basic_06.JPG new file mode 100644 index 00000000..1af5e757 Binary files /dev/null and b/docs/assets/img/product_pics/core/basic/basic_06.JPG differ diff --git a/docs/assets/img/product_pics/core/basic/basic_07.JPG b/docs/assets/img/product_pics/core/basic/basic_07.JPG new file mode 100644 index 00000000..1ef2e167 Binary files /dev/null and b/docs/assets/img/product_pics/core/basic/basic_07.JPG differ diff --git a/docs/assets/img/product_pics/core/basic/basic_08.JPG b/docs/assets/img/product_pics/core/basic/basic_08.JPG new file mode 100644 index 00000000..98a3d9f8 Binary files /dev/null and b/docs/assets/img/product_pics/core/basic/basic_08.JPG differ diff --git a/docs/assets/img/product_pics/core/basic/basic_09.JPG b/docs/assets/img/product_pics/core/basic/basic_09.JPG new file mode 100644 index 00000000..c855086d Binary files /dev/null and b/docs/assets/img/product_pics/core/basic/basic_09.JPG differ diff --git a/docs/assets/img/product_pics/core/basic/basic_10.JPG b/docs/assets/img/product_pics/core/basic/basic_10.JPG new file mode 100644 index 00000000..fa7b6747 Binary files /dev/null and b/docs/assets/img/product_pics/core/basic/basic_10.JPG differ diff --git a/docs/assets/img/product_pics/modules/lego+_01.jpg b/docs/assets/img/product_pics/modules/lego+_01.jpg index 14acefa1..2c227355 100644 Binary files a/docs/assets/img/product_pics/modules/lego+_01.jpg and b/docs/assets/img/product_pics/modules/lego+_01.jpg differ diff --git a/docs/assets/img/product_pics/modules/usb_01.jpg b/docs/assets/img/product_pics/modules/usb_01.jpg index 49cf522a..6b7d0635 100644 Binary files a/docs/assets/img/product_pics/modules/usb_01.jpg and b/docs/assets/img/product_pics/modules/usb_01.jpg differ diff --git a/docs/assets/img/product_pics/units/adc_sch.JPG b/docs/assets/img/product_pics/units/adc_sch.JPG new file mode 100644 index 00000000..604b5efb Binary files /dev/null and b/docs/assets/img/product_pics/units/adc_sch.JPG differ diff --git a/docs/assets/img/product_pics/units/adc_schematic.JPG b/docs/assets/img/product_pics/units/adc_schematic.JPG new file mode 100644 index 00000000..f1a2b54e Binary files /dev/null and b/docs/assets/img/product_pics/units/adc_schematic.JPG differ diff --git a/docs/assets/img/product_pics/units/env_sch.JPG b/docs/assets/img/product_pics/units/env_sch.JPG new file mode 100644 index 00000000..4ae17bb2 Binary files /dev/null and b/docs/assets/img/product_pics/units/env_sch.JPG differ diff --git a/docs/assets/img/product_pics/units/hub_sch.JPG b/docs/assets/img/product_pics/units/hub_sch.JPG new file mode 100644 index 00000000..4f0ca253 Binary files /dev/null and b/docs/assets/img/product_pics/units/hub_sch.JPG differ diff --git a/docs/assets/img/product_pics/units/ir_sch.JPG b/docs/assets/img/product_pics/units/ir_sch.JPG new file mode 100644 index 00000000..fd906c2d Binary files /dev/null and b/docs/assets/img/product_pics/units/ir_sch.JPG differ diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md index d976b887..599247b7 100644 --- a/docs/en/product_documents.md +++ b/docs/en/product_documents.md @@ -1,29 +1,73 @@ # Product Documents -[中文](zh_CN/product_documents) | English | [日本語](ja/product_documents) - -?> The `Quick Start` section of each product is placed in the corresponding product document. +*** -| M5Core | MiniCore | +**M5Core** + +[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](en/product_documents/m5stack-core/m5core_basic) [![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](en/product_documents/m5stack-core/m5core_gray) [![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](en/product_documents/m5stack-core/m5core_fire) + +**MiniCore** + +[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](en/product_documents/m5stack-core/minicore_stick) + +**Kit** + +[![](https://img-blog.csdnimg.cn/20181210155134684.png)](en/product_documents/m5stack-core/m5go_iot_starter_kit)[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](en/product_documents/m5stack-core/face_kit) + +*** + + + +**Communication Modules** + +[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](en/product_documents/modules/module_gps)[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](en/product_documents/modules/module_lora)[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](en/product_documents/modules/module_sim800)[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](en/product_documents/modules/module_commu)[![](https://img-blog.csdnimg.cn/20181212111936228.jpg)](en/product_documents/modules/module_usb) + +**Expansion Modules** + +[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](en/product_documents/modules/module_battery)[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](en/product_documents/modules/module_proto)[![](https://img-blog.csdnimg.cn/20181212110809815.png)](en/product_documents/modules/module_plus) + +**Drive Modules** + +[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](en/product_documents/modules/module_stepmotor)[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](en/product_documents/modules/module_servo)[![](https://img-blog.csdnimg.cn/2018121211200138.jpg)](en/product_documents/modules/module_lego+) + +*** + + + +**Input/Sensing Unit** + +[![](https://img-blog.csdnimg.cn/20181211173622546.png)](en/product_documents/units/unit_env)[![](https://img-blog.csdnimg.cn/20181211174001353.png)](en/product_documents/units/unit_ir)[![](https://img-blog.csdnimg.cn/20181211174020278.png)](en/product_documents/units/unit_pir)[![](https://img-blog.csdnimg.cn/20181211174328827.png)](en/product_documents/units/unit_angle)[![](https://img-blog.csdnimg.cn/20181211174313215.png)](en/product_documents/units/unit_adc) + +[![](https://img-blog.csdnimg.cn/20181211175208695.png)](en/product_documents/units/unit_dac)[![](https://img-blog.csdnimg.cn/20181211174349287.png)](en/product_documents/units/unit_button)[![](https://img-blog.csdnimg.cn/20181211175218426.png)](en/product_documents/units/unit_dual_button) + +**Output/Controlling Unit** + +[![](https://img-blog.csdnimg.cn/20181211174047354.png)](en/product_documents/units/unit_rgb)[![](https://img-blog.csdnimg.cn/20181211174057301.png)](en/product_documents/units/unit_relay)[![](https://img-blog.csdnimg.cn/20181211174111764.png)](en/product_documents/units/unit_neopixel) + +**Interface Unit** + +[![](https://img-blog.csdnimg.cn/20181211174142806.png)](en/product_documents/units/unit_hub)[![](https://img-blog.csdnimg.cn/20181211174154240.png)](en/product_documents/units/unit_396port) + + diff --git a/docs/en/product_documents/m5stack-core/m5core_basic.md b/docs/en/product_documents/m5stack-core/m5core_basic.md index fcdd7257..b56071e6 100644 --- a/docs/en/product_documents/m5stack-core/m5core_basic.md +++ b/docs/en/product_documents/m5stack-core/m5core_basic.md @@ -1,39 +1,53 @@ # M5Core BASIC -📝**[Example](https://github.com/m5stack/M5Stack/tree/master/examples)** | 💡**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)** | **[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)** +basic_02 basic_03 basic_04 -## DESCRIPTION +* * * -The M5Stack **BASIC** is a black development kit based on ESP32 chip composed of a black M5Core and a Bottom Base board. You can even program The M5Stack BASIC through Blockly, Arduino or MicroPython. The black core is a basic kit and **it does not own any MEMS chip(like MPU9250...)**. +:memo:**[Description](#Description)**|:bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)**|:octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)** | :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-ESP32-Basic-Core-Development-Kit-Extensible-Micro-Control-Wifi-BLE-IoT-Prototype/3226069_32837164440.html?spm=2114.12010615.8148356.2.3b9b2de96y27jH)**:clapper:**[Related Video](#Related-Video)** + +## Description + +**The M5Stack BASIC** is a black development kit based on **ESP32** chip composed of a black M5Core and a Bottom Base board. You can even program The M5Stack BASIC through Blockly, Arduino or MicroPython. The black core is a basic kit and **it does not own any MEMS chip(like MPU9250...)**. The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. -## FEATURES +## Feature -- Programming Support -- Arduino -- ESP-IDF -- MicroPython -- TF Card Support +- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) +- TF Card Support(Up to 16GB) -## PARAMETER +## Source PinMap -| Source | Parameter | -| :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | -| Flash | 4M-Bytes | -| Input | 5V @ 500mA | -| Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | -| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -| Speaker | 1W-0928 | -| Battery | 150mAh @ 3.7V, inside vb | -| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | -| Size | 54 x 54 x 12.5 mm | -| C.A.S.E | Plastic ( PC ) | -| Weight | 120g with bottom, 100g only core | +*We have several kinds of M5Cores, There is [their difference in schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md).* +**LCD & TF Card** -## PinMap +*LCD Resolution: 320x240* + + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
+ +**Button & Speaker** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
Button PinBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
+ +**GROVE A** + + + + +
ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA
+ + + -## INCLUDES +## Parameter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4M-Bytes
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
Battery150mAh @ 3.7V
Op.Temp.32°F to 104°F ( 0°C to 40°C )
Size54 x 54 x 12.5 mm
C.A.S.EPlastic ( PC )
Weight120g with bottom, 100g only core
+ +## Include - 1x M5Stack BASIC - 1x M5Stack BASIC Bottom - Type-C USB Cable - User Manual -## DOCUMENTS +basic_06 basic_07 +basic_08 basic_09 + +basic_10 + +## Related Link - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) -- **Quick Start** - - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) +## Related Video -- **[The difference between M5Cores](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** +- **m5stack's instroduce** -
- basic_01 -
-
- basic_02 -
-
- basic_03 -
-
- basic_04 -
-
- basic_05 -
+ diff --git a/docs/en/product_documents/m5stack-core/m5core_gray.md b/docs/en/product_documents/m5stack-core/m5core_gray.md index b23a8082..6266f1c2 100644 --- a/docs/en/product_documents/m5stack-core/m5core_gray.md +++ b/docs/en/product_documents/m5stack-core/m5core_gray.md @@ -1,24 +1,21 @@ -# M5Core GRAY +# 灰色升级版M5Core -[中文](/zh_CN/product_documents/m5stack-core/m5core_gray) | English | [日本語](ja/product_documents/m5stack-core/m5core_gray) +:octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)** | :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)** | :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[Purchase](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4004-1172588101.23.f64c4476tugBw5&id=559226082388)**|**[M-Bus](#mbus)** -## DESCRIPTION +## Description -The M5Core **GRAY** is a development kit based on ESP32 chip composed of a gray M5Core and a Bottom Base board. You can even program The M5Core GRAY through Blockly, Arduino or MicroPython. +**M5Core GRAY** is a development kit based on ESP32 chip composed of a gray M5Core and a Bottom Base board. You can even program The M5Core GRAY through Blockly, Arduino or MicroPython. -The M5Core GRAY equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TFT LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Core GRAY in a day in stead of couple weeks and so on. +The M5Core GRAY equips the ESP32 with everything necessary to program, run and develop on the wonderchip. It also features a MEMS Chip(**MPU9250**), and a TF `T LCD, so you can create a 3D remote gesture controller, a simple "Leap Motion" via M5Core GRAY in a day in stead of couple weeks and so on. The a Bottom board on the back of M5Core. It's designed for expanding gpio on M-Bus besides I2S Pins(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34)for DIY. Each gpio on M-Bus is expanded as pin and port for convenience and flexibility. -## FEATURES +## Feature -- Programming Support -- Arduino -- ESP-IDF -- MicroPython -- TF Card Support +- Programming Support: [UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/) and [Arduino](http://www.arduino.cc) +- TF Card Support(Up to 16GB) -## PARAMETER +## Parameter | Source | Parameter | | :----------: |:------------: | diff --git a/docs/en/product_documents/units/unit_env.md b/docs/en/product_documents/units/unit_env.md index 4b31709b..836a6b13 100644 --- a/docs/en/product_documents/units/unit_env.md +++ b/docs/en/product_documents/units/unit_env.md @@ -1,14 +1,19 @@ # Unit ENV -[中文](/zh_CN/product_documents/units/unit_env) | English | [日本語](ja/product_documents/units/unit_env) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**|:octocat:**[Example](Example)**| :electric_plug:**[Schematic](#Schematic)** | 🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=2114.12010615.8148356.2.758c5bcbURtQtR)** + + +## Description ENV is a environment sensor for M5GO that can easily detect temperature, humidity and air pressure with M5GO Core, including -temperature and humidity sensor and absolute barometric pressure sensor. +temperature and humidity sensor and absolute barometric pressure sensor. Connect to GRVE A of M5Core. -## FEATURES +## Features - Temperature: - measuring range: 20 ~ 60℃ @@ -22,11 +27,26 @@ temperature and humidity sensor and absolute barometric pressure sensor. - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Example - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=a2g1y.12024536.productList_5885013.subject_22)** +```c++ +DHT12 dht12; //new a object +Adafruit_BMP280 bme; -
- -
\ No newline at end of file +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +float pressure = bme.readPressure();//pressure +``` + +Click [here]((https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ENV)。) for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO21
ENV UnitSCLSDA
\ No newline at end of file diff --git a/docs/en/product_documents/units/unit_relay.md b/docs/en/product_documents/units/unit_relay.md index 0921a67a..aba24c52 100644 --- a/docs/en/product_documents/units/unit_relay.md +++ b/docs/en/product_documents/units/unit_relay.md @@ -1,6 +1,6 @@ # Unit relay -[中文](/zh_CN/product_documents/units/unit_relay) | English | [日本語](ja/product_documents/units/unit_relay) +[Example](#example) ## DESCRIPTION @@ -25,6 +25,46 @@ Only a low electrial level is sent to this unit, the relay will be close and the - **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_RELAY.pdf)** - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Relay-Unit-DC-3A-30V-AC-3A-220V-with-Triode-Driven-GROVE-Port/3226069_32922856211.html?spm=a2g1y.12024536.productList_5885013.subject_24)** + + + +*Example* + + + +#### ** Arduino Code** + +```c++ +#include + +void setup() { + M5.begin(); + M5.Lcd.clear(BLACK); + M5.Lcd.setTextFont(4); + M5.Lcd.setTextColor(YELLOW, BLACK); + //disable the speak noise + dacWrite(25, 0); + pinMode(26, OUTPUT); +} + +void loop(void) { + digitalWrite(26, HIGH); + delay(500); + digitalWrite(26, LOW); + delay(500); +} +``` + +#### ** MicroPython Code ** + +Coming soom... + +#### ** UIFlow ** + +Coming soom... + + +
diff --git a/docs/index.html b/docs/index.html index ce81a9c9..e256ea00 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,7 +21,10 @@
- + + @@ -76,5 +113,8 @@ + + + diff --git a/docs/index.md b/docs/index.md index e387668b..4d9bab00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,70 @@ -# M5Stack +# Product Documents + +*** + + + +**M5Core** + +[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](en/product_documents/m5stack-core/m5core_basic) [![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](en/product_documents/m5stack-core/m5core_gray) [![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](en/product_documents/m5stack-core/m5core_fire) + + + +**MiniCore** + +[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](en/product_documents/m5stack-core/minicore_stick) + + + +**Kit** + +[![](https://img-blog.csdnimg.cn/20181210155134684.png)](en/product_documents/m5stack-core/m5go_iot_starter_kit)[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](en/product_documents/m5stack-core/face_kit) + + + +*** + + + +**Communication Modules** + +[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](en/product_documents/modules/module_gps)[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](en/product_documents/modules/module_lora)[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](en/product_documents/modules/module_sim800)[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](en/product_documents/modules/module_commu)[![](https://img-blog.csdnimg.cn/20181212111936228.jpg)](en/product_documents/modules/module_usb) + + + +**Expansion Modules** + +[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](en/product_documents/modules/module_battery)[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](en/product_documents/modules/module_proto)[![](https://img-blog.csdnimg.cn/20181212110809815.png)](en/product_documents/modules/module_plus) + + + +**Drive Modules** + +[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](en/product_documents/modules/module_stepmotor)[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](en/product_documents/modules/module_servo)[![](https://img-blog.csdnimg.cn/2018121211200138.jpg)](en/product_documents/modules/module_lego+) + + + +*** + + + +**Input/Sensing Unit** + +[![](https://img-blog.csdnimg.cn/20181211173622546.png)](en/product_documents/units/unit_env)[![](https://img-blog.csdnimg.cn/20181211174001353.png)](en/product_documents/units/unit_ir)[![](https://img-blog.csdnimg.cn/20181211174020278.png)](en/product_documents/units/unit_pir)[![](https://img-blog.csdnimg.cn/20181211174328827.png)](en/product_documents/units/unit_angle)[![](https://img-blog.csdnimg.cn/20181211174313215.png)](en/product_documents/units/unit_adc) + +[![](https://img-blog.csdnimg.cn/20181211175208695.png)](en/product_documents/units/unit_dac)[![](https://img-blog.csdnimg.cn/20181211174349287.png)](en/product_documents/units/unit_button)[![](https://img-blog.csdnimg.cn/20181211175218426.png)](en/product_documents/units/unit_dual_button) + + + +**Output/Controlling Unit** + +[![](https://img-blog.csdnimg.cn/20181211174047354.png)](en/product_documents/units/unit_rgb)[![](https://img-blog.csdnimg.cn/20181211174057301.png)](en/product_documents/units/unit_relay)[![](https://img-blog.csdnimg.cn/20181211174111764.png)](en/product_documents/units/unit_neopixel) + +**Interface Unit** + +[![](https://img-blog.csdnimg.cn/20181211174142806.png)](en/product_documents/units/unit_hub)[![](https://img-blog.csdnimg.cn/20181211174154240.png)](en/product_documents/units/unit_396port) + + - - - - - | | | |:---:|:---:| |[Product Documents](/en/product_documents) | [M5Stack Cases](/en/m5stack_cases) | @@ -41,13 +88,7 @@ Our aim is "**Stackable Board is Product**". Here's the [Official Website](http: - :computer: Visit [Official Website](http://www.m5stack.com) for newest product - :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack - :mailbox_with_mail: If you have any questions, you can contact us by Email -- :convenience_store: If you want to get our products, access our [Store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) - - +- :convenience_store: If you want to get our products, access our [Store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) --> \ No newline at end of file diff --git a/docs/navbar.md b/docs/navbar.md index bb5bee82..24e9b34c 100644 --- a/docs/navbar.md +++ b/docs/navbar.md @@ -1,3 +1,7 @@ -- [中文](/zh_CN/) -- [En](/) -- [日本語](/ja/) \ No newline at end of file +- Translations + - [:uk: English](/) + - [:cn: 中文](/zh_CN/) + - [:jp: 日本語](/ja/) + + + \ No newline at end of file diff --git a/docs/sidebar.md b/docs/sidebar.md index 36d729a8..0f415d71 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,5 +1,5 @@ - [Product Documents](en/product_documents) -- [Quick Start](en/quick_start) + - [API Reference](en/api_reference) - [M5Stack Cases](en/m5stack_cases) - [Related Documents](en/related_documents) diff --git a/docs/sw.js b/docs/sw.js new file mode 100644 index 00000000..cf6295c4 --- /dev/null +++ b/docs/sw.js @@ -0,0 +1,83 @@ +/* =========================================================== + * docsify sw.js + * =========================================================== + * Copyright 2016 @huxpro + * Licensed under Apache 2.0 + * Register service worker. + * ========================================================== */ + +const RUNTIME = 'docsify' +const HOSTNAME_WHITELIST = [ + self.location.hostname, + 'fonts.gstatic.com', + 'fonts.googleapis.com', + 'unpkg.com' +] + +// The Util Function to hack URLs of intercepted requests +const getFixedUrl = (req) => { + var now = Date.now() + var url = new URL(req.url) + + // 1. fixed http URL + // Just keep syncing with location.protocol + // fetch(httpURL) belongs to active mixed content. + // And fetch(httpRequest) is not supported yet. + url.protocol = self.location.protocol + + // 2. add query for caching-busting. + // Github Pages served with Cache-Control: max-age=600 + // max-age on mutable content is error-prone, with SW life of bugs can even extend. + // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string. + // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190 + if (url.hostname === self.location.hostname) { + url.search += (url.search ? '&' : '?') + 'cache-bust=' + now + } + return url.href +} + +/** + * @Lifecycle Activate + * New one activated when old isnt being used. + * + * waitUntil(): activating ====> activated + */ +self.addEventListener('activate', event => { + event.waitUntil(self.clients.claim()) +}) + +/** + * @Functional Fetch + * All network requests are being intercepted here. + * + * void respondWith(Promise r) + */ +self.addEventListener('fetch', event => { + // Skip some of cross-origin requests, like those for Google Analytics. + if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) { + // Stale-while-revalidate + // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale + // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1 + const cached = caches.match(event.request) + const fixedUrl = getFixedUrl(event.request) + const fetched = fetch(fixedUrl, { cache: 'no-store' }) + const fetchedCopy = fetched.then(resp => resp.clone()) + + // Call respondWith() with whatever we get first. + // If the fetch fails (e.g disconnected), wait for the cache. + // If there’s nothing in cache, wait for the fetch. + // If neither yields a response, return offline pages. + event.respondWith( + Promise.race([fetched.catch(_ => cached), cached]) + .then(resp => resp || fetched) + .catch(_ => { /* eat any errors */ }) + ) + + // Update the cache with the version we fetched (only for ok status) + event.waitUntil( + Promise.all([fetchedCopy, caches.open(RUNTIME)]) + .then(([response, cache]) => response.ok && cache.put(event.request, response)) + .catch(_ => { /* eat any errors */ }) + ) + } +}) \ No newline at end of file diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 9724aec2..61190ebb 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -1,62 +1,143 @@ -# M5Stack +# 产品列表 -[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) -[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) -Star +*** -**欢迎阅读M5Stack文档!** + -?> 点击下划线的蓝色字体可以跳转到对应链接。 +**主控M5Core** - +[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](zh_CN/product_documents/m5stack-core/m5core_basic) [![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](zh_CN/product_documents/m5stack-core/m5core_gray) [![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](zh_CN/product_documents/m5stack-core/m5core_fire) - -**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** +**MiniCore** -**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。** +[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](zh_CN/product_documents/m5stack-core/minicore_stick) -我们的全系列产品基本是以ESP芯片为主芯片。 + -我们希望"**堆叠即是产品**"。 这是我们的[官网](http://www.m5stack.com)。 --> +**套件** - +[![](https://img-blog.csdnimg.cn/20181210155134684.png)](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](zh_CN/product_documents/m5stack-core/face_kit) -| | | -|:---:|:---:| -|[产品介绍](zh_CN/product_documents) | [M5Stack案例](zh_CN/m5stack_cases) | + -| | | -|:---:|:---:| -|[API参考](zh_CN/api_reference) | [常见问题解答](zh_CN/faq)| +*** - +**通讯模块** + +[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](zh_CN/product_documents/modules/module_gps)[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](zh_CN/product_documents/modules/module_lora)[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](zh_CN/product_documents/modules/module_sim800)[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](zh_CN/product_documents/modules/module_commu)[![](https://img-blog.csdnimg.cn/20181212111936228.jpg)](zh_CN/product_documents/modules/module_usb) + + + +**拓展模块** + +[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](zh_CN/product_documents/modules/module_battery)[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](zh_CN/product_documents/modules/module_proto)[![](https://img-blog.csdnimg.cn/20181212110809815.png)](zh_CN/product_documents/modules/module_plus) + + + +**驱动模块** + +[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](zh_CN/product_documents/modules/module_stepmotor)[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](zh_CN/product_documents/modules/module_servo)[![](https://img-blog.csdnimg.cn/2018121211200138.jpg)](zh_CN/product_documents/modules/module_lego+) + + + +*** + + + +**输入/传感类Unit** + +[![](https://img-blog.csdnimg.cn/20181211173622546.png)](zh_CN/product_documents/units/unit_env)[![](https://img-blog.csdnimg.cn/20181211174001353.png)](zh_CN/product_documents/units/unit_ir)[![](https://img-blog.csdnimg.cn/20181211174020278.png)](zh_CN/product_documents/units/unit_pir)[![](https://img-blog.csdnimg.cn/20181211174328827.png)](zh_CN/product_documents/units/unit_angle)[![](https://img-blog.csdnimg.cn/20181211174313215.png)](zh_CN/product_documents/units/unit_adc) + +[![](https://img-blog.csdnimg.cn/20181211175208695.png)](zh_CN/product_documents/units/unit_dac)[![](https://img-blog.csdnimg.cn/20181211174349287.png)](zh_CN/product_documents/units/unit_button)[![](https://img-blog.csdnimg.cn/20181211175218426.png)](zh_CN/product_documents/units/unit_dual_button) + + + +**输出/控制类Unit** + +[![](https://img-blog.csdnimg.cn/20181211174047354.png)](zh_CN/product_documents/units/unit_rgb)[![](https://img-blog.csdnimg.cn/20181211174057301.png)](zh_CN/product_documents/units/unit_relay)[![](https://img-blog.csdnimg.cn/20181211174111764.png)](zh_CN/product_documents/units/unit_neopixel) + +**接口类Unit** + +[![](https://img-blog.csdnimg.cn/20181211174142806.png)](zh_CN/product_documents/units/unit_hub)[![](https://img-blog.csdnimg.cn/20181211174154240.png)](zh_CN/product_documents/units/unit_396port) + + + + +| | | | +| :------------------: |:------------------:| :--------------------:| +| [LEGO-CABLE](zh_CN/product_documents/accessories/cables/lego_cable) | [FRAME](zh_CN/product_documents/accessories/frame) | / | + + + + +| 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](zh_CN/product_documents/units/unit_env) | [RGB](zh_CN/product_documents/units/unit_rgb) | [HUB](zh_CN/product_documents/units/unit_hub) | +| [IR](zh_CN/product_documents/units/unit_ir) | [RELAY](zh_CN/product_documents/units/unit_relay) | [3.96PORT](zh_CN/product_documents/units/unit_396port) | +| [PIR](zh_CN/product_documents/units/unit_pir) | [NeoPixel](zh_CN/product_documents/units/unit_neopixel) | / | +| [ANGLE](zh_CN/product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](zh_CN/product_documents/units/unit_earth) | / | / | +| [LIGHT](zh_CN/product_documents/units/unit_light) | / | / | +| [MAKEY](zh_CN/product_documents/units/unit_makey) | / | / | +| [BUTTON](zh_CN/product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](zh_CN/product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](zh_CN/product_documents/units/unit_joystick) | / | / | +| [THERMAL](zh_CN/product_documents/units/unit_thermal) | / | / | +| [ADC](zh_CN/product_documents/units/unit_adc) | / | / | +| [DAC](zh_CN/product_documents/units/unit_dac) | / | / | +| [Color Sensor](zh_CN/product_documents/units/unit_color_sensor) | / | / | +| [ToF](zh_CN/product_documents/units/unit_tof) | / | / | +| [ESP32Cam](zh_CN/product_documents/units/unit_esp32cam) | / | / | +| [M5Camera](zh_CN/product_documents/units/unit_m5camera) | / | / | +| [NCIR](zh_CN/product_documents/units/unit_ncir) | / | / | + + + + +| | | | +| :------------------: |:------------------:| :--------------------:| +| [BALA](zh_CN/product_documents/applications/application_bala) | [LidarBot](zh_CN/product_documents/applications/application_lidarbot) | / | + + + + +* [M5Stack USB Downloader](zh_CN/product_documents/tools/tool_usb_downloader) --> diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index 5e4885b3..ae46eb5d 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -1,11 +1,71 @@ # 产品列表 -中文 | [English](en/product_documents) | [日本語](ja/product_documents) - -?> 每个产品的`快速上手(Quick Start)`部分都放置在了该产品的介绍文档里。 +*** +**主控M5Core** + +[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](zh_CN/product_documents/m5stack-core/m5core_basic) [![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](zh_CN/product_documents/m5stack-core/m5core_gray) [![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](zh_CN/product_documents/m5stack-core/m5core_fire) + + + +**MiniCore** + +[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](zh_CN/product_documents/m5stack-core/minicore_stick) + + + +**套件** + +[![](https://img-blog.csdnimg.cn/20181210155134684.png)](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](zh_CN/product_documents/m5stack-core/face_kit) + + + +*** + + + +**通讯模块** + +[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](zh_CN/product_documents/modules/module_gps)[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](zh_CN/product_documents/modules/module_lora)[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](zh_CN/product_documents/modules/module_sim800)[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](zh_CN/product_documents/modules/module_commu)[![](https://img-blog.csdnimg.cn/20181212111936228.jpg)](zh_CN/product_documents/modules/module_usb) + + + +**拓展模块** + +[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](zh_CN/product_documents/modules/module_battery)[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](zh_CN/product_documents/modules/module_proto)[![](https://img-blog.csdnimg.cn/20181212110809815.png)](zh_CN/product_documents/modules/module_plus) + + + +**驱动模块** + +[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](zh_CN/product_documents/modules/module_stepmotor)[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](zh_CN/product_documents/modules/module_servo)[![](https://img-blog.csdnimg.cn/2018121211200138.jpg)](zh_CN/product_documents/modules/module_lego+) + + + +*** + + + +**输入/传感类Unit** + +[![](https://img-blog.csdnimg.cn/20181211173622546.png)](zh_CN/product_documents/units/unit_env)[![](https://img-blog.csdnimg.cn/20181211174001353.png)](zh_CN/product_documents/units/unit_ir)[![](https://img-blog.csdnimg.cn/20181211174020278.png)](zh_CN/product_documents/units/unit_pir)[![](https://img-blog.csdnimg.cn/20181211174328827.png)](zh_CN/product_documents/units/unit_angle)[![](https://img-blog.csdnimg.cn/20181211174313215.png)](zh_CN/product_documents/units/unit_adc) + +[![](https://img-blog.csdnimg.cn/20181211175208695.png)](zh_CN/product_documents/units/unit_dac)[![](https://img-blog.csdnimg.cn/20181211174349287.png)](zh_CN/product_documents/units/unit_button)[![](https://img-blog.csdnimg.cn/20181211175218426.png)](zh_CN/product_documents/units/unit_dual_button) + + + +**输出/控制类Unit** + +[![](https://img-blog.csdnimg.cn/20181211174047354.png)](zh_CN/product_documents/units/unit_rgb)[![](https://img-blog.csdnimg.cn/20181211174057301.png)](zh_CN/product_documents/units/unit_relay)[![](https://img-blog.csdnimg.cn/20181211174111764.png)](zh_CN/product_documents/units/unit_neopixel) + +**接口类Unit** + +[![](https://img-blog.csdnimg.cn/20181211174142806.png)](zh_CN/product_documents/units/unit_hub)[![](https://img-blog.csdnimg.cn/20181211174154240.png)](zh_CN/product_documents/units/unit_396port) + + diff --git a/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md b/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md index a1e56b3e..240aad84 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md @@ -1,59 +1,31 @@ -# M5Core BASIC +# 基础版本M5Core -中文 | [English](/en/product_documents/m5stack-core/m5core_basic) | [日本語](ja/product_documents/m5stack-core/m5core_basic) +basic_02 basic_03 basic_04 + +* * * + +:memo:**[描述](#描述)**|:bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**|:octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)**| :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[购买链接](https://item.taobao.com/item.htm?spm=a230r.7195193.1997079397.11.2bb86d62zW1YQG&id=557295147801&abbucket=8)**|:clapper:**[相关视频](#相关视频)** + + ## 描述 -M5Core **BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的基础版开发板，包括黑色的主板和底座。你可以用[UiFlow](http://flow.m5stack.com), MicroPython或Arduino来编程它. 这个黑色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽。底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 +**M5Core BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的基础版开发板，包括黑色的主板和底座。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)或[Arduino](http://www.arduino.cc)来编程它. + +这个黑色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽。底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 + +**注意，这款基础版M5Core不包含任何陀螺仪等姿态传感器** ## 特性 -- 可编程，支持[UiFlow](http://flow.m5stack.com), MicroPython和Arduino +- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) - 支持外置TF卡(最大16G) -## 参数 + +## 外设的管脚映射 + +*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* + +**LCD屏幕&TF卡** + +*LCD像素：320x240* +*TF卡最大支持16GB* + + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
+ +**按键&喇叭** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
+ +**GROVE接口A** + + + + +
ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA
+ + + + + + + +## 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
## 包含 @@ -86,32 +189,44 @@ M5Core **BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙 - Type-C USB 线 - 说明书 -## 文档 +basic_06 basic_07 -- **[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** +basic_08 basic_09 -- **例程** - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples) +basic_10 + + + + + + + + + + + + + +## 相关链接 - **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) -- **快速上手** - Arduino - [MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) +## 相关视频 -
- basic_01 -
-
- basic_02 -
-
- basic_03 -
-
- basic_04 -
-
- basic_05 -
+- **m5stack的简介** -
- basic_05 -
\ No newline at end of file + + + + + + + + + + + diff --git a/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md b/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md index b393e78f..68e341d7 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md @@ -1,90 +1,104 @@ -# M5Stack GRAY +# 灰色升级版M5Core -中文 | [English](/en/product_documents/m5stack-core/m5core_gray) | [日本語](ja/product_documents/m5stack-core/m5core_gray) +:octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)** | :bulb:**[Quick Start](en/quick_start/m5core/m5stack_core_quick_start)** | :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[Purchase](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4004-1172588101.23.f64c4476tugBw5&id=559226082388)**|**[M-Bus](#mbus)** ## 描述 -M5Core **GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的灰色开发板，内置MEMS传感器(**MPU9250**)。你可以用[UiFlow](http://flow.m5stack.com), MicroPython或Arduino来编程它. 这个灰色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、九轴陀螺仪MPU9250。底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 +**M5Core GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙)的灰色开发板，内置MEMS传感器(**MPU9250**)。你可以用[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc)来编程它. + +这个灰色主板包含3个按键、喇叭、LCD(320x240)、TF卡插槽、九轴陀螺仪MPU9250。 + +底座的设计用于拓展M-Bus总线的Pin管脚出来，以方便DIY和产品设计，每个Pin脚都引出来做成了排针或排母形式，非常方便(GPIO0, GPIO12, GPIO13, GPIO15, GPIO34这几个关于I2S功能的引脚没引出)。 ## 特性 -- 可编程，支持[UiFlow](http://flow.m5stack.com), MicroPython和Arduino +- 可编程，支持[UiFlow](http://flow.m5stack.com), [MicroPython](http://micropython.org/)和[Arduino](http://www.arduino.cc) - 支持外置TF卡(最大16G) +## 外设的管脚映射 + +*我们有几种M5Core的版本，点击[这里](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md)查看他们在硬件配置上比较* + +**LCD屏幕&TF卡** + +*LCD像素：320x240* +*TF卡最大支持16GB* + + + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341/MISOCLKCSDCRSTBL
TF卡MOSIMISOCLK CS
+ +**按键&喇叭** + + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
按键引脚BUTTON ABUTTON BBUTTON C
喇叭 喇叭引脚
+ +**GROVE接口A** + + + + +
ESP32 ChipGPIO22GPIO21
GROVE ASCLSDA
+ ## 参数 -| 主控资源 | 参数 | -| :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520K, Wi-Fi, dual mode Bluetooth | -| Flash) | 4M-Bytes | -| Input | 5V @ 500mA | -| Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | -| LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 | -| Speaker | 1W-0928 | -| **MEMS** | MPU9250 | -| Battery | 150mAh @ 3.7V, inside vb | -| Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) | -| Size | 54 x 54 x 12.5 mm | -| C.A.S.E | Plastic ( PC ) | -| Weight | 120g with bottom, 100g only core | - -## 管脚映射 - -**喇叭Speak** - -| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | - -**按键Button** - -| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**MEMS传感器** - -| MPU9250 | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**GROVE接口** - -| Port A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -**LCD屏** - -| ILI9341 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | - -**TF卡** - -| TFCard Pin | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus总线** - -*请查看本文的最后一张图片* + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主控资源参数
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash闪存4M-Bytes
输入电压5V @ 500mA
接口TypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD屏幕2 inch, 320x240 Colorful TFT LCD, ILI9342
喇叭1W-0928
电池150mAh @ 3.7V
工作温度32°F to 104°F ( 0°C to 40°C )
尺寸54 x 54 x 12.5 mm
外壳材质Plastic ( PC )
重量120g with bottom, 100g only core
## 包含 @@ -93,34 +107,28 @@ M5Core **GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙) - Type-C USB 线 - 说明书 -## 文档 - -- **[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** - -- **例程** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) +## 相关链接 - **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) -- **[旗舰店](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)** +gray_01 gray_02 gray_03 -- **快速上手** - Arduino - [MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) +gray_04 -
- gray_01 -
-
- gray_02 -
-
- gray_03 -
-
- gray_04 -
gray_05
-
+ + + + +**M-Bus总线** + +
+ + M_BUS
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/modules/module_gps.md b/docs/zh_CN/product_documents/modules/module_gps.md index 69505618..d05eeda7 100644 --- a/docs/zh_CN/product_documents/modules/module_gps.md +++ b/docs/zh_CN/product_documents/modules/module_gps.md @@ -1,6 +1,6 @@ # GPS模块 -中文 | [English](/en/product_documents/modules/module_gps) | [日本語](ja/product_documents/modules/module_gps) +:octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS)** | :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)** | :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** | 🛒**[购买链接](https://item.taobao.com/item.htm?spm=a230r.7195193.1997079397.11.2bb86d62zW1YQG&id=557295147801&abbucket=8)**|**[M-Bus总线](#mbus)** ## 描述 @@ -23,16 +23,6 @@ GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置 - 儿童定位手表 - 基于GPS的物流跟踪管理 -## 相关链接 - -- **[官网](https://m5stack.com)** - -- **Example** - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS) - -- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) - -- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** -
gps_01
@@ -43,4 +33,20 @@ GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置
gps_05 +
+ +## 其他链接 + +- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) + +- **[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69e0425eAVi1ET&id=559647865340)** + + + +**M-Bus总线** + +
+ + M_BUS
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/units/unit_adc.md b/docs/zh_CN/product_documents/units/unit_adc.md index 2974c99b..16b1257e 100644 --- a/docs/zh_CN/product_documents/units/unit_adc.md +++ b/docs/zh_CN/product_documents/units/unit_adc.md @@ -1,8 +1,5 @@ # Unit ADC -中文 | [English](/en/product_documents/units/unit_adc) | [日本語](ja/product_documents/units/unit_adc) - - ## 描述 这是带自校准功能的16位模拟数字转换unit，相比ESP32芯片自带的ADC（12位）功能分辨率高了不少，意味着你可以测量更小幅值的电压等模拟量，也就是能测量更细微一倍的模拟量，比如采集心电电压做心电监护项目、做血压监测项目、高精度电压监控项目等等。unit集成的ADC芯片通过I2C接口与M5的主控通讯，可以设置成单周期转换和连续转换方式。 diff --git a/docs/zh_CN/product_documents/units/unit_env.md b/docs/zh_CN/product_documents/units/unit_env.md index 9bc97966..edb00602 100644 --- a/docs/zh_CN/product_documents/units/unit_env.md +++ b/docs/zh_CN/product_documents/units/unit_env.md @@ -1,10 +1,14 @@ -# Unit ENV +# ENV - 温湿度和压力传感器 -中文 | [English](/en/product_documents/units/unit_env) | [日本語](ja/product_documents/units/unit_env) + + +*** + +:memo:**[描述](#描述)**|:octocat:**[例程](#例程)**| :electric_plug:**[原理图](#原理图)** | 🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.1-c.w4004-1172588101.29.f64c4476tugBw5&id=578200145474)** ## 描述 -ENV是一款集成DHT12(环境温湿度传感器)的Unit，这个Unit连接了M5Core之后能很方便的读取环境中的温湿度值。 +ENV是一款集成DHT12(环境温湿度传感器)和压强传感器BMP280的Unit，这个Unit连接了M5Core之后能很方便的读取环境中的温湿度值和大气压强。接M5Core的GROVE A口。 ## 特性 @@ -14,13 +18,39 @@ - 湿度测量精度: 0.1% - 气压测量范围: 300 ~ 1100hPa - 气压测量精度: ±1hPa +- GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 - Unit内置两个Lego插件孔，方便与Lego件结合 -## 相关链接 + -- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=a2g1y.12024536.productList_5885013.subject_22)** -
- -
\ No newline at end of file + + + + +## 例程 + +```c++ +DHT12 dht12; //new a object +Adafruit_BMP280 bme; + +float tmp = dht12.readTemperature();//temperature +float hum = dht12.readHumidity();//humidity +float pressure = bme.readPressure();//pressure +``` + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ENV)。 + +## 原理图 + + + +### 管脚映射 + + + + +
M5Core(GROVE A)GPIO22GPIO21
ENV UnitSCLSDA
\ No newline at end of file diff --git a/docs/zh_CN/product_documents/units/unit_ir.md b/docs/zh_CN/product_documents/units/unit_ir.md index 10dc26d5..38595a54 100644 --- a/docs/zh_CN/product_documents/units/unit_ir.md +++ b/docs/zh_CN/product_documents/units/unit_ir.md @@ -1,6 +1,10 @@ -# Unit IR +# IR - 红外对管 -中文 | [English](/en/product_documents/units/unit_ir) | [日本語](ja/product_documents/units/unit_ir) + + +*** + +:memo:**[描述](#描述)**|:octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Advanced/Blynk/Post-DHT12)**| :electric_plug:**[原理图](#原理图)** | 🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.49.6dd575f4jqLzgO&id=578200569184)** ## 描述 @@ -13,12 +17,9 @@ - GROVE接口，支持[UiFlow](http://flow.m5stack.com)编程，[Arduino](http://www.arduino.cc)编程 - Unit内置两个Lego插件孔，方便与Lego件结合 -## 相关链接 + - -- **[原理图](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_IR.pdf)** -- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Infrared-Unit-IR-Remote-Reflective-Sensor-with-Receiver-and-Transmitter-GPIO-GROVE-Connector/3226069_32933215001.html?spm=a2g1y.12024536.productList_5885013.subject_20)** -
- -
\ No newline at end of file +## 原理图 + + 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 7d4f8672..af0d633a 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,26 +1,25 @@ -# M5Core 上手指南(macOS, Arudino) -中文 | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) +# M5Core 上手指南(macOS, Arudino) ?> 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。 -!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection). +!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](zh_CN/related_documents/establish_serial_connection). ## 目录 -1. [配置环境](#setting-environment) +1. [配置环境](#配置环境) - - [Step1. 安装 Arduino IDE](#step1-install-arduino-ide) + - [Step1. 安装Arduino IDE](#Step1-安装arduino-ide) - - [Step2. 安装ESP32的支持包](#step2-esp32-board-support) + - [Step2. 安装ESP32的支持包](#Step2-安装ESP32的支持包) - - [Step3. 安装Arduino-M5Stack库](#step3-install-m5stack-lib) + - [Step3. 安装Arduino-M5Stack库](#Step3-安装arduino-m5stack库) -2. [示例](#example) +2. [示例](#示例) ## 配置环境 -### Step1. 安装`Arduino IDE` +### Step1. 安装Arduino IDE 首先，如果Arduino IDE还没安装的话，先安装它。 这是下载地址 *download address* https://www.arduino.cc/en/Main/Software @@ -48,7 +47,7 @@ python get.py `missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`, 请在终端输入如下命令`xcode-select --install`并Enter，等`xcode-select`安装好了，重启Arduino IDE。 -### Step3. 安装M5Stack Lib +### Step3. 安装Arduino-M5Stack库 打开Arduino IDE, 然后选择`Sketch`->`Include Library`->`Manage Libraries...` @@ -65,7 +64,7 @@ python get.py -## 例程 +## 示例 用USB线连接M5Core和PC，然后选择PC上正与M5Core连接的串口号。 @@ -124,4 +123,4 @@ python get.py
-?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html \ No newline at end of file +?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html 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 6b35182b..cead730a 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 @@ -1,6 +1,6 @@ # UiFlow 上手指南(Blockly/MicroPython) -中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) +[UIFlow简介](https://v.youku.com/v_show/id_XMzkzNTY1ODE4MA==.html?spm=a2hzp.8244740.0.0) ?> a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。 @@ -13,14 +13,14 @@ ## 目录 -1. [连接到UiFlow](#connect-to-uiflow) +1. [连接到UiFlow](#连接到UiFlow) -2. [编程Core](#program-with-core) +2. [编程Core](#编程Core) -3. [音乐例程](#play-a-song-now) +3. [音乐例程](#音乐例程) -## 1. 连接到UiFlow +## 连接到UiFlow 1. 现在用手机或者平板扫描M5Core上的二维码，或者你使用PC编程的话，在PC的浏览器上输入网址`flow.m5stack.com`。 @@ -38,7 +38,7 @@ 现在，可以继续下面的步骤，开始M5Core编程啦！ -## 2. 编程Core +## 编程Core ### a. 画一个UI @@ -82,7 +82,7 @@ lcd.print("Hello M5Stack") 这时候，M5Core屏幕上会打印出`Hello M5Stack`字样。 -## 3. 编写音乐例程 +## 音乐例程 下面，让我们在一两分钟内编写一个音乐例程。 diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index ec65bc1c..54d13221 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,7 +1,5 @@ # M5Cloud 上手指南(MicroPython) -中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - ?> 如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). ?> 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud). @@ -14,11 +12,11 @@ ## 目录 -1. [连接到M5Cloud](#connect-to-m5cloud) +1. [连接到M5Cloud](#连接到M5Cloud) -2. [绑定设备](#binding-device) +2. [绑定设备](#绑定设备) -3. [编程Core](#program-with-Core) +3. [编程Core](#编程Core) ## 1. 连接到M5Cloud 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 63b2e5ef..460bd05b 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 @@ -1,11 +1,9 @@ # M5Stack Core上手指南 -中文 | [English](en/quick_start/m5core/m5stack_core_quick_start) | [日本語](ja/quick_start/m5core/m5stack_core_quick_start) - ## 选择你需要的编程语言 -*使用Arduino/C++编程的话，选择Arduino；使用UiFlow/MicroPython，选择Blockly/MicroPython* +*使用Arduino/C++编程的话，选择Arduino；使用Blockly/MicroPython，选择UiFlow(Blockly/MicroPython)* | ---|--- -[Arduino](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) +[Arduino](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [UiFlow(Blockly/MicroPython)](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/zh_CN/related_documents/establish_serial_connection.md b/docs/zh_CN/related_documents/establish_serial_connection.md index 5c0280fe..6e471e90 100644 --- a/docs/zh_CN/related_documents/establish_serial_connection.md +++ b/docs/zh_CN/related_documents/establish_serial_connection.md @@ -1,7 +1,5 @@ # 如何安装USB驱动并建立与PC的串口通讯 -中文 | [English](/en/related_documents/establish_serial_connection) | [日本語](ja/related_documents/establish_serial_connection) - **这个文档会介绍如何安装USB驱动，并与PC建立串口通信.** ## For MacOS 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 3e4c84fd..cba4e1ee 100644 --- a/docs/zh_CN/related_documents/how_to_burn_firmware.md +++ b/docs/zh_CN/related_documents/how_to_burn_firmware.md @@ -1,7 +1,5 @@ # 如何通过M5Burner烧录固件 -中文 | [English](/en/related_documents/how_to_burn_firmware) | [日本語](ja/related_documents/how_to_burn_firmware) - **这个文档会介绍如何下载M5Burner，并通过M5Burner烧录固件.** ## For MacOS diff --git a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md index 91c94326..55bfed3a 100644 --- a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md @@ -1,8 +1,6 @@ # 连接Wi-Fi(For UiFlow) -中文 | [English](/en/related_documents/how_to_connect_wifi_using_core) | [日本語](ja/related_documents/how_to_connect_wifi_using_core) - -?> **Tip** *如果你的M5Core还没预先烧录了UiFlow固件的话，参考这篇文章[如何使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware))* +?> *如果你的M5Core还没预先烧录了UiFlow固件的话，参考这篇文章[如何使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware))* **烧录了UiFlow的固件，并重启M5Core之后，你会看到如下的欢迎界面，然后我们开始连接Wi-Fi.** diff --git a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index 025bed1a..542b10cb 100644 --- a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,8 +1,6 @@ # 如何连接WIFI (For M5Cloud) -中文 | [English](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud) | [日本語](ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud) - -?> **Tip** *如果你的M5Cloud还没预先烧录名为`M5Cloud`固件的话，请阅读这篇文章[如何烧录使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware)* +?> *如果你的M5Cloud还没预先烧录名为`M5Cloud`固件的话，请阅读这篇文章[如何烧录使用M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware)* **重启M5Core之后，你会看到M5Core出现下图界面。现在我们就开始连接WIFI吧** @@ -34,7 +32,7 @@ -?> **Tip** 如果你的M5Core没成功连接WIFI，请重试一次. +?> 如果你的M5Core没成功连接WIFI，请重试一次. ## 3. 重启M5Core diff --git a/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md index 1b0c2704..e0066f32 100644 --- a/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md +++ b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md @@ -1,7 +1,5 @@ # 安装Git和Arduino IDE (Windows) -中文 | [English](en/related_documents/how_to_install_git_and_arduino) | [日本語](ja/related_documents/how_to_install_git_and_arduino) - ## 1. 安装`Git` 如果你已经安装了`Git`，请直接从第2步开始。 diff --git a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md index 81d30340..c8a89dcf 100644 --- a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md +++ b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md @@ -1,7 +1,5 @@ # 升级M5Stack库(Arduino IDE Library) -中文 | [English](en/related_documents/upgrade_m5stack_lib) | [日本語](ja/related_documents/upgrade_m5stack_lib) - ### 1. 打开Arduino IDE，然后点击`Sketch`->`Include Library`->`Manage Libraries...` ### 2. 在搜索框输入`M5Stack`，并搜索 diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index 030a0f9f..d7d3175d 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -1,5 +1,5 @@ - [产品介绍](zh_CN/product_documents) -- [快速上手](zh_CN/quick_start) + - [API参考](zh_CN/api_reference) - [M5Stack案例](zh_CN/m5stack_cases) - [相关文档](zh_CN/related_documents)