diff --git a/docs/assets/img/product_pics/base/node_03.png b/docs/assets/img/product_pics/base/node_03.png index 4ec01701..5bd9a20f 100644 Binary files a/docs/assets/img/product_pics/base/node_03.png and b/docs/assets/img/product_pics/base/node_03.png differ diff --git a/docs/assets/img/product_pics/base/node_04.png b/docs/assets/img/product_pics/base/node_04.png index 5bd9a20f..4ec01701 100644 Binary files a/docs/assets/img/product_pics/base/node_04.png and b/docs/assets/img/product_pics/base/node_04.png differ diff --git a/docs/en/accessory/cables/lego_cable.md b/docs/en/accessory/cables/lego_cable.md index 74b4d0a4..a26b04bc 100644 --- a/docs/en/accessory/cables/lego_cable.md +++ b/docs/en/accessory/cables/lego_cable.md @@ -1,16 +1,14 @@ # LEGO Cable -[中文](/zh_CN/product_documents/accessories/cables/lego_cable) | English | [日本語](ja/product_documents/accessories/cables/lego_cable) - -## DESCRIPTION +## Description LEGO Cableis designed for connecting GRVOE interface and LEGO, particularly, using for connecting M5Core and LEGO. -## FEATURES +## Feature - 3 specifications: 10cm, 20cm, 30cm -## DOCUMENTS +## Related Link - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** diff --git a/docs/en/accessory/frame.md b/docs/en/accessory/frame.md index cb85c18b..af77927d 100644 --- a/docs/en/accessory/frame.md +++ b/docs/en/accessory/frame.md @@ -1,12 +1,10 @@ # Frame -[中文](zh_CN/product_documents/accessories/frame) | English | [日本語](ja/product_documents/accessories/frame) - -## DESCRIPTION +## Description Frameis designed as a fixed frame for M5Core. -## DOCUMENTS +## Related Link - [Purchase](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) diff --git a/docs/en/api_reference/micropython/api_lcd.md b/docs/en/api_reference/micropython/api_lcd.md index 2a15870f..792e2e8b 100644 --- a/docs/en/api_reference/micropython/api_lcd.md +++ b/docs/en/api_reference/micropython/api_lcd.md @@ -1,7 +1,5 @@ # LCD -[中文](/zh_CN/api_reference/micropython/api_lcd) | English | [日本語](/ja/api_reference/micropython/api_lcd) - ### lcd.setRotation(degree) **Example** @@ -163,7 +161,7 @@ lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) lcd.print('this is a print text function', 80, 80) ``` **Print the text at position (x,y).** - + | Param | Description | | --- | --- | | text | the string need to print | diff --git a/docs/en/api_reference/micropython/api_speaker.md b/docs/en/api_reference/micropython/api_speaker.md index 9cbd5a38..8936220a 100644 --- a/docs/en/api_reference/micropython/api_speaker.md +++ b/docs/en/api_reference/micropython/api_speaker.md @@ -1,7 +1,5 @@ # Speaker -[中文](/zh_CN/api_reference/micropython/api_speaker) | English | [日本語](/ja/api_reference/micropython/api_speaker) - ### tone > M5.Speaker.tone(uint32_t freq); diff --git a/docs/en/api_reference/micropython/peripherals/api_gpio.md b/docs/en/api_reference/micropython/peripherals/api_gpio.md index 33abe530..76abbad3 100644 --- a/docs/en/api_reference/micropython/peripherals/api_gpio.md +++ b/docs/en/api_reference/micropython/peripherals/api_gpio.md @@ -1,7 +1,5 @@ # GPIO -[中文](/zh_CN/api_reference/micropython/peripherals/api_gpio) | English | [日本語](/ja/api_reference/micropython/peripherals/api_gpio) - *Refer to GPIO API of [Arduino](http://www.arduino.cc)* ### digitalRead diff --git a/docs/en/application/bala.md b/docs/en/application/bala.md index 1e1bf09a..4ae9ed71 100644 --- a/docs/en/application/bala.md +++ b/docs/en/application/bala.md @@ -1,15 +1,19 @@ -# M5Stack BALA +# BALA - Balanced Car -[中文](/zh_CN/product_documents/applications/application_bala) | English | [日本語](ja/product_documents/applications/application_bala) + -## DESCRIPTION +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[Example](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** + +## Description The M5Stack BALA is a balance bot based on M5Stack FIRE, including a 2 DC driver module based on Mega328p which is a core chip on Arduino UNO You can even program The M5Stack BALA through Arduino or MicroPython with few code The 2 DC driver module communicates with M5Stack FIRE through I2C bus. It's default I2C address is **0x56** -## FEATURES +## Feature - Programming Support + Python @@ -36,35 +40,9 @@ Size | 54 x 54 x 21 mm C.A.S.E | Plastic ( PC ) Weight | 56g -## INCLUDES +## Include - 1x M5Stack BALA - 1x Motor Driver - 2x N20(Encoder included) - Type-C USB Cable - - -## DOCUMENTS -- **Example** - [Arduino](https://github.com/m5stack/M5Bala/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5Bala/tree/master/mpy) -- **[QuickStart](https://github.com/m5stack/M5Bala)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/en/application/lidarbot.md b/docs/en/application/lidarbot.md index 43382a36..cb66992c 100644 --- a/docs/en/application/lidarbot.md +++ b/docs/en/application/lidarbot.md @@ -1,8 +1,12 @@ # LidarBot -[中文](/zh_CN/product_documents/applications/application_lidarbot) | English | [日本語](ja/product_documents/applications/application_lidarbot) + -## DESCRIPTION +* * * + +:memo:**[Description](#Description)**   :octocat:**[Example](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** + +## Description LidarBot is a four-wheeled car based on indoor navigation. The car body is loaded with lidar, four Mecanum wheels, control-wheel bottom board(based on MEGA328), two RGB bars, M5Core(CarMainController) and some LEGO holes. @@ -10,7 +14,7 @@ Real-time communication via ESP-NOW between the car and the remote control handl And in addition to controlling the car's flexible front, rear, left and right movements, the indoor terrain can also be displayed on the display screens of the car master(M5Core) and the remote control handle. -## FEATURES +## Feature - Lidar: 8m @ 6Hz - Programming Support @@ -43,7 +47,7 @@ And in addition to controlling the car's flexible front, rear, left and right mo - ServoMotor1 <-> A1(MEGA328) - NeoPixelRGB <-> 11(MEGA328) -## INCLUDES +## Include - 1x LidarBot - 1x Remote Control Handle @@ -56,29 +60,4 @@ And in addition to controlling the car's flexible front, rear, left and right mo - Indoor Navigation - Autonomous walking maze - Route plan -- Autopilot\ - -## DOCUMENTS -- **Example** - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) -- **Quick Start** - (coming soon...) -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file +- Autopilot \ No newline at end of file diff --git a/docs/en/base/face_base.md b/docs/en/base/face_base.md index 19218ed3..dcdf1959 100644 --- a/docs/en/base/face_base.md +++ b/docs/en/base/face_base.md @@ -1,7 +1,5 @@ # FACE Base -[中文](/en/product_documents/bases/face_base) | English | [日本語](ja/product_documents/bases/face_base) - ## Description FACE Base is a base of [FACES Kit](en/product_documents/m5stack-core/face_kit). It's composed of M5Core base and battery as shown below. diff --git a/docs/en/base/lan_base.md b/docs/en/base/lan_base.md index 19a497de..baafd7e7 100644 --- a/docs/en/base/lan_base.md +++ b/docs/en/base/lan_base.md @@ -1,8 +1,12 @@ # LAN Base -[中文](/en/product_documents/bases/lan_base) | English| [日本語](ja/product_documents/bases/lan_base) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## 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. @@ -21,38 +25,21 @@ In addition, if you want to communicate with LAN through RS485, we also supply a | RST | GPIO13 | | INTn | GPIO34 | + **M-Bus** -
- M_BUS -
+ -## FEATURES +## Feature - Input Supply Voltage: 9-24V - HT3.96 port for supporting RS485 - Easy to fixed on the wall -## DOCUMENTS +## Related Link -- **[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)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/base/m5go_base.md b/docs/en/base/m5go_base.md index d0615c9e..f1b91e2c 100644 --- a/docs/en/base/m5go_base.md +++ b/docs/en/base/m5go_base.md @@ -1,8 +1,6 @@ # M5GO Base -[中文](/zh_CN/product_documents/bases/m5go_base) | English | [日本語](ja/product_documents/bases/m5go_base) - -## DESCRIPTION +## Description M5GO Baseis a base of [M5GO IOT Starter Kit](en/product_documents/m5stack-core/m5go_iot_starter_kit) or [M5Fire](en/product_documents/m5stack-core/m5core_fire). @@ -62,7 +60,7 @@ The charging indicator light will blink when base is charging, but the light wil M_BUS -## DOCUMENTS +## Related Link - **[Schematic](https://github.com/m5stack/M5GO/blob/master/hardware/schematics/M5GO_Base.pdf)** - **[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)** diff --git a/docs/en/base/node_base.md b/docs/en/base/node_base.md index 311c4674..8c4e5a61 100644 --- a/docs/en/base/node_base.md +++ b/docs/en/base/node_base.md @@ -1,8 +1,11 @@ # Node Module -[中文](/zh_CN/product_documents/bases/node_base) | English | [日本語](ja/product_documents/bases/node_base) + -## DESCRIPTION +*** +:memo:**[Description](#Description)**      :octocat:**[Example](https://github.com/m5stack/M5StackModule-Node/tree/master/example)**      :electric_plug:**[Schematic](https://github.com/m5stack/Bases-Node/tree/master/schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-NODE-Samrt-Speaker-WM8978-Audio-Development-Board-I2S-Module-with-DHT12-Sensor-MIC-IR/3226069_32949773234.html)** + +## Description Node is a base as a intelligent node in the IOT. If stacked a M5Core, it will be a intelligent node that can communicate with surrounding equipments via IR, Bluetooth or WIFI. @@ -11,13 +14,13 @@ * There are two MIC * A Codec chip(WM8978) inside that is often used to be applied for Hi-Fi Speaker. -## FEATURES +## Feature - Including 12 RGBLed - Including a HiFi stereo codec chip(Up to 24bit DAC) - Including a lithium battery interface -## INCLUDES +## Include - 1x Node Module - Wall holder @@ -31,27 +34,6 @@ - Webradio - Intelligent sound box -## DOCUMENTS +## Related Link -- **[WebSite](https://m5stack.com)** - **[WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978)** -- **[Schematic](https://github.com/m5stack/M5StackModule-Node/tree/master/schematic)** -- **[Example](https://github.com/m5stack/M5StackModule-Node/tree/master/example)** - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-NODE-Samrt-Speaker-WM8978-Audio-Development-Board-I2S-Module-with-DHT12-Sensor-MIC-IR/3226069_32949773234.html)** - -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index 01fd56eb..1b653c53 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -119,6 +119,6 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- ## Related Video -- **m5stack's instroduce** +- **m5stack instroduce** diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index 35f0216a..c291a407 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -1,7 +1,5 @@ # FACES Kit -[中文](/zh_CN/product_documents/m5stack-core/face_kit) | English | [日本語](ja/product_documents/m5stack-core/face_kit) - **FACES Kit** is a kit composed of M5Core GRAY, functional keyboards, FACES Base, FACES Charger and some accessories(including DuPont lines, lanyard, M3 fixing screws and so on). Currently, the functional keyboards are composed of GameBoy, Calculator and QWERTY. We'll add other keyboards to FACES Kit. You can program it through Arduino IDE or MicroPython. For different applications, you can stack corresponding keyboard on FACES Base and burn corresponding firmware into M5Core. And here, you can learn more about [FACES Base](en/product_documents/bases/face_base). *For each keyboard, it's integrated **MEGA328** chip, so that when you press a button, a corresponding value(**hexadecimal format**) will be sent from keyboard to M5Core. They(keyboard and m5core) are communicating using I2C. And the I2C address of each keyboard is 0x08.* diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index 986d15d7..610df978 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -1,8 +1,12 @@ # M5Stack FIRE -[中文](/zh_CN/product_documents/m5stack-core/m5core_fire) | English | [日本語](ja/product_documents/m5stack-core/m5core_fire) +fire_01 -## DESCRIPTION +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/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-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)**   :clapper:**[Related Video](#Related-Video)** + +## Description The M5Stack **FIRE** is a development kit based on ESP32 chip. FIRE is a kit which composed of red m5core, M5Go Base and M5Go CHG. Base(for charging red m5core). You can even program The M5Stack FIRE through Blockly, Arduino or MicroPython. @@ -10,7 +14,7 @@ The M5Stack FIRE equips the ESP32 with everything necessary to program, run and M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, 2 RGBLed Bars(SK6812), a microphone and a Battery(600mAh). -## FEATURES +## Feature - Programming Support - UiFlow @@ -19,122 +23,137 @@ M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, - Compatible LEGO - TF Card Support -## PARAMETER - -| Source | Parameter | -| :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | -| Flash | 16MB Flash + 4MB pSRAM | -| 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 | -| Microphone | MEMS Analog BSE3729 Microphone | -| LED | SK6812 3535 RGB LED x 10 | -| **MEMS** | MPU9250 (MPU6500 + AK8963) | -| Battery | 550mAh @ 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 | 56g | - ## PinMap -**POGO Pin** +*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | +#### MainBoard Pinmap -**LED Bar** +**LCD & TF Card** -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | +*LCD Pixel：320x240* +*Maximum storage of TF Card: 16GB* -**MIC** + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
-| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | +**Button & Speaker** -**Speak** + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
-| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | +**GROVE A** -**Button** + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
-| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | +**9-axis IMU sensor(MPU9250)** -**GROVE** +*I2C Address: 0x68* -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
-| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | +#### M5GO Base Pinmap -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | +**GROVE B** -**MEMS Chip** + + + +
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
-*MPU9250 i2c address: 0x68* +**GROVE C** -| MPU9250 | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | + + + +
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
-**LCD** +**LED Bar & MicroPhone** -| ILI9341 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | + + + + +
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
-**TF Card** +## PARAMETER -| TFCard Pin | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash & PSRAM16MB Flash + 4MB pSRAM
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
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
-**M-Bus** - -
- M_BUS -
- -## INCLUDES +## Include - 1x M5Stack FIRE - 1x M5GO Base @@ -142,46 +161,12 @@ M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, - Type-C USB Cable - User Manual -## DOCUMENTS +## Related Link -- **Example** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) -- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - [AK8963](https://www.akm.com/akm/en/file/datasheet/AK8963C.pdf) +## Related Video -- **Register map** - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) +- **m5stack instroduce** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)** - -- **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) - -## READ MORE - -### The difference between M5Cores - -https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md - -### Diagram of Fire - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
+ diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index 8511b85b..7571e297 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -1,6 +1,12 @@ # 灰色升级版M5Core -: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)** +gray_02 gray_02 gray_04 + + + +* * * + +: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-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)**   :clapper:**[Related Video](#Related-Video)** ## Description @@ -15,119 +21,151 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - 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 | 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 | -| **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 | - ## PinMap -**Speak** +*We have several kinds of m5core board on sale, click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores_zh_CN.md) for their difference.* -| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | +#### MainBoard Pinmap -**Button** +**LCD & TF Card** -| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | +*LCD Pixel：320x240* +*Maximum storage of TF Card: 16GB* -**MEMS Sensor** + + + + +
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
ILI9341(LCD Driver)/MISOCLKCSDCRSTBL
TF CardMOSIMISOCLK CS
-*IIC Address of MPU9250 is 0x68* +**Button & Speaker** -| MPU9250 | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | + + + + +
ESP32 ChipGPIO39GPIO38GPIO37GPIO25
ButtonBUTTON ABUTTON BBUTTON C
Speaker Speaker Pin
-**GROVE** +**GROVE A** -| Port A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | + + + +
ESP32 ChipGPIO22GPIO215VGND
GROVE ASCLSDA5VGND
-**LCD** +**9-axis IMU sensor(MPU9250)** -| ILI9341 | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | / | -| CLK | GPIO18 | -| CS | GPIO14 | -| DC | GPIO27 | -| RST | GPIO33 | -| BL | GPIO32 | +*I2C Address: 0x68* -**TF Card** + + + +
ESP32 ChipGPIO22GPIO215VGND
MPU9250SCLSDA5VGND
-| TFCard Pin | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | +#### M5GO Base Pinmap -**M-Bus** +**GROVE B** -
- M_BUS -
+ + + +
ESP32 ChipGPIO36GPIO265VGND
GROVE BGPIO36GPIO265VGND
-## INCLUDES +**GROVE C** + + + + +
ESP32 ChipGPIO16GPIO175VGND
GROVE CRXDTXD5VGND
+ +**LED Bar & MicroPhone** + + + + + +
ESP32 ChipGPIO15GPIO34
LED BarSIG Pin
MicroPhone MIC Pin
+ +## PARAMETER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
M5Core SourceParameter
ESP32240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth
Flash4MB
Input5V @ 500mA
InterfaceTypeC x 1, GROVE(I2C+I/0+UART) x 1
LCD2 inch, 320x240 Colorful TFT LCD, ILI9342
Speaker1W-0928
MicrophoneMEMS Analog BSE3729 Microphone
LEDSK6812 3535 RGB LED x 10
MEMSMPU9250
Battery550mAh @ 3.7V, inside vb
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 M5Core GRAY - 1x M5Core Bottom - Type-C USB Cable - User Manual -## DOCUMENTS +## Related Link -- **[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) -- **Datasheet** - [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) +## Related Video -- **[Purchase](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)** +- **m5stack instroduce** -- **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) - -- **[The difference between M5Cores](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** - -
- gray_01 -
-
- gray_02 -
-
- gray_03 -
-
- gray_04 -
-
- gray_05 -
+ diff --git a/docs/en/core/m5go_iot_starter_kit.md b/docs/en/core/m5go_iot_starter_kit.md index 1325bc6f..61fc1c84 100644 --- a/docs/en/core/m5go_iot_starter_kit.md +++ b/docs/en/core/m5go_iot_starter_kit.md @@ -1,8 +1,14 @@ # M5GO IOT Starter Kit -[中文](/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit) | English | [日本語](ja/product_documents/m5stack-core/m5go_iot_starter_kit) +gray_02 gray_02 gray_04 -## DESCRIPTION + + +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/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-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.4.44fa29faDagj56)**   :clapper:**[Related Video](#Related-Video)** + +## Description **M5GO IOT Starter Kit** is a kit designed for learning IOT programming which consists of 6 units(ENV, IR, RGB, PIR, ANGLE, HUB) and one white M5Core(based on ESP32 chip). @@ -10,7 +16,7 @@ Programming M5GO with [UiFlow](http://flow.m5stack.com) or Arduino IDE. We also supply some courses for teaching IOT programming. If you are interesting in it, contact us through Email please. -## FEATURES +## Feature - Programming Support - Arduino @@ -18,120 +24,7 @@ We also supply some courses for teaching IOT programming. If you are interesting - MicroPython - TF Card Support -## PARAMETER - -| Source | Parameter | -| :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth | -| Flash) | 16MB | -| 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 | 550mAh @ 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 | 300g with bottom | - -## PinMap - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED Bar** - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**Speak** - -| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | - -**Button** - -| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**MEMS Chip** - -*MPU9250 i2c address: 0x68* - -| MPU9250 | 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 Card** - -| TFCard Pin | ESP32 Chip | -| :----------: |:------------: | -| MOSI | GPIO23 | -| MISO | GPIO19 | -| CLK | GPIO18 | -| CS | GPIO4 | - -**M-Bus** - -
- M_BUS -
- -## INCLUDES +## Include - 1x white M5Core - 1x M5GO Base @@ -141,38 +34,18 @@ We also supply some courses for teaching IOT programming. If you are interesting - Type-C USB Cable - User Manual -## DOCUMENTS + -- **Example** - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) + -- **[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.6.44fa2da3D2i5Yi)** + -- **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 Link -
- -
+- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](http://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) -
- -
+## Related Video -
- -
+- **m5stack instroduce** -
- -
- -
- -
- -
- -
+ \ No newline at end of file diff --git a/docs/en/core/m5stick.md b/docs/en/core/m5stick.md index af369603..08ab5a76 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -1,14 +1,18 @@ # M5Stick -[中文](/zh_CN/product_documents/m5stack-core/minicore_stick) | English | [日本語](ja/product_documents/m5stack-core/minicore_stick) +gray_02 gray_02 gray_04 -## DESCRIPTION +* * * + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](en/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**     :electric_plug:**[Schematic](#Schematic)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-M5Stick-Mini-Development-Kit-ESP32-1-3-OLED-80mAh-Battery-Inside-Buzzer-IR/3226069_32947692973.html?spm=a2g1y.12024536.productList_5885011.subject_1)**    + +## Description **M5Stick** is a mini esp32 development board including 1.3' OLED Screen(64x128), led, button, buzzer, IR Transmitter, 80mAh-Battery and **optional MEMS(MPU9250)**. Usually, you can put it on your wrist with `WATCH BELT` or band it on the wall with `WALL` or `BRICK`. There are two version of it. One M5Stick does not contain MPU9250, another version contains MPU9250 and some accessories(likes `WATCH BELT`, `WALL` and `BRICK`). -## FEATURES +## Feature - Programming Support: Arduino, UiFlow(Blockly, MicroPython) - Wearable @@ -47,32 +51,14 @@ There are two version of it. One M5Stick does not contain MPU9250, another versi -## INCLUDES +## Include - 1x M5Stick including 80mAh-Battery - 1x Type-C USB Cable -MPU9250 Version: +**MPU9250 Version:** - Some accessories: `WATCH BELT`, `WALL` and `BRICK` -## DOCUMENTS - -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest) +## Related Link - **Datasheet** - [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) - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-M5Stick-Mini-Development-Kit-ESP32-1-3-OLED-80mAh-Battery-Inside-Buzzer-IR/3226069_32947692973.html?spm=a2g1y.12024536.productList_5885011.subject_1)** - -- **Quick Start** - [Arduino](en/quick_start/m5core/m5stick_get_started_arduino) - -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/en/core/white.md b/docs/en/core/white.md index 58773a95..2213a743 100644 --- a/docs/en/core/white.md +++ b/docs/en/core/white.md @@ -2,7 +2,7 @@ [中文](/zh_CN/product_documents/m5stack-core/m5core_white) | English | [日本語](ja/product_documents/m5stack-core/m5core_white) -## DESCRIPTION +## Description **The White M5Core is a main board of M5GO IOT Starter Kit.** The White M5Core is similar with M5Core GRAY. But it's bottom module is M5GO Base, not the same as M5Core GRAY. @@ -10,7 +10,7 @@ It equips the ESP32 with everything necessary to program, run and develop on the 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 - UiFlow @@ -132,7 +132,7 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- M_BUS -## INCLUDES +## Include - 1x M5Core WHITE - 1x M5GO Base @@ -140,7 +140,7 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - Type-C USB Cable - User Manual -## DOCUMENTS +## Related Link - **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) diff --git a/docs/en/module/battery.md b/docs/en/module/battery.md index 3112f2d8..7250eff2 100644 --- a/docs/en/module/battery.md +++ b/docs/en/module/battery.md @@ -1,23 +1,27 @@ # M5Stack BATTERY Module -[中文](/zh_CN/product_documents/modules/module_battery) | English | [日本語](ja/product_documents/modules/module_battery) + -# DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-Battery-Module-for-Arduino-ESP32-Core-Development-Kit-Capacity-850mAh-Stackable-IoT/3226069_32839688875.html?spm=2114.12010610.8148356.8.7b26c4a1uVFob3.html)** + +# Description The M5Stack BATTERY Module is module with 850mAh High-Capacity Battery. User can create a portble device with any series of M5Stack Core and M5Stack BATTERY Module easily. -# FEATURES +# Feature - 850mAh High-Capacity Battery -# INCLUDES +# Include - 1x M5Stack BATTERY Module -# DOCUMENTS +## Related Link -- [WebSite](https://m5stack.com) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-Battery-Module-for-Arduino-ESP32-Core-Development-Kit-Capacity-850mAh-Stackable-IoT/3226069_32839688875.html?spm=2114.12010610.8148356.8.7b26c4a1uVFob3.html) +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/btc.md b/docs/en/module/btc.md index 39804be1..82edc05e 100644 --- a/docs/en/module/btc.md +++ b/docs/en/module/btc.md @@ -1,8 +1,14 @@ # M5Stack BTC Module -[中文](/zh_CN/product_documents/modules/module_btc) | English | [日本語](ja/product_documents/modules/module_btc) + -# DESCRIPTION + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](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)** + +# Description The M5Stack BTC Module is a base including DHT12 module which can detect temperature and humidity. Your M5Stack Core board can stay as a small @@ -10,11 +16,11 @@ displayer(like a small TV or a small IOT central contronller) after adding this BTC Module. Absolutely, it is more easier to charge M5Stack Core via Type-C Cable after adding this BTC Module. -# FEATURES +# Feature - DHT12 inside -# INCLUDES +# Include - Type-C USB Cable - M3 x 16 @@ -22,6 +28,8 @@ Core via Type-C Cable after adding this BTC Module. # PinMap +**DHT12** + | DHT12 | ESP32 | | :----------: |:------------:| | SCL | G22 | @@ -29,26 +37,12 @@ Core via Type-C Cable after adding this BTC Module. | SDA | G21 | | 3V3 | 3V3 | -
- -
+ -# DOCUMENTS -- [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/DHT12) (for DHT12) +# Related Link -
- -
+- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** -
- -
- -
- -
\ No newline at end of file diff --git a/docs/en/module/commu.md b/docs/en/module/commu.md index 95932338..b1f4802b 100644 --- a/docs/en/module/commu.md +++ b/docs/en/module/commu.md @@ -1,21 +1,25 @@ # COMMU -[中文](/zh_CN/product_documents/modules/module_commu) | English | [日本語](ja/product_documents/modules/module_commu) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-COMMU-Module-Extend-RS485-TTL-CAN-I2C-Port-with-MCP2515-TJA1051-SP3485-Development-Board/3226069_32954475633.html?spm=a2g1y.12024536.productList_5885013.subject_2)** + +## Description COMMU is a communication interface converter which can meet most of the application design. Now, COMMU owns two I2C interfaces, one CAN interface and one RS485 interface. Simultaneously, COMMU also owns a TTL level interface. It means you just need to stack it underneath M5Core when you want to control a CAN device or RS485 device. Be care about TTL Interface. It is a UART Interface actually by default. But you can switch it to connect with UART2 after changed those jumpers(J6, J7, J9, J10). -## FEATURES +## Feature - 2x I2C Interface - 1x CAN Interface - 1x RS485 Interface - 1x TTL Interface -## INCLUDES +## Include - 1x M5Stack COMMU Module @@ -36,15 +40,8 @@ Be care about TTL Interface. It is a UART Interface actually by default. But you | IIC_SCL | GPIO22 | -## DOCUMENTS +## Related Link -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_commu_sch.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-COMMU-Module-Extend-RS485-TTL-CAN-I2C-Port-with-MCP2515-TJA1051-SP3485-Development-Board/3226069_32954475633.html?spm=a2g1y.12024536.productList_5885013.subject_2)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
- -
- -
+- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/gps.md b/docs/en/module/gps.md index 6676e23c..fdca0925 100644 --- a/docs/en/module/gps.md +++ b/docs/en/module/gps.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.69f6425e8Agsbh&id=559647865340)** +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](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)** ## Description @@ -42,8 +42,6 @@ global positioning information even you in the wild and get lost. - **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS) -- **[Purchase](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)** - ## Example ## Schematic diff --git a/docs/en/module/lan.md b/docs/en/module/lan.md index ce093700..9ee73c71 100644 --- a/docs/en/module/lan.md +++ b/docs/en/module/lan.md @@ -1,8 +1,12 @@ # M5Stack LAN Module -[中文](/zh_CN/product_documents/modules/module_lan) | English | [日本語](ja/product_documents/modules/module_lan) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## Description The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. @@ -10,12 +14,12 @@ When the speed of our wireless network is so slow that M5Stack Core can not norm So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. -## FEATURES +## Feature - W5500 - High-performance ethernet chip - Less code and Hand-in-hand program experience -## INCLUDES +## Include - 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) - 1x DIN-RAIL @@ -31,16 +35,10 @@ So we need a ethernet port board which is connected with M5Stack Core. This **LA + HTTP Clinet - SMTP/NTP Server -## DOCUMENTS +## Related Link -- [WebSite](https://m5stack.com) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- Example - + [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) +- **[Forum](http://forum.m5stack.com/)** -- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) - -- GitHub - + [Arduino GitHub](https://github.com/m5stack/M5Stack) - -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html) +- [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) \ No newline at end of file diff --git a/docs/en/module/lora.md b/docs/en/module/lora.md index 6a1cb44b..1f021fe3 100644 --- a/docs/en/module/lora.md +++ b/docs/en/module/lora.md @@ -1,8 +1,12 @@ # M5Stack LORA Module -[中文](/zh_CN/product_documents/modules/module_lora) | English | [日本語](ja/product_documents/modules/module_lora) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-LoRa-Module-for-ESP32-DIY-Development-Kit-Wireless-433MHz-Built-in-Antenna/3226069_32839736315.html?spm=2114.12010615.8148356.22.25e96be7xE1y22.html)** + +## Description The LoRa Module is a module with small LoRa module named Ra-02. You can program it after connected to any series of M5Stack Core through @@ -13,7 +17,7 @@ communication, and compatible FSK remote modulation and demodulation quickly, to solve the traditional wireless design can not take into account the distance, anti-interference and power consumption -## FEATURES +## Feature - LoRa Module named RA-02 supply by Ai-Thinker - Supports FSK, GFSK, MSK, GMSK, LoRa ™ and OOK modulation modes @@ -21,7 +25,7 @@ account the distance, anti-interference and power consumption - Programmable bit rate up to 300Kbps - Build-in Antenna -## INCLUDES +## Include - 1x M5Stack LoRa Module @@ -31,13 +35,13 @@ account the distance, anti-interference and power consumption - Home building automation - Remote irrigation system -## DOCUMENTS +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** -- **[WebSite](https://m5stack.com)** -- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Lora)** - **[LoRa Info](http://wiki.ai-thinker.com/lora) (LoRa)** -- **[GitHub](https://github.com/m5stack/M5Stack)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-LoRa-Module-for-ESP32-DIY-Development-Kit-Wireless-433MHz-Built-in-Antenna/3226069_32839736315.html?spm=2114.12010615.8148356.22.25e96be7xE1y22.html)** ?> **Note** If your board LCD can't display or has some other problem, we suggest you to add the two statements code followed by ``m5.begin();`` as shown @@ -50,15 +54,3 @@ below ?> **Note** Because GPIO5 who has connected NSS pin of LoRa module need be pull-up at the moment your board(or system) power on to prevent system's LCD can't display. - -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/en/module/lorawan.md b/docs/en/module/lorawan.md index b13d8934..057be51b 100644 --- a/docs/en/module/lorawan.md +++ b/docs/en/module/lorawan.md @@ -1,8 +1,12 @@ # LoRaWAN -[中文](/zh_CN/product_documents/modules/module_lorawan) | English | [日本語](ja/product_documents/modules/module_lorawan) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-LoRaWAN-Module-433-470Mhz-868-915MHz-with-Internal-Antenna-and-MCX-External-Antenna-Port/3226069_32953098569.html?spm=a2g1y.12024536.productList_5885011.pic_2)** + +## Description LoRaWAN is a small LoRa terminal module built-in LoRa chip(SX1276) and ST MCU that means this module has been built with complete LoRa protocal stack. So you can develop a LoRaWAN module through UART or simple AT command with M5Core. @@ -10,7 +14,7 @@ By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 st ?> **Notice** The 5 holes which are under the silk screen "LoRaWAN" are designed for upgrading the firmware of LoRaWAN module. -## FEATURES +## Feature - Supports 433/470MHz and 868/915MHz - Supports DataRate: 0.018-38.4kbps @@ -18,7 +22,7 @@ By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 st - Supports ADR(Adaptive Data Rate) - Build-in Antenna -## INCLUDES +## Include - 1x LoRa Module @@ -35,16 +39,12 @@ By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 st | RXD | GPIO17 | | TXD | GPIO16 | -## DOCUMENTS +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **[LoRaWAN Info](http://wiki.ai-thinker.com/sx127x-052) (LoRaWAN)** + - **[AT command for LoRaWAN](http://wiki.ai-thinker.com/_media/rhf-ps01509_lorawan_class_ac_at_command_specification_-_v4.4.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-LoRaWAN-Module-433-470Mhz-868-915MHz-with-Internal-Antenna-and-MCX-External-Antenna-Port/3226069_32953098569.html?spm=a2g1y.12024536.productList_5885011.pic_2)** - -
- -
- -
- -
diff --git a/docs/en/module/plc.md b/docs/en/module/plc.md index 4da085fc..6f168bed 100644 --- a/docs/en/module/plc.md +++ b/docs/en/module/plc.md @@ -1,8 +1,12 @@ # M5Stack PLC Module -[中文](/zh_CN/product_documents/modules/module_plc) | English | [日本語](ja/product_documents/modules/module_plc) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** + +## Description The M5Stack PLC Module is a prototye industrial board, including RS484 adapter and electricity meter module. @@ -10,14 +14,14 @@ adapter and electricity meter module. With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin relay output, digital input, communication interface etc. -## FEATURES +## Feature - Free DIY - Programmable Logic Controller - Individual package weight: 0.1kg (0.22lb.) - Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) -## INCLUDES +## Include - 1x PLC-Proto Broad - 1x RS485 module @@ -37,9 +41,8 @@ relay output, digital input, communication interface etc. - Digital Operation Processor - Strong Electric Controller -## DOCUMENTS +## Related Link -- [WebSiteStart](https://m5stack.com) -- GitHub - - [Arduino](https://github.com/m5stack/M5Stack) - - [MicroPython]() +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/plus.md b/docs/en/module/plus.md index 544a0660..492a34e0 100644 --- a/docs/en/module/plus.md +++ b/docs/en/module/plus.md @@ -1,32 +1,28 @@ # M5Stack PLUS -[中文](/zh_CN/product_documents/modules/module_plus) | English | [日本語](ja/product_documents/modules/module_plus) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-PLUS-Module-Encoder-Module-with-MEGA328P-500mAh-Battery-ISP-IR-Transmitter-UART-GPIO/3226069_32949278724.html?spm=a2g1x.12024536.productList_5885013.pic_1)** + +## Description This a enhanced module including battery(500mAh), gear potentiometer, IR transmitter, PORT B(GPIO Port), PORT C(UART Port) and MicroPhone Pad. You can stack it with a M5Core for function enhancement. The module comunicates with M5Core with I2C. It's I2C address is 0x89. -## FEATURES +## Feature - 500mAh Battery - Programmable gear potentiometer - IR transmitter - Including PORT B and PORT C -## INCLUDES +## Include - 1x PLUS Module -## DOCUMENTS +## Related Link -- [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Plus) -- [GitHub](https://github.com/m5stack/M5Stack) -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-PLUS-Module-Encoder-Module-with-MEGA328P-500mAh-Battery-ISP-IR-Transmitter-UART-GPIO/3226069_32949278724.html?spm=a2g1x.12024536.productList_5885013.pic_1) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
- -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** \ No newline at end of file diff --git a/docs/en/module/proto.md b/docs/en/module/proto.md index fe06fa19..0e68b34c 100644 --- a/docs/en/module/proto.md +++ b/docs/en/module/proto.md @@ -1,15 +1,19 @@ # M5Stack PROTO Module -[中文](/zh_CN/product_documents/modules/module_proto) | English | [日本語](ja/product_documents/modules/module_proto) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**     🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-Proto-Module-Proto-Board-with-Extension-Bus-Socket-for-Arduino-ESP32-Development/3226069_32843231933.html?spm=2114.12010610.8148356.4.7b26c4a1MZw8Xy.html)** + +## Description The M5Stack PROTO Module is a flexible blank circle with 30 pins which could connect with all series of M5Stack Core. You can create any circle that could controlled by any M5Stack Core on M5Stack PROTO Module as you like. -## FEATURES +## Feature - Flexible extended blank circle - Compatible with all series of M5Stack Core @@ -34,7 +38,7 @@ like. | HPOWR | 5V | | HPOWR | BAT | -## INCLUDES +## Include - 1x M5Stack PROTO Module - 1x Bus Socket @@ -42,18 +46,8 @@ like. - 1x Packing Box - User Manual -## DOCUMENTS +## Related Link -- [WebSite](https://m5stack.com) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- [GitHub](https://github.com/m5stack/M5Stack) - -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-Proto-Module-Proto-Board-with-Extension-Bus-Socket-for-Arduino-ESP32-Development/3226069_32843231933.html?spm=2114.12010610.8148356.4.7b26c4a1MZw8Xy.html) - -
- -
- -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/en/module/servo.md b/docs/en/module/servo.md index 65093f80..da3dbc49 100644 --- a/docs/en/module/servo.md +++ b/docs/en/module/servo.md @@ -1,8 +1,12 @@ # SERVO -[中文](/zh_CN/product_documents/modules/module_servo) | English | [日本語](ja/product_documents/modules/module_servo) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)** + +## Description Servo is a servo-motor driver module which can drive 12-way servo motors simultaneously. But actually, in our experiment, because of the maximum current, the maximum number of servo motor it can drive is 9. So we will publish a upgraded version soon after. @@ -10,13 +14,13 @@ It's too easy to drive servo motors so that you can drive many servo motors afte Servo is communicated with M5Core through GROVE interface(I2C communication). The I2C address is 0x53. -## FEATURES +## Feature - Drive multi-way servo motor simultaneously - Support wide-voltage power input: 6-12V - Support programming with Arduino IDE or UiFlow -## INCLUDES +## Include - 1x M5Stack Servo Module - 1x 6-12V Power Interface @@ -27,22 +31,36 @@ Servo is communicated with M5Core through GROVE interface(I2C communication). Th - Bionic multi-joint robot - 3-axis head for camera -## DOCUMENTS +## Related Link - +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Servo)** +- **[Forum](http://forum.m5stack.com/)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-SERVO-Module-Board-12-Channels-Servo-Controller-with-MEGA328-Inside-Power-Adapter-6-24V/3226069_32951356502.html?spm=a2g1y.12024536.productList_5885011.pic_0)** +## Example -
- -
+### 1. Arduino IDE -
- -
+```c++ +#define SERVO_ADDR 0x53 //the IIC address of SERVO Module +/* + * control servo(CH channle) by us + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x00); +Wire.write(timeL); +Wire.write(timeH); +Wire.endTransmission(); -
- -
\ No newline at end of file +/* + * control servo(CH channle) by angle + */ +Wire.beginTransmission(SERVO_ADDR); +Wire.write(CH|0x10); +Wire.write(angle);//0-180° +Wire.endTransmission(); +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino) for specifical example. + +## Schematic \ No newline at end of file diff --git a/docs/en/module/sim800.md b/docs/en/module/sim800.md index dec33bb6..7a1312d0 100644 --- a/docs/en/module/sim800.md +++ b/docs/en/module/sim800.md @@ -1,8 +1,12 @@ # M5Stack SIM800L Module -[中文](/zh_CN/product_documents/modules/module_sim800) | English | [日本語](ja/product_documents/modules/module_sim800) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html)** + +## Description The M5Stack SIM800L Module is a module with small SIM800L GSM/GPRS module. You can program it after connected to any series of M5Stack Core @@ -13,7 +17,7 @@ be connected with M5Stack Core via a serial port named USART2. Absolutely, you also can change the serial port number with jumper by your own. -## FEATURES +## Feature - SIM800L Module - Build-in Antenna @@ -33,11 +37,11 @@ your own. | SIM800 Pin | ESP32 Chip | | :----------: |:------------: | -| TXD | GPIO16 | -| RXD | GPIO17 | +| TXD | U2RXD(GPIO16) | +| RXD | U2TXD(GPIO17) | | RST | GPIO5 | -## INCLUDES +## Include - 1x M5Stack SIM800L Module @@ -47,10 +51,34 @@ your own. - Automatic Web Spider SMS-notifier - Remote meter reading system -## DOCUMENTS +## Related Link - -- [SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138)** (SIM800L) -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html) +## Example + +### 1. Arduino IDE + +Here's a example using SIM800 for sending SMS + +```c++ +/* +* Master.ino +*/ +Serial2.begin(9600, SERIAL_8N1, 16, 17); + +/* LoRaWAN Init */ +//entry test mode +Serial2.print("AT+Mode=Test"); +//Configure the modem,like Freq, SF, BW, Preamble length, TX output power +Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); +//send data as HEX format +Serial2.print("AT+TEST=TXLRPKT,"00 00 01 00 00 AF 80 07 02 00 00 39""); +``` + +## Schematic \ No newline at end of file diff --git a/docs/en/module/stepmotor.md b/docs/en/module/stepmotor.md index 0d011d35..c25e0492 100644 --- a/docs/en/module/stepmotor.md +++ b/docs/en/module/stepmotor.md @@ -1,18 +1,24 @@ # Step Motor Module -[中文](/zh_CN/product_documents/modules/module_stepmotor) | English | [日本語](ja/product_documents/modules/module_stepmotor) + -## DESCRIPTION + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-Stepmotor-Module-for-Arduino-ESP32-GRBL-12C-Step-Motor-MEGA328P-similar-as-12V/3226069_32889109142.html?spm=2114.12010612.8148356.17.50511b9b5ViNuz)** + +## Description This is a StepMotor Driver Module built in MEGA328P MCU which has been burnt GRBL firmware used to control stepper motors. The module comunicates with M5Core via I2C. It's I2C address is 0x70. -## FEATURES +## Feature - 9-24V Power Input - Driver 3-way stepper motors(X, Y, Z) - Including a lithium battery interface -## INCLUDES +## Include - 1x Step Motor Module - 12V Power @@ -23,28 +29,12 @@ This is a StepMotor Driver Module built in MEGA328P MCU which has b - DIY 3D Printer - Simple Robot Arm -## DOCUMENTS +## Related Link -- **[Example](https://github.com/m5stack/stepmotor_module/tree/master/Example/StepMotor_M5test)** - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-Stepmotor-Module-for-Arduino-ESP32-GRBL-12C-Step-Motor-MEGA328P-similar-as-12V/3226069_32889109142.html?spm=2114.12010612.8148356.17.50511b9b5ViNuz)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** -
- -
+## Example -
- -
- -
- -
- -
- -
\ No newline at end of file +## Schematic \ No newline at end of file diff --git a/docs/en/practice.md b/docs/en/practice.md deleted file mode 100644 index 77ee8d88..00000000 --- a/docs/en/practice.md +++ /dev/null @@ -1,7 +0,0 @@ -# Practice - -[中文](/zh_CN/practice) | English | [日本語](/ja/practice) - - | | ----|---|--- -[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/en/practice/practice_arduino.md b/docs/en/practice/practice_arduino.md deleted file mode 100644 index bdbbf4cc..00000000 --- a/docs/en/practice/practice_arduino.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for Arduino - -[中文](/zh_CN/practice/practice_arduino) | English | [日本語](/ja/practice/practice_arduino) - -## (coming soon...) \ No newline at end of file diff --git a/docs/en/practice/practice_blockly.md b/docs/en/practice/practice_blockly.md deleted file mode 100644 index 6d712f33..00000000 --- a/docs/en/practice/practice_blockly.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(Blockly) - -[中文](/zh_CN/practice/practice_blockly) | English | [日本語](/ja/practice/practice_blockly) - -## (coming soon...) \ No newline at end of file diff --git a/docs/en/practice/practice_micropython.md b/docs/en/practice/practice_micropython.md deleted file mode 100644 index 2697f115..00000000 --- a/docs/en/practice/practice_micropython.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(MicroPython) - -[中文](/zh_CN/practice/practice_micropython) | English | [日本語](/ja/practice/practice_micropython) - -## (coming soon...) \ No newline at end of file diff --git a/docs/en/quick_start/bala/bala_quick_start.md b/docs/en/quick_start/bala/bala_quick_start.md index b9544f29..ba578d81 100644 --- a/docs/en/quick_start/bala/bala_quick_start.md +++ b/docs/en/quick_start/bala/bala_quick_start.md @@ -1,5 +1,3 @@ # BALA Get Started -[中文](zh_CN/quick_start/bala/bala_quick_start) | English | [日本語](ja/quick_start/bala/bala_quick_start) - ## (coming soon...) \ No newline at end of file diff --git a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md index 937723f7..27a73969 100644 --- a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,7 +1,5 @@ # Burn A NES Game -[中文](zh_CN/quick_start/faces/gameboy_burn_a_nes_game) | English | [日本語](ja/quick_start/faces/gameboy_burn_a_nes_game) - *This document will help you for burning a gameboy game(NES file) so that you can play a game with GameBoy Keyboard.* ## CONTENT diff --git a/docs/en/quick_start/m5camera/m5camera_quick_start.md b/docs/en/quick_start/m5camera/m5camera_quick_start.md index a0df960b..b2a9c348 100644 --- a/docs/en/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/en/quick_start/m5camera/m5camera_quick_start.md @@ -1,7 +1,5 @@ # ESP32Cam/M5Camera Quick Start -[中文](zh_CN/quick_start/m5camera/m5camera_quick_start) | English | [日本語](ja/quick_start/m5camera/m5camera_quick_start) - ## 1. Out-of-the-box Demo It is really really out of the box. Your ESP32Cam/M5Camera will immediately run without any code after you power it. diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 3c02cb04..a575b4af 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,7 +1,5 @@ # M5Core Quick Start(macOS, Arudino) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - ?> If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows). !> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index f229341c..552f39e6 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,7 +1,5 @@ # M5Core Quick Start(Windows, Arudino) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - ?> If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS). !> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index b3852f5a..301ca122 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,7 +1,5 @@ # UiFlow Quick Start(Blockly/MicroPython) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - ?> a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](http://flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core). By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left. After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory. diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index c6056a2e..9e1597fa 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,7 +1,5 @@ # M5Cloud Quick Start(MicroPython) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) - ?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud). By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below. diff --git a/docs/en/quick_start/m5core/m5stick_get_started_arduino.md b/docs/en/quick_start/m5core/m5stick_get_started_arduino.md index e085dc3c..15966630 100644 --- a/docs/en/quick_start/m5core/m5stick_get_started_arduino.md +++ b/docs/en/quick_start/m5core/m5stick_get_started_arduino.md @@ -1,7 +1,5 @@ # M5Stick Quick Start(Arduino) -[中文](zh_CN/quick_start/m5core/m5stick_get_started_arduino) | English | [日本語](ja/quick_start/m5core/m5stick_get_started_arduino) - ## 1. Install `U8g2` library If you have installed `U8g2`, then just run and upload your m5stick's poject. diff --git a/docs/en/related_documents/establish_serial_connection.md b/docs/en/related_documents/establish_serial_connection.md index 307e9180..646a5ae0 100644 --- a/docs/en/related_documents/establish_serial_connection.md +++ b/docs/en/related_documents/establish_serial_connection.md @@ -1,7 +1,5 @@ # Establish Serial Connection -[中文](/zh_CN/related_documents/establish_serial_connection) | English | [日本語](ja/related_documents/establish_serial_connection) - **This section provides guidance how to establish serial connection between your board and PC.** ## For MacOS diff --git a/docs/en/related_documents/how_to_connect_wifi_using_core.md b/docs/en/related_documents/how_to_connect_wifi_using_core.md index cf12da20..473ea0ef 100644 --- a/docs/en/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/en/related_documents/how_to_connect_wifi_using_core.md @@ -1,7 +1,5 @@ # How to Connect WIFI Using Core -[中文](/zh_CN/related_documents/how_to_connect_wifi_using_core) | English | [日本語](ja/related_documents/how_to_connect_wifi_using_core) - ?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning)* **After powering on Core and pressing the red button on the left hand side of the M5，you will be greeted by this screen. Let's connect to networkable AP.** diff --git a/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index 04fc64ee..f66abafa 100644 --- a/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,7 +1,5 @@ # How to Connect WIFI (For M5Cloud) -[中文](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud) | English | [日本語](ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud) - ?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Cloud` in advance, please visit this article [How to burn firmware](en/related_documents/how_to_burn_firmware) for burnning)* **After powering on Core，you will be greeted by this screen. Let's connect to networkable AP.** diff --git a/docs/en/related_documents/how_to_install_git_and_arduino.md b/docs/en/related_documents/how_to_install_git_and_arduino.md index 7519de70..ebdf5e4e 100644 --- a/docs/en/related_documents/how_to_install_git_and_arduino.md +++ b/docs/en/related_documents/how_to_install_git_and_arduino.md @@ -1,7 +1,5 @@ # How to install Git and Arduino IDE (Windows) -[中文](/zh_CN/related_documents/how_to_install_git_and_arduino) | English | [日本語](ja/related_documents/how_to_install_git_and_arduino) - ## 1. Install `Git` If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it. diff --git a/docs/en/related_documents/upgrade_m5stack_lib.md b/docs/en/related_documents/upgrade_m5stack_lib.md index 2c9a5e29..6da8c7a1 100644 --- a/docs/en/related_documents/upgrade_m5stack_lib.md +++ b/docs/en/related_documents/upgrade_m5stack_lib.md @@ -1,7 +1,5 @@ # Upgrade M5Stack Lib -[中文](/zh_CN/related_documents/upgrade_m5stack_lib) | English | [日本語](ja/related_documents/upgrade_m5stack_lib) - ### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` ### 2. Type `M5Stack` into the search box, search it. diff --git a/docs/en/tool/usb_downloader.md b/docs/en/tool/usb_downloader.md index 1d1ddd6d..384b0b60 100644 --- a/docs/en/tool/usb_downloader.md +++ b/docs/en/tool/usb_downloader.md @@ -1,8 +1,6 @@ # M5Stack USB Downloader -[中文](/zh_CN/product_documents/tools/tool_usb_downloader) | English | [日本語](ja/product_documents/tools/tool_usb_downloader) - -## DESCRIPTION +## Description A tool built-in USB-to-UART bridge chip(CP2104) can be connected with UART port for automatically burning firmware. @@ -23,11 +21,11 @@ TXD led, RXD led, Power led and 6pin @ 2.54mm bus sockets. There are two reserved pins(RTS, DTR) on M5Stack USB Downloader for other applications. -## INCLUDES +## Include - 1x M5Stack USB Downloader -## DOCUMENTS +## Related Link - [Schematic](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/USBtool.pdf) - [UserGuide](https://github.com/watson8544/M5Stack-UserGuide/blob/master/TOOLS_DOCS/M5Stack-USB-Downloader-UserGuide.md) diff --git a/docs/en/unit/396port.md b/docs/en/unit/396port.md index ce970b69..f4f33223 100644 --- a/docs/en/unit/396port.md +++ b/docs/en/unit/396port.md @@ -1,23 +1,24 @@ -# Unit 3.96port +# Unit 396PORT -[中文](/zh_CN/product_documents/units/unit_396port) | English | [日本語](ja/product_documents/units/unit_396port) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-3-96-4Pin-Transfer-Module-Grove-Compatible-with-M5GO-FIRE-ESP32-Development-Kit/3226069_32922623759.html?spm=2114.12010612.8148356.26.57e2724dWGWCCC)** + +## Description 3.96port is a unit that aim to transfer GROVE interface to VH3.96-4Pin. -## FEATURES +## Feature - VH3.96 interface - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_2TO396.pdf)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- **[Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti)** +- **[Forum](http://forum.m5stack.com/)** -
- -
diff --git a/docs/en/unit/adc.md b/docs/en/unit/adc.md index 327b6882..87cac0f4 100644 --- a/docs/en/unit/adc.md +++ b/docs/en/unit/adc.md @@ -1,12 +1,16 @@ # Unit ADC -[中文](/zh_CN/product_documents/units/unit_adc) | English | [日本語](ja/product_documents/units/unit_adc) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ADC-Unit-16-Bit-I2C-GROVE-ADS1100-Module-0V-to-12V-analog-to-digital/3226069_32946953374.html?spm=a2g1x.12024536.productList_5885013.pic_7)** + +## Description This is a unit having self-calibrating function and 16bit analog-to-digitial coverter. The resolution is double than insided ADC of esp32, that means you can detect smaller amplitude voltage. The unit communicates with M5Core with I2C. It has provided two modes: continuously conversion and single conversion. -## FEATURES +## Feature - Up to 16 bits of resolution and perform conversions at rates of 8, 16, 32, or 128 samples per second - Programmable gain amplifier @@ -21,14 +25,34 @@ This is a unit having self-calibrating function and 16bit analog-to-digitial cov - Blood pressure measurement - Dynamometer -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ADC_ADS1100) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ADC-Unit-16-Bit-I2C-GROVE-ADS1100-Module-0V-to-12V-analog-to-digital/3226069_32946953374.html?spm=a2g1x.12024536.productList_5885013.pic_7)** +## Example -
- -
\ No newline at end of file +```c++ +ADS1100 ads;//new a object +ads.getAddr_ADS1100(0x48);//ADS1100_DEFAULT_ADDRESS: 0x48 + +ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion +result = ads.Measure_Differential();//Reads the conversion results +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)for Specific example. + +### 2. UIFlow +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
ADC UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/angle.md b/docs/en/unit/angle.md index 68aa6a46..2483a505 100644 --- a/docs/en/unit/angle.md +++ b/docs/en/unit/angle.md @@ -1,22 +1,76 @@ # Unit ANGLE -[中文](/zh_CN/product_documents/units/unit_angle) | English | [日本語](ja/product_documents/units/unit_angle) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Angle-Unit-Potentiometer-Inside-Resistance-Adjustable-GPIO-GROVE-Co-n-nec-to-r/3226069_32931834705.html?spm=a2g1y.12024536.productList_5885013.subject_18)** + +## Description The Unit ANGLE is a potentiometer sensor that can detect rotary angle. -## FEATURES +## Feature - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Angle-Unit-Potentiometer-Inside-Resistance-Adjustable-GPIO-GROVE-Co-n-nec-to-r/3226069_32931834705.html?spm=a2g1y.12024536.productList_5885013.subject_18)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int sensorPin = 36; +// last variable to store the value coming from the sensor +int last_sensorValue = 0; +// current variable to store the value coming from the sensor +int cur_sensorValue = 0; + +void setup() { + M5.begin(); + pinMode(sensorPin, INPUT); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("the value of ANGLE: "); +} + +void loop() { + // read the value from the sensor: + cur_sensorValue = analogRead(sensorPin); + M5.Lcd.setCursor(0, 25); + if(abs(cur_sensorValue - last_sensorValue) > 10){//debaunce + M5.Lcd.fillRect(0, 25, 100, 25, BLACK); + M5.Lcd.print(cur_sensorValue); + last_sensorValue = cur_sensorValue; + } + delay(50); +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)for `potentiometer_read.ino` example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)for specifical example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
ANGLE UnitANGLE Pin 5VGND
\ No newline at end of file diff --git a/docs/en/unit/button.md b/docs/en/unit/button.md index 21f9a629..377757b9 100644 --- a/docs/en/unit/button.md +++ b/docs/en/unit/button.md @@ -1,21 +1,43 @@ # Unit BUTTON -[中文](/zh_CN/product_documents/units/unit_button) | English | [日本語](ja/product_documents/units/unit_button) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8)** + +## Description The Unit BUTTON is a sigle-button unit that can be detected whether the button pressed or not -## FEATURES +## Feature - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + +```c++ +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/Unit/BUTTON/Arduino)for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO36GPIO265VGND
BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/color.md b/docs/en/unit/color.md index 40b75b07..f7c65891 100644 --- a/docs/en/unit/color.md +++ b/docs/en/unit/color.md @@ -1,12 +1,16 @@ # Unit COLOR -[中文](/zh_CN/product_documents/units/unit_color_sensor) | English | [日本語](ja/product_documents/units/unit_color_sensor) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)** + +## Description This is a unit can detecte the color of object surface which integrates TCS3472 (a color sensor). The unit comunicates with M5Core with I2C. -## FEATURES +## Feature - High precision - Detection range: -70℃~382.2℃ @@ -18,16 +22,36 @@ This is a unit can detecte the color of object surface which integrates TCS3472 - RGB LED Backlight Control - Product Color Verification -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - +## Example +### 1. Arduino IDE -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)** +```c++ +Adafruit_TCS34725 tcs; -
- -
+tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); + +tcs.getRawData(&red, &green, &blue, &clear);//get rgb value +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)for Specific example. + + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
COLOR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/dac.md b/docs/en/unit/dac.md index 9ea8155e..0e26a496 100644 --- a/docs/en/unit/dac.md +++ b/docs/en/unit/dac.md @@ -1,12 +1,16 @@ # Unit DAC -[中文](/zh_CN/product_documents/units/unit_dac) | English | [日本語](ja/product_documents/units/unit_dac) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-DAC-Unit-MCP4725-I2C-DAC-Converter-Breakout-Module-Digital-to-Analog-12-Bits-0V/3226069_32947696641.html?spm=a2g1x.12024536.productList_5885013.pic_6)** + +## Description This is a unit can convert digital signal to analog signal like voltage waveform, audio waveform and so on. It integrates a 12-bit high resolution DAC chip named MCP4725 which integrates a on-board non-volatile memory (EEPROM). The unit comunicates with M5Core with I2C. The DAC input and configuration data can be programmed to the EEPROM. -## FEATURES +## Feature - Up to 12 bits of resolution - Output 0~3.3V voltage @@ -18,14 +22,61 @@ This is a unit can convert digital signal to analog signal like voltage waveform - MP3 Audio Player - mini Oscilloscope -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/DAC_MCP4725) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-DAC-Unit-MCP4725-I2C-DAC-Converter-Breakout-Module-Digital-to-Analog-12-Bits-0V/3226069_32947696641.html?spm=a2g1x.12024536.productList_5885013.pic_6)** +## Example +### 1. Arduino IDE + -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Mini-Dual-Button-Unit-Mini-with-GROVE-Port-Cable-Connector-Compatible-with-FIRE/3226069_32923126250.html?spm=a2g1x.12024536.productList_2187621.9)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
DUAL_BUTTON UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/earth.md b/docs/en/unit/earth.md index 71f1b9db..d98bd53e 100644 --- a/docs/en/unit/earth.md +++ b/docs/en/unit/earth.md @@ -1,25 +1,49 @@ # Unit EARTH -[中文](/zh_CN/product_documents/units/unit_earth) | English | [日本語](ja/product_documents/units/unit_earth) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Earth-Module-Grove-Compatible-Soil-monitoring-Analog-and-Digital-Output/3226069_32922643696.html?spm=2114.12010615.8148356.2.45434ff2lDdyLQ)** + +## Description EARTH is a moisture detective unit for measuring the moisture in soil. The soil moisture sensor is pretty straight forward to use. The two large exp osed pads function as probes for the sensor, together acting as a variable resistor. The more water that is in the soil means the better the conductivity between the pads will be and will result in a lower resistance, and a higher SIG out. You can read the moisture in soil staright or get a digital signal(0/1) that means the high(or low) humidity. -## FEATURES +## Feature - Adjustable threshold, including 10K adjustable resistor - Analog & Digital output - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Earth) -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_EARTH.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Earth-Module-Grove-Compatible-Soil-monitoring-Analog-and-Digital-Output/3226069_32922643696.html?spm=2114.12010615.8148356.2.45434ff2lDdyLQ)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** + +## Example +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36); +digitalRead_value = digitalRead(26); +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
EARTH UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/en/unit/env.md b/docs/en/unit/env.md index 3ff9bdc4..553309f3 100644 --- a/docs/en/unit/env.md +++ b/docs/en/unit/env.md @@ -13,7 +13,7 @@ temperature, humidity and air pressure with M5GO Core, including temperature and humidity sensor and absolute barometric pressure sensor. Connect to GRVE A of M5Core. -## Features +## Feature - Temperature: - measuring range: 20 ~ 60℃ @@ -41,7 +41,7 @@ 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. +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV)for Specific example. ## Schematic diff --git a/docs/en/unit/esp32cam.md b/docs/en/unit/esp32cam.md index d0b810bd..6fc1f014 100644 --- a/docs/en/unit/esp32cam.md +++ b/docs/en/unit/esp32cam.md @@ -1,21 +1,25 @@ -# ESP32Cam +# Unit ESP32CAM -[中文](/zh_CN/product_documents/units/unit_esp32cam) | English | [日本語](ja/product_documents/units/unit_esp32cam) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[Purchase](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)** + +## Description The **ESP32Cam** is a tiny unit based on ESP32 chip and OV2640. You can even program it through ESP-IDF. The ESP32Cam equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger , so your ESP32Cam project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. -## INCLUDES +## Include - 1x M5 Camera - 1x Type-C USB Cable -## FEATURES +## Feature - ESP32 specifications + Dual-core Tensilica LX6 microprocessor @@ -46,20 +50,35 @@ The ESP32Cam equips the ESP32 with everything necessary to program, run and deve - Weight: 5g -## DOCUMENTS +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) -- **[Example](https://github.com/m5stack/esp32-cam-demo/tree/m5cam) (ESP32)** -- **[Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) (ESP32)** -- **[Datasheet](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) (OV2640)** - **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/hardware_diff_with_ESP32CAM_M5Camera.md)** -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)** + - **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** -- [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) -
- -
+## Example -
- -
+ + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/hub.md b/docs/en/unit/hub.md index f56b755d..bf962ca1 100644 --- a/docs/en/unit/hub.md +++ b/docs/en/unit/hub.md @@ -1,23 +1,29 @@ # Unit HUB -[中文](/zh_CN/product_documents/units/unit_hub) | English | [日本語](ja/product_documents/units/unit_hub) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-HUB-Unit-1-to-3-HUB-with-Universal-Connector-Grove-Port/3226069_32930928722.html?spm=a2g1y.12024536.productList_5885013.subject_17)** + +## Description HUB is a module for M5GO to expand GROVE port added three GROVE ports for user. So you can control 3 GROVE devices with only one M5GO Core at a time. -## FEATURES +## Feature - Instantly Add Three 4-Pins-GROVE ports to Any Compatible Device - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-HUB-Unit-1-to-3-HUB-with-Universal-Connector-Grove-Port/3226069_32930928722.html?spm=a2g1y.12024536.productList_5885013.subject_17)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Schematic + + diff --git a/docs/en/unit/ir.md b/docs/en/unit/ir.md index f32d02f4..31ff303b 100644 --- a/docs/en/unit/ir.md +++ b/docs/en/unit/ir.md @@ -1,8 +1,12 @@ # Unit IR -[中文](/zh_CN/product_documents/units/unit_ir) | English | [日本語](ja/product_documents/units/unit_ir) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](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)** + +## Description The Unit IR is a IR infrared obstacle avoidance sensor. It can be widely used in robot obstacle avoidance, obstacle avoidance car, line @@ -14,18 +18,68 @@ emit a certain frequency, when detecting direction meet with obstacles comparator circuit processing, green indicator will light up, at the same time signal output interface to output digital signal. -## FEATURES +## Feature - A pair of infrared transmitting and receiving tube - Detects the distance 2 ~ 5cm - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - -- **[Purchase](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)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +#include +// select the input pin for the potentiometer +int ir_recv_pin = 36; +int ir_send_pin = 26; +int last_recv_value = 0; +int cur_recv_value = 0; + +void setup() { + M5.begin(); + pinMode(ir_recv_pin, INPUT); + pinMode(ir_send_pin, OUTPUT); + //send infrared light + //now, you can see the infrared light through mobile phone camera + digitalWrite(ir_send_pin, 1); + M5.Lcd.setTextSize(2); + M5.Lcd.setCursor(0, 0); + M5.Lcd.print("Test for IR receiver: "); +} + +void loop() { + //now, once you press the button on a remote controller to send infrared light + //the screen will display "detected!" + cur_recv_value = digitalRead(ir_recv_pin); + if(last_recv_value != cur_recv_value){ + M5.Lcd.setCursor(0, 25); + M5.Lcd.fillRect(0, 25, 150, 25, BLACK); + if(cur_recv_value == 0){//0: detected 1: not detected + M5.Lcd.print("detected!"); + } + last_recv_value = cur_recv_value; + } + delay(100); +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino)for `ir_dectect.ino` example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
IR UnitReceiver PinTransmitter Pin5VGND
\ No newline at end of file diff --git a/docs/en/unit/joystick.md b/docs/en/unit/joystick.md index 32aa90a0..931e5bb6 100644 --- a/docs/en/unit/joystick.md +++ b/docs/en/unit/joystick.md @@ -1,29 +1,60 @@ # Unit JOYSTICK -[中文](/zh_CN/product_documents/units/unit_joystick) | English | [日本語](ja/product_documents/units/unit_joystick) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** + +## Description This Unit is a joystick unit the same as game controller button that can be detected the X-Y axis offset and whether the joystick be pressed -## FEATURES +## Feature - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Joystick)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Joystick-Unit-MEGA328P-I2C-Grove-Connector-Compatible-X-Y-Axis-Button-for-ESP32/3226069_32921785624.html?spm=a2g1x.12024536.productList_2187621.10)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** -
- -
+## Example -
- -
\ No newline at end of file +### 1. Arduino IDE + +```c++ +#define JOY_ADDR 0x52 + +//disable the speak noise +dacWrite(25, 0); +Wire.begin(21, 22, 400000); +Wire.requestFrom(JOY_ADDR); +while(Wire.available()) +{ + x_data = Wire.read();//x + y_data = Wire.read();//x + button_data = Wire.read();//x +} +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino)for Specific example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow)for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
JOYSTICK UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/light.md b/docs/en/unit/light.md index 89aea28f..c12899d5 100644 --- a/docs/en/unit/light.md +++ b/docs/en/unit/light.md @@ -1,26 +1,58 @@ -# Unit light +# Unit LIGHT -[中文](/zh_CN/product_documents/units/unit_light) | English | [日本語](ja/product_documents/units/unit_light) + -## DESCRIPTION +*** -The Unit light is a light sensor unit with an adjustable resistor that can detect the environmental light intensity. -You can read analog signal(environmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** + +## Description + +The Unit light is a light sensor unit with an adjustable resistor that can detect the lightironmental light intensity. +You can read analog signal(lightironmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. -## FEATURES +## Feature - Adjustable threshold, including 10K adjustable resistor - Analog & Digital output - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Light) -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_LIGHTNESS.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Light-Unit-with-Photoresistance-Grove-Port-Analog-Digital-Output-Compatible-with-M5GO-FIRE-ESP32/3226069_32920589923.html?spm=2114.12010615.8148356.4.1be27011RbDBo5)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** + +## Example + +### 1. Arduino IDE + +```c++ +//disable the speak noise +dacWrite(25, 0); + +analogRead_value = analogRead(36);//get analog value of LIGHT(0-4095) +digitalRead_value = digitalRead(26);//0: sense the ligth 1: do not sense +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino) for Specific example. + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow) for Specific example. + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
LIGHT UnitAinDin5VGND
\ No newline at end of file diff --git a/docs/en/unit/m5camera.md b/docs/en/unit/m5camera.md index cca1dd80..4ea21691 100644 --- a/docs/en/unit/m5camera.md +++ b/docs/en/unit/m5camera.md @@ -1,21 +1,25 @@ -# M5Camera +# Unit M5CAMERA -[中文](/zh_CN/product_documents/units/unit_m5camera) | English | [日本語](ja/product_documents/units/unit_m5camera) +
-## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-WROVER-with-PSRAM-Camera-Module-OV2640-Type-C-Grove-Port-Mini-Camera-Development/3226069_32909972455.html?spm=2114.12010612.8148356.24.57e2724dWGWCCC)** + +## Description The **M5Camera** is a tiny unit based on ESP32 chip and OV2640 including PSRAM. You can even program it through ESP-IDF. The M5Camera equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your M5Camera project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. -## INCLUDES +## Include - 1x M5 Camera - 1x Type-C USB Cable -## FEATURES +## Feature - ESP32 specifications + Dual-core Tensilica LX6 microprocessor @@ -46,17 +50,35 @@ The M5Camera equips the ESP32 with everything necessary to program, run and deve - Weight: 5g -## DOCUMENTS -- **[Example](https://github.com/m5stack/esp32-cam-demo/tree/m5cam-psram) (ESP32)** -- **[Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) (ESP32)** -- **[Datasheet](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) (OV2640)** +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) + - **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/hardware_diff_with_ESP32CAM_M5Camera.md)** + - **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** - +## Example - + - +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/makey.md b/docs/en/unit/makey.md index c1e102a0..fcce4ab4 100644 --- a/docs/en/unit/makey.md +++ b/docs/en/unit/makey.md @@ -1,12 +1,16 @@ -# Unit makey +# Unit MAKEY -[中文](/zh_CN/product_documents/units/unit_makey) | English | [日本語](ja/product_documents/units/unit_makey) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** + +## Description The Unit makey is a makey unit with 16 touchable pins.The Unit makey is based on Arduino Uno Mega328p chip.It communicates with M5Stack Core via GROVE(I2C).It's I2C address is 0x51. -## FEATURES +## Feature - Arduino Mega328p Controller - 16 Keys Fruit Piano(PD0-7 & PB0-5), 1 NeoPixel pin(PC2) and 1 Buzzer pin(PC3) @@ -19,20 +23,29 @@ The Unit makey is a makey unit with 16 touchable pins.The Unit makey is based on - Makey Application - RGB Application with Adafruit Library -## DOCUMENTS +## Related Link -- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Makey)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Makey-Unit-MEGA328P-Inside-16Key-Fruit-Paino-with-NEO-Pixel-and-BUZZER-for-ESP32/3226069_32924883456.html?spm=a2g1y.12024536.productList_5885013.subject_23)** +- **[Forum](http://forum.m5stack.com/)** -
- -
+## Example -
- -
+ + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
MAKEY UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/ncir.md b/docs/en/unit/ncir.md index 2655d1fd..b0963eb5 100644 --- a/docs/en/unit/ncir.md +++ b/docs/en/unit/ncir.md @@ -1,12 +1,16 @@ # Unit NCIR -[中文](/zh_CN/product_documents/units/unit_ncir) | English | [日本語](ja/product_documents/units/unit_ncir) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** + +## Description This is a unit can measure body temperature or be applicated for movement detection which integrates MLX90641 (an infrared thermometer designed for non-contact temperature sensing). The unit comunicates with M5Core with I2C. -## FEATURES +## Feature - High precision - Detection range: -70℃~382.2℃ @@ -18,16 +22,31 @@ This is a unit can measure body temperature or be applicated for movement detect - body temperature measurement - movement detection -## DOCUMENTS +## Related Link - +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [MLX90614](https://pdf1.alldatasheet.com/datasheet-pdf/view/218977/ETC2/MLX90614.html) - +## Example -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NCIR-Unit-MLX90614-Contactless-Temperature-Sensor-Module-70C-382-2C-GROVE-I2C-Development-Board/3226069_32947772098.html?spm=a2g1x.12024536.productList_5885013.pic_4)** + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
NCIR UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/neopixel.md b/docs/en/unit/neopixel.md index cfd6bd05..8bb87b54 100644 --- a/docs/en/unit/neopixel.md +++ b/docs/en/unit/neopixel.md @@ -1,23 +1,52 @@ -# Unit NeoPixel +# Unit NEOPIXEL -[中文](/zh_CN/product_documents/units/unit_neopixel) | English | [日本語](ja/product_documents/units/unit_neopixel) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** + +## Description This is a RGB LED Cable unit. You can program it using NeoPixel Lib supported by Adafruit or using UiFlow that will be easier. The unit comunicates with M5Core with GROVE Interface. -## FEATURES +## Feature - the length: 10cm/20cm/0.5m/1m/2m - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)** +- **[Forum](http://forum.m5stack.com/)** -
- -
+## Example + +### 1. Arduino IDE + + + +### 2. UIFlow + + + +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/pir.md b/docs/en/unit/pir.md index 8300f146..8e394902 100644 --- a/docs/en/unit/pir.md +++ b/docs/en/unit/pir.md @@ -1,23 +1,51 @@ # Unit PIR -[中文](/zh_CN/product_documents/units/unit_pir) | English | [日本語](ja/product_documents/units/unit_pir) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** + +## Description The Unit PIR is a human infrared sensor for M5GO that can easily detect whether someone appears in front of it with M5GO Core. -## FEATURES +## Feature - Detects the distance 150cm - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-PIR-Sensor-Human-Body-Infrared-PIR-Motion-Sensor-Detector-Module-GPIO-GROVE-Connector/3226069_32931794651.html?spm=a2g1y.12024536.productList_5885013.subject_19)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + + + +### 2. UIFlow + + + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow) for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
PIR UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/proto.md b/docs/en/unit/proto.md index f1af993a..8f57821b 100644 --- a/docs/en/unit/proto.md +++ b/docs/en/unit/proto.md @@ -1,25 +1,37 @@ -# Unit proto +# Unit PROTO -[中文](/zh_CN/product_documents/units/unit_proto) | English | [日本語](ja/product_documents/units/unit_proto) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Proto-Board-Unit-Universal-Double-Side-Prototype-2-54mm-PCB-Grove-Port-Compatible/3226069_32920617495.html?spm=2114.12010615.8148356.4.6735f4943FDruP)** + +## Description The M5Stack proto unit is a flexible blank circle with 100mil pitch of holes. You can create any circle that could controlled by M5GO Core as you like. -## FEATURES +## Feature - Flexible extended blank circle - 70 holes(pitch of holes: 100mil) - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link - -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_PROTO.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Proto-Board-Unit-Universal-Double-Side-Prototype-2-54mm-PCB-Grove-Port-Compatible/3226069_32920617495.html?spm=2114.12010615.8148356.4.6735f4943FDruP)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
+- **[Forum](http://forum.m5stack.com/)** + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
PROTO UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/relay.md b/docs/en/unit/relay.md index aba24c52..936d69b0 100644 --- a/docs/en/unit/relay.md +++ b/docs/en/unit/relay.md @@ -1,14 +1,18 @@ -# Unit relay +# Unit RELAY -[Example](#example) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[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)** + +## Description The Unit relay is a unit that allows you to control large power loads with a light-current, safe, reliable power control system. the large power loads you can safely control is up to 24 VDC or 120 VAC. Only a low electrial level is sent to this unit, the relay will be close and the large power loads you want to control will be working. -## FEATURES +## Feature - A single input - Up to 3A @ 24 VDC or 120 VAC - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) @@ -19,52 +23,47 @@ Only a low electrial level is sent to this unit, the relay will be close and the - Be perfect for large inductive loads(like DC motors electrocircuit, intelligent interpolation...) - Control a standard wall outlet device -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Relay) -- **[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)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** +- **[Forum](http://forum.m5stack.com/)** - +## Example -*Example* - - - -#### ** Arduino Code** +### 1. Arduino IDE ```c++ -#include +// RELAY is connected to GROVE B +pinMode(26, OUTPUT); -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); -} +digitalWrite(26, 0);//relay opened +delay(1000); +digitalWrite(26, 1);//relay closed +delay(1000); ``` -#### ** MicroPython Code ** +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino) for Specific example. -Coming soom... +### 2. UIFlow -#### ** UIFlow ** + -Coming soom... +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow) for Specific example. - +## Schematic -
- -
+ + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RELAY Unit RELAY Pin5VGND
+ +## Related Video + +- **m5stack introduction** + + diff --git a/docs/en/unit/rgb.md b/docs/en/unit/rgb.md index 3e8c34b4..0c2381ac 100644 --- a/docs/en/unit/rgb.md +++ b/docs/en/unit/rgb.md @@ -1,22 +1,45 @@ # Unit RGB -[中文](/zh_CN/product_documents/units/unit_rgb) | English | [日本語](ja/product_documents/units/unit_rgb) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** + +## Description The Unit RGB is a sensor including three RGB LED lights and two GROVE ports.You can display specified color using M5GO Core through Blockly, Arduino or MicroPython. -## FEATURES +## Feature - GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) - Two Lego installation holes -## DOCUMENTS +## Related Link -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -
- -
\ No newline at end of file +- **[Forum](http://forum.m5stack.com/)** + +## Example + + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE B)GPIO36GPIO265VGND
RGB UnitGPIO36GPIO265VGND
\ No newline at end of file diff --git a/docs/en/unit/temp.md b/docs/en/unit/temp.md new file mode 100644 index 00000000..16295253 --- /dev/null +++ b/docs/en/unit/temp.md @@ -0,0 +1,25 @@ +## Description + +This is a unit can detect distance using a newest "Time-to-Flight" sensor using laser light. It is higher precision than most distance sensors. The unit comunicates with M5Core with I2C. + +## Feature + +- High precision +- Measure absolute distances up to 2m +- GROVE interface, support [UiFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego installation holes + +## APPLICATION + +- 1D gesture recognition + +## Related Link + +- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/TOF_VL53L0X) + +- **Datasheet** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) + + + +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** + diff --git a/docs/en/unit/temp_folder/esp32cam.md b/docs/en/unit/temp_folder/esp32cam.md new file mode 100644 index 00000000..6fc1f014 --- /dev/null +++ b/docs/en/unit/temp_folder/esp32cam.md @@ -0,0 +1,84 @@ +# Unit ESP32CAM + + + +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)**       🛒**[Purchase](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)** + +## Description + +The **ESP32Cam** is a tiny unit based on ESP32 chip and OV2640. You can even program it through ESP-IDF. + +The ESP32Cam equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger , so your ESP32Cam project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. + + +## Include + +- 1x M5 Camera +- 1x Type-C USB Cable + + +## Feature + +- ESP32 specifications + + Dual-core Tensilica LX6 microprocessor + + Up to 240MHz clock frequency + + 512K internal SRAM + + 4MB Flash memory + + Integrated 802.11 BGN WiFi transceiver + + Integrated dual-mode Bluetooth (classic and BLE) + + Hardware accelerated encryption (AES, SHA2, ECC, RSA-4096) +- CP2104 USB TTL +- OV2640 sensor + - Output Formats(8-bit): + + YUV(422/420)/YCbCr422 + + RGB565/555 + + 8-bit compressed data + + 8-/10-bit Raw RGB data + - Maximum Image Transfer Rate + + UXGA/SXGA: 15fps + + SVGA: 30fps + + CIF: 60fps + - Scan Mode: Progressive +- Camera specifications + + CCD size : 1/4inch + + Field of View : 78 degree + + Maxmium Pixel: 200W +- Sensor best resolution: 1600 * 1200 +- Dimension: 25mm x 24mm +- Weight: 5g + + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) + +- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/hardware_diff_with_ESP32CAM_M5Camera.md)** + +- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** + +## Example + + + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/temp_folder/m5camera.md b/docs/en/unit/temp_folder/m5camera.md new file mode 100644 index 00000000..4ea21691 --- /dev/null +++ b/docs/en/unit/temp_folder/m5camera.md @@ -0,0 +1,84 @@ +# Unit M5CAMERA + +
+ +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-WROVER-with-PSRAM-Camera-Module-OV2640-Type-C-Grove-Port-Mini-Camera-Development/3226069_32909972455.html?spm=2114.12010612.8148356.24.57e2724dWGWCCC)** + +## Description + +The **M5Camera** is a tiny unit based on ESP32 chip and OV2640 including PSRAM. You can even program it through ESP-IDF. + +The M5Camera equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your M5Camera project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. + + +## Include + +- 1x M5 Camera +- 1x Type-C USB Cable + + +## Feature + +- ESP32 specifications + + Dual-core Tensilica LX6 microprocessor + + Up to 240MHz clock frequency + + 4MB internal SRAM + + 4MB Flash memory + + Integrated 802.11 BGN WiFi transceiver + + Integrated dual-mode Bluetooth (classic and BLE) + + Hardware accelerated encryption (AES, SHA2, ECC, RSA-4096) +- CP2104 USB TTL +- OV2640 sensor + - Output Formats(8-bit): + + YUV(422/420)/YCbCr422 + + RGB565/555 + + 8-bit compressed data + + 8-/10-bit Raw RGB data + - Maximum Image Transfer Rate + + UXGA/SXGA: 15fps + + SVGA: 30fps + + CIF: 60fps + - Scan Mode: Progressive +- Camera specifications + + CCD size : 1/4inch + + Field of View : 78 degree + + Maxmium Pixel: 200W +- Sensor best resolution: 1600 * 1200 +- Dimension: 25mm x 24mm +- Weight: 5g + + +## Related Link + +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** + +- **[Datasheet]** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) + +- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/hardware_diff_with_ESP32CAM_M5Camera.md)** + +- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** + +## Example + + + +## Schematic + + + +### PinMap + + \ No newline at end of file diff --git a/docs/en/unit/thermal.md b/docs/en/unit/thermal.md index a6df5c19..3047477b 100644 --- a/docs/en/unit/thermal.md +++ b/docs/en/unit/thermal.md @@ -1,15 +1,19 @@ -# Unit thermal +# Unit THERMAL -[中文](/zh_CN/product_documents/units/unit_thermal) | English | [日本語](ja/product_documents/units/unit_thermal) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Thermal-Camera-MLX90640-with-GROVE-I2C-Compatible-M5GO-FIRE-ESP32-Kit-Mini-Development/3226069_32918177644.html?spm=2114.12010615.8148356.2.4ad0717733LM7H)** + +## Description The Unit thermal is a thermal camera module contains thermopile sensors named MLX90640. the MLX90640 contains a 32x64 piexls IR array. It communicates with M5GO Core via GROVE which actually is a I2C interfacel. As the images show you can detect surface temperatures from many feet away with an accuracy of ±1.5°C (best case). After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner`, the module will be running. Then you can program it via Arduino IDE. -## FEATURES +## Feature - 32x24 piexls - Target temperature -40°C ÷ 300°C @@ -23,14 +27,31 @@ After burn the firmware of the module's demostatrion to M5GO Core via `M5Burner` - Visual IR thermometers - Temperature sensing element for intelligent building air conditioning -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/MLX90640) - [MLX90640 Drive](https://github.com/melexis/mlx90640-library) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [MLX90640](https://www.melexis.com/-/media/files/documents/datasheets/mlx90640-datasheet-melexis.pdf) -- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/UNIT_THERMAL.pdf)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-New-Thermal-Camera-MLX90640-with-GROVE-I2C-Compatible-M5GO-FIRE-ESP32-Kit-Mini-Development/3226069_32918177644.html?spm=2114.12010615.8148356.2.4ad0717733LM7H)** -
- -
+## Example + + + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
THERMAL UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/en/unit/tof.md b/docs/en/unit/tof.md index 96418e0e..9e5d8875 100644 --- a/docs/en/unit/tof.md +++ b/docs/en/unit/tof.md @@ -1,12 +1,16 @@ -# Unit ToF +# Unit TOF -[中文](/zh_CN/product_documents/units/unit_tof) | English | [日本語](ja/product_documents/units/unit_tof) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**       :electric_plug:**[Schematic](#Schematic)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** + +## Description This is a unit can detect distance using a newest "Time-to-Flight" sensor using laser light. It is higher precision than most distance sensors. The unit comunicates with M5Core with I2C. -## FEATURES +## Feature - High precision - Measure absolute distances up to 2m @@ -17,16 +21,37 @@ This is a unit can detect distance using a newest "Time-to-Flight" sensor using - 1D gesture recognition -## DOCUMENTS +## Related Link -- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/TOF_VL53L0X) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** - **Datasheet** - [VL53L0X](https://pdf1.alldatasheet.com/datasheet-pdf/view/948120/STMICROELECTRONICS/VL53L0X.html) - +## Example -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-ToF-Unit-VL53L0X-Time-of-Flight-ToF-Laser-Ranging-Sensor-Breakout-Laser-Distance-Sensor/3226069_32949310300.html?spm=a2g1x.12024536.productList_5885013.pic_3)** +### 1. Arduino IDE -
- -
+```c++ +#define SYSRANGE_START 0x00 +#define RESULT_RANGE_STATUS 0x14 +#define ToF_ADDR 0x29 //the IIC address of ToF + +write_byte_data_at(SYSRANGE_START, 0x01); //start measure +read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once +dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" +``` + +Click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino) for Specific example. + +## Schematic + + + +### PinMap + + + + +
M5Core(GROVE A)GPIO22GPIO215VGND
TOF UnitSCLSDA5VGND
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 5c6758b6..6d0109b3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -60,7 +60,7 @@ '/.*/navbar.md':'/navbar.md', '/en/':'/' }, - auto2top : true, + // auto2top : true, maxLevel : 1, subMaxLevel: 1, basePath: '/', diff --git a/docs/index.md b/docs/index.md index 466994b8..304ef42f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -52,7 +52,9 @@ -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](en/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](en/base/node_base) [![plc_01.png](https://i.loli.net/2018/12/13/5c122411a87d1.png)](en/base/plc_base) +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](en/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](en/base/node_base) + + *** diff --git a/docs/ja/README.md b/docs/ja/README.md index bec0ec67..b8764e20 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -48,7 +48,9 @@ -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](ja/bases/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](ja/bases/node_base) [![plc_01.png](https://i.loli.net/2018/12/13/5c122411a87d1.png)](ja/bases/plc_base) +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](ja/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](ja/base/node_base) + + *** diff --git a/docs/ja/accessory/cables/lego_cable.md b/docs/ja/accessory/cables/lego_cable.md index 711b5182..e9a45294 100644 --- a/docs/ja/accessory/cables/lego_cable.md +++ b/docs/ja/accessory/cables/lego_cable.md @@ -1,6 +1,6 @@ # LEGO-CABLE -[中文](zh_CN/product_documents/accessories/cables/lego_cable) | [English](en/product_documents/accessories/cables/lego_cable) | 日本語 + ## 概要 diff --git a/docs/ja/accessory/frame.md b/docs/ja/accessory/frame.md index a54b32ea..470504c1 100644 --- a/docs/ja/accessory/frame.md +++ b/docs/ja/accessory/frame.md @@ -1,6 +1,6 @@ # FRAME -[中文](zh_CN/product_documents/accessories/frame) | [English](en/product_documents/accessories/frame) | 日本語 + ## 概要 diff --git a/docs/ja/api_reference.md b/docs/ja/api_reference.md index 1a42ebdc..6b1ea7b4 100644 --- a/docs/ja/api_reference.md +++ b/docs/ja/api_reference.md @@ -1,6 +1,6 @@ # API リファレンス -[中文](/zh_CN/api_reference) | [English](/en/api_reference) | 日本語 + | MicroPython | Arduino | |:------------|:--------| diff --git a/docs/ja/api_reference/micropython/api_lcd.md b/docs/ja/api_reference/micropython/api_lcd.md index ab64316a..35b5a0a9 100644 --- a/docs/ja/api_reference/micropython/api_lcd.md +++ b/docs/ja/api_reference/micropython/api_lcd.md @@ -1,6 +1,6 @@ # LCD -[中文](/zh_CN/api_reference/micropython/api_lcd) | [English](/en/api_reference/micropython/api_lcd) | 日本語 + ### lcd.setRotation(degree) diff --git a/docs/ja/api_reference/micropython/api_speaker.md b/docs/ja/api_reference/micropython/api_speaker.md index d363f120..83b5a142 100644 --- a/docs/ja/api_reference/micropython/api_speaker.md +++ b/docs/ja/api_reference/micropython/api_speaker.md @@ -1,6 +1,6 @@ # Speaker -[中文](/zh_CN/api_reference/micropython/api_speaker) | [English](/en/api_reference/micropython/api_speaker) | 日本語 + ### tone > M5.Speaker.tone(uint32_t freq); diff --git a/docs/ja/api_reference/micropython/peripherals/api_gpio.md b/docs/ja/api_reference/micropython/peripherals/api_gpio.md index ce910600..2e579178 100644 --- a/docs/ja/api_reference/micropython/peripherals/api_gpio.md +++ b/docs/ja/api_reference/micropython/peripherals/api_gpio.md @@ -1,6 +1,6 @@ # GPIO -[中文](/zh_CN/api_reference/micropython/peripherals/api_gpio) | [English](/en/api_reference/micropython/peripherals/api_gpio) | 日本語 + *Refer to GPIO API of [Arduino](http://www.arduino.cc)* diff --git a/docs/ja/application/bala.md b/docs/ja/application/bala.md index 1eb3d930..4ec345f6 100644 --- a/docs/ja/application/bala.md +++ b/docs/ja/application/bala.md @@ -1,6 +1,6 @@ # M5BALA -[中文](zh_CN/product_documents/applications/application_bala) | [English](en/product_documents/applications/application_bala) | 日本語 + ## 概要 diff --git a/docs/ja/application/lidarbot.md b/docs/ja/application/lidarbot.md index 893a9be5..c3cb0897 100644 --- a/docs/ja/application/lidarbot.md +++ b/docs/ja/application/lidarbot.md @@ -1,6 +1,6 @@ # LidarBOT -[中文](zh_CN/product_documents/applications/application_lidarbot) | [English](en/product_documents/applications/application_lidarbot) | 日本語 + ## 概要 diff --git a/docs/ja/base/face_base.md b/docs/ja/base/face_base.md index 068cd905..d2a9ecd1 100644 --- a/docs/ja/base/face_base.md +++ b/docs/ja/base/face_base.md @@ -1,6 +1,6 @@ # FACES ベース -[中文](zh_CN/product_documents/bases/face_base) | [English](/en/product_documents/bases/face_base) | 日本語 + ## 概要 diff --git a/docs/ja/base/lan_base.md b/docs/ja/base/lan_base.md index b0ac9199..90811d81 100644 --- a/docs/ja/base/lan_base.md +++ b/docs/ja/base/lan_base.md @@ -1,6 +1,6 @@ # LAN ベース -[中文](zh_CN/product_documents/bases/lan_base) | [English](/en/product_documents/bases/lan_base) | 日本語 + ## 概要 diff --git a/docs/ja/base/m5go_base.md b/docs/ja/base/m5go_base.md index 51998ab4..d58fff36 100644 --- a/docs/ja/base/m5go_base.md +++ b/docs/ja/base/m5go_base.md @@ -1,6 +1,6 @@ # M5GO ベース -[中文](/zh_CN/product_documents/bases/m5go_base) | [English](/en/product_documents/bases/m5go_base) | 日本語 + ## 概要 diff --git a/docs/ja/base/node_base.md b/docs/ja/base/node_base.md index cbc66ff7..49fe4ead 100644 --- a/docs/ja/base/node_base.md +++ b/docs/ja/base/node_base.md @@ -1,6 +1,6 @@ # Node ベース -[中文](zh_CN/product_documents/bases/base_node) | [English](/en/product_documents/bases/base_node) | 日本語 + ## 概要 diff --git a/docs/ja/base/plc_base.md b/docs/ja/base/plc_base.md index 8b9104e6..87796c79 100644 --- a/docs/ja/base/plc_base.md +++ b/docs/ja/base/plc_base.md @@ -1,6 +1,6 @@ # PLC ベース -[中文](zh_CN/product_documents/bases/base_node) | [English](/en/product_documents/bases/base_node) | 日本語 + ## 概要 diff --git a/docs/ja/core/basic.md b/docs/ja/core/basic.md index 8392e2c8..a14486bf 100644 --- a/docs/ja/core/basic.md +++ b/docs/ja/core/basic.md @@ -1,6 +1,6 @@ # M5Stack BASIC -[中文](zh_CN/product_documents/m5stack-core/m5core_basic) | [English](en/product_documents/m5stack-core/m5core_basic) | 日本語 + ## 概要 diff --git a/docs/ja/core/face_kit.md b/docs/ja/core/face_kit.md index b8c22196..b202729c 100644 --- a/docs/ja/core/face_kit.md +++ b/docs/ja/core/face_kit.md @@ -1,6 +1,6 @@ # FACES Kit -[中文](zh_CN/product_documents/m5stack-core/face_kit) | [English](en/product_documents/m5stack-core/face_kit) | 日本語 + ## 概要 diff --git a/docs/ja/core/fire.md b/docs/ja/core/fire.md index 03877ed2..f13ab557 100644 --- a/docs/ja/core/fire.md +++ b/docs/ja/core/fire.md @@ -1,6 +1,6 @@ # M5Stack FIRE -[中文](zh_CN/product_documents/m5stack-core/m5core_fire) | [English](en/product_documents/m5stack-core/m5core_fire) | 日本語 + ## 概要 diff --git a/docs/ja/core/gray.md b/docs/ja/core/gray.md index 5303fee5..855f635e 100644 --- a/docs/ja/core/gray.md +++ b/docs/ja/core/gray.md @@ -1,6 +1,6 @@ # M5Stack GRAY -[中文](zh_CN/product_documents/m5stack-core/m5core_gray) | [English](en/product_documents/m5stack-core/m5core_gray) | 日本語 + ## 概要 diff --git a/docs/ja/core/m5go_iot_starter_kit.md b/docs/ja/core/m5go_iot_starter_kit.md index 02c6ff27..e87ef17a 100644 --- a/docs/ja/core/m5go_iot_starter_kit.md +++ b/docs/ja/core/m5go_iot_starter_kit.md @@ -1,6 +1,6 @@ # M5GO IoT Starter Kit -[中文](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit) | [English](en/product_documents/m5stack-core/m5go_iot_starter_kit) | 日本語 + ## 概要 diff --git a/docs/ja/core/m5stick.md b/docs/ja/core/m5stick.md index b8e79ed8..e914853d 100644 --- a/docs/ja/core/m5stick.md +++ b/docs/ja/core/m5stick.md @@ -1,6 +1,6 @@ # M5Stick -[中文](zh_CN/product_documents/m5stack-core/minicore_stick) | [English](en/product_documents/m5stack-core/minicore_stick) | 日本語 + ## 概要 diff --git a/docs/ja/core/white.md b/docs/ja/core/white.md index 773d52c1..fd280541 100644 --- a/docs/ja/core/white.md +++ b/docs/ja/core/white.md @@ -1,6 +1,6 @@ # M5Core WHITE -[中文](zh_CN/product_documents/m5stack-core/m5core_white) | [English](en/product_documents/m5stack-core/m5core_white) | 日本語 + ## 概要 diff --git a/docs/ja/faq.md b/docs/ja/faq.md index cbf2b89f..69058a09 100644 --- a/docs/ja/faq.md +++ b/docs/ja/faq.md @@ -1,6 +1,6 @@ # よくある質問 -[中文](/zh_CN/faq) | [English](/en/faq) | 日本語 + --- diff --git a/docs/ja/file_delet_line.py b/docs/ja/file_delet_line.py new file mode 100644 index 00000000..981c59b5 --- /dev/null +++ b/docs/ja/file_delet_line.py @@ -0,0 +1,222 @@ +#-*-coding:utf-8-*- + +""" +1. 将模板env文件拷贝到新建文件夹中 +2. 拷贝旧文件的中间部分内容（描述，特性...），插入到新建文件夹中的模板文件env +3. 替换模板文件env中的unit名字为旧文件的，替换“购买链接”为速卖通，删除多余旧文件拷贝过来的“原理图”“购买链接” +4. 把改好的文件重命名，再拷贝到上一层目录中替换旧文件 +""" + +import os +import sys +import re +import shutil + +cur_path = os.getcwd() +# newFolderName = 'newFolder' +target_path = "" +files_list = []# 保存所有文件到这个列表中 +flag_find_desc = 0 +flag_find_picture = 0 +flag_file_exit_picture = 0 +pattern_desc = re.compile(r'^\[中文\]\([(/zh_CN)(zh_CN)]') +pos_example = 0 +count = 0 +count_example = 0 +data_to_write = [] +link_list = [] +add_related_links = ["- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)**", "\n", "\n", "- **[Forum](http://forum.m5stack.com/)**", "\n"] + +def delet_line(path): + # filename = os.path.split(path)[1] + # print("path: %s, filename: %s"%(path, filename)) + content_list = [] + with open(path,"r",encoding="utf-8") as f_r: + for line in f_r.readlines(): + # print(line) + match_desc = pattern_desc.match(line) + if match_desc: + # print(line) + content_list.append("\n") + continue + content_list.append(line) + f_r.close() + # print(content_list) + with open(path,"w",encoding="utf-8") as f_w: + for content in content_list: + f_w.write(content) + f_w.close() + print(path) + +def make_dir(path, new_folder): + global target_path + target_path = cur_path+os.path.sep+new_folder + if not os.path.exists(target_path): + os.makedirs(target_path) + else: + print('路径已经存在') +# file_list = os.listdir(cur_path) +# print(file_list) +# print("length of file_list: %d"%(len(file_list))) + +def get_filepath_shotname_extension(filename): + (filepath, tempfilename) = os.path.split(filename) + (shotname, extension) = os.path.splitext(tempfilename) + # print("filepath: %s, shotname: %s, extension: %s"%(filepath, shotname, extension)) + return (shotname, extension) + +def get_all_files(path): + files_list = [] + for i in os.listdir(path): + if os.path.isdir(path+'\\'+i): + # recurseDir(path+'\\'+i) # 注释这条语句，不处理目录 + print("dir: %s"%(path+'\\'+i)) + else: + p=path+'\\'+i + # print(p) + extension = get_filepath_shotname_extension(p)[1] + if extension == ".md": + files_list.append(os.path.split(p)[1])# 把所有文件都放进这个列表中保存 + # print(os.path.split(p)[1]) + return files_list + +def extract_content(filename): + global flag_find_desc + global flag_find_picture + global flag_file_exit_picture + global data_to_write + + # filename = get_filepath_shotname_extension(filename) + with open(filename,"r",encoding="utf-8") as f_r: + for line in f_r.readlines(): + match_desc = pattern_desc.match(line) + match_picture = pattern_picture.match(line) + if match_desc or match_picture: + if match_desc: + flag_find_desc = 1 # get a flag + if match_picture: + flag_find_picture = 1 + if flag_find_picture: # end + flag_file_exit_picture = 1 + flag_find_picture = 0 + flag_find_desc = 0 + print(count) + f_r.close() + if flag_find_desc: + data_to_write.append(line) # add data to a list + # count+=1 + if flag_file_exit_picture: + flag_file_exit_picture = 0 + else: # this file doesn't have pictures + # print("this file doesn't have pictures: %s"%filename) + flag_find_desc = 0 + f_r.close() + # print(data_to_write) + os.chdir(target_path) # 切换到临时文件夹，并把列表写入到临时文件中（如果文件不存在，则创建） + with open("temp.md","w",encoding="utf-8") as temp_f_w: + for i in data_to_write: + temp_f_w.write(i)# 保存要拷贝的内容到临时文件中 + temp_f_w.close() + +def add_data_to_file(des_file, src_file):# 插入到中文文件 + fp = open(des_file, "r", encoding="utf-8") + fp_add = open(src_file,"r", encoding="utf-8") + content = fp.read() + content_add = fp_add.read() + fp.close() + fp_add.close() + post = content.find("## Example")# 寻找待插入位置所在的字符串 + if post != 1: + content = content[:post] + content_add + content[post:] + # print(content) + fp = open(des_file, "w", encoding="utf-8") + fp.write(content) + fp.close() + +def get_device_name(filename): + shotname = get_filepath_shotname_extension(filename)[0] + dev_name = shotname + # print(dev_name) + return dev_name + +def delect_replace_content(filename): + """ + 先通过正则表达式匹配出两个网址，然后将第一个匹配到的网址替换成第二个网址 + 替换文件中的内容为对应unit名字 + 删除多余的内容 + """ + global link_list + # filename = get_filepath_shotname_extension(filename) + with open(filename,"r",encoding="utf-8") as fp: + lines = fp.readlines() + for line in lines: + match_purchase = pattern_purchase.search(line) + if match_purchase: + link_list.append(match_purchase.group(2))# 找到两个购买链接，以备后面替换 + print(link_list) + with open(filename,"w",encoding="utf-8") as f_w: + for line in lines: + if "ENV" in line: + line = line.replace("ENV", get_device_name(filename).upper()) + if "env" in line: + line = line.replace("env", get_device_name(filename)) + if link_list[0] in line: + line = line.replace(link_list[0], link_list[1]) + print(line) + # if ("- **Example**" or "- **Example**" or "- **[Purchase]" or "- **[Purchase]") in line: + # # print(line) + # continue # 删除多余的 + f_w.write(line) + fp.close() + f_w.close() + with open(filename,"r+",encoding="utf-8") as fp: + global add_related_links + links_index = 0 + count = 0 + lines = fp.readlines() + for line in lines: + if ("## Related Link") in line: + links_index = count + print(links_index) + count = count + 1 + fp.seek(0) + for i in range(len(add_related_links)): + lines.insert(links_index+i+2, add_related_links[i]) + for line in lines: + fp.write(line) + fp.close() + +def recursive_exect_file(path): + # files_list = os.listdir(path) + for root, dirs, files in os.walk(path): + for file in files: + # print(old_path) + old_path = os.path.join(root, file) + filetype = get_filepath_shotname_extension(old_path)[1] + if filetype == '.md': + delet_line(old_path) + # print(file) + # if os.path.isfile(old_path): + # filetype = get_filepath_shotname_extension(old_path)[1] + # if filetype == '.md': + # # delet_line(file) + # print(file) + # else: + # recursive_exect_file(old_path) + +if __name__ == "__main__": + # make_dir(cur_path, "temp_folder") + # files_list = get_all_files(cur_path) + # for filename in files_list: + # if not filename == "env_template.md": + # print(filename) + # shutil.copyfile(cur_path+"\\env_template.md", target_path+"\\"+filename) + # extract_content(filename)# make a temp file at cur_path + # add_data_to_file(filename, "temp.md") + # delect_replace_content(filename) + # data_to_write.clear()# 清空列表 + # link_list.clear() + # # print(data_to_write) + # os.chdir(cur_path) + + recursive_exect_file('.') \ No newline at end of file diff --git a/docs/ja/m5stack_cases.md b/docs/ja/m5stack_cases.md index 6556ba53..001695e3 100644 --- a/docs/ja/m5stack_cases.md +++ b/docs/ja/m5stack_cases.md @@ -1,6 +1,6 @@ # M5Stack アプリケーション -[中文](/zh_CN/m5stack_cases) | [English](/en/m5stack_cases) | 日本語 + ## STEM 教育例 diff --git a/docs/ja/module/battery.md b/docs/ja/module/battery.md index ce402aa7..cb8049ea 100644 --- a/docs/ja/module/battery.md +++ b/docs/ja/module/battery.md @@ -1,6 +1,6 @@ # BATTERY モジュール -[中文](zh_CN/product_documents/modules/module_battery) | [English](en/product_documents/modules/module_battery) | 日本語 + ## 概要 diff --git a/docs/ja/module/btc.md b/docs/ja/module/btc.md index d8de5a47..61d383dd 100644 --- a/docs/ja/module/btc.md +++ b/docs/ja/module/btc.md @@ -1,6 +1,6 @@ # BTC モジュール -[中文](/zh_CN/product_documents/modules/module_btc) | [English](en/product_documents/modules/module_btc) | 日本語 + ## 概要 diff --git a/docs/ja/module/commu.md b/docs/ja/module/commu.md index f4673086..1c04db7f 100644 --- a/docs/ja/module/commu.md +++ b/docs/ja/module/commu.md @@ -1,6 +1,6 @@ # COMMU モジュール -[中文](zh_CN/product_documents/modules/module_commu) | [English](en/product_documents/modules/module_commu) | 日本語 + ## 概要 diff --git a/docs/ja/module/gps.md b/docs/ja/module/gps.md index 50c465c9..09fc83e6 100644 --- a/docs/ja/module/gps.md +++ b/docs/ja/module/gps.md @@ -1,6 +1,6 @@ # GPS モジュール -[中文](zh_CN/product_documents/modules/module_gps) | [English](en/product_documents/modules/module_gps) | 日本語 + ## 概要 diff --git a/docs/ja/module/lan.md b/docs/ja/module/lan.md index fab6fe75..ec763a64 100644 --- a/docs/ja/module/lan.md +++ b/docs/ja/module/lan.md @@ -1,6 +1,6 @@ # LAN モジュール -[中文](zh_CN/product_documents/modules/module_lan) | [English](en/product_documents/modules/module_lan) | 日本語 + ## 概要 diff --git a/docs/ja/module/lego_plus.md b/docs/ja/module/lego_plus.md index 2ebd3337..b50d2bf4 100644 --- a/docs/ja/module/lego_plus.md +++ b/docs/ja/module/lego_plus.md @@ -22,9 +22,9 @@ -
+ ## 関連情報 diff --git a/docs/ja/module/lora.md b/docs/ja/module/lora.md index 0041473b..8eff39a2 100644 --- a/docs/ja/module/lora.md +++ b/docs/ja/module/lora.md @@ -1,6 +1,6 @@ # LORA モジュール -[中文](zh_CN/product_documents/modules/module_lora) | [English](en/product_documents/modules/module_lora) | 日本語 + ## 概要 diff --git a/docs/ja/module/lorawan.md b/docs/ja/module/lorawan.md index 129f274d..6593d771 100644 --- a/docs/ja/module/lorawan.md +++ b/docs/ja/module/lorawan.md @@ -1,6 +1,6 @@ # LoRaWAN モジュール -[中文](zh_CN/product_documents/modules/module_lorawan) | [English](en/product_documents/modules/module_lorawan) | 日本語 + ## 概要 diff --git a/docs/ja/module/plc.md b/docs/ja/module/plc.md index 298de875..49d554a2 100644 --- a/docs/ja/module/plc.md +++ b/docs/ja/module/plc.md @@ -1,6 +1,6 @@ # M5Stack PLC モジュール -[中文](zh_CN/product_documents/modules/module_plc) | [English](en/product_documents/modules/module_plc) | 日本語 + ## 概要 diff --git a/docs/ja/module/plus.md b/docs/ja/module/plus.md index 48bc4506..4e4b69ef 100644 --- a/docs/ja/module/plus.md +++ b/docs/ja/module/plus.md @@ -1,6 +1,6 @@ # PLUS モジュール -[中文](zh_CN/product_documents/modules/module_plus) | [English](en/product_documents/modules/module_plus) | 日本語 + ## 概要 diff --git a/docs/ja/module/proto.md b/docs/ja/module/proto.md index 229a6630..e6fcf3fc 100644 --- a/docs/ja/module/proto.md +++ b/docs/ja/module/proto.md @@ -1,6 +1,6 @@ # PROTO モジュール -[中文](zh_CN/product_documents/modules/module_proto) | [English](en/product_documents/modules/module_proto) | 日本語 + ## 概要 @@ -62,13 +62,13 @@ ### Kit
- proto_kit_01 + proto_kit_01
- proto_kit_02 + proto_kit_02
- proto_kit_03 + proto_kit_03
### モジュールのみ @@ -86,16 +86,16 @@ ### ボードのみ
- proto_board_01 + proto_board_01
- proto_board_02 + proto_board_02
- proto_board_03 + proto_board_03
- proto_board_04 + proto_board_04
## 関連情報 diff --git a/docs/ja/module/servo.md b/docs/ja/module/servo.md index 5d97d995..62aa578a 100644 --- a/docs/ja/module/servo.md +++ b/docs/ja/module/servo.md @@ -1,6 +1,6 @@ # SERVO モジュール -[中文](zh_CN/product_documents/modules/module_servo) | [English](en/product_documents/modules/module_servo) | 日本語 + ## 概要 diff --git a/docs/ja/module/sim800.md b/docs/ja/module/sim800.md index 936d68b1..f93a3585 100644 --- a/docs/ja/module/sim800.md +++ b/docs/ja/module/sim800.md @@ -1,6 +1,6 @@ # SIM800L モジュール -[中文](zh_CN/product_documents/modules/module_sim800) | [English](en/product_documents/modules/module_sim800) | 日本語 + ## 概要 diff --git a/docs/ja/module/stepmotor.md b/docs/ja/module/stepmotor.md index 4b945e32..5c560183 100644 --- a/docs/ja/module/stepmotor.md +++ b/docs/ja/module/stepmotor.md @@ -1,6 +1,6 @@ # STEPMOTOR モジュール -[中文](zh_CN/product_documents/modules/module_stepmotor) | [English](en/product_documents/modules/module_stepmotor) | 日本語 + ## 概要 diff --git a/docs/ja/practice/practice_arduino.md b/docs/ja/practice/practice_arduino.md deleted file mode 100644 index 3a0bd50f..00000000 --- a/docs/ja/practice/practice_arduino.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for Arduino - -[中文](/zh_CN/practice/practice_arduino) | [English](/en/practice/practice_arduino) | 日本語 - -## (近日公開...) \ No newline at end of file diff --git a/docs/ja/practice/practice_blockly.md b/docs/ja/practice/practice_blockly.md deleted file mode 100644 index 18614617..00000000 --- a/docs/ja/practice/practice_blockly.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(Blockly) - -[中文](/zh_CN/practice/practice_blockly) | [English](/en/practice/practice_blockly) | 日本語 - -## (近日公開...) \ No newline at end of file diff --git a/docs/ja/practice/practice_micropython.md b/docs/ja/practice/practice_micropython.md deleted file mode 100644 index db737d8e..00000000 --- a/docs/ja/practice/practice_micropython.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(MicroPython) - -[中文](/zh_CN/practice/practice_micropython) | [English](/en/practice/practice_micropython) | 日本語 - -## (近日公開...) \ No newline at end of file diff --git a/docs/ja/product_documents.md b/docs/ja/product_documents.md index 0e452a3a..e6cd5f4c 100644 --- a/docs/ja/product_documents.md +++ b/docs/ja/product_documents.md @@ -1,6 +1,6 @@ # 製品ドキュメント -[中文](/zh_CN/product_documents) | [English](/en/product_documents) | 日本語 + ?> 各製品の使用方法は、製品の詳細情報の中に記載されています。 diff --git a/docs/ja/quick_start.md b/docs/ja/quick_start.md index 98a02ed1..24aa19c9 100644 --- a/docs/ja/quick_start.md +++ b/docs/ja/quick_start.md @@ -1,6 +1,6 @@ # クイックスタート -[中文](/zh_CN/quick_start) | [English](/en/quick_start) | 日本語 + *このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。* diff --git a/docs/ja/quick_start/bala/bala_quick_start.md b/docs/ja/quick_start/bala/bala_quick_start.md index f589fcd0..064fb7e4 100644 --- a/docs/ja/quick_start/bala/bala_quick_start.md +++ b/docs/ja/quick_start/bala/bala_quick_start.md @@ -1,6 +1,6 @@ # BALA クイックスタート -[中文](zh_CN/quick_start/bala/bala_quick_start) | [English](en/quick_start/bala/bala_quick_start) | 日本語 + !>M5Balaを使用するためには、M5Stack FIREまたはM5GO(WHITE)のいずれかが別途必要になります。 diff --git a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md index 514f9dc1..bffe27d4 100644 --- a/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/ja/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,6 +1,6 @@ # NESゲーム クイックスタート (Windows向け) -[中文](zh_CN/quick_start/faces/gameboy_burn_a_nes_game) | [English](en/quick_start/faces/gameboy_burn_a_nes_game) | 日本語 + *このページでは、NESゲームを遊ぶために必要なソフトウェアの書き込み方法を紹介します。* diff --git a/docs/ja/quick_start/m5camera/m5camera_quick_start.md b/docs/ja/quick_start/m5camera/m5camera_quick_start.md index 1301744f..f91db064 100644 --- a/docs/ja/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/ja/quick_start/m5camera/m5camera_quick_start.md @@ -1,6 +1,6 @@ # ESP32Cam/M5Camera クイックスタート -[中文](zh_CN/quick_start/m5camera/m5camera_quick_start) | [English](en/quick_start/m5camera/m5camera_quick_start) | 日本語 + ## 1. デモ diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index d6886905..2dd276e5 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,6 +1,6 @@ # M5Core クイックスタート(macOS, Arudino) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | 日本語 + ?> **Tip** もしWindowsを使っているなら[こちらへ](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 0796b609..54e44423 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,6 +1,6 @@ # M5Core クイックスタート(Windows, Arudino) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | 日本語 + ?> **Tip** もしMacをお使いの方は[こちら](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)を参照してください。 diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md index 16828141..daaaad20 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -1,6 +1,6 @@ # UiFlow クイックスタート(Blockly/MicroPython) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython) | 日本語 + ?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* diff --git a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 0f6365c9..c22f40bb 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -1,6 +1,6 @@ # M5Cloud クイックスタート(MicroPython) -[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | 日本語 + ?> **Note** *初めてM5Stackを使う場合、あらかじめ指定のファームウェアを書き込む必要があります。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)を参照してください。また、Wi-Fi接続先を変更したい場合は、このページを参照してください。 [M5StackのWi-Fi接続方法 (M5Cloud向け)](/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud)* diff --git a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md index ce9487bd..982b8c1a 100644 --- a/docs/ja/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/ja/quick_start/m5core/m5stack_core_quick_start.md @@ -1,6 +1,6 @@ # 今すぐ始めるM5Stack -[中文](zh_CN/quick_start/m5core/m5stack_core_quick_start) | [English](en/quick_start/m5core/m5stack_core_quick_start) | 日本語 + ## 好きなプログラミング言語を以下から選んでください。 diff --git a/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md b/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md index 315aed7f..f8df65a8 100644 --- a/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md +++ b/docs/ja/quick_start/m5core/m5stick_get_started_arduino.md @@ -1,6 +1,6 @@ # M5Stick クイックスタート(Arduino) -[中文](zh_CN/quick_start/m5core/m5stick_get_started_arduino) | [English](en/quick_start/m5core/m5stick_get_started_arduino) | 日本語 + ## 1. `U8g2` ライブラリをインストール diff --git a/docs/ja/related_documents.md b/docs/ja/related_documents.md index 2d9a3dcb..b736ceaa 100644 --- a/docs/ja/related_documents.md +++ b/docs/ja/related_documents.md @@ -1,6 +1,6 @@ # その他のドキュメント -[中文](/zh_CN/related_documents) | [English](/en/related_documents) | 日本語 + 1. [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) 2. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) diff --git a/docs/ja/related_documents/establish_serial_connection.md b/docs/ja/related_documents/establish_serial_connection.md index daf893cc..331cd8c1 100644 --- a/docs/ja/related_documents/establish_serial_connection.md +++ b/docs/ja/related_documents/establish_serial_connection.md @@ -1,6 +1,6 @@ # シリアル接続の確立方法 -[中文](zh_CN/related_documents/establish_serial_connection) | [English](en/related_documents/establish_serial_connection) | 日本語 + **このページでは、M5StackとPCとの間でシリアル接続を確立するための方法を説明します。** diff --git a/docs/ja/related_documents/how_to_burn_firmware.md b/docs/ja/related_documents/how_to_burn_firmware.md index 7fa3c357..2b7112d8 100644 --- a/docs/ja/related_documents/how_to_burn_firmware.md +++ b/docs/ja/related_documents/how_to_burn_firmware.md @@ -1,6 +1,6 @@ # ファームウェアの更新方法 -[中文](zh_CN/related_documents/how_to_burn_firmware) | [English](en/related_documents/how_to_burn_firmware) | 日本語 + **このページではM5Stackのファームウェアの更新方法を説明します。** diff --git a/docs/ja/related_documents/how_to_connect_wifi_using_core.md b/docs/ja/related_documents/how_to_connect_wifi_using_core.md index 1ab2c0ee..66d200e3 100644 --- a/docs/ja/related_documents/how_to_connect_wifi_using_core.md +++ b/docs/ja/related_documents/how_to_connect_wifi_using_core.md @@ -1,6 +1,6 @@ # M5StackのWi-Fi接続方法 -[中文](zh_CN/related_documents/how_to_connect_wifi_using_core) | [English](en/related_documents/how_to_connect_wifi_using_core) | 日本語 + ?> **Tip** *もしあなたのM5Stackに`UiFlow`向けのファームウェアが書き込まれていない場合は、あらかじめ、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* diff --git a/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md b/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md index 992b4fd0..028ee7a3 100644 --- a/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md +++ b/docs/ja/related_documents/how_to_connect_wifi_using_core_with_m5cloud.md @@ -1,6 +1,6 @@ # M5StackのWi-Fi接続方法 (M5Cloud向け) -[中文](zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud) | [English](en/related_documents/how_to_connect_wifi_using_core_with_m5cloud) | 日本語 + ?> **Tip** *もしあなたのM5Stackにあらかじめ`M5Cloud`向けのファームウェアが書き込まれていない場合は、こちらを参考にファームウェアを書き込んでください。[ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware)* diff --git a/docs/ja/related_documents/how_to_install_git_and_arduino.md b/docs/ja/related_documents/how_to_install_git_and_arduino.md index e5d99716..a26f263b 100644 --- a/docs/ja/related_documents/how_to_install_git_and_arduino.md +++ b/docs/ja/related_documents/how_to_install_git_and_arduino.md @@ -1,6 +1,6 @@ # GitとArduino IDEのインストール方法 -[中文](zh_CN/related_documents/how_to_install_git_and_arduino) | [English](en/related_documents/how_to_install_git_and_arduino) | 日本語 + ## Windows diff --git a/docs/ja/related_documents/upgrade_m5stack_lib.md b/docs/ja/related_documents/upgrade_m5stack_lib.md index 2cf8ddf0..90ffb6b3 100644 --- a/docs/ja/related_documents/upgrade_m5stack_lib.md +++ b/docs/ja/related_documents/upgrade_m5stack_lib.md @@ -1,6 +1,6 @@ # Arduino IDEのM5Stackライブラリ更新方法 -[中文](zh_CN/related_documents/upgrade_m5stack_lib) | [English](en/related_documents/upgrade_m5stack_lib) | 日本語 + ### 1. Arduino IDEを起動し、`スケッチ`->`ライブラリをインクルード`->`ライブラリを管理...` diff --git a/docs/ja/tool/usb_downloader.md b/docs/ja/tool/usb_downloader.md index 4968df14..18710d4f 100644 --- a/docs/ja/tool/usb_downloader.md +++ b/docs/ja/tool/usb_downloader.md @@ -1,6 +1,6 @@ # M5Stack USB Downloader -[中文](zh_CN/product_documents/tools/tool_usb_downloader) | [English](en/product_documents/tools/tool_usb_downloader) | 日本語 + ## 概要 diff --git a/docs/ja/unit/396port.md b/docs/ja/unit/396port.md index b3c5e75a..92b2ddbc 100644 --- a/docs/ja/unit/396port.md +++ b/docs/ja/unit/396port.md @@ -1,6 +1,6 @@ # 3.96port ユニット -[中文](zh_CN/product_documents/units/unit_396port) | [English](en/product_documents/units/unit_396port) | 日本語 + ## 概要 @@ -14,10 +14,10 @@ ## ドキュメント
- M5GO_Unit_3.96_01 + M5GO_Unit_396port
- M5GO_Unit_3.96_02 + unit_396port_02
## 関連情報 diff --git a/docs/ja/unit/adc.md b/docs/ja/unit/adc.md index 6df6dfd3..1cb1b740 100644 --- a/docs/ja/unit/adc.md +++ b/docs/ja/unit/adc.md @@ -1,6 +1,6 @@ # ADC ユニット -[中文](zh_CN/product_documents/units/unit_adc) | [English](en/product_documents/units/unit_adc) | 日本語 + ## 概要 diff --git a/docs/ja/unit/angle.md b/docs/ja/unit/angle.md index 32dcb4c5..5e6bd15f 100644 --- a/docs/ja/unit/angle.md +++ b/docs/ja/unit/angle.md @@ -1,6 +1,6 @@ # ANGLE ユニット -[中文](zh_CN/product_documents/units/unit_angle) | [English](en/product_documents/units/unit_angle) | 日本語 + ## 概要 diff --git a/docs/ja/unit/button.md b/docs/ja/unit/button.md index 1f79cfd0..a9a708a8 100644 --- a/docs/ja/unit/button.md +++ b/docs/ja/unit/button.md @@ -1,6 +1,6 @@ # BUTTON ユニット -[中文](zh_CN/product_documents/units/unit_button) | [English](en/product_documents/units/unit_button) | 日本語 + ## 概要 diff --git a/docs/ja/unit/color.md b/docs/ja/unit/color.md index aa348caa..3cbdea34 100644 --- a/docs/ja/unit/color.md +++ b/docs/ja/unit/color.md @@ -1,6 +1,6 @@ # COLOR SENSOR ユニット -[中文](zh_CN/product_documents/units/unit_color) | [English](en/product_documents/units/unit_color) | 日本語 + ## 概要 diff --git a/docs/ja/unit/dac.md b/docs/ja/unit/dac.md index 7315a003..3898c010 100644 --- a/docs/ja/unit/dac.md +++ b/docs/ja/unit/dac.md @@ -1,6 +1,6 @@ # DAC ユニット -[中文](zh_CN/product_documents/units/unit_dac) | [English](en/product_documents/units/unit_dac) | 日本語 + ## 概要 diff --git a/docs/ja/unit/dual_button.md b/docs/ja/unit/dual_button.md index 20ff2be4..ea75e0b9 100644 --- a/docs/ja/unit/dual_button.md +++ b/docs/ja/unit/dual_button.md @@ -1,6 +1,6 @@ # Dual BUTTON ユニット -[中文](zh_CN/product_documents/units/unit_dual_button) | [English](en/product_documents/units/unit_dual_button) | 日本語 + ## 概要 diff --git a/docs/ja/unit/earth.md b/docs/ja/unit/earth.md index f3aa56b4..9036612a 100644 --- a/docs/ja/unit/earth.md +++ b/docs/ja/unit/earth.md @@ -1,6 +1,6 @@ # EARTH ユニット -[中文](/zh_CN/product_documents/units/unit_earth) | [English](en/product_documents/units/unit_earth) | 日本語 + ## 概要 @@ -18,9 +18,9 @@ - **サンプルコード** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Earth) -
+
M5GO_Unit_earth_02
diff --git a/docs/ja/unit/env.md b/docs/ja/unit/env.md index e27c7f46..1df60cbf 100644 --- a/docs/ja/unit/env.md +++ b/docs/ja/unit/env.md @@ -1,6 +1,6 @@ # ENV ユニット -[中文](zh_CN/product_documents/units/unit_env) | [English](en/product_documents/units/unit_env) | 日本語 + ## 概要 diff --git a/docs/ja/unit/esp32cam.md b/docs/ja/unit/esp32cam.md index 771e0cfc..672cee34 100644 --- a/docs/ja/unit/esp32cam.md +++ b/docs/ja/unit/esp32cam.md @@ -1,6 +1,6 @@ # ESP32Cam ユニット -[中文](zh_CN/product_documents/units/unit_esp32cam) | [English](en/product_documents/units/unit_esp32cam) | 日本語 + ## 概要 diff --git a/docs/ja/unit/hub.md b/docs/ja/unit/hub.md index bb0293f8..9fd872c2 100644 --- a/docs/ja/unit/hub.md +++ b/docs/ja/unit/hub.md @@ -1,6 +1,6 @@ # HUB ユニット -[中文](zh_CN/product_documents/units/unit_hub) | [English](en/product_documents/units/unit_hub) | 日本語 + ## 概要 diff --git a/docs/ja/unit/ir.md b/docs/ja/unit/ir.md index 5eb6e884..4f82a908 100644 --- a/docs/ja/unit/ir.md +++ b/docs/ja/unit/ir.md @@ -1,6 +1,6 @@ # IR ユニット -[中文](zh_CN/product_documents/units/unit_ir) | [English](en/product_documents/units/unit_ir) | 日本語 + ## 概要 diff --git a/docs/ja/unit/joystick.md b/docs/ja/unit/joystick.md index 02a542cc..d9e772fa 100644 --- a/docs/ja/unit/joystick.md +++ b/docs/ja/unit/joystick.md @@ -1,6 +1,6 @@ # JOYSTICK ユニット -[中文](zh_CN/product_documents/units/unit_joystick) | [English](en/product_documents/units/unit_joystick) | 日本語 + ## 概要 @@ -21,11 +21,11 @@
- M5GO_Unit_joystick_02 + M5GO_Unit_joystick_02
- M5GO_Unit_joystick_03 + M5GO_Unit_joystick_03
## 関連情報 diff --git a/docs/ja/unit/light.md b/docs/ja/unit/light.md index 35a4190b..f58f930c 100644 --- a/docs/ja/unit/light.md +++ b/docs/ja/unit/light.md @@ -1,6 +1,6 @@ # LIGHT ユニット -[中文](zh_CN/product_documents/units/unit_light) | [English](en/product_documents/units/unit_light) | 日本語 + ## 概要 diff --git a/docs/ja/unit/m5camera.md b/docs/ja/unit/m5camera.md index 7a8c547c..36e157be 100644 --- a/docs/ja/unit/m5camera.md +++ b/docs/ja/unit/m5camera.md @@ -1,6 +1,6 @@ # M5Camera ユニット -[中文](zh_CN/product_documents/units/unit_m5camera) | [English](en/product_documents/units/unit_m5camera) | 日本語 + ## 概要 diff --git a/docs/ja/unit/makey.md b/docs/ja/unit/makey.md index 34409121..85d58ad2 100644 --- a/docs/ja/unit/makey.md +++ b/docs/ja/unit/makey.md @@ -1,6 +1,6 @@ # MAKEY ユニット -[中文](zh_CN/product_documents/units/unit_makey) | [English](en/product_documents/units/unit_makey) | 日本語 + ## 概要 diff --git a/docs/ja/unit/ncir.md b/docs/ja/unit/ncir.md index 95316f4f..5268c172 100644 --- a/docs/ja/unit/ncir.md +++ b/docs/ja/unit/ncir.md @@ -1,6 +1,6 @@ # NCIR ユニット -[中文](zh_CN/product_documents/units/unit_ncir) | [English](en/product_documents/units/unit_ncir) | 日本語 + ## 概要 diff --git a/docs/ja/unit/neopixel.md b/docs/ja/unit/neopixel.md index ec024cbf..51efc2cf 100644 --- a/docs/ja/unit/neopixel.md +++ b/docs/ja/unit/neopixel.md @@ -1,6 +1,6 @@ # NeoPixel ユニット -[中文](zh_CN/product_documents/units/unit_neopixel) | [English](en/product_documents/units/unit_neopixel) | 日本語 + ## 概要 diff --git a/docs/ja/unit/pir.md b/docs/ja/unit/pir.md index 5ba6f049..9e580bf3 100644 --- a/docs/ja/unit/pir.md +++ b/docs/ja/unit/pir.md @@ -1,6 +1,6 @@ # PIR ユニット -[中文](zh_CN/product_documents/units/unit_pir) | [English](en/product_documents/units/unit_pir) | 日本語 + ## 概要 diff --git a/docs/ja/unit/proto.md b/docs/ja/unit/proto.md index 53258cf9..1beee65a 100644 --- a/docs/ja/unit/proto.md +++ b/docs/ja/unit/proto.md @@ -1,6 +1,6 @@ # PROTO ユニット -[中文](zh_CN/product_documents/units/unit_proto) | [English](en/product_documents/units/unit_proto) | 日本語 + ## 概要 diff --git a/docs/ja/unit/relay.md b/docs/ja/unit/relay.md index c7ba851a..d60b8b92 100644 --- a/docs/ja/unit/relay.md +++ b/docs/ja/unit/relay.md @@ -1,6 +1,6 @@ # RELAY ユニット -[中文](zh_CN/product_documents/units/unit_relay) | [English](en/product_documents/units/unit_relay) | 日本語 + ## 概要 diff --git a/docs/ja/unit/rgb.md b/docs/ja/unit/rgb.md index 89c4994e..3cf3c90c 100644 --- a/docs/ja/unit/rgb.md +++ b/docs/ja/unit/rgb.md @@ -1,6 +1,6 @@ # RGB ユニット -[中文](zh_CN/product_documents/units/unit_rgb) | [English](en/product_documents/units/unit_rgb) | 日本語 + ## 概要 diff --git a/docs/ja/unit/thermal.md b/docs/ja/unit/thermal.md index b11b7936..6dd27ae3 100644 --- a/docs/ja/unit/thermal.md +++ b/docs/ja/unit/thermal.md @@ -1,6 +1,6 @@ # THERMAL ユニット -[中文](zh_CN/product_documents/units/unit_thermal) | [English](en/product_documents/units/unit_thermal) | 日本語 + ## 概要 diff --git a/docs/ja/unit/tof.md b/docs/ja/unit/tof.md index c01c5df5..bddb04a2 100644 --- a/docs/ja/unit/tof.md +++ b/docs/ja/unit/tof.md @@ -1,6 +1,6 @@ # ToF ユニット -[中文](zh_CN/product_documents/units/unit_tof) | [English](en/product_documents/units/unit_tof) | 日本語 + ## 概要 diff --git a/docs/ja/unit/unit_color.md b/docs/ja/unit/unit_color.md index aa348caa..3cbdea34 100644 --- a/docs/ja/unit/unit_color.md +++ b/docs/ja/unit/unit_color.md @@ -1,6 +1,6 @@ # COLOR SENSOR ユニット -[中文](zh_CN/product_documents/units/unit_color) | [English](en/product_documents/units/unit_color) | 日本語 + ## 概要 diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index 0b115481..1410c5ef 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -38,7 +38,9 @@ -[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](zh_CN/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](zh_CN/base/node_base) [![plc_01.png](https://i.loli.net/2018/12/13/5c122411a87d1.png)](zh_CN/base/plc_base) +[![lan_01.png](https://i.loli.net/2018/12/13/5c1223ee16411.png)](zh_CN/base/lan_base) [![node_01.png](https://i.loli.net/2018/12/13/5c1223fd8d2cb.png)](zh_CN/base/node_base) + + *** diff --git a/docs/zh_CN/application/bala.md b/docs/zh_CN/application/bala.md index 552ae7e1..528179a1 100644 --- a/docs/zh_CN/application/bala.md +++ b/docs/zh_CN/application/bala.md @@ -1,6 +1,10 @@ -# BALA +# BALA - 平衡车 -中文 | [English](en/product_documents/applications/application_bala) | [日本語](ja/product_documents/applications/application_bala) + + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](/zh_CN/quick_start/bala/bala_quick_start)**   :octocat:**[例程](https://github.com/m5stack/M5Bala/tree/master/examples)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.13.3b6d425eZah7wG&id=574761698176)** ## 描述 @@ -20,29 +24,3 @@ - 1x 电机驱动 - 2x 带编码器的N20电机 - Type-C USB线 - - -## 相关链接 -- **例程** - [Arduino](https://github.com/m5stack/M5Bala/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5Bala/tree/master/mpy) -- **[上手指南](/zh_CN/quick_start/bala/bala_quick_start)** -- **[购买链接](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/zh_CN/application/lidarbot.md b/docs/zh_CN/application/lidarbot.md index f47517b1..6b79873e 100644 --- a/docs/zh_CN/application/lidarbot.md +++ b/docs/zh_CN/application/lidarbot.md @@ -1,6 +1,10 @@ # LidarBot -中文 | [English](en/product_documents/applications/application_lidarbot) | [日本語](ja/product_documents/applications/application_lidarbot) + + +* * * + +:memo:**[描述](#描述)**   :octocat:**[例程](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.17fd425e0xq2aq&id=580401820385)** ## 描述 @@ -52,29 +56,3 @@ - 自主走迷宫 - 路径规划 - 自动驾驶 - -## 文档 -- **例程** - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) - [MicroPython]() - -- **[旗舰店](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)** - - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/zh_CN/base/face_base.md b/docs/zh_CN/base/face_base.md index ffd442f8..246e4204 100644 --- a/docs/zh_CN/base/face_base.md +++ b/docs/zh_CN/base/face_base.md @@ -1,7 +1,5 @@ # FACE Base -中文 | [English](/en/product_documents/bases/face_base) | [日本語](ja/product_documents/bases/face_base) - ## 描述 FACE Base是[FACES Kit](zh_CN/product_documents/m5stack-core/face_kit)套件中的底座，主要由M5Core底座和电池模块组成，如下图。 diff --git a/docs/zh_CN/base/lan_base.md b/docs/zh_CN/base/lan_base.md index 5b5240e9..4d936b1a 100644 --- a/docs/zh_CN/base/lan_base.md +++ b/docs/zh_CN/base/lan_base.md @@ -1,6 +1,10 @@ # LAN底座 -中文 | [English](/en/product_documents/bases/lan_base) | [日本語](ja/product_documents/bases/lan_base) + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/LAN/Arduino)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.6c24425eKdAPr3&id=574863427657)** ## 描述 @@ -23,12 +27,11 @@ | RST | GPIO13 | | INTn | GPIO34 | + **M-Bus** -
- M_BUS -
+ ## 特性 @@ -39,22 +42,8 @@ ## 相关链接 -- **[原理图](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)** +- **[官方频道视频](https://i.youku.com/i/UNjE1ODA2MzE0OA==?spm=a2hzp.8253869.0.0)** -
- -
+- **[官方论坛](http://forum.m5stack.com/)** -
- -
- -
- -
- -
- -
\ No newline at end of file +## 原理图 diff --git a/docs/zh_CN/base/m5go_base.md b/docs/zh_CN/base/m5go_base.md index 81522c88..54c260d9 100644 --- a/docs/zh_CN/base/m5go_base.md +++ b/docs/zh_CN/base/m5go_base.md @@ -1,7 +1,5 @@ # M5GO底座 -中文 | [English](/en/product_documents/bases/m5go_base) | [日本語](ja/product_documents/bases/m5go_base) - ## 描述 M5GO底座是[M5GO IOT Starter Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit)套件中的底座，[M5Fire](zh_CN/product_documents/m5stack-core/m5core_fire)的套件中也配套了这个底座。 diff --git a/docs/zh_CN/core/face_kit.md b/docs/zh_CN/core/face_kit.md index 03259736..103782a0 100644 --- a/docs/zh_CN/core/face_kit.md +++ b/docs/zh_CN/core/face_kit.md @@ -1,7 +1,5 @@ # FACES Kit -中文 | [English](/en/product_documents/m5stack-core/face_kit) | [日本語](ja/product_documents/m5stack-core/face_kit) - **FACES Kit**是有M5Core、功能面板、FACES Base、充电底座FACES Charger和其他配件(杜邦线、FACES Kit挂绳、M3固定螺丝等等)组成的套件。目前功能面板有GameBoy、Calculator和QWERTY三种，以后会继续增加。可以通过Arduino IDE或者M5Cloud对套件编程，在不同的应用场景下，堆叠不一样的功能面板，烧录对应固件到M5Core，实现对应的功能。其中FACES底座的电池是650mAh。而关于FACES底座的详情欢迎阅读介绍[FACES Base](zh_CN/product_documents/bases/face_base)的介绍。 *每个功能面板都集成了**MEGA328**芯片，在按下每个独立按键都可以返回唯一的键值。功能面板与M5Core之间通过**I2C**通信，而从机(即功能面板)的I2C地址为0x08。* diff --git a/docs/zh_CN/core/fire.md b/docs/zh_CN/core/fire.md index 4a43d3c9..b541eac6 100644 --- a/docs/zh_CN/core/fire.md +++ b/docs/zh_CN/core/fire.md @@ -169,27 +169,3 @@ M5GO CHG.底座包含POGO Pin。FIRE主控通过POGO Pin与这个充电底座连 - **m5stack的简介** - -## READ MORE - -### Diagram of Fire - -
- -
- -
- -
- -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/zh_CN/core/m5go_iot_starter_kit.md b/docs/zh_CN/core/m5go_iot_starter_kit.md index d331172b..7040304b 100644 --- a/docs/zh_CN/core/m5go_iot_starter_kit.md +++ b/docs/zh_CN/core/m5go_iot_starter_kit.md @@ -1,6 +1,12 @@ # M5GO IOT Starter Kit -中文 | [English](/en/product_documents/m5stack-core/m5go_iot_starter_kit) | [日本語](ja/product_documents/m5stack-core/m5go_iot_starter_kit) +gray_02 gray_02 gray_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=a1z10.3-c.w4002-1172588106.10.1b28425eUFn3DY&id=568283585553)**   :clapper:**[相关视频](#相关视频)**** ## 描述 @@ -15,119 +21,6 @@ - 可编程，支持[UiFlow](http://flow.m5stack.com), MicroPython和Arduino - 支持外置TF卡(最大16G) -## 参数 - -| 主控资源 | 参数 | -| :----------: |:------------: | -| 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 | 550mAh @ 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 | 300g with bottom | - -## 管脚映射 - -**POGO Pin** - -| POGO Pin | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | - -**LED灯条** - -| LED Pin | ESP32 Chip | -| :----------: |:------------: | -| LED Pin | GPIO15 | - -**麦克风MIC** - -| MIC Pin | ESP32 Chip | -| :----------: |:------------: | -| MIC Pin | GPIO34 | - -**喇叭Speak** - -| Speak Pin | ESP32 Chip | -| :----------: |:------------: | -| Speak Pin | GPIO25 | - -**按键Button** - -| Button Pin | ESP32 Chip | -| :----------: |:------------: | -| BUTTON A | GPIO39 | -| BUTTON B | GPIO38 | -| BUTTON C | GPIO37 | - -**GROVE接口** - -| PORT A(I2C) | ESP32 Chip | -| :----------: |:------------: | -| SCL | GPIO22 | -| SDA | GPIO21 | -| 5V | 5V | -| GND | GND | - -| PORT B(I/O) | ESP32 Chip | -| :----------: |:------------: | -| G36 | GPIO36 | -| G26 | GPIO26 | -| 5V | 5V | -| GND | GND | - -| PORT C(UART2) | ESP32 Chip | -| :----------: |:------------: | -| RXD | GPIO16 | -| TXD | GPIO17 | -| 5V | 5V | -| GND | GND | - -**MEMS传感器** - -*MPU9250 i2c address: 0x68* - -| MPU9250 | 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总线** - -
- M_BUS -
- ## 包含 - 1x white M5Core主控 @@ -138,34 +31,12 @@ - Type-C USB 线 - 说明书 -## 文档 +## 相关链接 -- **例程** - [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://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.10.690a425eFsoYVX&id=568283585553)** +## 相关视频 -- **快速上手** - 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) +- **m5stack的简介** -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
- -
+ \ No newline at end of file diff --git a/docs/zh_CN/core/m5stick.md b/docs/zh_CN/core/m5stick.md index 84fbc43a..326bd113 100644 --- a/docs/zh_CN/core/m5stick.md +++ b/docs/zh_CN/core/m5stick.md @@ -1,7 +1,10 @@ # M5Stick -中文 | [English](/en/product_documents/m5stack-core/minicore_stick) | [日本語](ja/product_documents/m5stack-core/minicore_stick) +gray_02 gray_02 gray_04 +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stick_get_started_arduino)**   :octocat:**[例程](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest)**   :electric_plug:**[原理图](#原理图)**   🛒**[购买链接](https://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.257b425esTi92S&id=581055502939)**    ## 描述 **M5Stick** 是一个包含1.3寸OLED屏幕(64x128)，LED灯，按键，蜂鸣器，红外发射管和80mA的电池的小型ESP32开发板。你通常可以将它戴在手腕上，也可以利用我们的配件将它固定到墙上。 @@ -45,34 +48,14 @@ M5Stick有两个版本，第一个是无PSRAM的版本，另外一个是有MPU92 | SDA | GPIO22 | | SCL | GPIO21 | - - ## 包含 - 1x M5Stick 内置 80mAh-Battery - 1x Type-C USB 线 -MPU9250 版本: +**MPU9250 版本:** - 一些配件: `WATCH BELT`, `WALL` and `BRICK` -## 文档 - -- **例程** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Stick/FactoryTest) +## 相关链接 - **数据手册** - [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://item.taobao.com/item.htm?spm=a1z10.3-c.w4002-1172588106.11.257b425esTi92S&id=581055502939)** - -- **上手指南** - [Arduino](zh_CN/quick_start/m5core/m5stick_get_started_arduino) - -
- -
- -
- -
- -
- -
\ No newline at end of file diff --git a/docs/zh_CN/module/btc.md b/docs/zh_CN/module/btc.md index ccce9505..318e0107 100644 --- a/docs/zh_CN/module/btc.md +++ b/docs/zh_CN/module/btc.md @@ -20,6 +20,7 @@ BTC模块是一款包含DHT12(温湿度)传感器的底座。有了BTC底座之 - Type-C USB线 - M3 x 16 +- Tools # 管脚映射 @@ -49,6 +50,6 @@ float tmp = dht12.readTemperature();//temperature float hum = dht12.readHumidity();//humidity ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ENV/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 ## 原理图 diff --git a/docs/zh_CN/module/gps.md b/docs/zh_CN/module/gps.md index d9bf9c90..f99ba4d6 100644 --- a/docs/zh_CN/module/gps.md +++ b/docs/zh_CN/module/gps.md @@ -8,7 +8,7 @@ ## 描述 -GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置的GPS小模块名字为UBLOX NEO-M8N。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。它都可提供全球定位信息，即使你在室外的任何地方。模块上电之后，就会一直接收定位信息。M5Core烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/GPS/Arduino)，堆叠了GPS模块和连接PC串口之后，屏幕和PC的串口显示终端就会打印GPS接收到的信息。 +GPS 模块是一款内置了GPS小模组的M5Stack系列可堆叠模块。内置的GPS小模块名字为UBLOX NEO-M8N。堆叠了M5Core之后，你可以用UiFlow、Arduino和MicroPython来编程它。它都可提供全球定位信息，即使你在室外的任何地方。模块上电之后，就会一直接收定位信息。M5Core烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)，堆叠了GPS模块和连接PC串口之后，屏幕和PC的串口显示终端就会打印GPS接收到的信息。 ## 特性 @@ -48,7 +48,7 @@ if(GPSRaw.available()) { } ``` -烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 +烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 ``` $GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 @@ -61,7 +61,7 @@ $GNZDA,,,,,,*56 $GPTXT,01,01,01,ANTENNA OPEN*25 ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/GPS/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)。 ## 原理图 diff --git a/docs/zh_CN/module/lan.md b/docs/zh_CN/module/lan.md index 7558a444..fd819ec3 100644 --- a/docs/zh_CN/module/lan.md +++ b/docs/zh_CN/module/lan.md @@ -1,8 +1,12 @@ # M5Stack LAN Module -中文 | [English](/en/product_documents/modules/module_lan) | [日本語](ja/product_documents/modules/module_lan) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Arrival-LAN-Module-with-W5500-Chip-LanProto-Ethernet-convert-Network-Module-Microcontroller-for-Arduino/3226069_32904089417.html)** + +## Description The M5Stack LAN Module is a ethernet module which with a I2C Grove port and 6 pins user ports. @@ -10,12 +14,12 @@ When the speed of our wireless network is so slow that M5Stack Core can not norm So we need a ethernet port board which is connected with M5Stack Core. This **LAN module** is that one who solves the awkward problem. -## FEATURES +## Feature - W5500 - High-performance ethernet chip - Less code and Hand-in-hand program experience -## INCLUDES +## Include - 1x M5Stack LAN Module(including USER-DEFINE 6 PIN and 1 Grove port) - 1x DIN-RAIL @@ -31,16 +35,10 @@ So we need a ethernet port board which is connected with M5Stack Core. This **LA + HTTP Clinet - SMTP/NTP Server -## DOCUMENTS +## Related Link -- [WebSite](https://m5stack.com) +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** -- Example - + [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/W5500) +- **[Forum](http://forum.m5stack.com/)** - [LAN Info](https://www.u-blox.com/zh/product/neo-m8-series) (LAN) - -- GitHub - + [Arduino GitHub](https://github.com/m5stack/M5Stack) - -- [Purchase](https://item.taobao.com/item.htm?spm=a1z10.5-c.w4002-1172588093.28.6c2275f4nUJEfh&id=574863427657) diff --git a/docs/zh_CN/module/lora.md b/docs/zh_CN/module/lora.md index 01cd5ccd..77e3855f 100644 --- a/docs/zh_CN/module/lora.md +++ b/docs/zh_CN/module/lora.md @@ -81,6 +81,6 @@ Serial2.print("AT+TEST=RFCFG,472.3,8,250,8,8,20"); Serial2.print("AT+TEST=RXLRPKT"); ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/LoraWAN/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/LORAWAN/Arduino)。 ## 原理图 diff --git a/docs/zh_CN/module/plc.md b/docs/zh_CN/module/plc.md index 75ac5900..6f168bed 100644 --- a/docs/zh_CN/module/plc.md +++ b/docs/zh_CN/module/plc.md @@ -1,8 +1,12 @@ # M5Stack PLC Module -中文 | [English](/en/product_documents/modules/module_plc) | [日本語](ja/product_documents/modules/module_plc) + -## DESCRIPTION +*** + +:memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-PLC-Proto-Industrial-Board-Module-Contains-RS485-ACS712-5B-Programmable-Logic-Controller-Relay-with-Magnet/3226069_32874916056.html?spm=2114.12010615.8148356.2.4c5b68a1WZ8sjd)** + +## Description The M5Stack PLC Module is a prototye industrial board, including RS484 adapter and electricity meter module. @@ -10,14 +14,14 @@ adapter and electricity meter module. With DC9~24V power input, PLC-Proto motherboard reserved 6Pin or 4Pin relay output, digital input, communication interface etc. -## FEATURES +## Feature - Free DIY - Programmable Logic Controller - Individual package weight: 0.1kg (0.22lb.) - Package size: 5cm \* 5cm \* 5cm (1.97in \* 1.97in \* 1.97in) -## INCLUDES +## Include - 1x PLC-Proto Broad - 1x RS485 module @@ -37,9 +41,8 @@ relay output, digital input, communication interface etc. - Digital Operation Processor - Strong Electric Controller -## DOCUMENTS +## Related Link -- [WebSiteStart](https://m5stack.com) -- GitHub - - [Arduino](https://github.com/m5stack/M5Stack) - - [MicroPython]() +- **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** + +- **[Forum](http://forum.m5stack.com/)** diff --git a/docs/zh_CN/module/plus.md b/docs/zh_CN/module/plus.md index e86ea537..83f06c7e 100644 --- a/docs/zh_CN/module/plus.md +++ b/docs/zh_CN/module/plus.md @@ -48,6 +48,6 @@ if(Wire.available()) { } ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/PLUS/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/PLUS/Arduino)。 ## 原理图 diff --git a/docs/zh_CN/module/servo.md b/docs/zh_CN/module/servo.md index 012fc42d..76df6de1 100644 --- a/docs/zh_CN/module/servo.md +++ b/docs/zh_CN/module/servo.md @@ -41,7 +41,7 @@ Servo模块使用起来非常简单，因为内置了MEGA328芯片来管理多 ```c++ #define SERVO_ADDR 0x53 //the IIC address of SERVO Module -/* +/* * control servo(CH channle) by us */ Wire.beginTransmission(SERVO_ADDR); @@ -50,15 +50,15 @@ Wire.write(timeL); Wire.write(timeH); Wire.endTransmission(); -/* +/* * control servo(CH channle) by angle */ Wire.beginTransmission(SERVO_ADDR); Wire.write(CH|0x10); Wire.write(angle);//0-180° -Wire.endTransmission(); +Wire.endTransmission(); ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/SERVO/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/Arduino)。 ## 原理图 \ No newline at end of file diff --git a/docs/zh_CN/module/sim800.md b/docs/zh_CN/module/sim800.md index 66f22c08..232d2eef 100644 --- a/docs/zh_CN/module/sim800.md +++ b/docs/zh_CN/module/sim800.md @@ -22,14 +22,14 @@ SIM800L是完整的支持四种频宽的GSM/GPRS解决方案。通过串口发 ## 管脚映射 -*SIM800モジュールは、M5Coreとスタックされた後、UART2を介して通信します。* +*SIM800与M5Core堆叠之后，它们之间通过UART2通信* **SIM800** | SIM800 Pin | ESP32 Chip | | :----------: |:------------: | -| TXD | GPIO16 | -| RXD | GPIO17 | +| TXD | U2RXD(GPIO16) | +| RXD | U2TXD(GPIO17) | | RST | GPIO5 | diff --git a/docs/zh_CN/practice.md b/docs/zh_CN/practice.md deleted file mode 100644 index e929507d..00000000 --- a/docs/zh_CN/practice.md +++ /dev/null @@ -1,7 +0,0 @@ -# 练习(ractice) - -中文 | [English](/en/practice) | [日本語](/ja/practice) - - | | ----|---|--- -[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/zh_CN/practice/practice_arduino.md b/docs/zh_CN/practice/practice_arduino.md deleted file mode 100644 index 866b9a2f..00000000 --- a/docs/zh_CN/practice/practice_arduino.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for Arduino - -中文 | [English](/en/practice/practice_arduino) | [日本語](/ja/practice/practice_arduino) - -## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/practice/practice_blockly.md b/docs/zh_CN/practice/practice_blockly.md deleted file mode 100644 index eaf508d2..00000000 --- a/docs/zh_CN/practice/practice_blockly.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(Blockly) - -中文 | [English](/en/practice/practice_blockly) | [日本語](/ja/practice/practice_blockly) - -## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/practice/practice_micropython.md b/docs/zh_CN/practice/practice_micropython.md deleted file mode 100644 index 1278568f..00000000 --- a/docs/zh_CN/practice/practice_micropython.md +++ /dev/null @@ -1,5 +0,0 @@ -# Practice for UiFlow(MicroPython) - -中文 | [English](/en/practice/practice_micropython) | [日本語](/ja/practice/practice_micropython) - -## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/unit/adc.md b/docs/zh_CN/unit/adc.md index bbcc967b..0f74b285 100644 --- a/docs/zh_CN/unit/adc.md +++ b/docs/zh_CN/unit/adc.md @@ -44,13 +44,13 @@ ads.setOSMode(OSMODE_SINGLE);// Set to start a single-conversion result = ads.Measure_Differential();//Reads the conversion results ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ADC/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/Arduino)。 ### 2. UIFlow +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ADC/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/angle.md b/docs/zh_CN/unit/angle.md index 4659c17c..632aec79 100644 --- a/docs/zh_CN/unit/angle.md +++ b/docs/zh_CN/unit/angle.md @@ -55,13 +55,13 @@ void loop() { } ``` -具体例程`potentiometer_read.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ANGLE/Arduino)。 +具体例程`potentiometer_read.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ANGLE/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/UIFlow)。 ## 原理图 diff --git a/docs/zh_CN/unit/button.md b/docs/zh_CN/unit/button.md index 9f8396d5..3dd06085 100644 --- a/docs/zh_CN/unit/button.md +++ b/docs/zh_CN/unit/button.md @@ -34,13 +34,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/BUTTON/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/BUTTON/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/color.md b/docs/zh_CN/unit/color.md index 37326aaa..ceac9816 100644 --- a/docs/zh_CN/unit/color.md +++ b/docs/zh_CN/unit/color.md @@ -41,7 +41,7 @@ tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS, TCS34725_GAIN_4X); tcs.getRawData(&red, &green, &blue, &clear);//get rgb value ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/COLOR/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino)。 烧录了例程后，串口显示终端会打印原始值，包括明光感应值(Clear)、红、绿、蓝(RGB) @@ -53,7 +53,7 @@ tcs.getRawData(&red, &green, &blue, &clear);//get rgb value +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/dac.md b/docs/zh_CN/unit/dac.md index c2198f26..73ab3ea8 100644 --- a/docs/zh_CN/unit/dac.md +++ b/docs/zh_CN/unit/dac.md @@ -67,15 +67,15 @@ void loop(void) { dac.setVoltage(2048, false); delay(1000); } -``` --> +``` - + ### 2. UIFlow +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DAC/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/dual_button.md b/docs/zh_CN/unit/dual_button.md index 00d6d6e1..2fecf75c 100644 --- a/docs/zh_CN/unit/dual_button.md +++ b/docs/zh_CN/unit/dual_button.md @@ -34,13 +34,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/DUAL_BUTTON/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/DUAL_BUTTON/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/earth.md b/docs/zh_CN/unit/earth.md index f387dfc3..04f54d8e 100644 --- a/docs/zh_CN/unit/earth.md +++ b/docs/zh_CN/unit/earth.md @@ -37,13 +37,13 @@ analogRead_value = analogRead(36); digitalRead_value = digitalRead(26); ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/EARTH/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/EARTH/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/UIFlow)。 ## 原理图 diff --git a/docs/zh_CN/unit/env.md b/docs/zh_CN/unit/env.md index 5f5c0774..a38cb5b6 100644 --- a/docs/zh_CN/unit/env.md +++ b/docs/zh_CN/unit/env.md @@ -40,13 +40,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ENV/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ENV/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。 ## 原理图 diff --git a/docs/zh_CN/unit/esp32cam.md b/docs/zh_CN/unit/esp32cam.md index 869811cd..c8102a0a 100644 --- a/docs/zh_CN/unit/esp32cam.md +++ b/docs/zh_CN/unit/esp32cam.md @@ -70,13 +70,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ESP32CAM/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ESP32CAM/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/ESP32CAM/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ESP32CAM/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/gps.md b/docs/zh_CN/unit/gps.md index c64992bd..4801dd94 100644 --- a/docs/zh_CN/unit/gps.md +++ b/docs/zh_CN/unit/gps.md @@ -53,7 +53,7 @@ if(GPSRaw.available()) { } ``` -烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Modules/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 +烧录[例程](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GPS/Arduino)之后，屏幕和串口显示终端会打印如下类似的信息 ``` $GPGSA,A,1,,,,,,,,,,,,,25.5,25.5,25.5*02 @@ -66,7 +66,7 @@ $GNZDA,,,,,,*56 $GPTXT,01,01,01,ANTENNA OPEN*25 ``` -具体例程`GPSRaw.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/GPS/Arduino)。 +具体例程`GPSRaw.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/GPS/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/M5CAMERA/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/makey.md b/docs/zh_CN/unit/makey.md index b91396a4..8fc6d440 100644 --- a/docs/zh_CN/unit/makey.md +++ b/docs/zh_CN/unit/makey.md @@ -40,13 +40,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/MAKEY/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/MAKEY/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/MAKEY/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/ncir.md b/docs/zh_CN/unit/ncir.md index 8ff3dab9..76c346a6 100644 --- a/docs/zh_CN/unit/ncir.md +++ b/docs/zh_CN/unit/ncir.md @@ -43,13 +43,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/NCIR/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NCIR/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/NCIR/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NCIR/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/neopixel.md b/docs/zh_CN/unit/neopixel.md index 15f135bb..a8cfff4e 100644 --- a/docs/zh_CN/unit/neopixel.md +++ b/docs/zh_CN/unit/neopixel.md @@ -37,13 +37,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/NEOPIXEL/Arduino)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)。 --> ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/NEOPIXEL/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/Arduino)。 --> ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/PIR/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow)。 ## 原理图 diff --git a/docs/zh_CN/unit/relay.md b/docs/zh_CN/unit/relay.md index dcfc54c1..f36fafad 100644 --- a/docs/zh_CN/unit/relay.md +++ b/docs/zh_CN/unit/relay.md @@ -36,13 +36,13 @@ digitalWrite(26, 1);//relay closed delay(1000); ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/RELAY/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/RELAY/UIFlow)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow)。 ## 原理图 diff --git a/docs/zh_CN/unit/rgb.md b/docs/zh_CN/unit/rgb.md index c22dace5..d231e8fe 100644 --- a/docs/zh_CN/unit/rgb.md +++ b/docs/zh_CN/unit/rgb.md @@ -34,13 +34,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/RGB/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/RGB/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/thermal.md b/docs/zh_CN/unit/thermal.md index b3327e06..2f35eb70 100644 --- a/docs/zh_CN/unit/thermal.md +++ b/docs/zh_CN/unit/thermal.md @@ -49,13 +49,13 @@ float hum = dht12.readHumidity();//humidity float pressure = bme.readPressure();//pressure ``` -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/THERMAL/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/THERMAL/Arduino)。 ### 2. UIFlow -具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/THERMAL/UIFlow)。 --> +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/THERMAL/UIFlow)。 --> ## 原理图 diff --git a/docs/zh_CN/unit/tof.md b/docs/zh_CN/unit/tof.md index 49aa4d0a..d8614761 100644 --- a/docs/zh_CN/unit/tof.md +++ b/docs/zh_CN/unit/tof.md @@ -52,13 +52,13 @@ read_block_data_at(RESULT_RANGE_STATUS, 12); //read 12 bytes once dist = makeuint16(gbuf[11], gbuf[10]); //split distance data and save at "dist" ``` -具体例程`MeasureDistance.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Units/TOF/Arduino)。 +具体例程`MeasureDistance.ino`请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/Arduino)。 +具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TOF/UIFlow)。 --> ## 原理图