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

Browse Source
This commit is contained in:
ali-admin
2021-03-08 12:33:15 +08:00
parent 3f3e44e1da dc3854120e
commit d60079ac7d
38 changed files with 430 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/css/main-min.css
Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/assets/css/main.css
+1
View File
@@ -58,6 +58,7 @@ img {
#pc_anchor .el-menu .el-menu-item-group__title {
background-color: #ececee;
display: none;
}
#pc_anchor .el-menu .el-menu-item span,.el-submenu__title span {
docs/assets/img/product_pics/atom_base/atom_socket/atom_socket_01.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 84 KiB

docs/assets/img/product_pics/atom_base/atom_socket/atom_socket_02.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

docs/assets/img/product_pics/atom_base/atom_socket/atom_socket_03.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

docs/assets/img/product_pics/module/com_lorawan470/com.lorawan470_01.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

docs/assets/img/product_pics/module/com_lorawan470/com.lorawan470_02.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 73 KiB

docs/assets/img/product_pics/module/com_lorawan470/com.lorawan470_03.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 58 KiB

docs/assets/img/product_pics/module/com_lorawan470/com.lorawan470_04.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

docs/assets/img/product_pics/module/com_lorawan915/com.lorawan915_03.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

docs/assets/img/product_pics/module/com_lorawan915/com.lorawan915_04.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

