m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'pr/43'

Browse Source
This commit is contained in:
watson134
2018-11-13 23:02:50 +08:00
parent 967056a4c4 209ebc9a9b
commit 4997b80e38
67 changed files with 350 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/product_pics/accessories/grove_cable.jpg
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 105 KiB

docs/assets/img/product_pics/modules/lora_01.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 478 KiB

docs/en/product_documents.md
+1 -14
View File
@@ -2,7 +2,7 @@
[中文](zh_CN/product_documents) | English | [日本語](ja/product_documents)
## Cores
*The `Quick Start` section of each product is placed in the corresponding product document.*
<img src='assets/img/product_pics/1.jpg'> <img src='assets/img/product_pics/cores.png'>
@@ -13,9 +13,6 @@
| [FIRE](/en/product_documents/m5stack-core/m5core_fire) | / |
| [M5GO IOT Kit](/en/product_documents/m5stack-core/m5go_iot_starter_kit) | / |
## Modules
<img src='assets/img/product_pics/2.jpg'> <img src='assets/img/product_pics/module.png'>
| Wireless Modules | Accessory Modules | Controlling Modules |
@@ -30,8 +27,6 @@
| / | / | / |
| / | / | / |
## Bases
<img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/bases.png'>
- [M5GO-Base](/en/file_to_diplay_null)
@@ -40,15 +35,11 @@
- [LAN](/en/product_documents/bases/lan_base)
- [Node-Base](/en/product_documents/bases/node_base)
## Accessories
<img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/accessory.png'>
- [LEGO-CABLE](/en/product_documents/accessorries/cables/accessory_lego_cable)
- [FRAME](/en/product_documents/accessorries/accessory_frame)
## Units
<img src='assets/img/product_pics/3.jpg'> <img src='assets/img/product_pics/unit.png'>
| Input/Sensing Class | Output/Controlling Class | Interface Class |
@@ -72,14 +63,10 @@
| [M5Camera](/en/product_documents/units/unit_m5camera) | / | / |
| [NCIR](/en/product_documents/units/unit_ncir) | / | / |
## Applications
<img src='assets/img/product_pics/4.jpg'> <img src='assets/img/product_pics/application.png'>
- [BALA](/en/product_documents/applications/application_bala)
## Tools
<img src='assets/img/product_pics/6.jpg'> <img src='assets/img/product_pics/tool.png'>
- [M5Stack USB Downloader](/en/product_documents/tools/tool_usb_downloader)
docs/en/product_documents/applications/application_lidarbot.md
+78
View File
@@ -0,0 +1,78 @@
# LidarBot
## DESCRIPTION
<mark>LidarBot</mark> 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.
Real-time communication via ESP-NOW between the car and the remote control handle. After receiving the control signal, the car master controlls the wheels and RGB bars through the specified protocol format.
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
- Lidar: 8m @ 6Hz
- Programming Support
+ Arduino
- Compatible LEGO
## Protocol for CarBottomBoard
*Protocol Format：Data Header(command type) + Data Packet + Data Tail*
| Control Target | Protocol Format |
| :-------------: |:------------------------------------: |
| Wheels | 0xAA,SpeedX,SpeedY,SpeedZ,SpeedA,0x55 |
| One RGB | 0xAB,LedIndex,R,G,B,0x55 |
| Front RGB Bar | 0xAC,R,G,B,0x55 |
| Back RGB Bar | 0xAD,R,G,B,0x55 |
| All RGB | 0xAE,R,G,B,0x55 |
| ServoMotor0 | 0xAF,Angle,0x55 |
| ServoMotor1 | 0xB0,Angle,0x55 |
## PARAMETER
- Communication Parameter
- M5Core(CarMain) <-> Lidar(GPIO16 <-> Lidar)
Serial Configuration: "230400bps, 8, n, 1"(8 bits data, no parity, 1 stop bit)
- M5Core(CarMain) <-> CarBottomBoard(GPIO17 <-> Lidar)
Serial Configuration: "115200bps, 8, n, 1"(8 bits data, no parity, 1 stop bit)
- PinMap
- ServoMotor0 <-> A0(MEGA328)
- ServoMotor1 <-> A1(MEGA328)
- NeoPixelRGB <-> 11(MEGA328)
## PARAMETER
- 1x LidarBot
- 1x Remote Control Handle
- 2x Battery(1300mAh @ 11.1V)
- 1x Power Charger
- 1x Type-C USB Cable
## APPLICATIONS
- Indoor Navigation
- Autonomous walking maze
- Route plan
- Autopilot
## DOCUMENTS
- **Example** - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) - [MicroPython]()
- **[Quick Start](zh_CN/file_to_display_null)**
- **[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)**
<figure>
<img src="assets/img/product_pics/applications/lidarbot_1.jpg">
</figure>
<figure>
<img src="assets/img/product_pics/applications/lidarbot_2.jpg">
</figure>
<figure>
<img src="assets/img/product_pics/applications/lidarbot_3.jpg">
</figure>
<figure>
<img src="assets/img/product_pics/applications/lidarbot_4.jpg">
</figure>
docs/en/product_documents/m5stack-core/minicore_stick.md
+1 -1
View File
@@ -20,7 +20,7 @@ There are two version of it. One M5Stick does not contain MPU9250, another versi
| *BUTTON* | *ESP32* |
| :----------: |:------------: |
| Button_Pin | GPIO25 |
| Button_Pin | GPIO35 |
| *BUZZER* | *ESP32* |
| :----------: |:------------: |
docs/en/product_documents/modules/module_btc.md
+16
View File
@@ -21,3 +21,19 @@ Core via Type-C Cable after adding this BTC Module.
# DOCUMENTS
- [WebSite](https://m5stack.com)
<figure>
<img src="assets/img/product_pics/modules/btc_01.png" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/btc_02.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/btc_03.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/btc_04.jpg" height="300" width="300">
</figure>
docs/en/product_documents/modules/module_gps.md
+15 -7
View File
@@ -30,14 +30,22 @@ global positioning information even you in the wild and get lost.
## DOCUMENTS
- [WebSite](https://m5stack.com)
- **Example** - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS)
- Example
- [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GPS)
- **[GPS Info](https://www.u-blox.com/zh/product/neo-m8-series)** (GPS)
- [GPS Info](https://www.u-blox.com/zh/product/neo-m8-series) (GPS)
- **GitHub** - [Arduino GitHub](https://github.com/m5stack/M5Stack)
- 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)**
- [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)
<figure>
<img src="assets/img/product_pics/modules/gps_01.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/gps_02.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/gps_03.jpg" height="300" width="300">
</figure>
docs/en/product_documents/modules/module_lora.md
+12
View File
@@ -48,3 +48,15 @@ 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.
<figure>
<img src="assets/img/product_pics/modules/lora_01.png" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/lora_02.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/lora_03.jpg" height="300" width="300">
</figure>
docs/en/product_documents/modules/module_lorawan.md
+3 -3
View File
@@ -1,4 +1,4 @@
# LoRaWAN
# LoRaWAN
## DESCRIPTION
@@ -30,8 +30,8 @@ By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 st
| *RHF76-052_UART* | *ESP32 Chip* |
| :----------: |:------------: |
| RXD | GPIO16 |
| TXD | GPIO17 |
| RXD | GPIO17 |
| TXD | GPIO16 |
## DOCUMENTS
docs/en/product_documents/modules/module_plus.md
+1 -2
View File
@@ -17,8 +17,7 @@ THis a enhanced module including battery(500mAh), gear potentiometer, IR transmi
## DOCUMENTS
- [WebSite](https://m5stack.com)
- [Example]()
- [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)
docs/en/product_documents/modules/module_proto.md
+12
View File
@@ -49,3 +49,15 @@ like.
- [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)
<figure>
<img src="assets/img/product_pics/modules/proto_01.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/proto_02.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/proto_03.jpg" height="300" width="300">
</figure>
docs/en/product_documents/modules/module_servo.md
+1 -3
View File
@@ -29,9 +29,7 @@ Servo is communicated with M5Core through GROVE interface(I2C communication). Th
- **[Schematic](en/file_to_display_null)**
- **GitHub** - [Arduino GitHub](en/file_to_display_null)
- **Example** - [Arduino Example](en/file_to_display_null)
- **[Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Servo)**
- **[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)**
docs/en/product_documents/modules/module_stepmotor.md
+5 -5
View File
@@ -28,21 +28,21 @@ This is a <mark>StepMotor Driver Module</mark> built in MEGA328P MCU which has b
- **[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)**
<figure>
<img src="assets/img/product_pics/modules/stepmotor_01.png" height="300" width="300">
<img src="assets/img/product_pics/modules/stepmotor_01.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/stepmotor_02.png" height="300" width="300">
<img src="assets/img/product_pics/modules/stepmotor_02.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/stepmotor_03.png" height="300" width="300">
<img src="assets/img/product_pics/modules/stepmotor_03.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/stepmotor_04.png" height="300" width="300">
<img src="assets/img/product_pics/modules/stepmotor_04.jpg" height="300" width="300">
</figure>
<figure>
<img src="assets/img/product_pics/modules/stepmotor_05.png" height="300" width="300">
<img src="assets/img/product_pics/modules/stepmotor_05.jpg" height="300" width="300">
</figure>
docs/en/product_documents/units/unit_adc.md
+3 -7
View File
@@ -20,15 +20,11 @@ This is a unit having self-calibrating function and 16bit analog-to-digitial cov
## DOCUMENTS
- GitHub
- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ADC_ADS1100)
- [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ADC_ADS1100)
- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html)
- 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)
- **[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)**
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_adc.png" height="300" width="300">
docs/en/product_documents/units/unit_angle.md
+2 -2
View File
@@ -11,8 +11,8 @@ angle.
## DOCUMENTS
- [GitHub](https://github.com/m5stack/M5GO)
- [Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti)
- **[Example](en/file_to_display_null)**
- **[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)**
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_angle.png">
docs/en/product_documents/units/unit_button.md
+2 -2
View File
@@ -11,8 +11,8 @@ The Unit BUTTON is a sigle-button unit that can be detected whether the button p
## DOCUMENTS
- [GitHub](en/file_to_display_null)
- [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)
- **[Example](en/file_to_display_null)**
- **[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)**
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_button.png">
docs/en/product_documents/units/unit_color_sensor.md
+1 -1
View File
@@ -17,7 +17,7 @@ This is a unit can detecte the color of object surface which integrates TCS3472
## DOCUMENTS
- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color)
- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color)
- **Datasheet** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html)
docs/en/product_documents/units/unit_dac.md
+1 -1
View File
@@ -17,7 +17,7 @@ This is a unit can convert digital signal to analog signal like voltage waveform
## DOCUMENTS
- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/DAC_MCP4725)
- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/DAC_MCP4725)
- **Datasheet** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html)
docs/en/product_documents/units/unit_dual_button.md
+1 -1
View File
@@ -11,7 +11,7 @@ This Unit is a dual-button unit that can be detected whether a single button pre
## DOCUMENTS
- **[GitHub](en/file_to_display_null)**
- **[Example](en/file_to_display_null)**
- **[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)**
<figure>
docs/en/product_documents/units/unit_env.md
+2 -1
View File
@@ -21,7 +21,8 @@ temperature and humidity sensor and absolute barometric pressure sensor.
## DOCUMENTS
- **[Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti)**
- **[Example](en/file_to_display_null)**
- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-ENV-Unit-with-DHT12-BMP280-Digital-DHT-12-Temperature-Humidity-Aire-Pressure-Sensor/3226069_32933115893.html?spm=a2g1y.12024536.productList_5885013.subject_22)**
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_env.png">

Some files were not shown because too many files have changed in this diff Show More