From 7a3a88b3393e71e1eb3b8ba2259992066bdfdc2b Mon Sep 17 00:00:00 2001 From: LiHuashen <854410664@qq.com> Date: Sun, 5 May 2019 11:28:54 +0800 Subject: [PATCH] updated --- docs/en/accessory/cable/grove_cable.md | 11 ++--- docs/en/accessory/cable/lego_cable.md | 19 ++++----- docs/en/accessory/converter/grove_t.md | 15 ++----- docs/en/accessory/frame.md | 37 ++++++++++------- docs/en/accessory/headers_socket.md | 3 -- docs/en/base/btc_base.md | 17 +++----- docs/en/base/core_bottom.md | 9 +--- docs/en/base/lan_base.md | 22 ++++------ docs/en/base/m5go_bottom.md | 11 ++--- docs/en/base/m5go_charger.md | 2 +- docs/en/base/m5go_rfid.md | 2 +- docs/en/base/node_base.md | 34 +++++++-------- docs/en/base/plc_base.md | 15 +++---- docs/en/unit/396port.md | 23 +++++++++-- docs/en/unit/adc.md | 34 ++++++++++----- docs/en/unit/angle.md | 21 +++++++--- docs/en/unit/butterfly.md | 57 ++++++++++++++------------ docs/en/unit/button.md | 4 +- docs/en/unit/cardkb.md | 20 +++++---- docs/en/unit/catear.md | 25 ++++++----- docs/en/unit/color.md | 14 +++---- docs/en/unit/dac.md | 10 ++--- docs/en/unit/dual_button.md | 12 +++--- docs/en/unit/earth.md | 17 +++++--- docs/en/unit/env.md | 13 +++--- docs/en/unit/esp32cam.md | 50 ++++++++++++---------- docs/en/unit/extio.md | 22 +++++----- docs/en/unit/finger.md | 22 ++++++---- docs/en/unit/gps.md | 24 +++++++---- docs/en/unit/heart.md | 28 +++++++++---- docs/en/unit/hex.md | 23 +++++++---- docs/en/unit/hub.md | 12 +++--- docs/en/unit/ir.md | 21 +++++----- docs/en/unit/joystick.md | 18 ++++---- docs/en/unit/light.md | 21 +++++----- docs/en/unit/m5camera.md | 48 +++++++++++++++------- docs/en/unit/m5camera_f.md | 36 ++++++++++------ docs/en/unit/makey.md | 35 ++++++++-------- docs/en/unit/ncir.md | 18 ++++---- docs/en/unit/neoflash.md | 20 ++++++--- docs/en/unit/neopixel.md | 19 +++++---- docs/en/unit/pir.md | 16 ++++---- docs/en/unit/proto.md | 13 +++--- docs/en/unit/relay.md | 19 +++++---- docs/en/unit/rfid.md | 18 ++++---- docs/en/unit/rgb.md | 22 ++++------ docs/en/unit/rs485.md | 18 ++++---- docs/en/unit/thermal.md | 14 +++---- docs/en/unit/tof.md | 17 ++++---- docs/en/unit/trace.md | 21 ++++++---- docs/en/unit/weight.md | 48 ++++++++++++++-------- docs/ja/accessory/headers_socket.md | 21 ---------- docs/ja/accessory/usb_uart_adapter.md | 20 --------- docs/zh_CN/accessory/headers_socket.md | 4 -- docs/zh_CN/unit/heart.md | 2 +- 55 files changed, 596 insertions(+), 521 deletions(-) delete mode 100644 docs/en/accessory/headers_socket.md delete mode 100644 docs/ja/accessory/headers_socket.md delete mode 100644 docs/ja/accessory/usb_uart_adapter.md delete mode 100644 docs/zh_CN/accessory/headers_socket.md diff --git a/docs/en/accessory/cable/grove_cable.md b/docs/en/accessory/cable/grove_cable.md index 6d4770f5..361810c4 100644 --- a/docs/en/accessory/cable/grove_cable.md +++ b/docs/en/accessory/cable/grove_cable.md @@ -1,14 +1,14 @@ -# GROVE Cable {docsify-ignore-all} +# Accessory GROVE Cable {docsify-ignore-all} *** -:memo:**[Description](#Description)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Universal-4Pin-Buckled-Grove-Cable-1m-2m-50cm-20cm-10cm/3226069_32949298454.html?spm=a2g1y.12024536.productList_12432753.subject_8)** +:memo:**[Description](#Description)**       🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Universal-4Pin-Buckled-Grove-Cable-1m-2m-50cm-20cm-10cm/3226069_32949298454.html?spm=2114.12010615.8148356.2.727858fe1xja76)** ## Description -**GROVE Cable** is a data line for communication between M5Stack products. The M5Stack producte (unit, module, etc) communicates with Core through the GROVE line to the GRVOE interface. +**GROVE Cable** would be a necessary tool used on M5Stack development, since all PORTs on M5Core are GROVE stadard. This Grove cable, compatible with the GROVE port on M5Core,simply have 4 lines, two for data, one for power,and one for Ground. We've offered alternative length: 10cm, 20cm, 50cm, 1m, 2m. @@ -19,8 +19,3 @@ ## Feature - 5 specifications: 10cm, 20cm, 0.5m, 1m, 2m - - - - - diff --git a/docs/en/accessory/cable/lego_cable.md b/docs/en/accessory/cable/lego_cable.md index ef932200..8c44b050 100644 --- a/docs/en/accessory/cable/lego_cable.md +++ b/docs/en/accessory/cable/lego_cable.md @@ -1,18 +1,17 @@ -# LEGO Cable {docsify-ignore-all} +# Accessory LEGO Cable {docsify-ignore-all} + + + +*** + +:memo:**[Description](#Description)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** ## Description -**LEGO Cable** is designed for connecting GRVOE interface and LEGO, particularly, using for connecting M5Core and LEGO. +**LEGO Cable** is used for LEGO motor which is compatible with BALA and M5Module LEGO+. We have prepared different length to fit your needs on different appliactions. ## Feature - 3 specifications: 10cm, 20cm, 30cm -## Related Link - - -- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-M5Bala-ESP32-6Pin-10-20/3226069_32923086380.html)** - -
- lego_cable_01 -
\ No newline at end of file +lego_cable_01 diff --git a/docs/en/accessory/converter/grove_t.md b/docs/en/accessory/converter/grove_t.md index d8486d78..04f2f8c5 100644 --- a/docs/en/accessory/converter/grove_t.md +++ b/docs/en/accessory/converter/grove_t.md @@ -1,4 +1,4 @@ -# Grove-T {docsify-ignore-all} +# Accessory Grove-T {docsify-ignore-all} @@ -8,15 +8,8 @@ ## Description -Grove-T is a accessory used for Grove Plug converting to Two-Way Grove Socket. If you want two M5Cores to collect data from sensor class units (such as ENV unit, THERMAL unit...), you can apply it. +**Grove-T** is a T-shaped hub. Is this remind you the HUB unit ? They are basically the same thing, just in different shape.This is also used for GROVE port expanding. + +Notice: **Grove-T** is just a hardware expander, if you are looking for hardware and software(standard protocol) expander like I2C, Single-bus, please check **PaHUB** or **PbHUB**. If you connectted two I2C slave devices onto **HUB** that share the same adress, you will have problem getting I2C data from both. - - - - - - - \ No newline at end of file diff --git a/docs/en/accessory/frame.md b/docs/en/accessory/frame.md index 2e53721e..3e7d59e7 100644 --- a/docs/en/accessory/frame.md +++ b/docs/en/accessory/frame.md @@ -1,22 +1,31 @@ -# Frame {docsify-ignore-all} +# Accessory Frame {docsify-ignore-all} + + + + + +*** + +:memo:**[Description](#Description)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-FRAME-Panel-Extended-Install-Components-2-Sets/3226069_32874948519.html?spm=2114.12010615.8148356.2.558e5ef0aiDoWQ)** ## Description -Frameis designed as a fixed frame for M5Core. +**Frame** , like its namesake, is a frame for M5Core. It gives you an extra structure supporting or containing M5Core. + +## Include + +- 1x FRAME +- 4x hexagon screw KA2x4 +- 1x Allen wrench ## Related Link - [Purchase](https://www.aliexpress.com/store/product/M5Stack-2/3226069_32874948519.html) -
- frame_01 -
-
- frame_02 -
-
- frame_03 -
-
- frame_04 -
\ No newline at end of file + + +frame_03 + +frame_04 diff --git a/docs/en/accessory/headers_socket.md b/docs/en/accessory/headers_socket.md deleted file mode 100644 index 85981c63..00000000 --- a/docs/en/accessory/headers_socket.md +++ /dev/null @@ -1,3 +0,0 @@ -# Headers Socket {docsify-ignore-all} - -## (coming soom...) diff --git a/docs/en/base/btc_base.md b/docs/en/base/btc_base.md index b33d74c9..775ebcfb 100644 --- a/docs/en/base/btc_base.md +++ b/docs/en/base/btc_base.md @@ -2,28 +2,21 @@ - - *** :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-GPS-Module-with-Internal-External-Antenna-MCX-Interface-IoT-Development-Board-for/3226069_32840757048.html?spm=2114.12010615.8148356.2.7c6c2743BZthY3)** - - # Description -**BTC** is a base including DHT12 module which can detect -temperature and humidity. - -Your M5Stack Core board can stay as a small displayer(like a small TV or a small IOT central contronller) after adding this BTC Module. +**BTC** is a M5 base that allows you sit your M5 core instead of laying them down or hang on the wall. BTC is not just a sit for holding the M5 core but also comes with serveral features like temperature and humiluty detection(by DHT12), and charging base. **Note:** -* Although M5Core [BASIC](en/core/basic) or [GRAY](en/core/gray) can be attached to this base, but BTC can not charge them. Actually, our Cores, as we know, are built in chargin chip (IP5306). After plugged a USB cable in, the Core was charging without any charger. +* Although M5Core [BASIC](https://docs.m5stack.com/#/en/core/basic) or [GRAY](https://docs.m5stack.com/#/en/core/gray) can be attached to this base, but BTC can not charge them. Actually, our Cores, as we know, are built in chargin chip (IP5306). After plugged a USB cable in, the Core was charging without any charger. -* Once M5Core has been attached to BTC, it can not controll ENV Unit at this time. Because BTC has been built in DHT12 sensor which will cause IIC address conflit. +* Once M5Core has been attached to BTC, it can not controll ENV Unit at this time. Because BTC has been built in DHT12 sensor which will cause IIC address conflict. -# Feature +### Product Features - DHT12 inside @@ -57,7 +50,7 @@ Your M5Stack Core board can stay as a small displayer(like a small TV or a small ### Arduino IDE -*If you want the code `BTC.ino`, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/BTC/Arduino).* +*To get the code `BTC.ino`, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Base/BTC/Arduino).* ```arduino #include diff --git a/docs/en/base/core_bottom.md b/docs/en/base/core_bottom.md index c5177faa..c5bbd2fe 100644 --- a/docs/en/base/core_bottom.md +++ b/docs/en/base/core_bottom.md @@ -6,11 +6,9 @@ :memo:**[Description](#Description)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Battery-Bottom-150mAh-for-M5Stack-Arduino-ESP32-IoT-Development-Kit-I-O-IO-Extend/3226069_32970683235.html?spm=a2g1y.12024536.productList_5885013.subject_2)** - - ## Description -**Core BOTTOM** is a base of [M5Core BASIC](en/core/basic) kit and [M5Core GRAY](en/core/gray) kit. This base has extended part of the interface of M-Bus in the form of pin headers and female headers so that you can connect other devices more conveniently. +**Core BOTTOM** is the bottom part of M5Core like M5Basic and M5 GRAY, with M-BUS socket and extend pins on the side, also include a Lipo battery . If you want to buy these bottoms separately, you can get it from here. @@ -18,9 +16,4 @@ M_BUS - - diff --git a/docs/en/base/lan_base.md b/docs/en/base/lan_base.md index e59537ad..500fa5e5 100644 --- a/docs/en/base/lan_base.md +++ b/docs/en/base/lan_base.md @@ -1,4 +1,4 @@ -# LAN Base {docsify-ignore-all} +# Base LAN {docsify-ignore-all} @@ -8,27 +8,23 @@ ## Description -**LAN Base** is base with integrated Ethernet chip W5500 and network interface. It meets the needs of M5Core access to wired networks. +Although M5 core is ESP32-based, having Wi-Fi and Bluetooth intergrated, it doesn't stop you enable the Ethernet function. This **LAN** is a M5 Base that having a W5500 chip, which is a Hardwired TCP/IP embedded Ethernet controller that provides easier Internet connection to embedded systems. This Base is speciffically design for industrial application scenarioes, comes with couple of HT3.96 connectors, 485(?) metal rail and magnet discs for easy installation and fixation. -Because M5Core integrates wireless WIFI, but there is no network interface, if you need to let M5Core access the wired network to work, then the LAN base is just right. +The 6 pin of HT3.96 connector are dangling, you can wired them up with the M-BUS and other circult as you like. -The LAN base is also equipped with metal rails and magnet discs for easy installation of the LAN to the wall or iron frame. - -The orange HT3.96 terminal on the LAN base, this interface is not yet electrically connected, and each of its pins can be connected to any pin on the M-Bus bus. - -**The figure below shows the inside of the LAN** +**The figure below shows the inner of LAN** -If you need to implement RS485 communication, then use the matching pin header and TLL-to-RS485 function board to solder to the LAN base, you can realize RS485 interface, so you can communicate with RS485 device through the above HT3.96 terminal. +If you need to add RS485 interface, soldering the RS485 board onto the mian board pin correspondingly. **TTL-to-RS485 adapter board and LAN base** -**The figure below shows how the TTL-to-RS485 adapter board can be combined with the LAN backplane** +**The figure below tells you how the TTL-to-RS485 adapter board connected onto LAN backplane** -*The RS485 small board is soldered to the LAN backplane. The serial port pins on the small board will be connected to the GPIO16 and GPIO17 of the LAN backplane.* +*The serial port pins on the RS485 board will be connected to the GPIO16 and GPIO17 of the LAN backplane.* @@ -49,11 +45,11 @@ If you need to implement RS485 communication, then use the matching pin header a -## Feature +### Product Features - Input Supply Voltage: 9-24V - HT3.96 port for supporting RS485 -- Support RS485 communication, control RS485 device +- Support RS485 communication - Easy to fixed on the wall ## Include diff --git a/docs/en/base/m5go_bottom.md b/docs/en/base/m5go_bottom.md index 92b08d3b..dbc16108 100644 --- a/docs/en/base/m5go_bottom.md +++ b/docs/en/base/m5go_bottom.md @@ -8,9 +8,9 @@ ## Description -**M5GO BOTTOM** is a normal base of [M5GO Lite](en/core/m5go_lite), [M5GO IOT Starter Kit](en/core/m5go) or [M5Fire](en/core/fire). +**M5GO BOTTOM** is apparently the bottom part of M5GO which is a upgrade of basic bottoms, with a larger battery, LOGO-compatilble holes, MICPHONE, LED Bar , two more GROVE PORT，and more. -M5GO Base is composed of battery(600mAh), M-Bus interface, charging indicator(red led), two RGB Bar, PORT B and PORT C. +**M5GO BOTTOM** is the same Bottom of [M5GO Lite](https://docs.m5stack.com/#/en/core/m5go_lite), [M5GO IoT Kit](https://docs.m5stack.com/#/en/core/m5go) and [M5Fire](https://docs.m5stack.com/#/en/core/fire). ## PinMap @@ -55,14 +55,15 @@ M5GO Base is composed of battery(600mAh), M-Bus interface, charging indicator(re M_BUS -## Related Link - -- **[M5GO IOT Starter Kit Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** +## Related Link + +- **[M5GO IOT Starter Kit Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.2.52385ab04i7vIu)** + ## Schematic diff --git a/docs/en/base/m5go_charger.md b/docs/en/base/m5go_charger.md index 1c84475e..b082022f 100644 --- a/docs/en/base/m5go_charger.md +++ b/docs/en/base/m5go_charger.md @@ -8,7 +8,7 @@ ## Description -**M5GO CHARGER** is a charging base for [M5GO Lite](en/core/m5go_lite) kit and [M5GO IOT Starter Kit](en/core/m5go) kit. Certainly, it is also the charging base of [M5Fire](en/core/fire) kit. +**M5GO CHARGER** is a charger base for [M5GO Lite](https://docs.m5stack.com/#/en/core/m5go_lite) kit and [M5GO IOT Kit](https://docs.m5stack.com/#/en/core/m5go_lite) and [FIRE](https://docs.m5stack.com/#/en/core/m5go_lite). diff --git a/docs/en/base/m5go_rfid.md b/docs/en/base/m5go_rfid.md index 5b9bccfc..4b4a43a0 100644 --- a/docs/en/base/m5go_rfid.md +++ b/docs/en/base/m5go_rfid.md @@ -10,7 +10,7 @@ ## Description -**M5GO RFID** is a upgraded version base of [M5GO BOTTOM](en/base/m5go_bottom). Comparing to the normal version ([M5GO Bottom](en/base/m5go_bottom)), M5GO RFID owns **RFID function** and **IR transmitter**, **miss maget**. And it's battery capacity is only **330 mAh**. +**M5GO RFID** is a upgraded version base of [M5GO BOTTOM](en/base/m5go_bottom). Comparing to the normal version ([M5GO Bottom](en/base/m5go_bottom)), M5GO RFID owns **RFID function** and **IR transmitter**, **miss maget**. And it's battery capacity is only **330 mAh**. M5GO Base is composed of battery(330mAh), M-Bus interface, charging indicator(red led), **RFID coil**, **IR transmitter**, two RGB Bar, PORT B and PORT C. diff --git a/docs/en/base/node_base.md b/docs/en/base/node_base.md index af477c84..07b8630d 100644 --- a/docs/en/base/node_base.md +++ b/docs/en/base/node_base.md @@ -1,4 +1,4 @@ -# Node Base {docsify-ignore-all} +# Base Node {docsify-ignore-all} @@ -8,26 +8,28 @@ ## Description -**Node** is a node/base station class base in an IoT scenario. +**Node**, like its namesake, is a smart node with full-featured functions in a IoT application scenarios. It can be program as a intelligent speaker like Echo. Node provides more hardware resources: built-in high-fidelity audio codec chip，MIC, DHT12, IR emitter ... -Install Node on the wall and stack any M5Core. At this time, Node + M5Core is an intelligent node that can communicate with many nearby nodes or terminal devices. You can use the terminal remote control to control remote devices through Node forwarding signals. Realize the interconnection of multiple intelligent terminals. Speech recognition can also be implemented. +ESP32 provides an Audio Develope Platform called ESP-ADF. +ESP-ADF supports development of audio applications for the Espressif Systems ESP32 chip in the most comprehensive way. With ESP-ADF, you can easily add features, develop audio applications from simple to complex: -* Including 12 RGBs and one temperature and humidity sensor(DHT12), it means Node can display its own status and perception surrounding environment. -* There are 4 IR Transmitter LED at four corners and two IR Receiver -* There are two MIC -* A Codec chip(WM8978) inside that is often used to be applied for Hi-Fi Speaker. +- Music player or recorder supports audio formats such as MP3, AAC, FLAC, WAV, OGG, AMR, TS, EQ, Downmixer, Sonic, G.711, SPEEX ... +- Play music from sources: HTTP, HLS(HTTP Live Streaming), SPIFFS, SDCARD, A2DP-Source, A2DP-Sink, HFP ... +- Integrate Media services such as: DLNA, WeChat ... +Internet Radio +- Voice recognition and integration with online services such as Alexa, DuerOS, and more. + +##Product Feature + +* 1x 12 RGBs +* 1x temperature & humidity sensor(DHT12),which can display its own status and perception surrounding environment. +* 4x IR Transmitter LEDs at four corners and 2x IR Receivers +* 2x MIC +- 1x HiFi stereo codec chip ( Up to 24bit DAC ) +- 1x 500mAh lithium battery -You can use the M5Core and Node to implement infrared remote control application. Because of the built-in high-fidelity audio codec chip, you can even implement smart speaker functions. - -## Feature - -- Built-in infrared transmission and infrared receiver -- Built-in 12 RGBLed and DHT12 sensor -- Built-in a HiFi stereo codec chip ( Up to 24bit DAC ) -- Built-in a 500mAh lithium battery - ## PinMap diff --git a/docs/en/base/plc_base.md b/docs/en/base/plc_base.md index 8b69b44b..e090fcef 100644 --- a/docs/en/base/plc_base.md +++ b/docs/en/base/plc_base.md @@ -1,4 +1,4 @@ -# PLC-Base {docsify-ignore-all} +# Base PLC {docsify-ignore-all} @@ -8,13 +8,15 @@ ## Description -**PLC** is a Base for an industrial application. This base has power conversion and TTL level to RS485 level function so that you can realize 9-24V voltage application with it. Realize TTL level to RS485 level output function after soldering the RS485 adapter board to this base core board. +**PLC** is a Base specifically design for industrial application. DC Power in 9-24V. +Does this PLC remind you of the 'PLC' in industrial controll short for 'Programmable Logic Controller'. This PLC base is not the typical 'PLC' used in programmable controller, but its does able to implement the most common controller in industrial field. Based on the current M5 development system, you can add as many Realys as you want, you can enable the TTL-RS485 communication, you can layout your customized circult on the protoboard. you also can make it an LoRa node by stacking a LoRa module etc. This base gives you unlimited number of combinations, it is powerful, flexiable, and covered with industrial-grade case. If you're happen to working in an industrial field, We especially recommend this PLC base to you which will surely give you the best and the most fast way to resolve your requirement. **The current sensor (ACS712TELC-05B)** is also integrated on **the RS485 adapter board** for current monitoring. -The following picture shows this base core board and the RS485 conversion board. You can connect the specified pin on the M-Bus bus to the 6 Pin 3.96H terminal on the right by soldering the wire. And It is also possible to solder the RS485 converter board to the lower right of the core board to achieve serial port 2 (UART2) to RS485 level. The RS485 output interface is the 4 Pin 3.96H terminal block below the core board. +If you need to add RS485 interface, soldering the RS485 board onto the mian board pin correspondingly. +*The serial port pins on the RS485 board will be connected to the GPIO16 and GPIO17 of the LAN backplane.* @@ -39,13 +41,6 @@ The following picture shows this base core board and the RS485 conversion board. - - ## Related Link - **[Offical Video](https://www.youtube.com/channel/UCozgFVglWYQXbvTmGyS739w)** diff --git a/docs/en/unit/396port.md b/docs/en/unit/396port.md index abc92af7..d40b8d2f 100644 --- a/docs/en/unit/396port.md +++ b/docs/en/unit/396port.md @@ -8,19 +8,34 @@ ## Description -**3.96port** is a unit that aim to transfer GROVE interface to VH3.96-4Pin. If you want to connect the VH3.96-4Pin interface device as shown below, it is better to use this unit. +**3.96port** a GROVE-to-VH3.96 interface convertor. +The HT3.96 piece is 4 pins. +HT3.96 is classed as Pluggable System Terminal Block catelog. + +Terminal blocks are used to secure and/or terminate wires and, in their simplest form, consist of several individual terminals arranged in a long strip. Terminals are useful for connecting wiring to a ground or, in the case of electrical power, for connecting electrical switches and outlets to the mains -## Feature +## Product Features -- VH3.96 interface -- Two Lego installation holes +- 1x HT3.96 connector(4 pins) +- 2x Lego cpmpatible holes + +### Connector Specifications + +- Type: Plug, Female Sockets +- Number of Positions: 6 +- Positions Per Level: 6 +- Number of Levels: 1 +- Pitch: 0.156"（3.96mm） +- Header Orientation: - +- Mounting Type: Free-hanging ## Include - 1x 396PORT Unit - 1x Grove Cable +- 1x HT3.96 Male Socket ## Related Link diff --git a/docs/en/unit/adc.md b/docs/en/unit/adc.md index 26aedc33..3349ab9c 100644 --- a/docs/en/unit/adc.md +++ b/docs/en/unit/adc.md @@ -8,16 +8,29 @@ ## Description -**ADC** is a unit having self-calibrating function and 16bit analog-to-digitial coverter. The resolution is double than insided ADC of esp32, that means you can detect smaller amplitude voltage. The unit communicates with M5Core with I2C (I2C address is 0x48). It has provided two modes: continuously conversion and single conversion. +**ADC** integrated with ADS1100 which is a fully differential, 16-bit, self-calibrating,delta-sigma A/D converter. +It communicates through an I2C interface,which means you can collect AD data thru PortA on M5 core from this unit to enhence your A/D performance. -## Feature +The I2C address is 0x48. -- Up to 16 bits of resolution and perform conversions at rates of 8, 16, 32, or 128 samples per second -- Bult in programmable gain amplifier, thereby collecting analog signals with smaller amplitudes - - Gain = 1, 2, 4, OR 8 -- Detect 0~12V voltage Input -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +### Product Specification + +- COMPLETE DATA ACQUISITION SYSTEM IN A + TINY SOT23-6 PACKAGE +- 16-BITS NO MISSING CODES +- INL: 0.0125% of FSR MAX +- CONTINUOUS SELF-CALIBRATION +- SINGLE-CYCLE CONVERSION +- PROGRAMMABLE GAIN AMPLIFIER +GAIN = 1, 2, 4, OR 8 +- LOW NOISE: 4µVp-p +- PROGRAMMABLE DATA RATE: 8SPS to 128SPS +- INTERNAL SYSTEM CLOCK +- I2CTM INTERFACE +- POWER SUPPLY: 2.7V to 5.5V +- LOW CURRENT CONSUMPTION: 90µA +- AVAILABLE IN EIGHT DIFFERENT ADDRESSES +- Two Lego-compatible holes ## APPLICATION @@ -27,8 +40,9 @@ ## Include -- 1x ADC Unit -- 1x Grove Cable +- 1x ADC unit +- 1x GROVE Cable +- 1x HT3.96 Male Socket(2 pins) ## Related Link diff --git a/docs/en/unit/angle.md b/docs/en/unit/angle.md index a9815086..eb8c68dc 100644 --- a/docs/en/unit/angle.md +++ b/docs/en/unit/angle.md @@ -8,17 +8,28 @@ ## Description -**ANGLE** is a Unit with the highest resistance of **10K** potentiometer. The potentiometer is a resistance element having three terminals and the resistance value can be adjusted by the knob rotation. Each time the potentiometer is rotated to a different position, the Unit outputs a different voltage value named Uo. It can be used to adjust motor speed, LED brightness and more. The specific analysis is shown in the figure below. +**ANGLE** is a rotary switch Unit,simply having a **10K** potentiometer inside. This unit can be used for Continuous singal control, such as volume, brightness, or motor speed. + +A potentiometer is a manually adjustable, variable resistor with three terminals. Two terminals are connected to a resistive element, the third terminal is connected to an adjustable wiper. The position of the wiper determines the output voltage. +The out voltage is captured and converted by AD on ESP32 on portB. + + +*In M5Stack product system, Normally the Grove color indicates the type of communications.* +- Black: Single BUS (AD ,DA ,GPIO) +- Red: I2C +- Blue：Uart +- White： Others(depends) + The Unit's Grove interface is black, indicating an analog interface that needs to be connected to the M5Core's GROVE B interface. -## Feature +## Product Features - Output voltage range: 0 ~ 2500mV - GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Two Lego-compatible holes ## Include @@ -35,9 +46,9 @@ The Unit's Grove interface is black, indicating an analog interface that needs t ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino).* +*The code below is incomplete. To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ANGLE/Arduino).* -Example function: Display the digital quantity corresponding to the Unit output voltage value on the screen, the range is 0 ~ 4095 +Example function: Display the digital value converted from the Unit output voltage (0 ~ 4095) ```arduino #include diff --git a/docs/en/unit/butterfly.md b/docs/en/unit/butterfly.md index c622cf40..fc3f3d72 100644 --- a/docs/en/unit/butterfly.md +++ b/docs/en/unit/butterfly.md @@ -1,4 +1,4 @@ -# BUTTERFLY {docsify-ignore-all} +# Unit BUTTERFLY {docsify-ignore-all} @@ -8,36 +8,39 @@ ## Description -**BUTTERFLY** is a butterfly model driven by Servo Motor. When servo turn to **0 degree**, "butterfly" will be locked; When servo turns to **30 degree**, "butterfly" will be released and fly out. - - - -## Assembly - -Before "butterfly" fly out, we need assemble it. First, burn this [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTERFLY/UIFlow) into Core, then connect Core with Launcher through GROVE cable and Grove2Pin converter so that you can control the Lanuncher(Servo Motor) through the Core. - - - - - -Assemble "butterfly", control the Servo Motor to **30 degree**, then bind "butterfly" to the Lanuncher, and control the Servo Motor to **0 degree** for locking "butterfly". - - - - - - - -## Related Video - -**Assembly of BUTTERFLY** +**BUTTERFLY** is a butterfly model launcher, that allows you to lauch a butterfly model to the air. The launcher is implmented by 1 servo and a plastic seat. This set can be placed on dress at fashion show or anywhere you want decorate with some flying bufferflies. +To set the butterfly model you need to tight up the rubber band by rotate the model at one end and fixed the other end. Put the tighten-up butterfly at the bottom the launcher. Now everything is ready to go. +For more infomation please check out the video. -**Demonstration of BUTTERFLY** - \ No newline at end of file + + +## Product Features + +- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) + +## Steps + +1, download this [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTERFLY/UIFlow) into Core. +2, Wire the Core with Launcher by GROVE cable and Grove2Pin converter +Now that you can control the Lanuncher(Servo Motor) through the Core. + + + + + +to realse "butterfly", program the Servo Motor to rotate **30 degree** +to lock it, program the Servo Motor to **0 degree**, + + + + + + + + diff --git a/docs/en/unit/button.md b/docs/en/unit/button.md index d610b469..4c560659 100644 --- a/docs/en/unit/button.md +++ b/docs/en/unit/button.md @@ -8,7 +8,7 @@ ## Description -**BUTTON** is a single momentary push button Unit. It contains one independent "momentary on/off" button. “Momentary” means that the button rebounds on its own after it is released. The button outputs a LOW signal when pressed, and HIGH when released. The Btn stands for signal while NC stands for not used at all. +**BUTTON** is a single button Unit. The button status can be detected by the input pin status,simply capture the high/low electrical level. **As shown in the figure below:** @@ -45,7 +45,7 @@ This unit communicates with M5Core through GROVE B port. ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/Arduino).* +*The code below is incomplete(just for usage). To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/BUTTON/Arduino).* ```arduino #include diff --git a/docs/en/unit/cardkb.md b/docs/en/unit/cardkb.md index 71de03f7..db9505b7 100644 --- a/docs/en/unit/cardkb.md +++ b/docs/en/unit/cardkb.md @@ -8,7 +8,9 @@ ## Description -**CardKB** is a unit can achieve QWERTY full keyboard. It also can achieve button combination(Sym+Key, Shift+Key, Fn+Key) and output richer key value. This unit communicates with M5Core through GROVE A port(IIC interface), and it's IIC address is 0x5F. +**CardKB** is a unit can implement a full-featured QWERTY keyboard. Consider that you want make some cool stuff that require keyboard typing and interaction, but M5 core it self just have 3 buttons, here comes the flexible and powerful CardKB unit. + +It also can achieve button combination(Sym+Key, Shift+Key, Fn+Key) and output richer key value. This unit communicates with M5Core through GROVE A port(IIC interface). Address is 0x5F. **1. Button combination description:** @@ -22,11 +24,11 @@ -## Feature +## Product Features -- GROVE interface, IIC communication - -- Full keyboard function, multi-key combination +- Full-function keyboard, multi-key combination +- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego compatible holes ## Include @@ -43,13 +45,13 @@ - **[Forum](http://forum.m5stack.com/)** -- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/firmware_328p/CardKeyBoard)** +- **[CardKB Firmware](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/firmware_328p/CardKeyBoard)** ## Example ### 1. Arduino IDE -*If you want the example code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/Arduino)。* +*To get the code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/Arduino)。* ```arduino #include @@ -87,11 +89,11 @@ void loop() } ``` - + ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/UIFlow)。* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CARDKB/UIFlow)。* diff --git a/docs/en/unit/catear.md b/docs/en/unit/catear.md index c06fc7a6..12d33962 100644 --- a/docs/en/unit/catear.md +++ b/docs/en/unit/catear.md @@ -1,4 +1,4 @@ -# CATEAR {docsify-ignore-all} +# Unit CATEAR {docsify-ignore-all} @@ -8,12 +8,17 @@ ## Description -**CATEAR** is a cat ear shaped Neopixel bar built in 118 RGB LEDs. It can be connected to GROVE A, B or C on M5Core. +**CATEAR** is a cat ear headband made by 118 Neopixels. Neopixels are smart RGB LEDs. Each one can be programmed and display any color. It is also allowed to set the brightness , lighting-up flow and Blink-mode. +If you want be standout in a party, at Halloween, why not get this good to add on some excellent lighting effects on your outfit. -## Feature +It can be programmed by any type of M5 core. Connected with Grove port. +Alternative Port: A, B, C -- The number of RGB: 118 -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +## Product Features + +- Neopixel quantity: 118 +- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego-compatible holes ## Include @@ -26,21 +31,21 @@ - **[Forum](http://forum.m5stack.com/)** +Arduino Library realted to Neopixel driving: + - **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)** - **[FastLED Reference(Chinese version)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)** ## Example - - ### UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CATEAR/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/CATEAR/UIFlow).* -### PinMap +## PinMap **If CATEAR was connected to GROVE A** @@ -57,7 +62,7 @@
**If CATEAR was connected to GROVE C** -\ + diff --git a/docs/en/unit/color.md b/docs/en/unit/color.md index 7b205f56..2947e071 100644 --- a/docs/en/unit/color.md +++ b/docs/en/unit/color.md @@ -8,7 +8,7 @@ ## Description -**COLOR** is color recognition unit with integrated **TCS3472** chip. +**COLOR** is color recognition unit integrated **TCS3472**. Like its namesake, **COLOR** is able to detect color value and return RGB data to the host. **Identify color principle:** @@ -28,13 +28,13 @@ When we get coordinates (x, y), please reference the below figure so as to get t -This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x29. +This Unit communicates with the M5Core via the GROVE A interface(I2C). Address is 0x29. -## Feature +## Product Features -- Detection range: -40℃~85℃ -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Detection range: -40℃~85℃ +- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego-compatible holes ## Include @@ -58,7 +58,7 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino).* +*The code below is incomplete. To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/COLOR/Arduino).* ```arduino /* diff --git a/docs/en/unit/dac.md b/docs/en/unit/dac.md index 7e46c535..dc2ed644 100644 --- a/docs/en/unit/dac.md +++ b/docs/en/unit/dac.md @@ -6,18 +6,16 @@ :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-DAC-Unit-MCP4725-I2C-DAC-Converter-Breakout-Module-Digital-to-Analog-12-Bits-0V/3226069_32947696641.html?spm=a2g1x.12024536.productList_5885013.pic_6)** - - ## Description **DAC** is a unit can convert digital signal to analog signal like voltage waveform, audio waveform and so on. It integrates a 12-bit high resolution DAC chip named **MCP4725** which integrates a on-board non-volatile memory (EEPROM). The unit comunicates with M5Core with I2C. The DAC input and configuration data can be programmed to the EEPROM. I2C address is 0x60. -## Feature +## Product Features - Up to 12 bits of resolution - Output 0~3.3V voltage - -- Two Lego installation holes + GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego-compatible holes ## Include @@ -41,7 +39,7 @@ ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DAC/Arduino).* +*The code below is incomplete(just for usage). To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DAC/Arduino).* ```arduino /* diff --git a/docs/en/unit/dual_button.md b/docs/en/unit/dual_button.md index 8d188e17..19282bf0 100644 --- a/docs/en/unit/dual_button.md +++ b/docs/en/unit/dual_button.md @@ -8,9 +8,9 @@ ## Description -**Dual Button** is a unit built-in two momentary push buttons. It contains two independent "momentary on/off" buttons. “Momentary” means that the button rebounds on its own after it is released. The button pressed outputs a LOW signal when pressed, and HIGH when released. The GPIO36 pin outputs the level signal of Button A (blue button), and the GPIO26 (red button) pin outputs the level signal of Button B. +**Dual Button**, as its namesake, has two buttons with different color. If the Button unit is not enough, how about double it up to a pair. They share the exact same mechanism, button status can be detected by the input pin status,simply capture the high/low electrical level. -**Output status:** +This unit communicates with M5Core through GROVE B port. @@ -18,10 +18,10 @@ -## Feature +## Product Features - GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Two Lego-compatible holes ## Include @@ -43,7 +43,7 @@ ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/Arduino).* +*The code below is incomplete(just for usage). TO get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/Arduino).* ```arduino #include @@ -65,7 +65,7 @@ M5.update(); ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/DUAL_BUTTON/UIFlow).* diff --git a/docs/en/unit/earth.md b/docs/en/unit/earth.md index 2716ecc5..2873733a 100644 --- a/docs/en/unit/earth.md +++ b/docs/en/unit/earth.md @@ -8,17 +8,22 @@ ## Description -**EARTH** is a moisture detective unit for measuring the moisture in soil. The soil moisture sensor is pretty straight forward to use. The two large exp osed pads function as probes for the sensor, together acting as a variable resistor. The more water that is in the soil means the better the conductivity between the pads will be and will result in a lower resistance, and a higher SIG out. -You can read the moisture in soil staright or get a digital signal(0/1) that means the high(or low) humidity. +**EARTH** unit is a Soil Moisture Sensor for measuring the moisture in soil and similar materials. + +The soil moisture sensor is pretty straight forward to use. The two large exposed pads function as probes for the sensor, together acting as a variable resistor. The higher moisture that is in the soil means the better the conductivity between the two so that the sensor will result in a lower resistance, and a higher SIG out. + +You can read the moisture in soil by ADC. +Inside this Unit we put an extra potentiometers to +change the measurement range. -## Feature +## Product Features - Adjustable threshold, including 10K adjustable resistor - Analog & Digital output - GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Two Lego-compatible holes ## Include @@ -39,7 +44,7 @@ You can read the moisture in soil staright or get a digital signal(0/1) that mea ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino).* +*The code below is incomplete. To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/Arduino).* ```arduino #include @@ -63,7 +68,7 @@ void loop() { ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EARTH/UIFlow).* diff --git a/docs/en/unit/env.md b/docs/en/unit/env.md index 9e5019fe..8f966447 100644 --- a/docs/en/unit/env.md +++ b/docs/en/unit/env.md @@ -9,9 +9,10 @@ ## Description -**ENV** is a environment sensor for M5GO that can easily detect -temperature, humidity and air pressure with M5GO Core, including -temperature and humidity sensor and absolute barometric pressure sensor. Connect to GRVE A of M5Core. +**ENV** is a environment sensor, can be used for temperature, humidity, and atmospheric pressure measurement. Build with DHT12 and BMP280. + +DHT12 is a upgradation version of DHT11 humidity temperature sensor, fully downward compatible, more precise and add I2C interface. +BMP280 is an absolute barometric pressure sensor especially designed for mobile applications, offers highest flexibility to optimize the device regarding power consumption, resolution and filter performance. ## Feature @@ -42,9 +43,11 @@ temperature and humidity sensor and absolute barometric pressure sensor. Connect ### 1. Arduino IDE -This is a ENV example for reading temperature, humidity and atmospheric pressure. But before compiling this program, please install `Adafruit BMP280 Library` and copy `Adafruit_Sensor.h` to `C:\Users\\Documents\Arduino\libraries\Adafruit_BMP280_Library` first. +This is a ENV example, implemented reading temperature, humidity and atmospheric pressure function. +1, Before compiling, please install `Adafruit BMP280 Library` +2, copy `Adafruit_Sensor.h` to `C:\Users\\Documents\Arduino\libraries\Adafruit_BMP280_Library` -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ENV).* +*The code below is incomplete. To get the complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ENV).* ```arduino /* diff --git a/docs/en/unit/esp32cam.md b/docs/en/unit/esp32cam.md index e9ff07ba..fca9346d 100644 --- a/docs/en/unit/esp32cam.md +++ b/docs/en/unit/esp32cam.md @@ -1,4 +1,4 @@ -# ESP32CAM - Normal Lens (noPSRAM) {docsify-ignore-all} +# Unit ESP32CAM {docsify-ignore-all} @@ -8,9 +8,25 @@ ## Description -**ESP32Cam** is a camera unit based on ESP32 chip and OV2640. You can even program it through ESP-IDF. But to compare with [M5Camera](m5camera.md), ESP32CAM does not integrates PSRAM. +**ESP32CAM** is a development board for image recognition. It features an ESP32(4M Flash + 520K RAM) chip and 2-Megapixel carmera(OV2640). It also supports image transmission via Wi-Fi and debuging through USB Type-C port. -This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and humidity pressure sensor (BME280) and **analog MIC (SPQ2410)**. If you need those devices, you can Self-weld them or purchase those version thraightly. Additionally, M5CameraF also reserves the weld of battery. +The hardware comes preloaded software, programmed by ESP-IDF. It is an application to run Wi-Fi camera. The output image is size 600*800, since it's 2-Maga camera, you sure can optimize the software to output the maximum size of photos. + +what this software can do? +- Power the board via USB type-C or GROVE +- Use your phone to Wi-Fi scan an AP name start with 'm5stack-' and click to connect this AP. +- Open up web browser on your phone and visit 192.168.4.1 +- Then here comes the picture. Video is about 5-6 frames per senconds. not super fast. + +The hardware also comes with some reserved weld pad, just in case you want put these chips back on board. +- 9-axis gyroscope (MPU6050) +- pressure sensor (BME280) +- **analog MIC (SPQ2410)** +- Battery socket + +**ESP32CAM** is the most popular pattern among the M5 camera series so far. If you need more storage please check M5Camera. If you need fisheye lens, please check M5CameraF. + + **Note: ESP32CAM is named differently when different hardware is selected. They follow the rules below.** @@ -20,16 +36,12 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h * If also configured with microphone, will be named ESP32CAM_6050_MIC * If also configured with BME280, will be named ESP32CAM_6050_MIC_BME280 - - -Because the module can generate WIFI hotspot AP, So you can use your mobile phone, PC or other device to get the camera image wirelessly via WIFI, or wirely via GRVOE interface. - -## Feature +## Product Features - ESP32 specifications + Dual-core Tensilica LX6 microprocessor + Up to 240MHz clock frequency - + **512KB internal RAM** + + **520KB internal RAM** + **4MB Flash memory** + Integrated 802.11 BGN WiFi transceiver + Integrated dual-mode Bluetooth (classic and BLE) @@ -48,8 +60,8 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon - Scan Mode: Progressive - Camera specifications + Field of View : **65 degree** - + Maxmium Pixel: 200M pixels (Because of the small RAM, the board can't obtain it. It can output images up to 800*600 JPEG.) -- 尺寸：20.5 × 46.5 × 11.5mm + + Maxmium Pixel: 2M +- Size: 20.5 × 46.5 × 11.5mm ## Include @@ -95,7 +107,7 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon | :-----------: | :--------: | | LED_Pin | IO16 | -**reserved chip interfaces** +**reserved chip interfaces** **BME280 Interface** @@ -122,15 +134,15 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon | :-----------: | :------: | | OUT | IO32 | -**NOTE:** +**NOTE:** 1. **Camera Power Down** pin does not need to be connected to ESP32 GPIO. Instead it may be pulled down to ground with 10 kOhm resistor. -2. We have several kinds of camera boards, the following figures show the main differece with them. +2. We have several patterns of camera board, the following figures shows the main differece - If you want to **view** the detailed defference with them, please click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). + **view** click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). - If you want to **download** the detailed defference with them, please click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). + **download** click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). @@ -142,18 +154,12 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - - ## Code ### Firmware - **[ESP32CAM Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/NoPsram)** - - ## Related Video **ESP32CAM Case - 01** diff --git a/docs/en/unit/extio.md b/docs/en/unit/extio.md index e65b2ed5..d3bea19b 100644 --- a/docs/en/unit/extio.md +++ b/docs/en/unit/extio.md @@ -1,4 +1,4 @@ -# EXT.IO {docsify-ignore-all} +# Unit EXT.IO {docsify-ignore-all} @@ -6,19 +6,21 @@ :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://pt.aliexpress.com/store/product/M5Stack-Official-Extend-Serial-IO-I-O-Unit-Grove-Cable-I2C-Interface-for-Arduino-Blockly-ESP32/3226069_32966582585.html?spm=a2g03.12010615.8148356.48.3b773d71o7oNY1)** - - ## Description -**EXT.IO** is a unit used to expand I/O port. It integrates PCA9554PW that can achieve two I/O pins expand to 8 bits of General Purpose parallel Input/Output(GPIO). +**EXT.IO** is a GOIO Expander. With simple I2C commands you can have up to 8 GPIOs. -This unit connects to GRVOE A interface on M5Core, and it communicates with M5Core through IIC(the IIC address is 0x27). +Integrates PCA9554PW. This 8-bit I/O expander for the two-line bidirectionalbus (I2C) is designed for 2.3-V to 5.5-V VCC • Open-Drain Active-Low Interrupt Output operation. It provides general-purpose remote I/O expansion for most microcontroller families via the I2C interface. -## Feature +IIC address: 0x27. + +It’s difficult to foresee the needs of your project from the start. EXT.IO is the perfect solution for expanding the number of IO. It allows you to add new features, logic,timing and sensing to alrady highly integrated designs. + +## Product Features - Expanded I/O number: 8 -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Two Lego-compatible holes ## Include @@ -37,7 +39,7 @@ This unit connects to GRVOE A interface on M5Core, and it communicates with M5Co ### 1. Arduino IDE -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EXTIO/Arduino)。* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EXTIO/Arduino)。* ```arduino /* @@ -82,7 +84,7 @@ Serial.println(ioCon1.digitalWritePort0(0x00)); ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EXTIO/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/EXTIO/UIFlow).* diff --git a/docs/en/unit/finger.md b/docs/en/unit/finger.md index 027d6773..85173c78 100644 --- a/docs/en/unit/finger.md +++ b/docs/en/unit/finger.md @@ -6,17 +6,21 @@ :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://pt.aliexpress.com/store/product/M5Stack-Official-Finger-Print-Unit-FPC1020A-Capacitive-Fingerprint-Identification-Module-Grove-Cable-UART-Interface-for-ESP32/3226069_32966642182.html?spm=a2g03.12010612.8148356.36.73ee56a05T9uR7)**      :clapper:**[Related Video](#Related-Video)** - - ## Description -**FINGER** is a fingerprint recognition unit. The unit integrates the **FPC1020A** capacitive fingerprint recognition module and Fingerprint recognition algorithm chip. It can realize fingerprint information entry, 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. +**FINGER** Unit is a fingerprint sensor. This all-in-one fingerprint sensor makes fingerprint adding,verification,mananging super simple. -**It's serial communication(UART Interface) between FINGER and M5Core.** +Uart protocol, Compact size and ultra-low power consumption makes it very attractive to use around M5Stack series product. it performs fast fingerprint matching with highest security level and optimal user convenience. You can program to set the fingerprint recognition comparison level and different security level . if you ever consider secure your project with biometrics,don't forget to include this M5unit **FINGER**. -The parameter of UART: Baudrate(**default: 19200bps**), Start bits(1 bit), Stop bits(1 bit), Parity(no) +**This unit cummunicate with M5Core by UART protocol connected via PORTC** -## Feature +UART settings: +- Baudrate(**default: 19200bps**) +- Start bits(1 bit) +- Stop bits(1 bit) +- Parity(no) + +## Product Features @@ -35,8 +39,8 @@ The parameter of UART: Baudrate(**default: 19200bps**), Start bits(1 bit), Stop ## Application -- Fingerprint attendance -- Fingerprint lock +- Fingerprint Attendance Machine +- Fingerprint Locker ## Related Link @@ -50,7 +54,7 @@ The parameter of UART: Baudrate(**default: 19200bps**), Start bits(1 bit), Stop ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/FINGER/Arduino).* +*The code below is incomplete(just for usage). To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/FINGER/Arduino).* ```arduino /* diff --git a/docs/en/unit/gps.md b/docs/en/unit/gps.md index b6b59303..a36c38fe 100644 --- a/docs/en/unit/gps.md +++ b/docs/en/unit/gps.md @@ -8,15 +8,22 @@ ## Description -**GPS** is a Unit that integrates the Zhongke Weibeidou navigation chip AT6558 and the signal amplification chip MAX2659. AT6558 is capable of highly performance,supportting many types of satellite navigation system. It can receive satellite signals on 56 channels. It is capable of receiving GNSS signal from 6 satellite navigation system, and capable of joint location, navigation, and timing. Therefore the module is able to obtain accurate global location information. The AT6558 can be positioned quickly and accurately anywhere in the city, in the canyon, under the overhead, and at any location inside the car. The module can be widely used in vehicle monitoring, bus reporting, car navigation, onboard navigation, notebook navigation and other products. +This is the M5Unit version of **GPS**, integrates a Zhongke Weibeidou navigation chip **AT6558** and a amplification chip **MAX2659** used for amplifying antenna signal. -Regards to the gps Unit , a signal amplifying chip is **MAX2659** integrated inside. +**AT6558** is highly performance, supports many types of satellite navigation system,able to receive satellite signals on 56 channels GNSS signal from 6 satellite navigation system, joint location, navigation, timing and more. +The module is able to obtain accurate global location information. quick and accurate positioning for anywhere in the city, in the canyon, under the overhead, and inside the car. -You can connect it to M5Core port C with GROVE cable, and develope it with UART communication. +The module can be widely used in vehicle monitoring, bus reporting, car navigation, onboard navigation, notebook navigation and other products. -The parameter of UART: Baudrate(**default: 9600bps**), Start bits(1 bit), Stop bits(1 bit), Parity(no) +You can plug it into port C on M5core via GROVE cable, which is a standard UART interface. -## Feature +UART settings : +- Baudrate(**default: 9600bps**) +- Start bits(1 bit) +- Stop bits(1 bit) +- Parity(no) + +## Product Features - Functional specification - Positioning accuracy: 2.5 meters (CEP50, open space) @@ -39,7 +46,7 @@ The parameter of UART: Baudrate(**default: 9600bps**), Start bits(1 bit), Stop b - Warm start: 32 seconds - Hot start: 1 second - Operating temperature: -40~85°C -- Two Lego installation holes +- Two Lego-compatible holes ## Include @@ -49,8 +56,7 @@ The parameter of UART: Baudrate(**default: 9600bps**), Start bits(1 bit), Stop b ## Application - Car, ship positioning and navigation -- High precision timing -- Intelligent law enforcement positioning +- Smart law enforcement positioning ## Related Link @@ -70,7 +76,7 @@ The parameter of UART: Baudrate(**default: 9600bps**), Start bits(1 bit), Stop b ### Arduino IDE -*If you want the complete code `GPSRaw.ino`, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/GPS/Arduino).* +*To get the complete code `GPSRaw.ino`, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/GPS/Arduino).* ```arduino #include diff --git a/docs/en/unit/heart.md b/docs/en/unit/heart.md index aadeb7f8..ceb7c4e3 100644 --- a/docs/en/unit/heart.md +++ b/docs/en/unit/heart.md @@ -1,4 +1,4 @@ -# HEART {docsify-ignore-all} +# Unit HEART {docsify-ignore-all} @@ -8,14 +8,26 @@ ## Description -**HEART** is a unit integrated **MAX30100**(pulse oximeter chip). The principle is that the amount of oxygen and non-carrying oxygen in the red blood cells can be detected by infrared LED illumination, and the ADC value of the heart rate can be obtained. MAX30100 is built in two light emitting diodes and one light detector. After the unit is connected to the GROVE A port of the M5Core, you only need to put your finger on the MAX30110 module of the unit to read the physiological information. +**HEART** is build with **MAX30100**. -## Feature +MAX30100 is a complete pulse oximetry and heartrate sensor system solution designed for the demanding requirements of wearable devices. The MAX30100 provides very small total solution size without sacrificing optical or electrical performance. Minimal external hardware components are needed for integration into a wearable device. -- Low noise -- Can output specific blood oxygen value and heart rate value -- GROVE interface, support [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- How do we use this Unit to test the heart rate and ? +**Put your finger on the detection area.** + +- What is the communication protocol between M5 core and this unit? +**I2C**. + +## Product Features + +- Programmable Sample Rate and LED Current for Power Savings +- Ultra-Low Shutdown Current (0.7µA, typ) +- Advanced Functionality Improves Measurement Performance +- High Sample Rate Capability +- Fast Data Output Capability +- GROVE interface +- Software Develop platform: Arduino +- Two Lego-compatible holes ## Include @@ -36,7 +48,7 @@ ### 1. Arduino IDE -*If you want the code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEART/Arduino).* +*To get the code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEART/Arduino).* ```arduino /* diff --git a/docs/en/unit/hex.md b/docs/en/unit/hex.md index fc97e877..6134ee89 100644 --- a/docs/en/unit/hex.md +++ b/docs/en/unit/hex.md @@ -1,4 +1,4 @@ -# HEX {docsify-ignore-all} +# Unit HEX {docsify-ignore-all} @@ -8,16 +8,18 @@ ## Description -**HEX** is a hexagon RGB LED unit built in 37 RGB. And you can connect many HEXs in series one by one. +**HEX** is a hexagona Neopixel panel. Total 37 Neopixels. With a input port and a output port, you can have mutiple of them in series connection. -This's a figure about HEX serial number. + +This how LEDs layout in the panel. Pay attention to the sequence in your code. -## Feature +## Product Features -- The number of RGB: 37 -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Total LED: 37 +- Software development platform: Arduino,UIFlow(Blockly & python) +- Two Lego-compatible holes ## Include @@ -30,6 +32,8 @@ This's a figure about HEX serial number. - **[Forum](http://forum.m5stack.com/)** +Neopixel Library on Arduino + - **[FastLED Library](https://github.com/FastLED/FastLED/wiki/Overview)** - **[FastLED Reference(Chinese version)](http://www.taichi-maker.com/homepage/reference-index/arduino-library-index/fastled-library/)** @@ -38,9 +42,10 @@ This's a figure about HEX serial number. ### 1. Arduino IDE -This is a HEX example that displays gradient rainbow color. Before compiling this example, you need to install FastLED library and connect HEX to GROVE A of M5Core. +FastLED library on Arduino presents excellent and colorful lighting effects. +Before compile, it is require to install the FastLED library and connect HEX to GROVE A. -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEX/Arduino)。* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEX/Arduino)。* ```arduino /* @@ -82,7 +87,7 @@ void loop(){ ### UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEX/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/HEX/UIFlow).* diff --git a/docs/en/unit/hub.md b/docs/en/unit/hub.md index 93aa2593..68bf295a 100644 --- a/docs/en/unit/hub.md +++ b/docs/en/unit/hub.md @@ -8,15 +8,13 @@ ## Description -**HUB** is a module for M5GO to expand GROVE port added three GROVE -ports for user. So you can control 3 GROVE devices with only one M5GO -Core at a time. +**HUB** is one of the six Units in M5GO, allowed buy separately. This Units is used for GROVE port expanding. +Notice: **HUB** is just a hardware expander, if you are looking for hardware and software(standard protocol) expander like I2C, Single-bus, please check **PaHUB** or **PbHUB**. If you connectted two I2C slave devices onto **HUB** that share the same adress, you will have problem getting I2C data from both. -## Feature +## Product Features -- Instantly Add Three 4-Pins-GROVE ports to Any Compatible Device -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- GROVE Expander +- Two Lego-compatible holes ## Include diff --git a/docs/en/unit/ir.md b/docs/en/unit/ir.md index 42394263..bfe525fe 100644 --- a/docs/en/unit/ir.md +++ b/docs/en/unit/ir.md @@ -8,18 +8,17 @@ ## Description -**IR** is an infrared photoelectric pair unit that integrates a pair of infrared transmitting and receiving tubes. +**IR** is an pair of infrared photoelectric. Also from M5Go Kit, Contains 1x infrared emitter and 1x receiver. -After connecting with the M5Core, you can control whether to emit infrared light through the M5Core. The other receiving tube can detect whether infrared light is sent from other devices to the unit. +IR remote control is widely used in consumer electronics,it can be used to operate devices such as a television set, DVD player, or other home appliance, from a short distance. Since this unit comes with emitter and receiver, you can practice not only onIR encode but also on IR decode. -Because the GROVE interface has two signal pins, one controls infrared transmission and one controls infrared reception, so if you want to send infrared light, you need the OUTPUT pin (GPIO26) to output high level. +## Product Features -## Feature - -- A pair of infrared transmitting and receiving tube -- Detects the distance 2 ~ 5cm -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- 1x infrared emitter +- 1x infrared receiver +- Distance range: < 5m +- Software Development Platform: Arduino, UIFlow(Blockly,Python) +- Two Lego-compatible holes ## Include @@ -36,7 +35,7 @@ Because the GROVE interface has two signal pins, one controls infrared transmiss ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino).* +*The code below is incomplete. TO get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/Arduino).* ```arduino #include @@ -56,7 +55,7 @@ cur_recv_value = digitalRead(ir_recv_pin);// read the status of receiver ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/IR/UIFlow).* diff --git a/docs/en/unit/joystick.md b/docs/en/unit/joystick.md index 155a6fe4..1eaed0ee 100644 --- a/docs/en/unit/joystick.md +++ b/docs/en/unit/joystick.md @@ -8,22 +8,22 @@ ## Description -**JOYSTICK** is a unit which is very similar to the 'analog' joystick on PS2 (PlayStation 2) controllers. The X and Y axes are two 10k potentiometers which control 2D movement by generating analog signals. The joystick also has a push button that could be used for special applications. Therefore, the entire Unit can output X-Y motion signals in both directions and Z direction. +**JOYSTICK**, we have two types of JOYSTICKs one is build on a panle compatible with FACES Kit, this is the M5Unit version of **JOYSTICK** -As designed in the schematic, the Joystick X dimension is connected to pin A0 of MEGA328, the Joystick Y dimension is connected to pin A1 of MEGA328, the Joystick Z dimension is connected to pin A2 of MEGA328. +JOYSTICK is very similar to the 'analog' joystick on PS2 (PlayStation 2) controllers. The X and Y axes are two 10k potentiometers which control 2D movement by generating analog signals. The joystick also has a push button that could be used for special applications. Therefore, the entire Unit can output X-Y motion signals in both directions and Z direction. + +As designed in the schematic, the Joystick X dimension is connected to pin A0 of MEGA328, the Joystick Y dimension is connected to pin A1 on MEGA328, the Joystick Z dimension is connected to pin A2 on MEGA328. -The Joystick Unit is controlled by PORT A (I2C) after connected with the M5Core, and the I2C address is 0x52. By reading the data transferred from this I2C address(0x52),you can obtain the motion info of the Joystick. - This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x52. By reading the data transferred from JOSTICK, you can obtain the motion information of JOYSTICK. -## Feature +## Product Features - Output value of X, Y direction: 10 ~ 250 - Output value of Z direction is (0: released; 1: pressed) -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Software Development Platform : Arduino, UIFlow(Blockly, Python) +- Two Lego-compatible holes ## Include @@ -45,7 +45,7 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino).* +*The code below is incomplete(just for usage).To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/Arduino).* ```arduino #include @@ -78,7 +78,7 @@ if (Wire.available()) { ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/JOYSTICK/UIFlow).* diff --git a/docs/en/unit/light.md b/docs/en/unit/light.md index 98000bca..e1165ab8 100644 --- a/docs/en/unit/light.md +++ b/docs/en/unit/light.md @@ -8,17 +8,18 @@ ## Description -LIGHT is a light sensor unit with an adjustable resistor that can detect the lightironmental light intensity. -You can read analog signal(lightironmental light intensity) staright or get a digital signal(0/1) that means whether the light exists or not. +**LIGHT** is a light intensity sensor unit with an adjustable photoresistor。 -When light intensity is big enough, the unit will output hight level(digital signal "1"). Otherwise, it'll output low level. +A photoresistor is a light-controlled variable resistor. The resistance of a photoresistor decreases with increasing incident light intensity, and vice versa. +It exhibits photoconductivity which make it possiable to detect the varies based on Voltage, and use a AD to convert the digital data. -## Feature +We add some extra work to strengthen the circult, a Dual Differential Comparators **LM393**, compares the differntial voltage between the photoresistor and the varistor. It could offer larger and accuracy range of light intensity. -- Adjustable threshold, including 10K adjustable resistor -- Analog & Digital output -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +## Product Features + +- 10K adjustable resistor +- Software Development Platform: Arduino, UIFlow(Blocky,Python) +- Two Lego-compatible holes ## Include @@ -35,7 +36,7 @@ When light intensity is big enough, the unit will output hight level(digital sig ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino).* +*The code below is incomplete. To complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/Arduino).* ```arduino #include @@ -58,7 +59,7 @@ digitalRead_value = digitalRead(26); ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/LIGHT/UIFlow).* diff --git a/docs/en/unit/m5camera.md b/docs/en/unit/m5camera.md index 264ac607..fc476eff 100644 --- a/docs/en/unit/m5camera.md +++ b/docs/en/unit/m5camera.md @@ -1,4 +1,4 @@ -# M5Camera - Normal Lens (4MB PSRAM) {docsify-ignore-all} +# Unit M5Camera {docsify-ignore-all} @@ -8,9 +8,30 @@ ## Description -The **M5Camera** is a camera unit based on ESP32 chip and OV2640 **including PSRAM**. You can even program it through ESP-IDF or Arduino IDE. +**M5Camera** is a development board for image recognition. It features an ESP32(4M Flash + 520K RAM) chip and 2-Megapixel carmera(OV2640).**M5Camera** offers plenty of storage, with an extra 4 Mbyte PSRAM. It also supports image transmission via Wi-Fi and debuging through USB Type-C port. -**There are two versions of M5Camera Unit: A Model and B Model.** +The hardware comes preloaded software, programmed by ESP-IDF. It is an application to run Wi-Fi camera. The output image is size 600*800, since it's 2-Maga camera, you sure can optimize the software to output the maximum size of photos. + +what this software can do? +- Power the board via USB type-C or GROVE +- Use your phone to Wi-Fi scan an AP name start with 'm5stack-' and click to connect this AP. +- Open up web browser on your phone and visit 192.168.4.1 +- Then here comes the picture. Video is about 5-6 frames per senconds. not super fast. + +The hardware also comes with some reserved weld pad, just in case you want put these chips back on board. +- 9-axis gyroscope (MPU6050) +- pressure sensor (BME280) +- **Analog MIC (SPQ2410)** +- Battery socket + + + +**Please notice:** There are 2 types of **M5Camera** +- Model A & Model B +- They have different circuits, can be identified by backside sticker +- Model A is halt production. The new coming **M5Camera** is just Model B +- In Model A circult design MPU6050 and camera sensor have I2C conflict, which means you can't use both at the same time. +- Model B have better performance on image quality and processing speed. @@ -24,9 +45,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h * If also configured with microphone, will be named M5Camera_6050_MIC * If also configured with BME280, will be named M5Camera_6050_MIC_BME280 - - -## Feature +## Product Features - ESP32 specifications + Dual-core Tensilica LX6 microprocessor @@ -49,9 +68,9 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h + CIF: 60fps - Scan Mode: Progressive - Camera specifications - + CCD size : 1/4inch + + CCD size : 1/4 inch + Field of View : **65 degree** - + Maxmium Pixel: 200W + + Maxmium Pixel: 2M - Sensor best resolution: 1600 * 1200 - Dimension: 40 × 49 × 13mm @@ -62,7 +81,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h ## PinMap -**There are two versions of M5Camera Unit: A Model and B Model.** +**There are two versions of M5Camera Unit: A Model and B Model.** **Camera Interface PinMap** @@ -102,7 +121,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h | :-----------: | :------: | :------: | | LED_Pin | IO14 | IO14 | -**The following tables are Reserved Chip Interfaces** +**The following tables are Reserved Chip Interfaces** **BME280 Interface** @@ -130,14 +149,15 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h | SCL |IO2|IO2| | SDA |IO4|IO4| -**NOTE:** +**NOTE:** 1. **Camera Power Down** pin does not need to be connected to ESP32 GPIO. Instead it may be pulled down to ground with 10 kOhm resistor. -2. We have several kinds of camera boards, the following figures show the main differece with them. - If you want to **view** the detailed defference with them, please click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). +2. We have several patterns of camera board, the following figures shows the main differece - If you want to **download** the detailed defference with them, please click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). + **view** click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). + + **download** click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). diff --git a/docs/en/unit/m5camera_f.md b/docs/en/unit/m5camera_f.md index 07ac3a73..96c67d64 100644 --- a/docs/en/unit/m5camera_f.md +++ b/docs/en/unit/m5camera_f.md @@ -1,4 +1,4 @@ -# M5CameraF - FishEye Lens (4MB PSRAM) {docsify-ignore-all} +# Unit M5CameraF {docsify-ignore-all} @@ -8,10 +8,26 @@ ## Description -The **M5CameraF** is a camera unit based on ESP32 chip and OV2640 **including PSRAM**, **160° Fisheye Lens**. You can even program it through ESP-IDF or Arduino IDE. +**M5CameraF** is a development board for image recognition. It features an ESP32(4M Flash + 520K RAM) chip and 2-Megapixel carmera(OV2640).**M5CameraF** offers plenty of storage, with an extra 4 Mbyte PSRAM. It also supports image transmission via Wi-Fi and debuging through USB Type-C port. +The hardware comes preloaded software, programmed by ESP-IDF. It is an application to run Wi-Fi camera. The output image is size 600*800, since it's 2-Maga camera, you sure can optimize the software to output the maximum size of photos. + +what this software can do? +- Power the board via USB type-C or GROVE +- Use your phone to Wi-Fi scan an AP name start with 'm5stack-' and click to connect this AP. +- Open up web browser on your phone and visit 192.168.4.1 +- Then here comes the picture. Video is about 5-6 frames per senconds. not super fast. + +The hardware also comes with some reserved weld pad, just in case you want put these chips back on board. +- 9-axis gyroscope (MPU6050) +- pressure sensor (BME280) +- **Digital silicon microphone (SPM1423)** +- Battery socket + + + This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and humidity pressure sensor (BME280) and **Digital silicon microphone (SPM1423)**. If you need those devices, you can Self-weld them or purchase those version thraightly. Additionally, M5CameraF also reserves the weld of battery. The size of the battery that can be accommodated in the case corresponds to a battery capacity of **80mAh**. **Note: M5CameraF is named differently when different hardware is selected. They follow the rules below.** @@ -23,8 +39,6 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h * If also configured with BME280, will be named M5CameraF_6050_MIC_BME280 * If also configured with battery, will be named M5CameraF_6050_MIC_BME280_BAT - - ## Feature - ESP32 specifications @@ -51,7 +65,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h + Field of View : **160 degree** + Maxmium Pixel: 200W - Sensor best resolution: 1600 * 1200 -- 尺寸：23.5 × 48 × 23.5mm +- Size：23.5 × 48 × 23.5mm ## Include @@ -102,7 +116,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h | :-----------: | :------: | | LED_Pin | IO14 | -**The following tables are Reserved Chip Interfaces** +**The following tables are Reserved Chip Interfaces** **BME280 Interface** @@ -130,15 +144,15 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h | CLK |IO4| | DATA |IO2| -**NOTE:** +**NOTE:** 1. **Camera Power Down** pin does not need to be connected to ESP32 GPIO. Instead it may be pulled down to ground with 10 kOhm resistor. -2. We have several kinds of camera boards, the following figures show the main differece with them. +2. We have several patterns of camera board, the following figures shows the main differece - If you want to **view** the detailed defference with them, please click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). + **view** click [here](https://shimo.im/sheets/gP96C8YTdyjGgKQC). - If you want to **download** the detailed defference with them, please click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). + **download** click [here](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/M5%20Camera%20Detailed%20Comparison.xlsx). @@ -150,8 +164,6 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - - ## Code ### Firmware diff --git a/docs/en/unit/makey.md b/docs/en/unit/makey.md index 8389d576..a252e7f9 100644 --- a/docs/en/unit/makey.md +++ b/docs/en/unit/makey.md @@ -8,32 +8,33 @@ ## Description -**MAKEY** is a unit with built-in MEGA328P chip, buzzer and RGB led, with 16 pins. +**MAKEY** Unit is inspired by an Invention kit called Makey Makey which brings the concept that users can +connect everyday objects to computer programs. Using a circuit board, alligator clips, and a USB cable, the circult uses closed loop electrical signals to send the microprocessor either a keyboard stroke or mouse click signal. +We've tried connect a bounch of fruits, one for each key,to this Unit. When you touch the apple, you make a connection, and MaKey sends the processor a keyboard message. The buzzer inside or speaker on M5core will exhibit the key value, so instead of using a keyboard, you can make a fruit piano. -This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x51. +This Unit communicates with the M5Core via the GROVE A I2C(0x51). **Instructions:** -1）Just the buzzer on the unit sounds +1）Use the buzzer on the unit to exhibit sounds: -A DuPont line or a common wire is connected to the GND hole of the unit, and the other end of this DuPont line is held in the left hand; +Take a Dupont wire(male to male), one end plug into GND, hold the other end to your hand. +Take another Dupont wire(male to male), one end plug into different key holes, the other end hold by the other hand. Make it a close circult. Plug into different key tones the buzzer will emit the corresponding tones. -Another DuPont line holds the right hand at one end, the other end of this DuPont line touches the tone hole on the unit, and MAKEY will emit the corresponding tone. -2）Speaker sounds on m5core +2）Use the speaker on the M5core to exhibit sounds: +Connct MAKEY with M5Core via Grove A +Download this [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version). -Unit is connected to the interface A of m5core through the GROVE line, and burns [example](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version). +Repeat the same operation as above. you will see this sound much better. -A DuPont line or a common wire is connected to the GND hole of the unit, And the other end of this DuPont line is held in the left hand; - -Another DuPont line holds the right hand at one end, the other end of this DuPont line touches the tone hole on the unit, and m5core will emit the corresponding tone. - -## Feature +## Product Features - Arduino Mega328p Controller - Buzzer inside -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Up to 16 keys +- Software Development Platform: Arduino, UIFlow(Blockly,Python) +- Two Lego-compatible holes ## Include @@ -52,13 +53,13 @@ Another DuPont line holds the right hand at one end, the other end of this DuPon - **[Forum](http://forum.m5stack.com/)** -- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)** +- **[Maykey Firmware](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/firmware_328p)** ## Example ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version).* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/Arduino/Makey_new_version).* ```arduino #include @@ -84,7 +85,7 @@ while (Wire.available()) { ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/Makey_NewVersion/UIFlow).* diff --git a/docs/en/unit/ncir.md b/docs/en/unit/ncir.md index 5f307495..6704aa49 100644 --- a/docs/en/unit/ncir.md +++ b/docs/en/unit/ncir.md @@ -8,20 +8,20 @@ ## Description -**NCIR** is a Unit with built-in infrared sensor **MLX90614**. Use it to measure the temperature of the surface of a human body or other object. +**NCIR** featured with built-in infrared sensor **MLX90614**. It can be used to measure the surface temperature of a human body or other object. Unlike most temperature sensors, this sensor measures infrared light bouncing off of remote objects so it can sense temperature without having to touch them physically. Simply point the sensor towards what you want to measure and it will detect the temperature by absorbing IR waves emitted. Because it doesn't have to touch the object it's measuring, it can sense a wider range of temperatures than most digital sensors: from -70°C to +380°C! It takes the measurement over an 90-degree field of view so it can be handy for determining the average temperature of an area. -This unit communicates with M5Core through GROVE A port(IIC interface), and it's IIC address is 0x5A. +Connect with M5Core via GROVE A IIC(0x5A). -## Feature +## Product Features - Operating voltage: 4.5 to 5.5V - Measuring temperature range: -70°C ~ 382.2°C - Measurement accuracy at room temperature: ±0.5°C - Field of view: 90° -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego plug-in holes for easy integration with Lego +- Sofrware Development Platform: Arduino, UIFlow(Blockly, Python) +- Two Lego-compatible holes ## Include @@ -30,8 +30,8 @@ This unit communicates with M5Core through GROVE A port(IIC interface), and it's ## APPLICATION -- body temperature measurement -- Object (biological) motion detection +- Body Temperature Measurement +- Object (biological) Motion Detection ## Related Link @@ -45,7 +45,7 @@ This unit communicates with M5Core through GROVE A port(IIC interface), and it's ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/NCIR).* +*The code below is incomplete. TO get complete code, please click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/NCIR).* ```arduino #include @@ -75,7 +75,7 @@ temperature = result * 0.02 - 273.15; ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NCIR/UIFlow).* +*TO get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NCIR/UIFlow).* diff --git a/docs/en/unit/neoflash.md b/docs/en/unit/neoflash.md index 09aabe41..77fca087 100644 --- a/docs/en/unit/neoflash.md +++ b/docs/en/unit/neoflash.md @@ -1,4 +1,4 @@ -# NEOFLASH {docsify-ignore-all} +# Unit NEOFLASH {docsify-ignore-all} @@ -8,14 +8,22 @@ ## Description -**NEOFLASH**is a RGB LED panel with 192 RGB LED(24x8). The upper left corner is the first LED, and the LEDs are incremented from left to right and top to bottom. NEOFLASH is also equipped with three GROVE A interfaces (IIC interfaces) for easy integration with Neoflash. +**NEOFLASH** is a RGB LED panel with 192 RGB LED(24x8). +When you program this Unit, please pay attention to the sequence of the Neopixels. From top left (Where PIR placed) to right, and top to bottom. + +Connect this unit with M5Core via GROVE PORTB Single-Bus. +We put Magnet on the backside, which means you can attach this to any metal surface. +When you plug the GROVE PORTA into M5core, you have convert it into 3 extended GROVE A laid on the side. -## Feature +## Product Features -- The number of RGB: 192 -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Total Neopixel quantity: 192 +- PIR +- PORTA extension(up to 3) +- Software Development Platform: Arduino, UIFlow(Blockly, python) +- Two Lego-compatible holes ## Include @@ -38,7 +46,7 @@ This is a example that takes real-time time from the network and displays it on NEOFLASH. Show real time when someone is shaking before NEOFLASH, otherwise the time "disappears". -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)。* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)。* diff --git a/docs/en/unit/neopixel.md b/docs/en/unit/neopixel.md index c5fde7f4..80af99ef 100644 --- a/docs/en/unit/neopixel.md +++ b/docs/en/unit/neopixel.md @@ -1,4 +1,4 @@ -# NEOPIXEL {docsify-ignore-all} +# Unit NEOPIXEL {docsify-ignore-all} @@ -8,17 +8,18 @@ ## Description -**NeoPixel** is a RGB LED Cable unit. You can program it using NeoPixel Lib supported by Adafruit or using [UIFlow](http://flow.m5stack.com) that will be easier. The unit comunicates with M5Core with GROVE Interface. +**NeoPixel** is a extendable strip light with Neopixels lined on. Just in case you haven’t heard about Neopixel yet, Neopixel features digitally addressable LEDs,which means each led can display RGB color and brightness individually. It is very easy to program by Single-BUS with simple protocol. Another feature is the extension and flexiblulity.You can even connect many of them up together to create a massive long LED display. It's important to note that, the brightness and the quantity of LEDs matters the most to the power consuming, if you have a bunch of them connectted up, you will need extra power supply. -?> Be carefull that a Neopixel unit has input port and output port. When this unit is connected with M5Core, the input port must be attach with Core and it's output port can be attach with another neopixel unit as shown below. +*Notice: please pay attention to the direction of the input port and output port* -## Feature +## Product Features -- the length: 10cm/20cm/0.5m/1m/2m -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Alternative length: 10cm/20cm/0.5m/1m/2m +- Sofeware Development Platform: Arduino, UIFlow(Blockly,Python) +- Two Lego-compatible holes +- extendable ## Include @@ -39,7 +40,7 @@ ### 1. Arduino IDE -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)。* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/Arduino)。* ```arduino /* @@ -100,7 +101,7 @@ void FastLEDshowTask(void *pvParameters){ ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow).* +*To get the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/NEOPIXEL/UIFlow).* diff --git a/docs/en/unit/pir.md b/docs/en/unit/pir.md index 1b0a3da0..7d940967 100644 --- a/docs/en/unit/pir.md +++ b/docs/en/unit/pir.md @@ -8,11 +8,11 @@ ## Description -**PIR** is a unit with integrated body sensing module. It's used to sense human activity. Through this Unit, you can perceive whether someone is passing in front of Unit, which is suitable for the project of human body sensing. +**PIR** is used to measure infrared (IR) light radiating from objects in its field of view. PIR sensors are commonly called simply "PIR", or sometimes "PID", for "passive infrared detector". The term passive refers to the fact that PIR devices do not radiate energy for detection purposes. They work entirely by detecting infrared radiation emitted by or reflected from objects. -The working process is to output a high level when the infrared is sensed. During the delay period, if a human body is active in its sensing range, its output will remain high. Delay to turn high level low until the person leaves ( The sensing module detects a delay time period after each activity of the human body. And the time of the last activity is the starting point of the delay time). +This Unit communicates with the M5Core via the GROVE B. -This Unit communicates with the M5Core via the GROVE B interface. +*Notice: This Unit has 2s delay time.* ## Feature @@ -31,9 +31,9 @@ This Unit communicates with the M5Core via the GROVE B interface. ## Application -- Human body induction lamp -- security product -- Automatic induction appliance settings +- Human body Induction Lamp +- Security Product +- Automatic Induction Appliance Settings ## Related Link @@ -45,7 +45,7 @@ This Unit communicates with the M5Core via the GROVE B interface. ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/Arduino).* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/Arduino).* ```arduino #include @@ -61,7 +61,7 @@ M5.update(); ### 2. UIFlow -If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow). +To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/PIR/UIFlow). diff --git a/docs/en/unit/proto.md b/docs/en/unit/proto.md index dd9ceeb7..1554aa20 100644 --- a/docs/en/unit/proto.md +++ b/docs/en/unit/proto.md @@ -8,15 +8,14 @@ ## Description -**PROTO** is unit built in a flexible extended blank circuit with 100mil pitch of holes. +**PROTO** is a Unit size of universal prototyping board. You can have the total freedom to make your own project as you want it, with prototyping perboards that allows laying out customized circult to interact with the M5 core GROVE Port. -If you need to customize a simple circuit and want to use this Unit package, you can solder the circuit directly into the PROTO Unit. Finally connect to the M5Core via the GROVE line and implement M5Core to control your custom circuitry. +## Product Features -## Feature - -- Flexible extended blank circuit -- 70 holes(pitch of holes: 100mil) -- Two Lego installation holes +- Hole Size: 0.039" 1mm (CNC Drilled) +- Hole Pitch: 0.1 in - (2.54 mm) +- Entire Hole Quantity: 70 Holes +- Two Lego-compatible holes ## Include diff --git a/docs/en/unit/relay.md b/docs/en/unit/relay.md index a4879c99..67b64b47 100644 --- a/docs/en/unit/relay.md +++ b/docs/en/unit/relay.md @@ -8,21 +8,22 @@ ## Description -**RELAY** is a unit that allows you to control large power loads with a light-current, safe, reliable power control system. the large power loads you can safely control is up to 30 VDC or 220 VAC. -Only a low electrial level is sent to this unit, the relay will be close and the large power loads you want to control will be working. +**RELAY**, as its namesake, is a M5Unit that implenments a Relay functions. Relay can be used as an electrically operated switch, uses an electromagnet to mechanically operate a switch,to where it is necessary to control a large power load circuit by a separate low-power signal, like a digital signal output from a mircoprocessor. Up to 30V DC and 220V AC. +There are 3 pins named: ON, OFF, COM. You can program to make COM connect to ON or OFF, just by high and low out put of a digital GPIO. -## Feature +## Product Features -- A single input -- Up to 3A @ 30 VDC or 220 VAC -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Single-BUS control +- Up to 3A @ 30 V DC or 220 V AC +- Software Development Platform: Arduino, UIFlow(Blockly,Python) +- Two Lego-compatible holes ## Include - 1x RELAY Unit - 1x Grove Cable +- 1x 3.96 soket ## Application @@ -38,7 +39,7 @@ Only a low electrial level is sent to this unit, the relay will be close and the ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino).* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/Arduino).* ```arduino #include @@ -63,7 +64,7 @@ void loop(void) { ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RELAY/UIFlow).* diff --git a/docs/en/unit/rfid.md b/docs/en/unit/rfid.md index 66c23966..bc98f3b1 100644 --- a/docs/en/unit/rfid.md +++ b/docs/en/unit/rfid.md @@ -1,4 +1,4 @@ -# RFID {docsify-ignore-all} +# Unit RFID {docsify-ignore-all} @@ -8,11 +8,15 @@ ## Description -**RFID** is a unit that integrates the **MFRC522** RFID chip. The MFRC522 operates in the 13.56MHz frequency band and uses the modulation and demodulation principle to interact with the proximity card. The MFRC522 supports MIFARE's higher speed contactless communication with bidirectional data rates up to 424 kbit/s. The unit can realize the function of the card reading device, can identify and record multiple card information, and establish applications such as access control system, punching system, warehouse goods storage and community vehicle access registration. +**RFID** has an RFID chip **MFRC522** inside. -This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x28. +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 a RF card. -## Feature +It is able tp establish applications such as access control system, punching system, warehouse goods storage and community vehicle access registration. + +Connect this Unit to GROVE PORTA on M5Core, IIC adress is 0x28. + +## Product Features - Operating frequency: 13.56 MHz - I2C data rate: Fast mode: up to 400 Kbit/s; High-speed mode: up to 3400 Kbit/s @@ -21,7 +25,7 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre - Operate temperature: -20℃-85℃ - How long data be saved for: > 10 years - Reading and writing distance: < 8 cm -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Program Platform: Arduino, UIFlow(Blockly, Python) - Two Lego installation holes ## Include @@ -48,7 +52,7 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RFID/Arduino).* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RFID/Arduino).* After programming the RFID.ino, the IC card or the mobile phone NFC, close to the unit, moves back and forth around the unit, and the UID of the IC card or the RFID chip in the mobile phone will be printed on the screen of the M5Core. @@ -93,7 +97,7 @@ void ShowReaderDetails() { ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RFID/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RFID/UIFlow).* After opening and burning this example using [UIFlow](flow.m5stack.com), place the proximity card on the Unit surface and the screen displays “True” and the UID number of the card. diff --git a/docs/en/unit/rgb.md b/docs/en/unit/rgb.md index ccf562e1..38792c17 100644 --- a/docs/en/unit/rgb.md +++ b/docs/en/unit/rgb.md @@ -6,18 +6,16 @@ :memo:**[Description](#Description)**      :octocat:**[Example](#Example)**      🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-RGB-Unit-with-NeoPixel-RGB-LED-Light-x3-GPIO-GROVE-Connector/3226069_32929809133.html?spm=a2g1y.12024536.productList_5885013.subject_21)** - - ## Description -**RGB** is a sensor including three RGB LED lights and two GROVE -ports.You can display specified color using M5GO Core through Blockly, -Arduino or MicroPython. +**RGB** is LED Unit include 3 individual LEDs. It is also one of the Unit from M5GO Kit. Each one can display anycolor based on RGB value. One feature of this Unit is extension, which means you can have mutiple of them wired together. -## Feature +This is a very useful piece on STEM class, students can program it to realize some of cool applications, for example a traffic light. -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +## Product Features + +- Program Platform: Arduino, UIFlow(Blockly, Python) +- Two Lego-compatible holes ## Include @@ -34,7 +32,7 @@ Arduino or MicroPython. ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/Arduino).* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/Arduino).* ```arduino /* @@ -62,14 +60,10 @@ pixels.show(); // This sends the updated pixel color to the hardware. ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/UIFlow).* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/RGB/UIFlow).* - - - - ### PinMap
M5Core(GROVE C)GPIO16GPIO175VGND
CATEAR Unit CATEAR Pin5VGND
diff --git a/docs/en/unit/rs485.md b/docs/en/unit/rs485.md index 77f42d80..93ef5cc4 100644 --- a/docs/en/unit/rs485.md +++ b/docs/en/unit/rs485.md @@ -1,4 +1,4 @@ -# RS485 {docsify-ignore-all} +# Unit RS485 {docsify-ignore-all} @@ -6,18 +6,20 @@ :memo:**[Description](#Description)**      🛒**[Purchase](https://pt.aliexpress.com/store/product/M5Stack-Official-RS485-to-TTL-Unit-GROVE-Grove-Cable-UART-Interface-for-Arduino-ESP32-Development-Board/3226069_32966570641.html?spm=a2g03.12010615.8148356.2.5e6e66005SP84o)** - - ## Description -**RS485** is a unit used for converting TTL level to RS485 level. If the device to be controlled only can communicate with other device through RS485, you can connect this device with M5Core through this unit. In this case, you could easily control a RS485 device with [UIFlow](http://flow.m5stack.com). +**RS485** is a TTL to RS485 convertor. -## Feature +RS485 is a standard defining the electrical characteristics of drivers and receivers for use in serial communications systems, widely used in industrial field. multipoint systems are supported. + +used for converting TTL level to RS485 level. If the device to be controlled only can communicate with other device through RS485, you can connect this device with M5Core through this unit. In this case, you could easily control a RS485 device with [UIFlow](http://flow.m5stack.com). + +## Product Features - Built in MAX485/SP485EEN -- Drive RS485 devices up to 12V -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- DC in 12/24 V +- Program Platform: Arduino, UIFlow(Blockly,Pyhton) +- Two Lego-compatible holes ## Include diff --git a/docs/en/unit/thermal.md b/docs/en/unit/thermal.md index 26f9b251..5d94cd5a 100644 --- a/docs/en/unit/thermal.md +++ b/docs/en/unit/thermal.md @@ -8,17 +8,18 @@ ## Description -**THERMAL** is a thermal camera Unit contained thermopile sensors named **MLX90640**. It can be used to measure the surface temperature of an object and form a thermographic image by a temperature gradient composed of different surface temperatures. The image size and resolution of the MLX90640 output is **32 x 24**. +**THERMAL** is a thermal imager Unit contains a thermopile sensors named **MLX90640**. It can be used to measure the surface temperature of an object and form a thermographic image by a temperature gradient composed of different surface temperatures. +The image resolution is **32 x 24**. The MLX90640 Infrared (IR) sensor array combines high resolution and reliable operation in harsh environments, providing a cost-effective alternative to more expensive high-end thermal imaging cameras. Unlike the case of a microbolometer, the sensor does not require frequent recalibration, ensuring continuous monitoring and reducing system cost. -The field of view (FoV) option includes a standard 55° x 35° version and a wide angle version of 110° x 75° for distances up to 7m. THERMAL uses a version of **110°×75° FoV**, also known as the BAA package. +The field of view (FoV) option includes a standard 55° x 35° version and a wide angle version of 110° x 75° for distances up to 7m. This Unit is **110°×75° FoV**, also known as the BAA package. -The Unit communicates with the M5Core through the Grove A interface, and its IIC address is **0x33** +The Unit communicates with the M5Core through the Grove A interface, IIC address is **0x33** -## Feature +## Product Features - Operating Voltage: 3V ~ 3.6V - Current Consumption: 23mA @@ -27,8 +28,7 @@ The Unit communicates with the M5Core through the Grove A interface, and its IIC - Resolution: ±1.5°C - Refresh Rate: 0.5Hz-64Hz - Operating temperature: -40°C ~ 85°C - -- Two Lego installation holes +- Two Lego-compatible holes ## Include @@ -53,7 +53,7 @@ The Unit communicates with the M5Core through the Grove A interface, and its IIC ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/THERMAL/Arduino)。* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/THERMAL/Arduino)。* ```arduino /* diff --git a/docs/en/unit/tof.md b/docs/en/unit/tof.md index 95af1750..fdc88ca4 100644 --- a/docs/en/unit/tof.md +++ b/docs/en/unit/tof.md @@ -8,17 +8,19 @@ ## Description -**TOF** is a unit that can detect distance using a newest "Time-of-Flight" sensor using laser light. It is higher precision than most distance sensors. The unit comunicates with M5Core with I2C. +**TOF** that employs time-of-flight techniques to resolve distance between the emit point and the reach point of a subject, measuring the round trip time of an artificial light signal provided by a laser. -The unit communicates with m5core through GROVE A(IIC). And the IIC address is 0x29. +This unit integrated a distance measuring sensor VL53L0x providing accurate distance measurement whatever the target reflectance, unlike conventional technologies. It can measure absolute distances up to 2m in less than 30ms. -## Feature +This unit comunicates with M5Core via I2C(0x29). + +## Product Features - High precision - Measure absolute distances up to 2m -- the wavelength of laser: 940nm -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- The wavelength of laser: 940nm +- Program Platform: Arduino, UIFlo(Blockly, Python) +- Two Lego-compatible holes ## Include @@ -28,11 +30,8 @@ The unit communicates with m5core through GROVE A(IIC). And the IIC address is 0 ## APPLICATION - 1D gesture recognition - - Laser Ranging - - 3D structured light imaging（3D sensing） - - Camera assist (ultra fast autofocus and depth of field) ## Related Link diff --git a/docs/en/unit/trace.md b/docs/en/unit/trace.md index b04c1a63..3c7924e2 100644 --- a/docs/en/unit/trace.md +++ b/docs/en/unit/trace.md @@ -1,4 +1,4 @@ -# TRACE - Line follower Unit {docsify-ignore-all} +# Unit TRACE {docsify-ignore-all} @@ -8,16 +8,19 @@ ## Description -**TRACE** is A line of built-in 4 sets of infrared emitting LEDs and infrared sensitive phototransistors. It can output digital signal to a microcontroller so that the robot can follow a black line on white background, or vice versa. +**TRACE** is mainly consist of 4 sets of IR, 1x infrared emitting and 1x infrared receiver for each set. The infrared LEDs should be placed towards and close to the ground where having black tracing lines and white background (or vice versa) layouts. -This Unit communicates with the M5Core via the GROVE A interface. It's I2C address is 0x5A. +The IR transmitter keep emitting, at the mean time infrared ray would be absorbed by different color of objects. Black can absorb more ray than other color, so the infrared receiver (infrared sensitive phototransistor) would receive less which makes the resistance value of the phototransistor would vary with different object color. Then we assign an AD convertor tp capture the data. + +This Unit communicates with the M5Core via GROVE PORTA I2C(0x5A). -## Feature +## Product Features - operation range: The reflecting surface is less than 11mm from the photoelectric surface -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) +- Program Platform: Arduino, UIFlow(Blockly,Python) +- Two Lego-compatible holes ## Include @@ -26,7 +29,7 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre ## Application -- Follow line robot +- Self-tracing robot ## Related Link @@ -34,13 +37,13 @@ This Unit communicates with the M5Core via the GROVE A interface. It's I2C addre - **[Forum](http://forum.m5stack.com/)** -- **[The Firmware of inside MEGA328](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/firmware_328p)** +- **[TRACE Firmeare](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/firmware_328p)** ## Example ### 1. Arduino IDE -*The below code is incomplete(just for usage). If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/Arduino)。* +*The code below is incomplete. To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/Arduino)。* ```arduino #include @@ -77,7 +80,7 @@ SensorArray[0] = (value&0x01)>>0; ### 2. UIFlow -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/UIFlow)。* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/TRACE/UIFlow)。* diff --git a/docs/en/unit/weight.md b/docs/en/unit/weight.md index 1dfa0538..fe91e8e6 100644 --- a/docs/en/unit/weight.md +++ b/docs/en/unit/weight.md @@ -1,4 +1,4 @@ -# WEIGHT {docsify-ignore-all} +# Unit WEIGHT {docsify-ignore-all} @@ -8,25 +8,41 @@ ## Description -**WEIGHT** is a metering unit that integrates an ADC chip dedicated to the scale design. +**WEIGHT** intergrates an 24 bits A/D chip **HX711** that is specifically designed for electronic weighing device. -* Because the Unit is connected to the GROVE port (the GRVOE port is a 5V supply voltage), the positive supply voltage is +5V for the **HX711** in Unit. Output voltage range is 0 ~ 5mV. The greater the applied pressure, the greater the voltage value of the corresponding output. +The input multiplexer selects either Channel A or B differential input to the low-noise programmable gain amplifier (PGA). Channel A can be programmed with a gain of 128 or 64, corresponding to a full-scale differential input +voltage of ±20mV or ±40mV respectively, when a 5V supply is connected to AVDD analog power supply pin. Channel B has a fixed gain of 32. There is no programming needed for the +internal registers. All controls to the HX711 are +through the pins. -* HX711 has two input channels A, B. Compared to channel B, Channel A has programmable signal amplification. Channel A is used in the circuit design of this Unit, so this unit has programmable amplification. - -The unit is connected to the pressure sensor at one end and the M5Core is connected to the other end through the GROVE line. +In the test, we have this Unit channel A to connect a pressure sensor. Then use M5Core screen to display the weight data. -## Feature +## Product Features -- Programmable magnification: 32, 64, 128 -- ADC accuracy inside the HX711: 24 bits -- Output voltage range: 0 ~ 5mV -- GROVE interface, support [UIFlow](http://flow.m5stack.com) and [Arduino](http://www.arduino.cc) -- Two Lego installation holes +- Two selectable differential input channels +- On-chip active low noise PGA with selectable gain +of 32, 64 and 128 +- On-chip power supply regulator for load-cell and +ADC analog power supply +- On-chip oscillator requiring no external +component with optional external crystal +- On-chip power-on-reset +- Simple digital control and serial interface: +pin-driven controls, no programming needed +- Selectable 10SPS or 80SPS output data rate +- Simultaneous 50 and 60Hz supply rejection +- Current consumption including on-chip analog +power supply regulator: + normal operation < 1.5mA, power down < 1uA +- Operation supply voltage range: 2.6 ~ 5.5V +- Operation temperature range: -40 ~ +85℃ +- 16 pin SOP-16 package +- Program Platform: Arduino, UIFlow(Blockly, Python) +- Two Lego-compatible holes ## Include @@ -50,9 +66,9 @@ The unit is connected to the pressure sensor at one end and the M5Core is connec ### 1. Arduino IDE -This example uses a 10Kg range sensor. (Unit: gram) +We used a pressure sensor(10kg) in this experiment. (Unit: gram) -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/WEIGHT/Arduino/weight)。* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/WEIGHT/Arduino/weight)。* ```arduino /* @@ -99,9 +115,7 @@ void loop(){ ### 2. UIFlow -After each download of the program with nothing on the electronic scale, you need to press the button A for calibration. Then put the object to be measured and the weight of the object will be displayed on the screen. (Unit: gram) - -*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/WEIGHT/UIFlow)。* +*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/WEIGHT/UIFlow)。* diff --git a/docs/ja/accessory/headers_socket.md b/docs/ja/accessory/headers_socket.md deleted file mode 100644 index 9d7984aa..00000000 --- a/docs/ja/accessory/headers_socket.md +++ /dev/null @@ -1,21 +0,0 @@ -# Headers Socket {docsify-ignore-all} - -## 概要 - -(近日公開...) - -## 特徴 - -## ドキュメント - -
- headers_socket_01 -
-
- headers_socket_02 -
- -## 関連情報 - -- [Headers Socket 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/3654/) -- [Headers Socket 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-2-15-2-54-4-M5Stack/3226069_32840923472.html) diff --git a/docs/ja/accessory/usb_uart_adapter.md b/docs/ja/accessory/usb_uart_adapter.md deleted file mode 100644 index d283a60e..00000000 --- a/docs/ja/accessory/usb_uart_adapter.md +++ /dev/null @@ -1,20 +0,0 @@ -# USB-TTL UART Serial Adapter {docsify-ignore-all} - -## 概要 - -(近日公開...) - -## 特徴 - -## ドキュメント - -
- usb_ttl_01 -
-
- usb_ttl_02 -
- -## 関連情報 - -- [USB-TTL UART Serial Adapter 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ttl-uart-6-c-usb/3226069_32874729163.html) \ No newline at end of file diff --git a/docs/zh_CN/accessory/headers_socket.md b/docs/zh_CN/accessory/headers_socket.md deleted file mode 100644 index abb97a56..00000000 --- a/docs/zh_CN/accessory/headers_socket.md +++ /dev/null @@ -1,4 +0,0 @@ -# Headers Socket {docsify-ignore-all} - -## (敬请期待...) - diff --git a/docs/zh_CN/unit/heart.md b/docs/zh_CN/unit/heart.md index 38c4f329..d5e4aa81 100644 --- a/docs/zh_CN/unit/heart.md +++ b/docs/zh_CN/unit/heart.md @@ -8,7 +8,7 @@ ## 描述 -**HEART** 是一款集成 MAX30110 模块，能够非侵入式检测血氧和心率的 Unit。 MAX30110 模块包含两个红外发光二极管和一个光检测器，其检测血氧饱和度的原理是通过红外 led 灯照射，检测携带氧气和非携带氧气的红血球数量比例，从而得到血氧含量。 +**HEART** 是一款集成 MAX30100 模块，能够非侵入式检测血氧和心率的 Unit。 MAX30110 模块包含两个红外发光二极管和一个光检测器，其检测血氧饱和度的原理是通过红外 led 灯照射，检测携带氧气和非携带氧气的红血球数量比例，从而得到血氧含量。 该 unit 接入 M5Core 的 GROVE A 口之后，只需要将手指紧贴在 unit 的 MAX30110 模块上，即可读出生理信息。