diff --git a/docs/en/module/battery.md b/docs/en/module/battery.md index 2c253acd..a79aa552 100644 --- a/docs/en/module/battery.md +++ b/docs/en/module/battery.md @@ -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 @@ -52,6 +53,8 @@ Once the BATTERY is stacked underneath the M5 controller, the battery positive p +Last updated: 2020-12-21 + \ No newline at end of file + diff --git a/docs/en/module/bus.md b/docs/en/module/bus.md index efe6a964..58c1e3ea 100644 --- a/docs/en/module/bus.md +++ b/docs/en/module/bus.md @@ -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. @@ -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 +Last updated: 2020-12-21 + \ No newline at end of file + diff --git a/docs/en/module/commu.md b/docs/en/module/commu.md index 427795f0..5bd1d336 100644 --- a/docs/en/module/commu.md +++ b/docs/en/module/commu.md @@ -136,6 +136,8 @@ If you want the complete code `faces_encoder.ino`, please click [here](https://g +Last updated: 2020-12-21 + \ No newline at end of file + diff --git a/docs/en/module/comx_gps.md b/docs/en/module/comx_gps.md index 8785bb8a..21c577d5 100644 --- a/docs/en/module/comx_gps.md +++ b/docs/en/module/comx_gps.md @@ -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
-- **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 +Last updated: 2020-12-23 + \ No newline at end of file + diff --git a/docs/en/module/comx_gsm.md b/docs/en/module/comx_gsm.md index e8a7f988..f25427fa 100644 --- a/docs/en/module/comx_gsm.md +++ b/docs/en/module/comx_gsm.md @@ -11,9 +11,9 @@ -?>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) +Last updated: 2020-12-23 + \ No newline at end of file + diff --git a/docs/en/module/comx_lorawan.md b/docs/en/module/comx_lorawan.md index 02943e90..f34c906c 100644 --- a/docs/en/module/comx_lorawan.md +++ b/docs/en/module/comx_lorawan.md @@ -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) +Last updated: 2020-12-23 + \ No newline at end of file + diff --git a/docs/en/module/comx_lte-data.md b/docs/en/module/comx_lte-data.md index be1b1095..8ba05c0c 100644 --- a/docs/en/module/comx_lte-data.md +++ b/docs/en/module/comx_lte-data.md @@ -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) +Last updated: 2020-12-24 + \ No newline at end of file + diff --git a/docs/en/module/comx_lte.md b/docs/en/module/comx_lte.md index 3ed28576..8d68da3a 100644 --- a/docs/en/module/comx_lte.md +++ b/docs/en/module/comx_lte.md @@ -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) +Last updated: 2020-12-24 + \ No newline at end of file + diff --git a/docs/en/module/comx_nb-iot.md b/docs/en/module/comx_nb-iot.md index db7b8519..4a644016 100644 --- a/docs/en/module/comx_nb-iot.md +++ b/docs/en/module/comx_nb-iot.md @@ -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) +Last updated: 2020-12-24 \ No newline at end of file + diff --git a/docs/en/module/comx_sigfox.md b/docs/en/module/comx_sigfox.md index a42b16ef..e232655b 100644 --- a/docs/en/module/comx_sigfox.md +++ b/docs/en/module/comx_sigfox.md @@ -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. @@ -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) +Last updated: 2020-12-24 + \ No newline at end of file + diff --git a/docs/en/module/ecg.md b/docs/en/module/ecg.md index 44b1d511..6ab833bd 100644 --- a/docs/en/module/ecg.md +++ b/docs/en/module/ecg.md @@ -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. @@ -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 @@ ECGRXTXVINGND +Last updated: 2020-12-24 + \ No newline at end of file + diff --git a/docs/en/module/faces.md b/docs/en/module/faces.md index 34f04e7e..0148e2ad 100644 --- a/docs/en/module/faces.md +++ b/docs/en/module/faces.md @@ -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. @@ -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 @@ +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/facesII.md b/docs/en/module/facesII.md index 6625ef15..70b59cfb 100644 --- a/docs/en/module/facesII.md +++ b/docs/en/module/facesII.md @@ -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 +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/faces_calculator.md b/docs/en/module/faces_calculator.md index ecf29957..66037c4d 100644 --- a/docs/en/module/faces_calculator.md +++ b/docs/en/module/faces_calculator.md @@ -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 +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/faces_finger.md b/docs/en/module/faces_finger.md index fcf8d297..36dda546 100644 --- a/docs/en/module/faces_finger.md +++ b/docs/en/module/faces_finger.md @@ -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.
-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 +Last updated: 2020-12-28 \ No newline at end of file + diff --git a/docs/en/module/faces_gameboy.md b/docs/en/module/faces_gameboy.md index 6b3bdec0..13b7a715 100644 --- a/docs/en/module/faces_gameboy.md +++ b/docs/en/module/faces_gameboy.md @@ -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 @@
Windows MacOS - +
@@ -119,6 +118,7 @@ ESPTool burning game tutorial：https://docs.m5stack.com/#/zh_CN/quick_start/fac Click here to burn the sample game with one click +Last updated: 2020-12-28 \ No newline at end of file + diff --git a/docs/en/module/faces_keyboard.md b/docs/en/module/faces_keyboard.md index 714a9885..b541db74 100644 --- a/docs/en/module/faces_keyboard.md +++ b/docs/en/module/faces_keyboard.md @@ -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. +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/faces_rfid.md b/docs/en/module/faces_rfid.md index f1167d63..c6a6cd10 100644 --- a/docs/en/module/faces_rfid.md +++ b/docs/en/module/faces_rfid.md @@ -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.
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 +Last updated: 2020-12-28 \ No newline at end of file + diff --git a/docs/en/module/fan.md b/docs/en/module/fan.md index 85cab33e..b7ec12c0 100644 --- a/docs/en/module/fan.md +++ b/docs/en/module/fan.md @@ -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 @@ +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/goplus.md b/docs/en/module/goplus.md index 81ba6c82..af37be6a 100644 --- a/docs/en/module/goplus.md +++ b/docs/en/module/goplus.md @@ -6,9 +6,9 @@ ## Description -**GoPlus** is a enhanced M5 module. It features an all-in-one motor driver module, provides a combination of several M5 Modules and Units(SERVO, PbHUB, IR). +**GoPlus** is an enhanced M5 module. It features an all-in-one motor driver module, provides a combination of several M5 Modules and Units in one (SERVO, PbHUB, IR). -comes with 2x DC motor channel, 4x Servo motor channel, IR transmitter, IR receiver, 3x extend PORT B(GPIO Port). This Module can surely help build more complicated and organized motor applications. +Comes with 2x DC motor channel, 4x Servo motor channel, IR transmitter, IR receiver, 3x extend PORT B(GPIO Port). This Module can surely help build more complicated and organized motor applications. Communication Protocol: IIC (0x61). @@ -21,7 +21,6 @@ Communication Protocol: IIC (0x61). - MEGA328P - LV8548MC - ## Include - 1x M5Stack GoPlus Module @@ -61,7 +60,7 @@ Communication Protocol: IIC (0x61). >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) ## PinMap @@ -79,10 +78,10 @@ Communication Protocol: IIC (0x61). ## Related Link -- Agreement manual +- Agreement manual - **[I2C](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/GoPlus_I2C_Protocol%20operation%20instructions.pdf)** -- Datasheet +- Datasheet - **[LV8548MC](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/module/LV8548MC-D.PDF)** ## Example @@ -99,6 +98,8 @@ Communication Protocol: IIC (0x61). +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/goplus2.md b/docs/en/module/goplus2.md index 9a8b1c15..16487697 100644 --- a/docs/en/module/goplus2.md +++ b/docs/en/module/goplus2.md @@ -6,7 +6,7 @@ ## Description -**GoPlus2** is a stackable multi-functional motor and servo control module. The master control adopts STM32F030C8T6. The module is equipped with 2-way DC motor drive interface and 4-way servo drive interface. Three PORT-B interfaces(Analog Input,Digital Output,Digital Input) can be expanded. Built-in 500mAh battery and support infrared (IR) transmission and receive. In order to meet the requirements of multi-channel interface power supply at the same time, a DC power interface is provided for external power supply, battery can be charged through the M5Core with USB-C. +**GoPlus2** is a stackable multi-functional motor and servo control module. The master control integrates the STM32F030C8T6 chipset. The module is equipped with 2-way DC motor drive interface and 4-way servo drive interface. Three PORT-B interfaces(Analog Input,Digital Output,Digital Input) can be expanded. Built-in 500mAh battery and support infrared (IR) transmission and receive. In order to meet the requirements of multi-channel interface power supply at the same time, a DC power interface is provided for external power supply, battery can be charged through the M5Core with USB-C. Communication protocol: IIC(0x38) @@ -115,7 +115,7 @@ Communication protocol: IIC(0x38) ## Related Link -- Protocol Manual +- Protocol Manual - **[GoPlus2 I2C Protocol](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/GO%20PLUS2%20Guide.docx)** ## Example @@ -124,6 +124,8 @@ Communication protocol: IIC(0x38) To get example code, please [click here to download](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Module/GoPLUS2) +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/gps.md b/docs/en/module/gps.md index 1fdd0c33..5c5958cd 100644 --- a/docs/en/module/gps.md +++ b/docs/en/module/gps.md @@ -6,15 +6,15 @@ ## Description -**GPS** is build with NEO-M8N, u-blox M8 concurrent GNSS modules and come with an active Antenna. +**GPS** is build with u-blox M8 NEO-M8N module with an integrated built in active antenna. -The NEO-M8 series provides high sensitivity and minimal acquisition times while maintaining low system power. +The NEO-M8 series provides high sensitivity and minimal acquisition times while maintaining low power usage. The NEO-M8N integrates a 72-channel [u-blox](https://www.u-blox.com) M8 GNSS engine that supports multiple GNSS systems ( Beidou, Galileo, GLONASS, GPS / QZSS ) and able to receive 3 GNSS systems simultaneously. The series communicate protocol between M5Core and GPS is UART, physically connected via **UART2 (GPIO16, GPIO17)** -If you want to Change the uart baudrate,please check here ( [u-center-just-for-Windows](https://www.u-blox.com/en/product/u-center-windows) ) +If you want to change the UART baud-rate, please check here ( [u-center-just-for-Windows](https://www.u-blox.com/en/product/u-center-windows) ) **Notice: GPS signal can only be found outdoors** @@ -22,7 +22,7 @@ If you want to Change the uart baudrate,please check here ( [u-center-just-for-W -?> **M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of GPS module. Therefore, when using the GPS module with the M5Stack Fire, you might have to cut the TXD and RXD from GPS module and wire fly to another set of UART pin +> **M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of GPS module. Therefore, when using the GPS module with the M5Stack Fire, you might have to cut the TXD and RXD from GPS module and wire fly to another set of UART pin ## Product Features @@ -37,7 +37,6 @@ If you want to Change the uart baudrate,please check here ( [u-center-just-for-W - Industry leading -167dBm sensitivity - Backward compatibility with NEO‐7 and NEO‐6 series - ## Include - 1x GPS Module @@ -93,7 +92,7 @@ If you want to Change the uart baudrate,please check here ( [u-center-just-for-W >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) ## Example @@ -119,6 +118,8 @@ Please refer to the [u-blox 8 / u-blox M8 Receiver Description - Manual](https:/ +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/gsm.md b/docs/en/module/gsm.md index 8dc2d589..d823a0d8 100644 --- a/docs/en/module/gsm.md +++ b/docs/en/module/gsm.md @@ -7,13 +7,13 @@ ## Description This is a 2G and industrial wireless communication module, integrated an GSM/GPRS module M6315, released by China Mobile, -supported GPRS class12 and GPRS CS-1, CS-2, CS-3, CS-4 encode, M6315 has LCC package type, features tiny dimension, highly reliability, strong anti-interference capability. +supported GPRS class12 and GPRS CS-1, CS-2, CS-3, CS-4 encode, M6315 has LCC package type, features tiny dimension, highly reliability, strong anti-interference capability.
-It can apply to the comunication requirement on diversity industrial, electricity, petroleum, transportation, financial, etc +It can apply to the communication requirement on diversity industrial, electricity, petroleum, transportation, financial, etc
In the GSM module scheme, we added more hardware resources, 1 reserved speaker- SPK1, 1 onboard speaker-SPK2, LEDs, 2 alternative antenna.
-M6315 is 2.8V power input, so in the hardware of GSM module, we added a Bidirectional Voltage-Level Translator (TXS0104E), to switch the power supply to 2.8V. +M6315 is 2.8V power input, so in the hardware of GSM module, we added a Bidirectional Voltage-Level Translator (TXS0104E), to switch the power supply to 2.8V.

