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:
Gitshaoxiang
2021-01-05 15:11:38 +08:00
parent 08d8eebd98 8ec90d33ee
commit 25580f57a6
31 changed files with 239 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/module/battery.md
+8 -5
View File
@@ -6,11 +6,13 @@
## Description
**BATTERY**: The Lipo Battery extension module, 750 mAh ADD-ON.
**BATTERY**: The Battery extension module is a 750mAh battery ADD-ON.
You want to make a demo or prototype product that needs more battery life, then you realize the battery in M5GO base and Basic base is not enough. Here comes BATTERY which is a handy M5modules to upgrade your Lipo battery life. Since the Lipo batteries is parallelable, you can stack mutilple of them to maximum your power endurance.
Would you like to make a demo or prototype that requires longer battery life? Perhaps using the battery in M5GO base and Basic base is not enough not for you.
*CAUTION: The safety of Lipo battery is affected by many conditions. Overcharge, over-discharge, over-temperature, short circuit, crush and nail penetration may all result in a catastrophic failure, including the pouch rupturing, the electrolyte leaking, and fire. Although every battery we offer have accompany by a protect circuit board, using Lipo battery in you product still needs to be treated with caution*
Here comes the BATTERY which is a handy M5modules to upgrade your Lipo battery life. Since the Lipo batteries can work in parallel, you can stack multiple batteries to maximize your power endurance.
*CAUTION: The safety of Lipo battery is affected by many conditions. Overcharge, over-discharge, over-temperature, short circuit, crush and nail penetration may all result in a catastrophic failure, including the pouch rupturing, the electrolyte leaking, and fire. Although every battery we offer have accompany by a protection circuit board, using Lipo battery in you product still needs to be treated with caution*
Once the BATTERY is stacked underneath the M5 controller, the battery positive pole is connected to VBAT pin at IP5306
@@ -22,7 +24,6 @@ Once the BATTERY is stacked underneath the M5 controller, the battery positive p
- 1x M5Stack BATTERY Module
## Specification
<table>
@@ -52,6 +53,8 @@ Once the BATTERY is stacked underneath the M5 controller, the battery positive p
<img src="assets\img\product_pics\module\module_bus.webp"/>
<el-divider content-position="right">Last updated: 2020-12-21</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/battery-module';
@@ -59,4 +62,4 @@ Once the BATTERY is stacked underneath the M5 controller, the battery positive p
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/bus.md
+5 -4
View File
@@ -6,9 +6,9 @@
## Description
**BUS** allows you add your own circult design on the Universal prototype perboard and interact with the M5 core via M-BUS.
**BUS** allows you add your own custom circuit design to the universal prototype perboard so it could interact with the M5Core via M-BUS.
Just like other M5modules, BUS is able to connected with other layer through M-BUS, while in this module, we've extended the M_BUS pin to pin to the other side of the board. You might need to cut off the fence on the side to be able to dupont out the pins. we've include a 2*15 90 degree pin set in the package.
Just like other M5modules, BUS can connect with other layer through M-BUS, while in this module, we've extended the M_BUS pin to pin to the other side of the board. You might need to cut off the fence on the side to be able to expose the pins. We've included a 2*15 90 degree pin set in the package.
<img src="assets/img/product_pics/module/module_bus_04.webp" width = "30%"><img src="assets/img/product_pics/module/module_bus_05.webp" width = "30%">
@@ -18,7 +18,6 @@ Just like other M5modules, BUS is able to connected with other layer through M-B
- Hole Pitch: 0.1 in - (2.54 mm)
- Entire Hole Quantity: 200 Holes
## Include
- 1x BUS Module
@@ -52,6 +51,8 @@ Just like other M5modules, BUS is able to connected with other layer through M-B
<img src="assets\img\product_pics\module\module_bus.webp"/>
<el-divider content-position="right">Last updated: 2020-12-21</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/bus-module';
@@ -59,4 +60,4 @@ Just like other M5modules, BUS is able to connected with other layer through M-B
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/commu.md
+3 -1
View File
@@ -136,6 +136,8 @@ If you want the complete code `faces_encoder.ino`, please click [here](https://g
<img src="assets/img/product_pics/module/commu_sch.webp">
<el-divider content-position="right">Last updated: 2020-12-21</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/commu-module';
@@ -143,4 +145,4 @@ If you want the complete code `faces_encoder.ino`, please click [here](https://g
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_gps.md
+6 -4
View File
@@ -14,9 +14,9 @@ If you want to change the serial port baud rate, please click ( [u-center-just-f
**UART protocol: baud rate (default is 9600bps), data bit (8 bits), start bit (1 bit), stop bit (1 bit), check bit (none).**
?>COM.GPS RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, **M5Stack Fire** GPIO16 /GPIO17 is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
>COM.GPS RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, **M5Stack Fire** GPIO16 /GPIO17 is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
?>The right dial switch is invalid for this module, no need to set.
>The right dial switch is invalid for this module, no need to set.
## Product Features
@@ -100,7 +100,7 @@ If you want to change the serial port baud rate, please click ( [u-center-just-f
</tr>
</table>
- **datasheet**
- **datasheet**
- [NEO-M8N](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/NEO-M8-FW3_DataSheet_en.pdf)
## EasyLoader
@@ -154,6 +154,8 @@ For more information,please refer to [u-blox 8 / u-blox M8 Receiver Description
<img src="assets/img/product_pics/module/com.x_gps/com.x_gps_sch.webp">
<el-divider content-position="right">Last updated: 2020-12-23</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/com-gps-module-neo-m8n-with-antenna';
@@ -161,4 +163,4 @@ For more information,please refer to [u-blox 8 / u-blox M8 Receiver Description
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_gsm.md
+6 -4
View File
@@ -11,9 +11,9 @@
<img src="assets/img/product_pics/module/com.x_gsm/comx_gsm_02.webp" width = "30%">
?>COM GSM RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default, conflicts may occur when using GSM. It is recommended to use any set of UART pins in the remaining two groups.
>COM GSM RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default, conflicts may occur when using GSM. It is recommended to use any set of UART pins in the remaining two groups.
?>The DIP switch on the right is invalid for the GSM module, no need to set.
>The DIP switch on the right is invalid for the GSM module, no need to set.
## Product Features
@@ -125,7 +125,7 @@
- [SIM800C datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM800C_datasheet.pdf)
- **AT Command**
- **AT Command**
- [SIM800C AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM800_Series_AT_Command_Manual_V1.09.pdf)
## Schematic
@@ -149,6 +149,8 @@
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COMX_GSM)
<el-divider content-position="right">Last updated: 2020-12-23</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/com-gsm-module-sim800c';
@@ -156,4 +158,4 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_lorawan.md
+12 -6
View File
@@ -6,14 +6,18 @@
## Description
**COM.LoRaWAN**is a LoRaWAN communication module in the M5Stack stackable module series, supporting node-to-node or LoRaWAN communication. The LoRaWAN module based on ASR6501 encapsulates the PSoC4000 and SX1262 chips, supports the 868MHz frequency band, is based on an ultra-low power design, and consumes very low current (3.5μA) in deep sleep mode. In order to facilitate the user to configure the pins, the DIP switch is used to set the hardware serial port pins. The user only needs to switch the corresponding pins to ON as needed and specify the pins in the program. A DC power socket is designed under the module, which can be powered by an external power supply, and an external antenna can be used to obtain better signal quality. This module is especially suitable for remote low-power transmission application scenarios with ultra-low power consumption and ultra-small size as the core requirements.
Since LoRa defines the lower physical layer, the upper networking layers were lacking. LoRaWAN was developed to define the upper layers of the network. LoRaWAN is a media access control (MAC) layer protocol but acts mainly as a network layer protocol for managing communication between LPWAN gateways and end-node devices as a routing protocol,maintained by the LoRa Alliance.You can upgrade your work with a LoRa / LoRaWAN radio, so it can communicate over very long distances and extremely low power consuming.
**COM.LoRaWAN**is a LoRaWAN communication module in the M5Stack stackable module series, supporting node-to-node or LoRaWAN communication. The LoRaWAN module based on ASR6501 encapsulates the PSoC4000 and SX1262 chips, supports the 868MHz frequency band, is based on an ultra-low power design, and consumes very low current (3.5μA) in deep sleep mode. In order to facilitate the user to configure the pins, the DIP switch is used to set the hardware serial port pins.
COM.LoRaWAN serial port settings baud rate: 115200, stop bit: 1, data bit: 8, parity bit: none, terminator: none
The user only needs to switch the corresponding pins to ON as needed and specify the pins in the program. A DC power socket is designed under the module, which can be powered by an external power supply, and an external antenna can be used to obtain better signal quality. This module is especially suitable for remote low-power transmission application scenarios with ultra-low power consumption and ultra-small size as the core requirements.
Since LoRa defines the lower physical layer, the upper networking layers were lacking.
?>COM.LoRaWAN RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default. It is recommended to use any set of UART pins in the remaining two groups.
LoRaWAN was developed to define the upper layers of the network. LoRaWAN is a media access control (MAC) layer protocol but acts mainly as a network layer protocol for managing communication between LPWAN gateways and end-node devices as a routing protocol, maintained by the LoRa Alliance.You can upgrade your work with a LoRa / LoRaWAN radio, so it can communicate over very long distances and extremely low power consuming.
?>The DIP switch on the right is invalid for the LoRaWAN module, no need to set.
COM LoRaWAN serial port settings baud rate: 115200, stop bit: 1, data bit: 8, parity bit: none, terminator: none
>COM.LoRaWAN RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default. It is recommended to use any set of UART pins in the remaining two groups.
>The DIP switch on the right is invalid for the LoRaWAN module, no need to set.
## Product Features
@@ -138,6 +142,8 @@ COM.LoRaWAN serial port settings baud rate: 115200, stop bit: 1, data bit: 8, pa
[Click here to download](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COM_LoRaWAN/UIFlow)
<el-divider content-position="right">Last updated: 2020-12-23</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/com-lorawan-module-868mhz-asr6501';
@@ -146,4 +152,4 @@ COM.LoRaWAN serial port settings baud rate: 115200, stop bit: 1, data bit: 8, pa
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_lte-data.md
+13 -7
View File
@@ -7,11 +7,15 @@
## Description
**COM.LTE-DATA** is a stackable multifunctional LTE communication module with built-in LTE communication module A7600C, supporting LTE-TDD/LTE-FDD/EDGE/GPRS and GSM frequency bands, and the transmission rate is LTE.CAT1 standard. Its performance is stable, the appearance is small and well designed, the cost performance is high and can transmit data with low power consumption. The module has a DC power input and can provide 5V-12V power supply through an external power supply. In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. This module is especially suitable for remote meter reading, smart phones, smart wearables, smart parking, municipal management and other IoT industries with low power consumption and compact size as the core requirements.
**COM.LTE-DATA** is a stackable multifunctional LTE communication module with built-in LTE communication module A7600C, supporting LTE-TDD/LTE-FDD/EDGE/GPRS and GSM frequency bands, and the transmission rate is LTE.CAT1 standard.
?>COM.LTE-DATA RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
Its performance is stable, the appearance is small and well designed, the cost performance is high and can transmit data with low power consumption. The module has a DC power input and can provide 5V-12V power supply through an external power supply.
?>Dial the DIP switch on the side of the audio configuration pin to ON when in use
In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. This module is especially suitable for remote meter reading, smart phones, smart wearables, smart parking, municipal management and other IoT industries with low power consumption and compact size as the core requirements.
>COM.LTE-DATA RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
>Dial the DIP switch on the side of the audio configuration pin to ON when in use
## Product Features
@@ -33,9 +37,9 @@
- LTE Cat 1
- (UL) 5Mbps
- (DL) 10Mbps
- EDGE
- EDGE
- UL/DL 236.8Kbps
- GPRS
- GPRS
- UL/DL 85.6Kbps
- Protocol
@@ -134,7 +138,7 @@ The following content is for reference only.
## Related Link
- **AT Command**
- **AT Command**
- [A7600C AT command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM7500_SIM7600%20Series_AT%20Command%20Manual%20_V1.10.pdf)
@@ -153,6 +157,8 @@ The following content is for reference only.
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COMX_LTE-DATA)
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/com-lte-data-modulea7600c';
@@ -160,4 +166,4 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_lte.md
+13 -7
View File
@@ -7,11 +7,15 @@
## Description
**COM.LTE(4G)** is a stackable multifunctional LTE communication module, built-in LTE communication module SIM7600G, supports LTE-TDD/LTE-FDD/WCDMA and GSM frequency bands, supports LTE.CAT4 (downlink speed is 150Mbps), supports voice calls SMS with SMS. It has stable performance, small appearance, high cost performance, and can realize the transmission of SMS and data information with low power consumption. The module has a DC power input and can provide 5V-12V power supply through an external power supply. In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. The onboard microphone and 3.5mm headphone jack support the insertion of headphone with microphone. This module is especially suitable for scenarios that require high-speed network connections, such as video calls, drone data transmission, industrial Internet of Things, etc.
**COM.LTE(4G)** is a stackable multifunctional LTE communication module, built-in LTE communication module SIM7600G, supports LTE-TDD/LTE-FDD/WCDMA and GSM frequency bands, supports LTE.CAT4 (downlink speed is 150Mbps), supports voice calls SMS with SMS.
?>COM.LTE(4G) RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
It has stable performance, small appearance, high cost performance, and can realize the transmission of SMS and data information with low power consumption. The module has a DC power input and can provide 5V-12V power supply through an external power supply.
?>Dial the DIP switch on the side of the audio configuration pin to ON when in use
In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. The onboard microphone and 3.5mm headphone jack support the insertion of headphone with microphone. This module is especially suitable for scenarios that require high-speed network connections, such as video calls, drone data transmission, industrial Internet of Things, etc.
>COM.LTE(4G) RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
>Dial the DIP switch on the side of the audio configuration pin to ON when in use
## Product Features
@@ -41,14 +45,14 @@
- HSPA+
- UL:5.76Mbps
- DL:42Mbps
- WCDMA
- UL/DL:384Kbps
- EDGE/GPRS
- UL/DL:236.8Kbps
- Protol
- Protol
- TCP/IP/IPV4/IPV6/ Multi-PDP/FTP/FTPS/HTTP/ HTTPS/DNS
- TLS
- RNDIS/ECM
@@ -161,7 +165,7 @@ The following content is for reference only.
- **Datasheet**
- [SIM7600G datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM7600-H%20Series_SPEC_20200528.pdf)
- **AT Command**
- **AT Command**
- [SIM7600G AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM7500_SIM7600%20Series_AT%20Command%20Manual%20_V1.10.pdf)
@@ -180,6 +184,8 @@ The following content is for reference only.
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COMX_LTE)
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/com-lte-modulesim7600g';
@@ -187,4 +193,4 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_nb-iot.md
+11 -6
View File
@@ -7,11 +7,15 @@
## Description
**COM.NB-IoT** is a stackable multi-band NB-IoT wireless communication module with built-in SIM7020G communication module. The module supports PSM and eDRX low power consumption modes. The COM.NB-IoT module has a wide coverage signal. Compared with GSM, NB-IoT has a strong gain, which also enables the product to have wireless communication capabilities in locations such as basements. The module has a DC power input and can provide 5V-12V power supply through an external power supply. In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. The SIM7020G module is the optimal solution for low latency, low power consumption, and low throughput applications. It is very suitable for IoT applications such as metering, remote control, asset tracking, remote monitoring, telemedicine, and ride sharing.
**COM.NB-IoT** is a stackable multi-band NB-IoT wireless communication module with built-in SIM7020G communication module. The module supports PSM and eDRX low power consumption modes.
?>COM.NB-IoT RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
The COM.NB-IoT module has a wide coverage signal. Compared to GSM, NB-IoT has a strong gain, which also enables the product to have wireless communication capabilities in locations such as basements.
?>Dial the DIP switch on the side of the audio configuration pin to ON when in use
The module has a DC power input and can provide 5V-12V power supply through an external power supply. In order to facilitate the user to configure the pin, the DIP switch is used to set the pin. The SIM7020G module is the optimal solution for low latency, low power consumption, and low throughput applications. It is very suitable for IoT applications such as metering, remote control, asset tracking, remote monitoring, telemedicine, and ride sharing.
>COM.NB-IoT RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch, GPIO in **M5Stack Fire** 16/17 It is connected to PSRAM by default. It is recommended to use any one of the remaining two groups of pins.
>Dial the DIP switch on the side of the audio configuration pin to ON when in use
## Product Features
@@ -31,7 +35,7 @@
- Data transmission speed:
Upload:150Kbps Download:126Kbps
- Protol:
- Protol:
TCP/UDP/HTTP/HTTPS/TLS/DTLS/DNS/ NTP/PING/LWM2M/COAP/MQTT/MQTTS
## Include
@@ -141,7 +145,7 @@ The following content is for reference only.
- **Datasheet**
- [SIM7020G datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM7020_en.zip)
- **AT Command**
- **AT Command**
- [SIM7020G AT Command](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/SIM7020%20Series_AT%20Command%20Manual_V1.05.pdf)
@@ -160,6 +164,7 @@ The following content is for reference only.
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COMX_NB-IoT)
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
@@ -168,4 +173,4 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/comx_sigfox.md
+13 -8
View File
@@ -6,12 +6,15 @@
## Description
**SigFox Module** is a universal wireless module suitable for SigFox communication and Tracker equipment in the COM.X series. The module is SFM11R3, and the internal RF chip is AX-SFJK-1-01. It supports RC3 and RC5. The transmission frequency band is 923.2 MHz, receiving frequency band is 922.2 MHz, and the bandwidth is 192KHz. In order to facilitate the user to configure the pins, the DIP switch is used to set the hardware serial port pins. The user only needs to switch the corresponding pins to ON and specify the pins in the program. A DC power socket is designed under the module, which can be powered by an external power source.
**SigFox Module** is a universal wireless module suitable for SigFox communication and Tracker equipment in the COM.X series. The module is based on the SFM11R3 chipset, with the AX-SFJK-1-01 internal RF chip.
The transmission frequency is 923.2 MHz, receiving frequency is 922.2 MHz, and the bandwidth is 192KHz. In order to allow the user to modify the configurations of pins, the DIP switch is used to set the hardware serial port pins.
?>COM.SigFox RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default. It is recommended to use any set of UART pins in the remaining two groups.
The user only needs to switch the corresponding pins to ON and specify the pins in the program. A DC power socket is designed under the module, which can be powered by an external power source.
?>The DIP switch on the right is invalid for the LoRaWAN module, no need to set.
>COM.SigFox RXD/TXD can be connected to M5Stack's UART (TX(0/13/17)RX(5/15/16)) by setting the DIP switch. Since these GPIO in **M5Stack Fire** 16/17 are connected to PSRAM by default. It is recommended to use any set of UART pins in the remaining two groups.
>The DIP switch on the right is invalid for the LoRaWAN module, no need to set.
<img src="assets/img/product_pics/module/nb-iot/module_nbiot_note01.webp" width="100%">
@@ -34,8 +37,8 @@
## Applications
- Smart Parking
- Smart Meter
- Smart Parking
- Smart Meter
- IoT in City
## Specification
@@ -105,7 +108,7 @@
## Related Link
- **Datasheet**
- **Datasheet**
- [SFM11R3](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/DS_SFM11R3000_REV05.pdf)
@@ -122,7 +125,7 @@
## Usage
Debugging method:
Debugging method:
1. Download and Install [Sigfox Network Emulator](https://support.sigfox.com/downloads/snek.exe), and run snek.vbs
2. Insert SDR Dongle
@@ -140,6 +143,8 @@ Debugging method:
To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/COMX_SigFox)
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
var purchase_link = '';
@@ -147,4 +152,4 @@ To get complete code, please click [here](https://github.com/m5stack/M5-ProductE
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/ecg.md
+10 -4
View File
@@ -6,9 +6,13 @@
## Description
**ECG** is a heart rate monitor (electrocardiogram) unit，it can detect the heart rate and output a cardiogram signal. Electrocardiogram (ECG) is a technology that uses an electrocardiograph to record the changes in the electrical activity of the heart during each cardiac cycle. At the signal acquisition end, this ECG module integrates the AD8232 single-lead heart rate monitoring at the front end, the collected ECG signal is processed by the AD8603 low-pass filter, and the 10bit-ADC (AD7476) performs analog/digital signal input to STM32 (built-in heart rate statistics) Algorithm) for signal analysis. Finally, the processing results are output in the form of serial communication to facilitate the acquisition and display of the main control device. In terms of signal output, it adopts front-end/digital full isolation design to enhance equipment stability and safety.
**ECG** is a heart rate monitor (electrocardiogram) unit，it can detect the heart rate and output a cardiogram signal. Electrocardiogram (ECG) is a technology that uses an electrocardiograph to record the changes in the electrical activity of the heart during each cardiac cycle.
?>Caution: This product only allows the use of `5V` power input. Please strictly abide by the power input standard when using this product to avoid damage to the equipment or injury.
At the signal acquisition end, this ECG module integrates the AD8232 single-lead heart rate monitoring at the front end, the collected ECG signal is processed by the AD8603 low-pass filter, and the 10bit-ADC (AD7476) performs analog/digital signal input to STM32 (built-in heart rate statistics) Algorithm) for signal analysis.
Finally, the processing results are output in the form of serial communication to facilitate the acquisition and display of the main control device. In terms of signal output, it adopts front-end/digital full isolation design to enhance equipment stability and safety.
>Caution: This product only allows the use of `5V` power input. Please strictly abide by the power input standard when using this product to avoid damage to the equipment or injury.
<img src="assets/img/product_pics/module/ecg/ecg_02.webp" width="300px">
@@ -98,7 +102,7 @@
## Related Link
- **Datasheet**
- **Datasheet**
- [AD8232](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/AD8232_datasheet_en.pdf)
- [AD8603](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/AD8603_datasheet_en.pdf)
- [AD7476](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/AD7476_datasheet_en.pdf)
@@ -107,7 +111,7 @@
- [RawDisplay-PC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/software/RawDisplay.zip)
- [UART Pass Through Firmware](https://github.com/m5stack/M5Stack/tree/master/examples/Advanced/Serial2)
?>When using the PC-side heart rate reading tool, the device needs to burn the serial port transparent transmission firmware(Before uploading, please change the serial port initialization pin to the actually connected pin) and forward the data to the PC.
>When using the PC-side heart rate reading tool, the device needs to burn the serial port transparent transmission firmware(Before uploading, please change the serial port initialization pin to the actually connected pin) and forward the data to the PC.
## Schematic
@@ -126,6 +130,8 @@
<tr><td>ECG</td><td>RX</td><td>TX</td><td>VIN</td><td>GND</td></tr>
</table>
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
var purchase_link = 'https://m5stack.com/products/ecg-module13-2-ad8232-with-cables-and-pads';
docs/en/module/encoder.md
+5 -3
View File
@@ -6,9 +6,9 @@
## Description
**ENCODER** is compatible with FACE Kit. You can have it replace the keycoard panel inside the FACE kit. It is designed for rotary encoder control, integrated Mega328 microprocessor inside and LEDs around the encoder.
**ENCODER** is compatible with FACE Kit. You can have it replace the key-card panel inside the FACE kit. It is designed for rotary encoder control, integrated Mega328 microprocessor inside and LEDs around the encoder.
The series communication protocol between M5 core and ENCODER is IIC (adress: 0x5E)
The series communication protocol between M5 core and ENCODER is IIC (The default I2c address is: 0x5E)
<img src="assets/img/product_pics/module/module_encoder_03.webp" width="60%" height="60%">
@@ -152,6 +152,8 @@ If you want the complete code `faces_encoder.ino`, please click [here](https://g
<img src="assets/img/product_pics/module/module_example/ENCODER/encoder.webp" >
<el-divider content-position="right">Last updated: 2020-12-24</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/encoder-module';
@@ -159,4 +161,4 @@ If you want the complete code `faces_encoder.ino`, please click [here](https://g
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces.md
+9 -3
View File
@@ -6,7 +6,11 @@
## Description
**FACES BOTTOM** It is a multi-function panel base compatible with M5Core. The side directly leads to the M-BUS pin header, which is convenient for connecting various peripherals. It is compatible with all function panels in the FACES Kit. You can flexibly change the panel according to the project requirements. The base is connected to the host through the M-BUS bus and communicates using the I2C protocol. The base has a built-in 600mAh rechargeable lithium battery and is equipped with a power management chip for easy use as a handheld device. The bottom of the back of the base is equipped with Pogo Pin contacts, which can be charged through the charging base. The M3 screw holes and hanging holes on the top can be easily fixed.
**FACES BOTTOM** is a multi-function panel base compatible with M5Core. The side directly leads to the M-BUS pin header, which is convenient for connecting various peripherals. It is compatible with all function panels in the FACES Kit.
You can flexibly change the panel according to the project requirements. The base is connected to the host through the M-BUS bus and communicates using the I2C protocol. The base has a built-in 600mAh rechargeable lithium battery and is equipped with a power management chip for easy use as a handheld device.
The bottom of the back of the base is equipped with Pogo Pin contacts, which can be charged through the charging base. The M3 screw holes and hanging holes on the top can be easily fixed.
<img src="assets/img/product_pics/module/faces_bottom/different.webp" width="30%" height="30%" >
@@ -14,7 +18,7 @@
- 2.54mm pitch pin output on both sides
- Compatible with FACES Kit panels
- Rechargeable
- Rechargeable
- Easy to handheld
## Include
@@ -54,6 +58,8 @@
<img src="assets\img\product_pics\module\module_bus.webp"/>
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/all/products/m5-faces-bottom-board';
@@ -61,4 +67,4 @@
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/facesII.md
+4 -2
View File
@@ -15,7 +15,7 @@
- Colorful RGB LED light bars（GPIO 15)
- Compatible with GROVE interface for easy connection
- Compatible with FACES Kit panels
- Rechargeable
- Rechargeable
- Handheld
## Include
@@ -60,6 +60,8 @@ To the complete code , click [here](https://github.com/m5stack/M5Stack/tree/mast
<img src="assets\img\product_pics\module\module_bus.webp"/>
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/all/products/m5-faces-ii-bottom-board';
@@ -67,4 +69,4 @@ To the complete code , click [here](https://github.com/m5stack/M5Stack/tree/mast
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces_calculator.md
+6 -2
View File
@@ -6,7 +6,9 @@
## Description
**Calculator** is a full-featured calculator panel adapted to FACE_BOTTOM, which can be used for mathematical calculations or custom key functions. The panel adopts a 4 * 5 button layout design, which covers the basic function buttons required for mathematical calculations. You can also remap them to custom function buttons by modifying the firmware. The panel integrates **MEGA328** processor and communicates via I2C The protocol (0x08) works in slave mode.
**Calculator** is a complete featured calculator panel adapted to the FACE_BOTTOM product which can be used for mathematical calculations or custom key operations.
The panel based upon a 4 * 5 button layout design, which covers the basic function buttons required for mathematical calculations. You can also remap them to custom function buttons by modifying the firmware. The panel integrates **MEGA328** processor and communicates via I2C protocol (with default address: 0x08), by default it works in slave mode.
## Product Features
@@ -111,6 +113,8 @@
- Click [Here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/CALCULATOR)to get Arduino example
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/m5-faces-calculator-panel';
@@ -120,4 +124,4 @@
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces_finger.md
+5 -5
View File
@@ -6,9 +6,9 @@
## Description
**FACE-FINGER** is another FACES kit compatible panel, with the fingerprinter recognition module on it. Same as FINGER units, FACE-FINGER integrated the FPC1020A capacitive fingerprint recognition module and Fingerprint recognition algorithm chip.
**FACE-FINGER** is another FACES kit compatible panel, with a built-in finger-print recognition module inside of it. Similar to the FINGER unit, FACE-FINGER integrated the FPC1020A capacitive fingerprint recognition module and Fingerprint recognition algorithm chip.
<br>
It can identify fingerprint information entrance, fingerprint deletion, fingerprint search, feature extraction for multiple people and so on. The unit also can be set fingerprint recognition comparison level and different security level. With FACES panel, you can have an upgrade level of Fingerprint management machine with a more complete and enclosed pattern.
It can identify fingerprint information entrance, fingerprint deletion, fingerprint search, feature extraction for multiple people and so on. The unit can configure the fingerprint recognition comparison and security levels. With FACES panel, you can upgrade the level of Fingerprint management machine with a more complete and enclosed pattern.
Communication Protocol: UART.
@@ -18,7 +18,6 @@ Communication Protocol: UART.
- Interface Serial： UART2 (16/17)
- FPC1020A
## Include
- 1x FACES-FINGER Panel
@@ -83,7 +82,7 @@ Communication Protocol: UART.
>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 EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/M5Burner#install-usb-driver)
>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/M5Burner#install-usb-driver)
## Schematic
@@ -115,6 +114,7 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
<img src="assets/img/product_pics/module/faces_finger/finger.webp">
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
@@ -123,4 +123,4 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces_gameboy.md
+4 -4
View File
@@ -6,7 +6,7 @@
## Description
**GAMEPAD** is a gamepad panel adapted to FACE_BOTTOM. It contains commonly used up/down/left/right, A/B buttons and start/pause, 8 buttons, adapted to the controller layout of classic game consoles such as FC and GAMEBOY. You can burn the game simulator firmware to load the game freely, or write the game by yourself. The panel integrates **MEGA328** processor, working in slave mode through I2C communication protocol (0x08).
**GAMEPAD** is a game pad panel designed for the FACE_BOTTOM module. It contains commonly used up/down/left/right, A/B buttons and start/pause, 8 buttons, adapted to the controller layout of classic game consoles such as FC and GAMEBOY. You can burn the game simulator firmware to load the game freely, or write the game by yourself. The panel integrates **MEGA328** processor, working in slave mode through I2C communication protocol (0x08).
## Product Features
@@ -71,8 +71,7 @@
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/CORE/EasyLoader_FACES_FactoryTest.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/CORE/EasyLoader_FACES_FactoryTest.dmg">MacOS</a>
<!-- <a>Linux</a>
<a>MacOS</a> -->
<!--<a>Linux</a><a>MacOS</a> -->
</div>
</div>
<div>
@@ -119,6 +118,7 @@ ESPTool burning game tutorial：https://docs.m5stack.com/#/zh_CN/quick_start/fac
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/M5Core/Faces_kit/Faces_GameBoy_BladeBuster.exe">Click here to burn the sample game with one click</a>
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
@@ -129,4 +129,4 @@ ESPTool burning game tutorial：https://docs.m5stack.com/#/zh_CN/quick_start/fac
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces_keyboard.md
+8 -2
View File
@@ -6,7 +6,11 @@
## Description
**QWERTY** is a full-featured keyboard panel adapted to FACE_BOTTOM. There are 35 keys in total, and each key can be multiplexed by combination keys to output different characters. The internal integration **MEGA328** processor, works in slave through I2C communication protocol (0x08) In computer mode, the "sym" and "Fn" function keys are used to switch between upper and lower gears, and the "aA" function key is used to switch between upper and lower case. Click the corresponding function key and the indicator light is always on to activate single-character input. Double-click the indicator light to flash. Activate continuous input and click Resume again.
**QWERTY** is a full-featured keyboard panel adapted to FACE_BOTTOM. There are 35 keys in total, and each key can be multiplexed by combination keys to output different characters.
The internal integration **MEGA328** processor, works in slave through I2C communication protocol (0x08) In computer mode, the "sym" and "Fn" function keys are used to switch between upper and lower gears, and the "aA" function key is used to switch between upper and lower case.
Click the corresponding function key and the indicator light is always on to activate single-character input. Double-click the indicator light to flash. Activate continuous input and click Resume again.
## Product Features
@@ -116,6 +120,8 @@
- Click [here to download](https://github.com/m5stack/M5Stack/tree/master/examples/Face/KEYBOARD) to get Arduino example.
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/m5-faces-qwerty-panel';
@@ -125,4 +131,4 @@
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/faces_rfid.md
+6 -3
View File
@@ -6,7 +6,9 @@
## Description
**FACE-RFID** is another FACES kit compatible panel, with the Radio frequency identification on it. Same as RFID units, it is MFRC522-based. The MFRC522 operates in the 13.56MHz frequency band and uses the modulation and demodulation principle to interact with the proximity RF card.
**FACE-RFID** is a FACES kit compatible panel, with the Radio frequency identification chipset integrated on it.
Same as RFID units, it is MFRC522-based. The MFRC522 operates in the 13.56MHz frequency band and uses the modulation and demodulation principle to interact with the proximity RF card.
<br>
This unit can realize the function of the card reading and writing device, to identify and record multiple card information, to encode and authority an RF card. With FACES panel, you can have an upgrade level of RFID device with a more complete and enclosed pattern.
@@ -90,7 +92,7 @@ Communication Protocol: I2C.
>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 EasyLoader is burned. [Click here to view the driver installation tutorial](en/related_documents/M5Burner#install-usb-driver)
>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/M5Burner#install-usb-driver)
## Schematic
@@ -119,6 +121,7 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
<img src="assets/img/product_pics/module/faces_rfid/faces_rfid.webp" width="50%" height="50%">
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
@@ -127,4 +130,4 @@ If you want the complete code, please click [here](https://github.com/m5stack/M5
anchor_search(purchase_link);
scrollFunc();
</script>
</script>
docs/en/module/fan.md
+4 -3
View File
@@ -6,7 +6,7 @@
## Description
**FAN** is one of the M5Stack stacking module series. The fan cooling module can effectively cool the body, so that other hardware can stabilize the normal work. The fan on the module is connected to the power pin by default, and the stack can be used.
**FAN** is one of the M5Stack stacking module series. The fan cooling module can effectively cool the device itself, so that other hardware components can work in a stable and efficient way. The fan on the module is connected to the power pin by default, and can be stacked as well on other M5 Core devices.
## Product Features
@@ -18,7 +18,6 @@
- Bearing: Hydraulic bearing
- Wiring: red line positive, black line negative
## Include
- 1x M5Stack FAN Module
@@ -52,6 +51,8 @@
<img src="assets\img\product_pics\module\module_bus.webp"/>
<el-divider content-position="right">Last updated: 2020-12-28</el-divider>
<script>
var purchase_link = 'https://m5stack.com/collections/m5-module/products/step-motor-module-adapter-fan-module';
@@ -59,4 +60,4 @@
anchor_search(purchase_link);
scrollFunc();
</script>
</script>

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