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 'master' of https://github.com/m5stack/m5-docs

Browse Source
This commit is contained in:
LottesLiu
2019-06-13 19:04:12 +08:00
parent 7bbc5b5fb8 7b744df6f9
commit 2f89f1810f
108 changed files with 926 additions and 593 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/product_pics/module/module_plus_01.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 466 KiB

After

Width:  |  Height:  |  Size: 447 KiB

docs/assets/js/main.js
+1 -1
View File
@@ -118,4 +118,4 @@
// Main
// =========================================================================
initStyleSwitcher();
})();
})();
docs/en/app/Demo-Board.md → docs/en/app/demo-board.md
View File
docs/en/base/PM2.5.md → docs/en/base/pm2.5.md
View File
docs/en/faq.md
+142 -2
View File
@@ -1,5 +1,144 @@
# FAQ {docsify-ignore-all}
**[M5CORE](#M5CORE-Question)**      **[UNIT](#UNIT-Question)**
## M5CORE Question
- **Q1: What's the difference between those Cores?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q1">answer</button>
<div id="Q1" class="collapse">
The main difference between these Cores is the internal hardware configuration and kit matching. From the basic version to the upgraded version, the attitude sensor MPU9250 is added and the RAM and FLASH are increased. For details, please visit <a href="https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores_en.md">here</a>
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_table/core_comparison/core_main_comparison_04_en.png">
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_table/core_comparison/core_main_comparison_05_en.png">
</div>
</div>
- **Q2: How to turn off the speaker function of M5Core？**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q2">answer</button>
<div id="Q2" class="collapse">
Add the following statement to functioin Setup( ){ }
```arduino
dacWrite(M5STACKFIRE_SPEAKER_PIN, 0);
```
</div>
</div>
- **Q3: Some modules cannot be downloaded after stacking with M5Core, such as USB module and M5Core stacking.**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q3">answer</button>
<div id="Q3" class="collapse">
Probably after the stack, the pins GPIO0 and M5Core on the M5-Bus bus are not very well connected.
In this case, when downloading the program, GPIO0 should always remain low, but because the contact is not good, GPIO0 can not remain low all the time, so the download fails.
Solution: Manually let GPIO0 connect to GND during the download process to ensure that it is pulled low enough。
</div>
</div>
- **Q4: After the [M5GO bottom](en/base/m5go_bottom) is stacked with the M5Core, the M5Core cannot be turned on, but the base battery in this M5GO bottom is fully charged.**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q4">answer</button>
<div id="Q4" class="collapse">
It may be that after the stacking, the BATTERY of the lower left corner of the M5-Bus bus on the base is not well connected to the M5Core. This is
caused by the deviation of the welding position during production. After **the bus pin welding position is slightly biased**, it is easy to see that the BATTERY pin is not in good contact with the M5Core.
Solution: Re-soldering the M5-Bus bus header, the pin header must be strictly aligned with the pad position.
</div>
</div>
- **Q5: Some computers are connected to the main control, but still can't use Arduino IDE, ESPFlashDownloadTool or M5Burner to burn the program. For example, the following figure using Arduino IDE.**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q5">answer</button>
<div id="Q5" class="collapse">
<img src="assets/img/faq/faq_03.png">
Solution: you need to connect the capacitor between RST pin and GND pin in your Core (Capacitance value is more than 0.1 uF) or connect GPIO 0 with GND when downloading your firmware so that GPIO 0 keeps low level for an enough time as the third following picture shows.
<img src="assets/img/faq/faq_05.png" width="80%" height="80%">
<img src="assets/img/faq/faq_06.png" width="80%" height="80%">
<img src="assets/img/faq/faq_07.png" width="100%" height="100%">
</div>
</div>
- **Q6: What special GPIO pins do you need to pay attention to in ESP32?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q6">answer</button>
<div id="Q6" class="collapse">
The ESP32 has 34 GPIO pins, of which GPIO 34-39 is only used as an input and cannot be used as an output. Others can be used as both an input and an output pin.
</div>
</div>
- **Q7: Why does the Stick with MPU9250 burn the factory firmware and press button A, the result shows "No", which means "No 9250"?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q7">answer</button>
<div id="Q7" class="collapse">
Restart this Stick and then it can display correctly. Because the code to read the MPU9250 is placed in the setup() function which only was executed once when booting. So reboot and let the Stick detect MPU9250 again.
</div>
</div>
- **Q8: After getting the FACES Kit or downloading the factory program of the FACES Kit, the following error is displayed on the screen. What happened?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#Q8">answer</button>
<div id="Q8" class="collapse">
<img src="assets/img/faq/faq_08_01.png" width="100%" height="100%">
This is normal, because there is no main.py file in the program, so this warning is available.
</div>
</div>
## UNIT Question
- **Q1: What is the difference between the various cameras of M5Stack?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#U-Q1">answer</button>
<div id="U-Q1" class="collapse">
The main difference between these cameras is that some pins (OV2640-SIOD, OV2640-VSYNC, GROVE interface), lens type, and whether or not there is PSRAM. For specific differences, please visit<a href="https://shimo.im/sheets/gP96C8YTdyjGgKQC/e2041">here</a>
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_table/camera_comparison/camera_comparison_zh_CN.png">
</div>
</div>
- **Q2: The camera transmits images to the mobile phone via WIFI, how far can it be transmitted?**
<div class="container">
<button type="button" class="btn btn-primary" data-toggle="collapse" data-target="#U-Q2">answer</button>
<div id="U-Q2" class="collapse">
After testing, using M5Camera indoors can transmit about 20 meters.
</div>
</div>
<!--
-----------------------------------------------------------------------------------------
# FAQ {docsify-ignore-all}
**[CORE](#CORE-Question)**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**[UNIT](#UNIT-Question)**
## CORE Question
@@ -73,6 +212,7 @@
After testing, using M5Camera indoors can transmit about 20 meters.
<!-- - **Q2: ESP32 有哪些特殊的 GPIO 管脚需要注意？**
ESP32 有 34 个 GPIO 管脚，其中 GPIO 34-39 仅用作输入，不能作为输出，其他的既可以作为输入又可以作为输出管脚。 -->
-->
docs/en/hat/ENV.md → docs/en/hat/hat-env.md
View File
docs/en/hat/PIR.md → docs/en/hat/hat-pir.md
View File
docs/en/hat/SPK.md → docs/en/hat/hat-spk.md
View File
docs/en/module/commu.md
+4 -5
View File
@@ -54,18 +54,17 @@ Be care about TTL Interface. It is a UART Interface actually by default. But you
- [SP3485](https://www.exar.com/ds/sp3485.pdf)
- [MCP2515](https://www.mouser.com/datasheet/2/268/20001801H-708845.pdf)
## Example
### Mini Burner
## EasyLoader
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_COMMU_Test_B.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/encoder.md
+4 -5
View File
@@ -79,17 +79,16 @@ void get_encoder_increment(void){
- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/ENCODER/firmware_328p/FacesEncoder328)**
## Example
## EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_faces_encoder.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/FAN.md → docs/en/module/fan.md
View File
docs/en/module/gps.md
+6 -5
View File
@@ -65,16 +65,17 @@ If you want to Change the uart baudrate,please check here ( [u-center-just-for-W
- **[u-blox Protocol Manual](https://www.u-blox.com/sites/default/files/products/documents/u-blox8-M8_ReceiverDescrProtSpec_%28UBX-13003221%29_Public.pdf)**
## Example
### EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_GPSRaw.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/joystick.md
+5 -5
View File
@@ -71,16 +71,16 @@ void get_joystick_offset(void){
- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/JOYSTICK/firmware_328p/FacesJoystick328)**
## Example
## EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_Faces_Joystick.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/lego_plus.md
+5 -4
View File
@@ -36,18 +36,19 @@ LEGO motor is one of the Technic pieces form LEGO. The purpose of LEGO Technic i
- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/LEGO_PLUS/firmware_328p)**
## Example
<!-- ### 1. Arduino IDE -->
### Mini Burner
## EasyLoader
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_LEGO_Test.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### UIFlow
docs/en/module/lora.md
+5 -5
View File
@@ -54,16 +54,16 @@ LoRa and LoRaWAN permit long-range connectivity for Internet of Things (IoT) dev
m5.begin();
``` -->
## Example
## EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_LoRaReceiverCallback.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/lorawan.md
+5 -5
View File
@@ -88,16 +88,16 @@ By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 st
- **[LoRaWAN Regional Parameters](https://lora-alliance.org/sites/default/files/2018-04/lorawantm_regional_parameters_v1.1rb_-_final.pdf)**
## Example
## EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_LoRaWAN_Transmmiter.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/plus.md
+4 -5
View File
@@ -31,17 +31,16 @@ Communication Protocol: IIC (0x62).
- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/PLUS/firmware_328p)**
## Example
### EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_Plus.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### Arduino IDE
docs/en/module/servo.md
+4 -5
View File
@@ -37,17 +37,16 @@ Servo is powered by MEGA328 communicate via IIC(0x53).
- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO/firmware_328p)**
## Example
### EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_Servo.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
### 1. Arduino IDE
docs/en/module/sim800.md
+3 -3
View File
@@ -59,14 +59,14 @@ Series Protocol: UART
- **[Forum](http://forum.m5stack.com/)**
### Mini Burner
## EasyLoader
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_SIM800L_Send_Message.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
<!-- - **[SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138)**
docs/en/module/usb.md
+5 -5
View File
@@ -36,18 +36,18 @@ Series Protocol: SPI
- **Datasheet** - [MAX3421E](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf)
## Example
## EasyLoader
### Mini Burner
>1.Mini Burner is a simple and fast program burner, and each product page has a product-related case program for Mini Burner.
>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.
[Click here to download](https://m5stack.oss-cn-shenzhen.aliyuncs.com/MiniBurner/Module/MiniBurner_USB_Mouse.exe)
>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning.
!>3.The CP210X (USB driver) needs to be installed before the Mini Burner is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
!>3.The CP210X (USB driver) needs to be installed before the EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/establish_serial_connection)
## Example
*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/USB/Arduino).*
**NOTE:**

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