Power Operation: @@ -23,20 +23,20 @@ Power Operation: - Power Off: Button long-press for 8s - Reset module: GPIO26 HIGH - +


*The Global System for Mobile Communications (GSM) is a standard developed by the European Telecommunications Standards Institute (ETSI) to describe the protocols for second-generation (2G) digital cellular networks used by mobile devices such as mobile phones and tablets.* -?> **M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of GSM module. Therefore, when using the GSM module with the M5Stack Fire, you might have to cut the TXD and RXD from GSM module and wire fly to another set of UART pin +>**M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of GSM module. Therefore, when using the GSM module with the M5Stack Fire, you might have to cut the TXD and RXD from GSM module and wire fly to another set of UART pin ## Product Features Product Feature: -- Serial communication: Uart 16/17 -- Alternative Antenna +- Serial communication: UART 16/17 +- External Antenna support - GSM 2G industrial level - SIM card type: Nano - 2x LEDs @@ -44,24 +44,23 @@ Product Feature: - M6315 - Tem:-40°C ~ + 85°C - Frequency Band（MHz: - - 850/900/1800/1900 + - 850/900/1800/1900 - Data Transmit: - - spped: (kbps) 85.6(UL)/85.6(DL) + - speed: (kbps) 85.6(UL)/85.6(DL) - GPRS: Class12 - SMS: supported PDU/TEXT mode - - Network Protocol: IPV4/IPV6*/TCP/UDP/PPP/HTTP/FTP/MQTT + - Network Protocol: IPV4/IPV6*/TCP/UDP/PPP/HTTP/FTP/MQTT - Consumption: - - <2mA@DRX=5 - + - <2mA@DRX=5 ## Include -- 1x GSM module +- 1x GSM module ## Applications - M2M industrial -- Wireless communication +- Wireless Communication - Industrial Application ## Specification @@ -120,8 +119,7 @@ Product Feature: >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) ## Example @@ -129,6 +127,8 @@ Product Feature: To get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/GSM_M6315) +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/joystick.md b/docs/en/module/joystick.md index 6954fb54..2bda1b5a 100644 --- a/docs/en/module/joystick.md +++ b/docs/en/module/joystick.md @@ -5,9 +5,9 @@ ## Description -**JOYSTICK** is a control column module. A joystick is an input device consisting of a stick that pivots on a base and reports its angle or direction to the device it is controlling. Same as ENCODER, it is compatible with FACE Kit. You can have it replace the keyboard panel inside the FACE kit. Through IIC you can get the offset data form (X, Y) axis, also the button status. You can customized the LED behavior as you like. +**JOYSTICK** is a joystick control panel compatible with the FACE kit. By pushing the joystick on the panel, you can input angle, direction and other data. Using the I2C communication protocol. It's possible to get the offset data of the joystick (X, Y coordinate) and the state of the middle button. An LED bar composed of 12 LEDs is embedded around the joystick. You can customize the luminous form of the LED light according to your needs. -JOYSTICK IIC address is 0x5E. +JOYSTICK IIC address is 0x5E by default. ## Product Features @@ -60,7 +60,7 @@ JOYSTICK IIC address is 0x5E. >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) ## PinMap @@ -119,7 +119,7 @@ void get_joystick_offset(void){ - +Last updated: 2020-12-28 \ No newline at end of file + diff --git a/docs/en/module/lego_plus.md b/docs/en/module/lego_plus.md index a941df1b..37764926 100644 --- a/docs/en/module/lego_plus.md +++ b/docs/en/module/lego_plus.md @@ -6,18 +6,16 @@ ## Description -**DC MOTOR** is build with MEGA328 and L293DD, implemented 4 driver channels. A DC power input is designed for power supplement. Through M-BUS the DC in can automaticlly power the M5 core at top.DC motor module can drive RJ12 interface encoder-motor easily and quickly, such as LEGO ev3 Motor.（This product is not affiliated with or endorsed by LEGO. LEGO is a trademark of the LEGO Group of companies） +**DC MOTOR** is built with MEGA328 and L293DD microcontrollers, implemented 4 driver channels. A DC power input is designed for power supplement. Through M-BUS the DC in can automatically power the M5 core at top. DC motor module can drive RJ12 interface encoder-motor easily and quickly, such as LEGO ev3 Motor.（This product is not affiliated with or endorsed by LEGO. LEGO is a trademark of the LEGO Group of companies） Series Communication: IIC (0x56). - - ## Product Features - DC Power input: 6-12V - DC Connector Type: XT30 (female) - 4x Motor port -- Compatible with LEGO ev3 motor +- Compatible with LEGO EV3 motor - 2x IIC GROVE port (extend PORTA from M5 Core) - L293DD: PUSH-PULL Driver Chip @@ -68,11 +66,11 @@ Series Communication: IIC (0x56). >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) ## PinMap -**Mega328 ISP**Download interface Pin foot definition +**Mega328 ISP** Download interface Pin foot definition @@ -102,6 +100,7 @@ If you want to change the firmware inside **MEGA328 chip** which has implemented +Last updated: 2020-12-28 \ No newline at end of file + diff --git a/docs/en/module/lora.md b/docs/en/module/lora.md index 57afab72..0236c40d 100644 --- a/docs/en/module/lora.md +++ b/docs/en/module/lora.md @@ -6,7 +6,7 @@ ## Description -**LoRa (433MHz)** integrated LoRa (433MHz) Module Ra-02, designed and produced by Ai-Thinker. On the board has some extra space left over, so we give you a prototyping area, it's great for adding on your customized circuit working with the LoRa (433MHz) Module. +**LoRa (433MHz)** is an integrated LoRa (433MHz) Module Ra-02, designed and produced by Ai-Thinker. On the board has some extra space left over, so we give you a prototyping area, it's great for adding on your customized circuit working with the LoRa (433MHz) Module. LoRa (433MHz) enables long-range transmissions (more than 10 km in rural areas) with low power consumption，The technology is presented in two parts: LoRa (433MHz), the physical layer and LoRaWAN (Long Range Wide Area Network), the upper layers. @@ -23,7 +23,7 @@ LoRa (433MHz) and LoRaWAN permit long-range connectivity for Internet of Things - Programmable bit rate up to 300Kbps - Build-in PCB Antenna - External Antenna port -- Program platform: Arduino, Micropython, UIFlow(Blockly) +- Program platform: Arduino, MicroPython, UIFlow (Blockly) ## Include @@ -78,7 +78,7 @@ LoRa (433MHz) and LoRaWAN permit long-range connectivity for Internet of Things >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) ## Example @@ -100,6 +100,7 @@ These are the point-to-point communication [examples](https://github.com/m5stack +Last updated: 2020-12-28 - diff --git a/docs/en/module/lora868.md b/docs/en/module/lora868.md index 1ead3571..a2bd5025 100644 --- a/docs/en/module/lora868.md +++ b/docs/en/module/lora868.md @@ -8,7 +8,9 @@ **LoRa868** is integrated with the LoRa Module Ra-01H which is designed and produced by Ai-Thinker.The board has some extra space left over, so we give you a prototyping area great for adding on your own customized circuit working with the LoRa868 Module. -LoRa enables long-range transmissions (more than 10 km in some areas) with low power consumption.The technology is presented in two parts: LoRa, the physical layer and LoRaWAN (Long Range Wide Area Network), the communication layers simillar to the OSI model. +LoRa enables long-range transmissions (more than 10 km in some areas) with low power consumption. + +The technology is presented in two parts: LoRa, the physical layer and LoRaWAN (Long Range Wide Area Network), the communication layers similar to the OSI model. LoRa and LoRaWAN permit long-range connectivity for Internet of Things (IoT) devices in various industrial applications. @@ -18,7 +20,7 @@ LoRa and LoRaWAN permit long-range connectivity for Internet of Things (IoT) dev - Communication Protocol: SPI - Universal Perfboard - Working Frequency: 803~930 MHz -- Supports FSK, GFSK, MSK, GMSK, LoRa ™ and OOK modulation modes +- Supports: FSK, GFSK, MSK, GMSK, LoRa™ and OOK modulation modes - Receive sensitivity: lowest to -141 dBm - Programmable bit rate up to 300Kbps - Built-in FPC Antenna @@ -112,6 +114,8 @@ These are the point-to-point communication [examples](https://github.com/m5stack +Last updated: 2020-12-28 + \ No newline at end of file + diff --git a/docs/en/module/lorawan.md b/docs/en/module/lorawan.md index cb0a848a..e37ef7ac 100644 --- a/docs/en/module/lorawan.md +++ b/docs/en/module/lorawan.md @@ -6,12 +6,11 @@ ## Description -**LoRaWAN** build with RHF76-052 and optional Antennas. RHF76-052 is designed by Ai-Thinker, it is a LoRaWAN ™ UART modem & compatible device, supports LoRaWAN communication. It's based on the RHF76-052 module and an embeded LoRaWAN stack. You can use M5 core as a host MCU to control this this modem with simple AT command or UART. +**LoRaWAN** built using the RHF76-052 with optional Antennas. RHF76-052 is designed by Ai-Thinker, it is a LoRaWAN ™ UART modem & compatible device, supports LoRaWAN communication. It's based on the RHF76-052 module and an embedded LoRaWAN stack. You can use M5 core as a host MCU to control this this modem with simple AT command or UART. -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 extrmely low power consuming. +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. By default, the UART configuration: "9600, 8, n, 1"(8 bits data, no parity, 1 stop bit) @@ -129,6 +128,8 @@ Press button A to clear the screen. +Last updated: 2021-01-04 + \ No newline at end of file + diff --git a/docs/en/module/lte.md b/docs/en/module/lte.md index a4bbc75e..8cc58a86 100644 --- a/docs/en/module/lte.md +++ b/docs/en/module/lte.md @@ -6,9 +6,14 @@ ## Description -This is a wireless communication module, integrated **M8321** module that released by China Mobile, provided TD-LTE/FDD-LTE/WCDMA/TD- SCDMA/GSM/GPRS/EDGE Frequency Band and LCC+LGA package type. -It has integrated plentiful Internet protocols, field standard interface, and functions, supported WindowsXP,Windows7,Windows8,Windows10,Linux and Android USB driver. -In the LTE-4G module scheme, we added more hardware resources, 1 reserved speaker solder panel, 3 LEDs, exported USB interface, double antennea allowed. +This is a wireless communication module with integrated **M8321** module that released by China Mobile, provided TD-LTE/FDD-LTE/WCDMA/TD- SCDMA/GSM/GPRS/EDGE Frequency Band and LCC+LGA package type. + +The LTE **M8321** module has plentiful of integrated Internet protocols, field standard interface and functions. + +Supported by the most popular operation systems such as WindowsXP, Windows7, Windows8, Windows10, Linux and Android USB driver. + +In the LTE-4G module scheme, we added more hardware resources, 1 reserved speaker solder panel, 3 LEDs, exported USB interface, double antenna is allowed. + M8321 is 4V power input, so in the hardware of LTE-4G module, we added a Bidirectional Voltage-Level Translator (TXS0104E), to switch the power supply to 4V. @@ -17,7 +22,7 @@ M8321 is 4V power input, so in the hardware of LTE-4G module, we added a Bidire *In telecommunication, Long-Term Evolution (LTE) is a standard for wireless broadband communication for mobile devices and data terminals, based on the GSM/EDGE and UMTS/HSPA technologies. It increases the capacity and speed using a different radio interface together with core network improvements.* -?> **M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of LTE module. Therefore, when using the LTE module with the M5Stack Fire, you might have to cut the TXD and RXD from LTE module and wire fly to another set of UART pin +> **M5Stack Fire** has occupied GPIO16 / 17 to connect with the PSRAM by default, it's conflict with TXD / RXD (GPIO16, GPIO17) of LTE module. Therefore, when using the LTE module with the M5Stack Fire, you might have to cut the TXD and RXD from LTE module and wire fly to another set of UART pin ## Product Features @@ -29,8 +34,8 @@ Product Feature: - M8321 - Tem:-40°C ~ + 85°C - Frequency Band: - - LTE-TDD：B38/B39/B40/B41 - - LTE-FDD：B1/B3/B8 + - LTE-TDD：B38/B39/B40/B41 + - LTE-FDD：B1/B3/B8 - TD-SCDMA：B34/B39 - WCDMA：B1/B8 - GSM(MHz):900/1800 @@ -41,22 +46,22 @@ Product Feature: - EDGE speed: (Kbps) 384(UL)/384(DL) - GPRS speed: (Kbps) 85.6(UL)/85.6(DL) - SMS supported PDU/TEXT mode - - Network Protocol: IPV4/IPV6/TCP/PPP/UDP/FTP/HTTP/NTP - - Comsuption: - - 17uA@Poweroff - - 3mA@Sleep + - Network Protocol: IPV4/IPV6/TCP/PPP/UDP/FTP/HTTP/NTP + - Consumption: + - 17uA@Poweroff + - 3mA@Sleep - 45mA@Idle ## Include - 1x Antenna -- 1x LTE module +- 1x LTE module ## Applications - M2M industrial -- Vehicle-mounted -- Video +- Vehicle-mounted +- Video - Security - CPE - Router @@ -118,7 +123,7 @@ Product Feature: >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) ## Example @@ -126,6 +131,8 @@ Product Feature: To get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/LTE_M8321) +Last updated: 2021-01-04 + \ No newline at end of file + diff --git a/docs/zh_CN/mpy_api/mpy_api_list.md b/docs/zh_CN/mpy_api/mpy_api_list.md new file mode 100644 index 00000000..e69de29b