docs/en/api/gpio.md
+1 -3
View File
@@ -2,8 +2,6 @@
*Refer to Arduino API of [Arduino](http://www.arduino.cc)*
*For the sake of convenience, I will focus on things that are closely related to M5Stack*
*M5STACK PIN allocation:*
| pin No | Name |allocation|
@@ -92,7 +90,7 @@ Writes the state of the terminal.
| Function argument |Type |Description |
| --- | --- | --- |
| pin | <code>uint8</code> |pin No |
| val | <code>uint8</code> |出力状態(0/1) |
| val | <code>uint8</code> |(0/1) |
**Function return value:**
docs/en/atom/atom_socket.md
+23 -31
View File
@@ -1,36 +1,36 @@
# ATOM Socket
# ATOM Socket Kit (HLW8023) - JP&US
<el-tag effect="plain">SKU:K052</el-tag>
<el-tag effect="plain">SKU:K055</el-tag>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atom_socket/atom_socket_01.webp"><img src="assets/img/product_pics/atom_base/atom_socket/atom_socket_02.webp"></ div>
<div class="product_pic"><img src="assets/img/product_pics/atom_base/atom_socket/atom_socket_01.webp"><img src="assets/img/product_pics/atom_base/atom_socket/atom_socket_02.webp"><img src="assets/img/product_pics/atom_base/atom_socket/atom_socket_03.webp"></div>
## Description
**ATOM Socket** is a smart power socket adapted to ATOM main control. Built-in HLW8032 high-precision energy metering IC, can read the electrical parameters (line voltage, current, active power, apparent power and power factor) of the socket through serial communication. The external jack adopts Japanese standard specifications, and the internal integrated single-circuit relay (AC-220V@10A) is used to control the power on and off of the socket. With the ATOM main control integrated with WIFI&Bluetooth module, the power socket can be easily connected to the network for remote control And energy metering. The extra socket integrates HY2.0-4P interface, which can interact with external equipment (relay signal input, key signal output).
**ATOM Socket** is a smart power socket adapted to ATOM main control. Built-in HLW8032 high-precision energy metering IC, can read the electrical parameters (line voltage, current, active power, apparent power and power factor) of the socket through serial communication. The external jack adopts Japanese standard specifications, and the internal integrated single-circuit relay (AC-100~120V@10A) is used to control the power on and off of the socket. With the ATOM main control integrated with WIFI&Bluetooth module, the power socket can be easily connected to the network for remote control And energy metering. The extra socket integrates HY2.0-4P interface, which can interact with external equipment (relay signal input, key signal output).
## Product Features
-Single relay control socket power on and off (220V@10A)
-HLW8032 High Precision Energy Metering IC
-Support voltage and current detection power calculation, within 1000:1 dynamic range:
-The measurement error of active power reaches 0.2%
-The effective current measurement error reaches 0.5%
-The effective voltage measurement error reaches 0.5%
-UART communication (baud: 4800)
-∑-Δ ADC, high-precision energy metering core
-Japanese standard jack
-HY2.0-4P external control interface
- Single relay control socket power on and off (100~120V@10A)
- HLW8032 High Precision Energy Metering IC
- Support voltage and current detection power calculation, within 1000:1 dynamic range:
- The measurement error of active power reaches 0.2%
- The effective current measurement error reaches 0.5%
- The effective voltage measurement error reaches 0.5%
- UART communication (baud: 4800)
- ∑-Δ ADC, high-precision energy metering core
- JP&US standard jack
- HY2.0-4P external control interface
## Includes
-1x ATOM Socket
-1x ATOM LITE
- 1x ATOM Socket
- 1x ATOM LITE
## Application
-Metering socket
-Smart WIFI socket
-Smart home appliance control
- Metering socket
- Smart WIFI socket
- Smart home appliance control
## Specification
@@ -49,7 +49,7 @@
</tr>
<tr>
<td>Relay parameters</td>
<td>AC-110V@10A</td>
<td>AC-100~120V@10A</td>
</tr>
<tr>
<td>Net weight</td>
@@ -69,14 +69,6 @@
</tr>
</table>
>Comparison of products of the same type in M5 system
<table>
<tr><td>Product</td><td>Jack standard</td><td>Power measurement solution</td><td>Compatible equipment</td><td>Communication method</td>< /tr>
<tr><td>AC Socket</td><td>China Standard</td><td>None</td><td>CORE</td><td>RS485</td></tr>
<tr><td>ATOM Socket</td><td>Japanese standard</td><td>HLW8032 energy measurement IC (serial communication)</td><td>ATOM</td><td>IO control relay /UART read energy information</td></tr>
</table>
## EasyLoader
>EasyLoader is a simple and fast program burner, which has a built-in product-related case program, which can be burned to the main control through simple steps to perform a series of functional verification.
@@ -94,7 +86,7 @@
</video>
<div class="easyloader-mask">
<a>
<svg id="play-btn" t="1583228776634" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p -id="4152" width="75" height="75"><path d="M512 0C229.216 0 0 229.216 0 512s229.216 512 512 512 512-229.216 512-512S794.784 0 512 0z m0 928C282. 24 928 96 741.76 96 512S282.24 96 512 96s416 186.24 416 416-186.24 416-416 416zM384 288l384 224-384 224z" p-id="4153" fill="#007aff"></path></svg></path></svg></ a>
<svg id="play-btn" t="1583228776634" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p -id="4152" width="75" height="75"><path d="M512 0C229.216 0 0 229.216 0 512s229.216 512 512 512 512-229.216 512-512S794.784 0 512 0z m0 928C282. 24 928 96 741.76 96 512S282.24 96 512 96s416 186.24 416 416-186.24 416-416 416zM384 288l384 224-384 224z" p-id="4153" fill="#007aff"></path></svg></path></svg></a>
<p>Case description:</p>
<p>Remotely control the ATOM Socket on and off the power supply, and monitor the power status</p>
</div>
@@ -121,11 +113,11 @@
## Example
-[Arduino code example](https://github.com/m5stack/M5Atom/tree/master/examples/ATOM_BASE/ATOM_Socket)
- [Arduino code example](https://github.com/m5stack/M5Atom/tree/master/examples/ATOM_BASE/ATOM_Socket)
<script>
var purchase_link ='https://m5stack.com/products/atom-motion-kit-with-motor-and-servo-driver-stm32f0';
var purchase_link ='https://m5stack.com/products/atom-socket-kit-hlw8023-jp-us';
anchor_search();
scrollFunc();
docs/en/hat/hat-bugc.md
+2 -2
View File
@@ -96,7 +96,7 @@ The Bugc base needs to be used in conjunction with the M5StickC controller. The
| FRONT_LEFT_reg[0] | R/W | FRONT_LEFT SPEED
| FRONT_RIGHT_reg[1] | R/W | FRONT_RIGHT SPEED
| REAR_LEFT_reg[2] | R/W | REAR_LEFT SPEED
| REAR_RIGHT_reg[2] | R/W | REAR_RIGHT SPEED
| REAR_RIGHT_reg[3] | R/W | REAR_RIGHT SPEED
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
@@ -109,7 +109,7 @@ The Bugc base needs to be used in conjunction with the M5StickC controller. The
| 1 FRONT_RIGHT RGB LED
| rgb_r_reg[1] | R/W | RED value
| rgb_g_reg[2] | R/W | Green value
| rgb_b_reg[2] | R/W | Blue value
| rgb_b_reg[3] | R/W | Blue value
/*----------------------------------------------------------------------------------------------------
```
docs/en/hat/hat-cardkb.md
+13
View File
@@ -88,6 +88,19 @@ The CardKB HAT also offers support for several button combinations (Shift+Key, F
<img src="assets\img\product_pics\app\mega328_isp.webp" width="30%" height="30%">
## Protocol
- Protocol type I2C
- I2C Address: **0x5F**
```clike
/*--------------------------------------------------------------------------------------------------*/
| KEYBOARD REG | 0x5F
| ------------------------------------------------------------------------------------------------
| keyboard_value_reg[0] | R | KEYBOARD VALUE
/*----------------------------------------------------------------------------------------------------
```
## Example
### 1. Arduino
docs/en/hat/hat-joyc.md
+79
View File
@@ -67,6 +67,85 @@
>2. After downloading the software, double-click to run the application, connect the M5 device to the computer through the data cable, select the port parameters,click **"Burn"** to start burning. (**For M5StickC burning, please Set the baud rate to 750000 or 115200**)
## Protocol
- Protocol type I2C
- I2C Address: **0x38**
```clike
/*--------------------------------------------------------------------------------------------------*/
| JOYC_COLOR_REG | 0x20
| ------------------------------------------------------------------------------------------------
| rgb_r_reg[0] | R/W | RED value
| rgb_g_reg[1] | R/W | Green value
| rgb_b_reg[2] | R/W | Blue value
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_LEFT_X_REG | 0x60
| ------------------------------------------------------------------------------------------------
| left_x_reg[0] | R | LEFT X VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_LEFT_Y_REG | 0x61
| ------------------------------------------------------------------------------------------------
| left_y_reg[0] | R | LEFT Y VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_RIGHT_X_REG | 0x62
| ------------------------------------------------------------------------------------------------
| right_x_reg[0] | R | RIGHT X VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_RIGHT_Y_REG | 0x63
| ------------------------------------------------------------------------------------------------
| right_y_reg[0] | R | RIGHT Y VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_PRESS_REG | 0x64
| ------------------------------------------------------------------------------------------------
| press_reg[0] | R | LEFT AND RIGHT PRESS VALUE
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
| R | R | R | R | R | R | LEFT | RIGHT |
| LEFT:
Pressed: 1
Released: 0
| RIGHT:
Pressed: 1
Released: 0
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_LEFT_ANGLE_REG | 0x70
| ------------------------------------------------------------------------------------------------
| left_angle_reg[0] | R | LEFT ANGLE VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_RIGHT_ANGLE_REG | 0x72
| ------------------------------------------------------------------------------------------------
| right_angle_reg[0] | R | RIGHT ANGLE VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_LEFT_DISTANCE_REG | 0x74
| ------------------------------------------------------------------------------------------------
| left_distance_reg[0] | R | LEFT DISTANCE VALUE
/*----------------------------------------------------------------------------------------------------
/*--------------------------------------------------------------------------------------------------*/
| JOYC_RIGHT_DISTANCE_REG | 0x76
| ------------------------------------------------------------------------------------------------
| right_distance_reg[0] | R | RIGHT DISTANCE VALUE
/*----------------------------------------------------------------------------------------------------
```
## Example
### 1.Arduino
docs/en/hat/hat_roverc_pro.md
+1 -1
View File
@@ -75,7 +75,7 @@ The PRO version provides a gripping mechanism controlled by a servo for gripping
<tr>
<td>Servo Gripper</td>
<td>x1</td>
<td>-//td>
<td>/</td>
</tr>
<tr>
<td>Servo Ext Port</td>
docs/en/module/comx_lorawan470.md
+105
View File
@@ -0,0 +1,105 @@
# COM.LoRaWAN470
<el-tag effect="plain">SKU:M031-C2</el-tag>
<div class="product_pic"><img src="assets/img/product_pics/module/com_lorawan470/com.lorawan470_01.webp"><img src="assets/img/product_pics/module/com_lorawan470/com.lorawan470_03.webp"><img src="assets/img/product_pics/module/com_lorawan470/com.lorawan470_04.webp"></div>
## Description
**COM.LoRaWAN470** is a LoRaWAN communication module suitable for 470MHz frequency launched by M5Stack. The module adopts the Ai-Thinker Ra-07 module solution, which supports long-distance communication and has both ultra-low power consumption and high sensitivity. The module integrates the LoRaWAN protocol stack and adopts a serial communication interface (using AT command set for control), and can be used as a collection node to access a large number of gateways for data collection and management.
An external power supply is provided (5V-12V input can be adjusted by switching the dial on-board switches). The module fits for long distance low power IoT communication applications, such as deployment of environmental monitoring nodes.
## Product Features
- Ai-Thinker Ra-07 module solution
- Operating frequency: 470MHz
- SMA antenna
- Communication interface: UART
- Command protocol: AT command
## Includes
- 1x LoRaWAN470 Module
- 1x SMA antenna
## Application
- Automatic remote meter reading
- Intelligent traffic intelligent parking lot
- Remote irrigation and environmental monitoring
## Major countries and regions supported by CN470
**China**
## Specification
<table>
<tr style="font-weight:bold">
<td>Specifications</td>
<td>Parameters</td>
</tr>
<tr>
<td>UART baud rate</td>
<td>115200</td>
</tr>
<tr>
<td>Net weight</td>
<td>35g</td>
</tr>
<tr>
<td>Gross weight</td>
<td>72g</td>
</tr>
<tr>
<td>Product size</td>
<td>54.2*54.2*13.2mm</td>
</tr>
<tr>
<td>Package size</td>
<td>165*60*36mm</td>
</tr>
</table>
## Pin mapping
<table>
<tr><td>CORE</td><td>RX</td><td>TX</td></tr>
<tr><td>SW DIP-6 dip switch</td><td>G17/G0/G13</td><td>G16/G5/G15</td></tr>
</table>
?>**M5Stack FIRE** GPIO 16/17 is connected to PSRAM by default. If the TXD/RXD of this module uses GPIO16, GPIO17 will conflict with it. Therefore, when using **M5Stack FIRE** to drive the module, you need to switch the DIP switch to any one of the remaining two sets of pins.
<img src="assets/img/product_pics/module/com_lorawan470/com.lorawan470_02.webp">
## Related Links
- [COM.LoRaWAN470 AT Command Set](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/COM.LoRaWAN.Ra-07.asr6501-asr6502-at-commands-introduction-v4.3.pdf)
- [LoRaWAN Regional Parameters](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/lorawantm_regional_parameters_v1.1rb_-_final.pdf)
## Schematic
- The module plugs into the base
<img src="assets/img/product_pics/module/com_lorawan/com.lorawan_sch.webp">
## Example
- [Arduino code example](https://github.com/m5stack/M5Atom/tree/master/examples/ATOM_BASE/ATOM_Socket)
## Video
<video class="video_size" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/Module/COM.LoRaWAN470.mp4" type="video/mp4">
</video>
<script>
var purchase_link ='https://item.taobao.com/item.htm?ft=t&id=639100397855';
anchor_search();
scrollFunc();
</script>
docs/en/module/comx_lorawan915.md
+10 -4
View File
@@ -1,8 +1,8 @@
# COM.LoRaWAN915
<el-tag effect="plain">SKU:M031-C</el-tag>
<el-tag effect="plain">SKU:M031-C3</el-tag>
<div class="product_pic"><img src="assets/img/product_pics/module/com_lorawan915/com.lorawan915_01.webp"></div>
<div class="product_pic"><img src="assets/img/product_pics/module/com_lorawan915/com.lorawan915_01.webp"><img src="assets/img/product_pics/module/com_lorawan915/com.lorawan915_03.webp"><img src="assets/img/product_pics/module/com_lorawan915/com.lorawan915_04.webp"></div>
## Description
@@ -75,7 +75,7 @@ An external power supply is provided (5V-12V input can be adjusted by switching
## Related Links
- [COM.LoRaWAN915 AT Command Set](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/COM.LoRaWAN915.asr6501-asr6502-at-commands-introduction-v4.3.pdf)
- [COM.LoRaWAN915 AT Command Set](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/COM.LoRaWAN.Ra-07.asr6501-asr6502-at-commands-introduction-v4.3.pdf)
- [LoRaWAN Regional Parameters](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/lorawantm_regional_parameters_v1.1rb_-_final.pdf)
@@ -89,9 +89,15 @@ An external power supply is provided (5V-12V input can be adjusted by switching
- [Arduino code example](https://github.com/m5stack/M5Atom/tree/master/examples/ATOM_BASE/ATOM_Socket)
## Video
<video class="video_size" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/Module/COM.LoRaWAN915.mp4" type="video/mp4">
</video>
<script>
var purchase_link ='https://m5stack.com/products/atom-motion-kit-with-motor-and-servo-driver-stm32f0';
var purchase_link ='https://m5stack.com/products/com-lorawan-module-915mhz-asr6501-with-antenna';
anchor_search();
scrollFunc();
docs/en/module/servo2.md
+1 -1
View File
@@ -102,7 +102,7 @@ To get the complete code, please click [here](https://github.com/m5stack/M5-Prod
- [Click here to download the UIFlow example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/SERVO2/UIFlow)
<img src="assets/img/product_picsmodule/module/servo2/UIFlowservo2.webp" width="70%" height="70%">
<img src="assets/img/product_pics/module/servo2/UIFlowservo2.webp" width="70%" height="70%">
<script>

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