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

add product search tag

Browse Source
This commit is contained in:
Gitshaoxiang
2020-05-07 14:27:35 +08:00
parent 883822f231 7d4a962534
commit 2b4c9d5e95
40 changed files with 604 additions and 286 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/app/m5scale_diy_kit.md
+1 -1
View File
@@ -64,7 +64,7 @@ The lego holes on bottom board allow you to place more M5 sensors for extension
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/EasyLoader_logo.webp" width="100px" style="margin-top:20px">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Application/M5SCALE_DIY_KIT/EasyLoader_APP_M5Scale_diy_kit.exe"><button type="button" class="btn btn-primary">click to download EasyLoader</button></a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/APPLICATION/EasyLoader_M5SCALE_APPLICATION.exe"><button type="button" class="btn btn-primary">click to download EasyLoader</button></a>
>1.EasyLoader is a simple and fast program burner. Every product page in EasyLoader provides a product-related case program. It can be burned to the master through simple steps, and a series of function verification can be performed. .
docs/en/base/lan_base.md
+1 -1
View File
@@ -6,7 +6,7 @@
## Description
Although M5 core is ESP32-based, having Wi-Fi and Bluetooth intergrated, it doesn't stop you enable the Ethernet function. This **LAN** is a M5 Base that having a W5500 chip, which is a Hardwired TCP/IP embedded Ethernet controller that provides easier Internet connection to embedded systems. This Base is speciffically design for industrial application scenarioes, comes with couple of HT3.96 connectors, 485(?) metal rail and magnet discs for easy installation and fixation.The 6 pin of HT3.96 connector are dangling, you can wired them up with the M-BUS and other circuit as you like.
Although M5 core is ESP32-based, having Wi-Fi and Bluetooth intergrated, it doesn't stop you enable the Ethernet function. This **LAN** is a M5 Base that having a W5500 chip, which is a Hardwired TCP/IP embedded Ethernet controller that provides easier Internet connection to embedded systems. This Base is speciffically design for industrial application scenarioes, comes with couple of HT3.96 connectors, 485 metal rail and magnet discs for easy installation and fixation.The 6 pin of HT3.96 connector are dangling, you can wired them up with the M-BUS and other circuit as you like.
**The figure below shows the inner of LAN**
docs/en/core/m5stickc.md
+1 -1
View File
@@ -309,7 +309,7 @@ For a tutorial on uiflow, see [here](https://docs.m5stack.com/#/en/uiflow/uiflow
<script>
var purchase_link = 'https://m5stack.com/collections/m5-core/products/basic-core-iot-development-kit';
var purchase_link = 'https://m5stack.com/collections/m5-core/products/stick-c';
var quickstart_link = 'https://docs.m5stack.com/#/en/quick_start/m5stickc/m5stickc_quick_start';
docs/en/core/m5stickc_plus.md
View File
docs/en/hat/hat-adc.md
+8 -6
View File
@@ -39,6 +39,14 @@ ADS1100 itself is able to accept a differential input from -5 ~ +5 V, but we hav
- **Datasheet** - [ADS1100](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/ads1100_en.pdf)
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets/img/product_pics/hat/adc_hat/adc_hat_04.webp" width="80%" height="80%">
@@ -65,12 +73,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets/img/product_pics/hat/adc_hat/adc.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
<script>
docs/en/hat/hat-dac.md
+8 -8
View File
@@ -45,7 +45,14 @@ I2C address: 0x60
## Links
- **Datasheet** - [MCP4725](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/MCP4725_en.pdf)
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets/img/product_pics/hat/dac_hat/dac_hat_04.webp" width="80%" height="80%">
@@ -72,13 +79,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets/img/product_pics/hat/dac_hat/dac.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-dac-hat-mcp4725';
docs/en/hat/hat-env.md
+7 -7
View File
@@ -48,6 +48,13 @@
- **[BMM150 Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BMM150_datasheet_en.pdf)**
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>HAT ENV</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
## EasyLoader
>EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver)
@@ -87,13 +94,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets/img/product_pics/hat/env_hat/env.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ENV</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat';
docs/en/hat/hat-joystick.md
+7 -7
View File
@@ -61,6 +61,13 @@ Register:
> Joystick calibration method：First i2c writes register 0x03 and then sends 0x02, the joystick is rotated several times around the top, bottom, left and right, and then 0x03 is saved in register 0x03.
## Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>Joystick HAT</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\joystick_hat\joystick_hat_07.webp" width="60%">
@@ -85,13 +92,6 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
<img src="assets\img\product_pics\hat\joystick_hat\joystick.webp" width="60%">
## Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>Joystick HAT</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/products/m5stickc-joystick-hat';
docs/en/hat/hat-ncir.md
+7 -7
View File
@@ -32,6 +32,13 @@ Connect with M5StickC via GOIO 0/26 (I2C add: 0x5A).<br>
- Body Temperature Measurement
- Object (biological) Motion Detection
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>HAT NCIR</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\ncir_hat\hat_ncir_04.webp" width="50%" height="50%">
@@ -62,13 +69,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets\img\product_pics\hat\ncir_hat\ncir.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT NCIR</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-ncir-hatmlx90614';
docs/en/hat/hat-neoflash.md
+7 -7
View File
@@ -41,6 +41,13 @@ If you thinking about adding a display on your project, NeoFlash is a good choic
<img src="assets\img\product_pics\hat\neoflash_hat\neoflash_hat_06.webp" height="300px"><img src="assets\img\product_pics\hat\neoflash_hat\neoflash_hat_07.webp" height="300px">
## Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>Neoflash HAT</td><td>DATA</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\neoflash_hat\neoflash_hat_08.webp" width="30%">
@@ -61,13 +68,6 @@ If you thinking about adding a display on your project, NeoFlash is a good choic
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/neoflash-hat/Arduino)
## Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>Neoflash HAT</td><td>DATA</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/products/m5stickc-neofalsh-hat';
docs/en/hat/hat-pir.md
+7 -6
View File
@@ -32,6 +32,13 @@
<img src="assets\img\product_pics\hat\pir_hat\pir_hat_04.webp" width="50%" height="50%">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO36</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT PIR</td><td>OUT</td><td>5V</td><td>GND</td></tr>
</table>
## EasyLoader
>EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver)
@@ -71,12 +78,6 @@ Open http://flow.m5stack.com and click Demo to load
<img src="assets\img\product_pics\hat\pir_hat\pir.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO36</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT PIR</td><td>OUT</td><td>5V</td><td>GND</td></tr>
</table>
<!--
## Video
**Demo**
docs/en/hat/hat-powerc.md
+9 -9
View File
@@ -37,6 +37,15 @@
- **[IP5209 Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/IP5209.pdf)**
- **[IP3005 Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/IP3005-INJOINIC.pdf)**
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>PowerC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
<tr><td>PortA</td><td>YELLO</td><td>WHITE</td><td>RED</td><td>BLACK</td></tr>
</table>
## Example
### 1. Arduino
@@ -76,15 +85,6 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
</div>
</div>
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>PowerC</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
<tr><td>PortA</td><td>YELLO</td><td>WHITE</td><td>RED</td><td>BLACK</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-powerc';
docs/en/hat/hat-rs485.md
+8 -8
View File
@@ -38,7 +38,14 @@ It is used to convert the TTL standard to the RS485 standard. If the outside ser
## Links
- **Datasheet** - [SP485EEN](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/SP485EEN_en.pdf)
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>TX</td><td>RX</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets/img/product_pics/hat/rs485_hat/rs485_hat_04.webp" width="80%" height="80%">
@@ -62,13 +69,6 @@ It is used to convert the TTL standard to the RS485 standard. If the outside ser
To get complete code, please click [here](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/RS485)
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT ADC</td><td>TX</td><td>RX</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-rs485-hat-aoz1282ci';
docs/en/hat/hat-spk.md
+7 -7
View File
@@ -24,6 +24,13 @@
- MP4/MP3
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT SPK</td><td>SD</td><td>IN-</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Hat/StickHat_SPK.pdf)**
@@ -73,13 +80,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets\img\product_pics\hat\spk_hat\spk.webp" >
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT SPK</td><td>SD</td><td>IN-</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-speaker-hat';
docs/en/hat/hat-thermal.md
+7 -7
View File
@@ -40,6 +40,13 @@ The I2C address is **0x33**. (GOIO 0/26)
- Intrusion / Movement detection
- Visual IR thermometers
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT THERMAL</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\thermal_hat\hat_thermal_05.webp" width="60%" height="60%">
@@ -70,13 +77,6 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
<img src="assets/img/product_pics/hat/thermal_hat/thermal.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>5V</td><td>GND</td></tr>
<tr><td>HAT THERMAL</td><td>SDA</td><td>SCL</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-unit/products/m5stickc-thermal-camera-hatmlx90640';
docs/en/hat/hat-tof.md
+7 -7
View File
@@ -39,6 +39,13 @@ Communication Info: I2C, **0x29**, GPIO0/26.
- **[VL53L0X Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/hat/VL53L0X_en.pdf)**
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>ToF HAT</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\tof_hat\tof_hat_07.webp" width="50%">
@@ -63,13 +70,6 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
<img src="assets\img\product_pics\hat\tof_hat\tof.webp" width="50%">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GPIO0</td><td>GPIO26</td><td>3.3V</td><td>GND</td></tr>
<tr><td>ToF HAT</td><td>SDA</td><td>SCL</td><td>3.3V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/products/m5stickc-tof-hatvl53l0x';
docs/en/hat/hat-yun.md
+7 -7
View File
@@ -45,6 +45,13 @@ One hook hole and two 6*4mm magnet mounting positions are reserved on the board,
- Smart home decoration
- Fridge Magnet
### Pin Map
<table>
<tr><td>M5StickC</td><td>GND</td><td>5V OUT</td><td>GPIO26</td><td>GPIO0</td><td>GPIO36</td><td>BAT</td><td>3V3</td><td>5V IN</td></tr>
<tr><td>YUN HAT</td><td>GND</td><td>+5V</td><td>SCL</td><td>SDA</td><td>/</td><td>BAT</td><td>+3.3V</td><td>+5V IN</td></tr>
</table>
## Schematic
<img src="assets\img\product_pics\hat\yun_hat\yun_hat_05.webp" width="50%">
@@ -78,13 +85,6 @@ Open http://flow.m5stack.com and Load Demo
<img src="assets/img/product_pics/hat/yun_hat/yun.webp">
### Pin Map
<table>
<tr><td>M5StickC</td><td>GND</td><td>5V OUT</td><td>GPIO26</td><td>GPIO0</td><td>GPIO36</td><td>BAT</td><td>3V3</td><td>5V IN</td></tr>
<tr><td>YUN HAT</td><td>GND</td><td>+5V</td><td>SCL</td><td>SDA</td><td>/</td><td>BAT</td><td>+3.3V</td><td>+5V IN</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/products/m5stickc-yun-hatsh20-bmp280-sk6812';
docs/en/module/gsm.md
+8 -7
View File
@@ -68,6 +68,14 @@ Product Feature:
- **Datasheet** - [MC6315 AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/M6315%20AT_Command_Interface_Specification_cn.pdf)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>5V</td><td>GND</td></tr>
<tr><td>Module GSM</td><td>RX</td><td>TX</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
- [GSM Module](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_gsm_sch.pdf)
@@ -91,13 +99,6 @@ Product Feature:
To get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GSM_M6315)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>5V</td><td>GND</td></tr>
<tr><td>Module GSM</td><td>RX</td><td>TX</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/m5stack-gsm-module';
docs/en/module/lte.md
+7 -8
View File
@@ -69,6 +69,13 @@ Product Feature:
- **Datasheet** - [M8321 AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/M8321%20AT_Command_Interface_Specification_cn.pdf)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>5V</td><td>GND</td></tr>
<tr><td>Module LTE</td><td>RX</td><td>TX</td><td>5V</td><td>GND</td></tr>
</table>
## Schematic
- [LTE Module](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_lte_sch.pdf)
@@ -91,14 +98,6 @@ Product Feature:
To get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/LTE_M8321)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>5V</td><td>GND</td></tr>
<tr><td>Module LTE</td><td>RX</td><td>TX</td><td>5V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/m5stack-lte-module';
docs/en/module/nb-iot.md
+8 -7
View File
@@ -100,6 +100,14 @@ only for reference
- **AT Command**
- [M5311 AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/M5311_AT_Command_Interface_Specification_en.pdf)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>3.3V</td><td>GND</td></tr>
<tr><td>Module NB-IoT</td><td>RX</td><td>TX</td><td>3.3V</td><td>GND</td></tr>
</table>
## Schematic
- [NB-IoT Module](https://github.com/m5stack/M5-Schematic/blob/master/Modules/module_nb_iot_sch.pdf)
@@ -122,13 +130,6 @@ only for reference
To get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/NB-IoT_M5311LV)
### Pin Map
<table>
<tr><td>M5Stack</td><td>GPIO16</td><td>GPIO17</td><td>3.3V</td><td>GND</td></tr>
<tr><td>Module NB-IoT</td><td>RX</td><td>TX</td><td>3.3V</td><td>GND</td></tr>
</table>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/m5stack-nb-iot-module';

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