diff --git a/docs/assets/img/product_pics/base/core_base_01.png b/docs/assets/img/product_pics/base/core_base_01.png new file mode 100644 index 00000000..24a4ef00 Binary files /dev/null and b/docs/assets/img/product_pics/base/core_base_01.png differ diff --git a/docs/assets/img/product_pics/base/core_base_02.png b/docs/assets/img/product_pics/base/core_base_02.png new file mode 100644 index 00000000..39791dbf Binary files /dev/null and b/docs/assets/img/product_pics/base/core_base_02.png differ diff --git a/docs/assets/img/product_pics/base/core_base_03.png b/docs/assets/img/product_pics/base/core_base_03.png new file mode 100644 index 00000000..575145c7 Binary files /dev/null and b/docs/assets/img/product_pics/base/core_base_03.png differ diff --git a/docs/assets/img/product_pics/base/core_base_04.png b/docs/assets/img/product_pics/base/core_base_04.png new file mode 100644 index 00000000..bca67c06 Binary files /dev/null and b/docs/assets/img/product_pics/base/core_base_04.png differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_lite_01.png b/docs/assets/img/product_pics/core/m5go/m5go_lite_01.png new file mode 100644 index 00000000..6a5091bf Binary files /dev/null and b/docs/assets/img/product_pics/core/m5go/m5go_lite_01.png differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_lite_02.png b/docs/assets/img/product_pics/core/m5go/m5go_lite_02.png new file mode 100644 index 00000000..78b0e771 Binary files /dev/null and b/docs/assets/img/product_pics/core/m5go/m5go_lite_02.png differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_lite_03.png b/docs/assets/img/product_pics/core/m5go/m5go_lite_03.png new file mode 100644 index 00000000..715e6a55 Binary files /dev/null and b/docs/assets/img/product_pics/core/m5go/m5go_lite_03.png differ diff --git a/docs/assets/img/product_pics/core/m5go/m5go_lite_04.png b/docs/assets/img/product_pics/core/m5go/m5go_lite_04.png new file mode 100644 index 00000000..dc8a9c1b Binary files /dev/null and b/docs/assets/img/product_pics/core/m5go/m5go_lite_04.png differ diff --git a/docs/assets/img/product_pics/module/module_bus_01.png b/docs/assets/img/product_pics/module/module_bus_01.png new file mode 100644 index 00000000..40467f39 Binary files /dev/null and b/docs/assets/img/product_pics/module/module_bus_01.png differ diff --git a/docs/assets/img/product_pics/module/module_bus_02.png b/docs/assets/img/product_pics/module/module_bus_02.png new file mode 100644 index 00000000..3133e1a5 Binary files /dev/null and b/docs/assets/img/product_pics/module/module_bus_02.png differ diff --git a/docs/assets/img/product_pics/module/module_bus_03.png b/docs/assets/img/product_pics/module/module_bus_03.png new file mode 100644 index 00000000..64e51c24 Binary files /dev/null and b/docs/assets/img/product_pics/module/module_bus_03.png differ diff --git a/docs/assets/img/product_pics/tool/tool_usb_isp_01.png b/docs/assets/img/product_pics/tool/tool_usb_isp_01.png new file mode 100644 index 00000000..edf20c4a Binary files /dev/null and b/docs/assets/img/product_pics/tool/tool_usb_isp_01.png differ diff --git a/docs/assets/img/product_pics/tool/tool_usb_isp_02.png b/docs/assets/img/product_pics/tool/tool_usb_isp_02.png new file mode 100644 index 00000000..2753cd16 Binary files /dev/null and b/docs/assets/img/product_pics/tool/tool_usb_isp_02.png differ diff --git a/docs/assets/img/product_pics/tool/tool_usb_isp_03.png b/docs/assets/img/product_pics/tool/tool_usb_isp_03.png new file mode 100644 index 00000000..54fdbbf9 Binary files /dev/null and b/docs/assets/img/product_pics/tool/tool_usb_isp_03.png differ diff --git a/docs/assets/img/product_pics/tool/tool_usb_isp_04.png b/docs/assets/img/product_pics/tool/tool_usb_isp_04.png new file mode 100644 index 00000000..58bb4e89 Binary files /dev/null and b/docs/assets/img/product_pics/tool/tool_usb_isp_04.png differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/3.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/3.png deleted file mode 100644 index e8857f3c..00000000 Binary files a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/3.png and /dev/null differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/4.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/4.png deleted file mode 100644 index b6eb767e..00000000 Binary files a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/4.png and /dev/null differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_01.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_01.png new file mode 100644 index 00000000..b0411d0d Binary files /dev/null and b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_01.png differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_02.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_02.png new file mode 100644 index 00000000..380b4c3e Binary files /dev/null and b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_02.png differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_04.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_04.png index 7450d6a4..b74c776a 100644 Binary files a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_04.png and b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_04.png differ diff --git a/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_05.png b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_05.png new file mode 100644 index 00000000..fcbc0266 Binary files /dev/null and b/docs/assets/img/product_pics/unit/unit_example/DUAL_BUTTON/example_unit_dual_button_05.png differ diff --git a/docs/en/base/core_base.md b/docs/en/base/core_base.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/core/m5go_iot_starter_kit.md b/docs/en/core/m5go_iot_starter_kit.md index dbd93650..0bde6a70 100644 --- a/docs/en/core/m5go_iot_starter_kit.md +++ b/docs/en/core/m5go_iot_starter_kit.md @@ -19,10 +19,10 @@ We also supply some courses for teaching IOT programming. If you are interesting ## Feature - Programming Support -- Arduino -- ESP-IDF -- MicroPython -- TF Card Support + - Arduino + - ESP-IDF + - MicroPython +- TF Card Support (Up to 16G) ## Include diff --git a/docs/en/core/m5go_lite.md b/docs/en/core/m5go_lite.md new file mode 100644 index 00000000..9da79a20 --- /dev/null +++ b/docs/en/core/m5go_lite.md @@ -0,0 +1,91 @@ +# M5GO Lite + +gray_02gray_04 + + + + + + +* * * + + + +:memo:**[Description](#Description)**   :bulb:**[Quick Start](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[Example](#Example)**   :electric_plug:**[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-Lite-IoT-Development-Board-Kit-ESP32-MPU9250-Grove-16MFlash-DHT12-Temperature-Humidity-Sensor-Module/3226069_32965981279.html?spm=a2g1y.12024536.productList_5885013.subject_3)**   :clapper:**[Related Video](#Related-Video)** + +## 描述 + +**M5GO Lite** is a small kit which consists of one **ENV unit** and a **white M5Core**(based on ESP32 chip). It's a simple version of [M5GO IOT Starter Kit](zh_CN/core/m5go_iot_starter_kit). + +You can program M5GO Lite with [UiFlow](http://flow.m5stack.com) or Arduino IDE. + +We also supply some courses for teaching IOT programming. If you are interesting in it, contact us through Email please. + +## 特性 + +- Programming Support + - Arduino + - ESP-IDF + - MicroPython +- TF Card Support (Up to 16G) + +## 包含 + +- 1x white M5Core +- 1x M5GO Base +- 1x Units +- 1x GROVE Cables +- Type-C USB Cable +- User Manual + +gray_02gray_04 + +## Related Link + +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## 例程 + +This is a example for reading temperature, humidity and atmospheric pressure after ENV unit was connected with M5Core. 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. + +*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/Core/m5go/m5go_lite/Arduino/ENV)。* + +```arduino +/* + Install Adafruit BMP280 Library first. +*/ +#include +#include "DHT12.h" +#include //The DHT12 uses I2C comunication. +#include "Adafruit_Sensor.h" +#include + +// new two objects +DHT12 dht12; +Adafruit_BMP280 bme; + +// initialization +M5.begin(); +Wire.begin(); +bme.begin(); + +// read data +float tmp = dht12.readTemperature(); +float hum = dht12.readHumidity(); +float pressure = bme.readPressure(); +``` + +**For more examples, click [here](https://github.com/m5stack/M5Stack/tree/master/examples/Basics) please.** + +### 2. UIFlow + +*If you want the complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。* + + + + +## Related Video + +- **m5stack instroduce** + + \ No newline at end of file diff --git a/docs/en/module/bus.md b/docs/en/module/bus.md new file mode 100644 index 00000000..28401773 --- /dev/null +++ b/docs/en/module/bus.md @@ -0,0 +1 @@ +https://www.aliexpress.com/store/product/M5Stack-Official-BUS-Module-for-Arduino-ESP32-IoT-development-kit-with-2-15pin-Bus-Socket-Stackable/3226069_32967936971.html?spm=a2g1y.12024536.productList_5885013.subject_0 \ No newline at end of file diff --git a/docs/en/tool/usb_isp.md b/docs/en/tool/usb_isp.md new file mode 100644 index 00000000..aded2367 --- /dev/null +++ b/docs/en/tool/usb_isp.md @@ -0,0 +1 @@ +https://www.aliexpress.com/store/product/M5Stack-Official-ISP-USBasp-Programmer-for-51-ATMEL-AVR-Download-support-Win7-64-Random-Color/3226069_32969199531.html?spm=a2g1y.12024536.productList_5885013.subject_2 \ No newline at end of file diff --git a/docs/en/unit/color.md b/docs/en/unit/color.md index 6d1d6791..c30fd10b 100644 --- a/docs/en/unit/color.md +++ b/docs/en/unit/color.md @@ -49,24 +49,12 @@ // declaration uint16_t clear, red, green, blue; -// set to false if using a common cathode LED -#define commonAnode true -// our RGB -> eye-recognized gamma color -byte gammatable[256]; +#define commonAnode true // set to false if using a common cathode LED // new a object Adafruit_TCS34725 tcs; tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS,TCS34725_GAIN_4X); -// other function -static uint16_t color16(uint16_t r, uint16_t g, uint16_t b) { - uint16_t _color; - _color = (uint16_t)(r & 0xF8) << 8; - _color |= (uint16_t)(g & 0xFC) << 3; - _color |= (uint16_t)(b & 0xF8) >> 3; - return _color; -} - // initialization M5.begin(true, false, false); tcs.begin(); @@ -75,12 +63,6 @@ tcs.setGain(TCS34725_GAIN_4X); // read data tcs.getRawData(&red, &green, &blue, &clear); -// Figure out some basic hex code for visualization -uint32_t sum = clear; -float r, g, b; -r = red; r /= sum; g = green; g /= sum; b = blue; b /= sum; -r *= 256; g *= 256; b *= 256; -uint16_t _color = color16((int)r, (int)g, (int)b); ``` After burnt this example, PC serial terminal will print original value RGBC(red, green, blue, clear). diff --git a/docs/en/unit/env.md b/docs/en/unit/env.md index 5360c796..ee4792ef 100644 --- a/docs/en/unit/env.md +++ b/docs/en/unit/env.md @@ -37,6 +37,8 @@ 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. + *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).* ```arduino diff --git a/docs/en/unit/esp32cam.md b/docs/en/unit/esp32cam.md index f0185745..3bb47273 100644 --- a/docs/en/unit/esp32cam.md +++ b/docs/en/unit/esp32cam.md @@ -51,7 +51,7 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon - Camera specifications + CCD size : 1/4inch + Field of View : 78 degree - + Maxmium Pixel: 200W + + Maxmium Pixel: 200W (Because of the small RAM, the board can't obtain it. It can output images up to 1024*768.) - Sensor best resolution: 1600 * 1200 - Dimension: 25mm x 24mm - Weight: 5g diff --git a/docs/ja/unit/color.md b/docs/ja/unit/color.md index a09c3eb0..55e13078 100644 --- a/docs/ja/unit/color.md +++ b/docs/ja/unit/color.md @@ -39,24 +39,12 @@ // declaration uint16_t clear, red, green, blue; -// set to false if using a common cathode LED -#define commonAnode true -// our RGB -> eye-recognized gamma color -byte gammatable[256]; +#define commonAnode true // set to false if using a common cathode LED // new a object Adafruit_TCS34725 tcs; tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS,TCS34725_GAIN_4X); -// other function -static uint16_t color16(uint16_t r, uint16_t g, uint16_t b) { - uint16_t _color; - _color = (uint16_t)(r & 0xF8) << 8; - _color |= (uint16_t)(g & 0xFC) << 3; - _color |= (uint16_t)(b & 0xF8) >> 3; - return _color; -} - // initialization M5.begin(true, false, false); tcs.begin(); @@ -65,12 +53,6 @@ tcs.setGain(TCS34725_GAIN_4X); // read data tcs.getRawData(&red, &green, &blue, &clear); -// Figure out some basic hex code for visualization -uint32_t sum = clear; -float r, g, b; -r = red; r /= sum; g = green; g /= sum; b = blue; b /= sum; -r *= 256; g *= 256; b *= 256; -uint16_t _color = color16((int)r, (int)g, (int)b); ``` ルーチンを燃やした後, シリアルディスプレイ端末は元の値を印刷します diff --git a/docs/zh_CN/core/m5go_lite.md b/docs/zh_CN/core/m5go_lite.md new file mode 100644 index 00000000..fb2853a8 --- /dev/null +++ b/docs/zh_CN/core/m5go_lite.md @@ -0,0 +1,86 @@ +# M5GO Lite + +gray_02gray_04 + + + + + + +* * * + +:memo:**[描述](#描述)**   :bulb:**[上手指南](zh_CN/quick_start/m5core/m5stack_core_quick_start)**   :octocat:**[例程](#例程)**   :electric_plug:**[原理图](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)**   🛒**[购买链接](https://www.aliexpress.com/store/product/M5Stack-NEW-Lite-IoT-Development-Board-Kit-ESP32-MPU9250-Grove-16MFlash-DHT12-Temperature-Humidity-Sensor-Module/3226069_32965981279.html?spm=a2g1y.12024536.productList_5885013.subject_3)**   :clapper:**[相关视频](#相关视频)**** + +## 描述 + +**M5GO Lite** 是一款以白色 M5Core 主控为核心，附带1个 **ENV unit** 的物联网开发套件。它是 [M5GO IOT Starter Kit](zh_CN/core/m5go_iot_starter_kit) 的简单版本。 + +你可以用 [UiFlow](http://flow.m5stack.com) 或 Arduino IDE 对它编程。 + +我们也提供了一些物联网开发课程方便你更快上手使用，如果你对这个感兴趣的话，欢迎给我司发邮件。 + +## 特性 + +- 可编程，支持 [UiFlow](http://flow.m5stack.com) , MicroPython 和 Arduino +- 支持外置 TF 卡 ( 最大 16G ) + +## 包含 + +- 1x white M5Core主控 +- 1x M5GO 底座 +- 1x ENV Unit +- 1x GROVE 线 +- Type-C USB 线 +- 说明书 + +gray_02gray_04 + +## 相关链接 + +- **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) + +## 例程 + +这是 ENV Unit 接入 M5Core 的例程，能读取温湿度值和气压值。可是在编译程序之前需要先安装库 `Adafruit BMP280 Library`，然后拷贝 `Adafruit_Sensor.h` 到 `Adafruit BMP280 Library` 的安装路径 `C:\Users\\Documents\Arduino\libraries\Adafruit_BMP280_Library` 下。 + +*以下仅为用法示意，并不完整。如果需要完整例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Core/m5go/m5go_lite/Arduino/ENV)。* + +```arduino +/* + Install Adafruit BMP280 Library first. +*/ +#include +#include "DHT12.h" +#include //The DHT12 uses I2C comunication. +#include "Adafruit_Sensor.h" +#include + +// new two objects +DHT12 dht12; +Adafruit_BMP280 bme; + +// initialization +M5.begin(); +Wire.begin(); +bme.begin(); + +// read data +float tmp = dht12.readTemperature(); +float hum = dht12.readHumidity(); +float pressure = bme.readPressure(); +``` + +**更多例程，请点击[这里](https://github.com/m5stack/M5Stack/tree/master/examples/Basics)** + +### 2. UIFlow + +*具体例程请点击[这里](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Unit/ENV/UIFlow)。* + + + + +## 相关视频 + +- **m5stack的简介** + + \ No newline at end of file diff --git a/docs/zh_CN/unit/catear.md b/docs/zh_CN/unit/catear.md new file mode 100644 index 00000000..2913bb45 --- /dev/null +++ b/docs/zh_CN/unit/catear.md @@ -0,0 +1,13 @@ +# CATEAR + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://pt.aliexpress.com/store/product/M5Stack-Official-Cute-Cat-Ears-Acrylic-Handbands-with-118Pcs-NeoPixel-LED-Lights-Control-by-UI-Flow/3226069_32956969127.html?spm=a2g03.12010615.8148356.2.1f4631c86nrIn6)**       + + + +## 描述 + +**CATEAR** \ No newline at end of file diff --git a/docs/zh_CN/unit/color.md b/docs/zh_CN/unit/color.md index b90bed6d..981e7821 100644 --- a/docs/zh_CN/unit/color.md +++ b/docs/zh_CN/unit/color.md @@ -48,24 +48,12 @@ Color是一个颜色传感器. 通过GROVE接口(I2C)与M5Core相连，能够识 // declaration uint16_t clear, red, green, blue; -// set to false if using a common cathode LED -#define commonAnode true -// our RGB -> eye-recognized gamma color -byte gammatable[256]; +#define commonAnode true // set to false if using a common cathode LED // new a object Adafruit_TCS34725 tcs; tcs = Adafruit_TCS34725(TCS34725_INTEGRATIONTIME_50MS,TCS34725_GAIN_4X); -// other function -static uint16_t color16(uint16_t r, uint16_t g, uint16_t b) { - uint16_t _color; - _color = (uint16_t)(r & 0xF8) << 8; - _color |= (uint16_t)(g & 0xFC) << 3; - _color |= (uint16_t)(b & 0xF8) >> 3; - return _color; -} - // initialization M5.begin(true, false, false); tcs.begin(); @@ -74,13 +62,23 @@ tcs.setGain(TCS34725_GAIN_4X); // read data tcs.getRawData(&red, &green, &blue, &clear); +``` + + 烧录了例程后，串口显示终端会打印原始值，包括明光感应值(Clear)、红、绿、蓝(RGB) diff --git a/docs/zh_CN/unit/dual_button.md b/docs/zh_CN/unit/dual_button.md index fe46d168..faff23a0 100644 --- a/docs/zh_CN/unit/dual_button.md +++ b/docs/zh_CN/unit/dual_button.md @@ -51,7 +51,10 @@ M5.update(); - + + + + ## 原理图 diff --git a/docs/zh_CN/unit/env.md b/docs/zh_CN/unit/env.md index 1967d8d6..6f4fd788 100644 --- a/docs/zh_CN/unit/env.md +++ b/docs/zh_CN/unit/env.md @@ -34,6 +34,8 @@ ### 1. Arduino IDE +这是ENV的例程，能读取温湿度值和气压值。可是在编译程序之前需要先安装库 `Adafruit BMP280 Library`，然后拷贝 `Adafruit_Sensor.h` 到 `Adafruit BMP280 Library` 的安装路径 `C:\Users\\Documents\Arduino\libraries\Adafruit_BMP280_Library` 下。 + *以下仅为用法示意，并不完整。如果需要完整例程请点击[这里](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ENV)。* ```arduino @@ -43,7 +45,7 @@ #include #include "DHT12.h" #include //The DHT12 uses I2C comunication. -#include +#include "Adafruit_Sensor.h" #include // new two objects diff --git a/docs/zh_CN/unit/esp32cam.md b/docs/zh_CN/unit/esp32cam.md index 876d6c1a..fb5c560a 100644 --- a/docs/zh_CN/unit/esp32cam.md +++ b/docs/zh_CN/unit/esp32cam.md @@ -50,7 +50,8 @@ - 摄像头特性 + CCD尺寸: 1/4inch + 可视范围: 78 degree - + 最大像素: 200W + + 最大像素: 200W（由于本模块内存比较小，所以摄像头能拍摄200W像素图像，可是板子无法获取和处理） +- 尺寸：25mm x 24mm - 重量: 5g ## 管脚映射