diff --git a/docs/assets/img/product_pics/unit/pbhub/pbhub_i2c_addr.webp b/docs/assets/img/product_pics/unit/pbhub/pbhub_i2c_addr.webp new file mode 100644 index 00000000..124f3ff3 Binary files /dev/null and b/docs/assets/img/product_pics/unit/pbhub/pbhub_i2c_addr.webp differ diff --git a/docs/en/api/coreink/eink_api.md b/docs/en/api/coreink/eink_api.md index 084201a4..28c6f825 100644 --- a/docs/en/api/coreink/eink_api.md +++ b/docs/en/api/coreink/eink_api.md @@ -20,6 +20,8 @@ Ink_Sprite InkPageSprite(&M5.M5Ink); **Description: create image area, configure whether to get image data buff from screen driver (default is to save true)**. +?>The `x` coordinate of the >create image area must be an integer multiple of 8. (eg: 0 , 8 , 16...) Otherwise, the display will not work properly. + **Example:** ```arduino diff --git a/docs/en/api/coreink/system_api.md b/docs/en/api/coreink/system_api.md index 522dc03d..69b3a8a3 100644 --- a/docs/en/api/coreink/system_api.md +++ b/docs/en/api/coreink/system_api.md @@ -82,8 +82,31 @@ M5.update(); M5.Speaker.tone(2700); ``` +## RTC + ?> Please use `M5.begin();` to initialize RTC related functions before using +``` +typedef struct RTC_Time +{ + int8_t Hours; + int8_t Minutes; + int8_t Seconds; + RTC_Time() : Hours(),Minutes(),Seconds(){} + RTC_Time(int8_t h,int8_t m,int8_t s) : Hours(h),Minutes(m),Seconds(s){} +} RTC_TimeTypeDef; + +typedef struct RTC_Date +{ + int8_t WeekDay; + int8_t Month; + int8_t Date; + int16_t Year; + RTC_Date() : WeekDay(),Month(),Date(),Year(){} + RTC_Date(int8_t w,int8_t m,int8_t d, int16_t y) : WeekDay(w),Month(m),Date(d),Year(y){} +} RTC_DateTypeDef; +``` + ## SetTime() **Syntax:** diff --git a/docs/en/api/lcd.md b/docs/en/api/lcd.md index acce5eb4..3e3058c3 100644 --- a/docs/en/api/lcd.md +++ b/docs/en/api/lcd.md @@ -309,6 +309,7 @@ None M5.Lcd.drawBmpFile(SD, "/p2.bmp",0,0); ``` +?>We provide a script that can be used to convert `jpg` images -> `.c` files, you can use it to convert some personal images and draw them on the screen using the following API.[bin2code.py](https://github.com/m5stack/M5Stack/tree/master/tools) ## drawJpg() @@ -1583,7 +1584,7 @@ M5.begin(); M5.Lcd.drawCentreString("hello", 160, 0, 2); ``` -##drawRightString() +## drawRightString() **Description:** @@ -1612,7 +1613,7 @@ M5.begin(); M5.Lcd.drawRightString("hello", 160, 0, 2); ``` -##int16_t fontHeight() +## int16_t fontHeight() **Description:** diff --git a/docs/en/arduino/arduino_home_page.md b/docs/en/arduino/arduino_home_page.md index fa8d8406..6d602919 100644 --- a/docs/en/arduino/arduino_home_page.md +++ b/docs/en/arduino/arduino_home_page.md @@ -14,7 +14,7 @@
- +
{{item.title}} @@ -37,7 +37,8 @@ const quickstart = { 'M5Stick':'#/en/arduino/arduino_development', 'ATOM Lite / Matrix':'#/en/arduino/arduino_development', 'M5Core2':'#/en/arduino/arduino_core2_development', - } + }, + "id":"quickstart" }; const m5core_api = { @@ -55,7 +56,18 @@ const m5core_api = { 'I2C':'#/en/api/commutil', 'WIFI':'#/en/api/wifi', 'Timer':'#/en/api/ticker', - } + }, + "id":"m5core_api" +}; + +const m5core2_api = { + 'title':"M5Core2 API", + 'item':{ + 'AXP192':'#/en/api/axp192_core2', + 'TFT-SCREEN':'#/en/api/lcd', + 'TOUCH':'#/en/api/touch', + }, + "id":"m5core2_api" }; const m5stickc_api = { @@ -67,16 +79,8 @@ const m5stickc_api = { 'IMU':'#/en/api/imu', 'RTC':'#/en/api/rtc', 'PWM':'#/en/api/pwm', - } -}; - -const m5core2_api = { - 'title':"M5Core2 API", - 'item':{ - 'AXP192':'#/en/api/axp192_core2', - 'TFT-SCREEN':'#/en/api/lcd', - 'TOUCH':'#/en/api/touch', - } + }, + "id":"m5stickc_api" }; const coreink_api = { @@ -84,7 +88,8 @@ const coreink_api = { 'item':{ 'System & Button & RTC & Speaker':'#/en/api/coreink/system_api', 'E-Ink':'#/en/api/coreink/eink_api' - } + }, + "id":"coreink_api" }; diff --git a/docs/en/base/node_base.md b/docs/en/base/node_base.md index 38908dd4..bded12ff 100644 --- a/docs/en/base/node_base.md +++ b/docs/en/base/node_base.md @@ -12,7 +12,7 @@ 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: - 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 ... +- Play music from sources: HTTP, HLS(HTTP Live Streaming), SPIFFS, TF-card(microSD), 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. diff --git a/docs/en/core/basic.md b/docs/en/core/basic.md index 9de10b2b..52ddc487 100644 --- a/docs/en/core/basic.md +++ b/docs/en/core/basic.md @@ -154,7 +154,7 @@ M5Stack Basic is consist with two separable parts. The upside part has all kinds

Description:

-

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, SD card, screen, etc.

+

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, TF-card(microSD), screen, etc.

@@ -358,7 +358,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Schematic diff --git a/docs/en/core/core2.md b/docs/en/core/core2.md index bbfbcf4b..04cc1291 100644 --- a/docs/en/core/core2.md +++ b/docs/en/core/core2.md @@ -18,7 +18,7 @@ The MCU is an ESP32 model D0WDQ6-V3 and has dual core Xtensa® 32-bit 240Mhz LX6 M5Core2 also features a built-in RTC module which can provide accurate timing. The power supply is managed by an AXP192 power management chip, which can effectively control the power consumption of the base and a built-in green LED power indicator helps to notify the user of battery level. The battery capacity has been upgraded to 390mAh, which can power the core for much longer than the previous model. -The M5Core2 retains the SD card slot and speakers. However, in order to ensure higher quality sound output, the I2S digital audio interface power amplifier chip is used to effectively prevent signal distortion. There are independent power and reset buttons on the left side and bottom of the base. +The M5Core2 retains the TF-card(microSD) slot and speakers. However, in order to ensure higher quality sound output, the I2S digital audio interface power amplifier chip is used to effectively prevent signal distortion. There are independent power and reset buttons on the left side and bottom of the base. The 3 icons on the front of the screen are capacitive buttons which are programmable. There is a small expansion board on the back of the base with a 6-axis IMU sensor and microphone. The development platform and programming language supported by M5Stack Core2: Arduino, [UIFlow](http://flow.m5stack.com) (using Blockly, MicroPython language) No matter what level of your development and programming skills, M5Stack will help You gradually turn your ideas into reality. @@ -196,7 +196,7 @@ Restart: Click the RST button at the bottom

Description:

-

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, SD card, screen, etc.

+

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, TF-card(microSD), screen, etc.

@@ -350,7 +350,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core2_api) ## Schematic diff --git a/docs/en/core/core2_aws.md b/docs/en/core/core2_aws.md index cb9b1d21..c8a91137 100644 --- a/docs/en/core/core2_aws.md +++ b/docs/en/core/core2_aws.md @@ -10,7 +10,7 @@ ### Core2 -**Core2** is the second generation device in the M5Stack development kit series. based on the original first generation device, with enhanced and improved hardware functionalities. The main controller which is based on the ESP32 D0WDQ6-V3 model cmomes with two Xtensa® 32-bit LX6 processors that can be controlled separately, the main frequency supports up to 240Mhz additionally to WiFi and Bluetooth and onboard 16MB Flash and 8MB PSRAM functionalities. The TYPE-C interface can be used to Download and upload programs to the microcontroller, The front side of the Core2 is equipped with a 2.0-inch integrated capacitive touch screen, which brings users a smoother human-computer interaction experience. The case has a built-in vibration motor, which can provide feedback and vibration reminder functionalities. The built-in RTC module can provide accurate timing, The power supply is equipped with AXP192 power management chip which can effectively control the power consumption of the Core2, At the same time, the Core2 is equipped with an SD card slot and speakers. In order to ensure higher quality sound effects, the I2S digital audio interface power amplifier chip can effectively prevent signal distortion. There are independent power buttons and reset (RST) buttons on the left and bottom of the Core2. The 3 dots on the front of the screen are part of the touch screen, and the hot zone (touch screen) can be mapped to 3 virtual buttons by programming. +**Core2** is the second generation device in the M5Stack development kit series. based on the original first generation device, with enhanced and improved hardware functionalities. The main controller which is based on the ESP32 D0WDQ6-V3 model cmomes with two Xtensa® 32-bit LX6 processors that can be controlled separately, the main frequency supports up to 240Mhz additionally to WiFi and Bluetooth and onboard 16MB Flash and 8MB PSRAM functionalities. The TYPE-C interface can be used to Download and upload programs to the microcontroller, The front side of the Core2 is equipped with a 2.0-inch integrated capacitive touch screen, which brings users a smoother human-computer interaction experience. The case has a built-in vibration motor, which can provide feedback and vibration reminder functionalities. The built-in RTC module can provide accurate timing, The power supply is equipped with AXP192 power management chip which can effectively control the power consumption of the Core2, At the same time, the Core2 is equipped with an TF-card(microSD) slot and speakers. In order to ensure higher quality sound effects, the I2S digital audio interface power amplifier chip can effectively prevent signal distortion. There are independent power buttons and reset (RST) buttons on the left and bottom of the Core2. The 3 dots on the front of the screen are part of the touch screen, and the hot zone (touch screen) can be mapped to 3 virtual buttons by programming. ### M5GO-Bottom For AWS @@ -194,7 +194,7 @@

Description:

-

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, SD card, screen, etc.

+

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, TF-card(microSD), screen, etc.

@@ -364,7 +364,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core2_api) ## Schematic diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index 9b89e369..6440c19e 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -359,7 +359,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Schematic diff --git a/docs/en/core/fire.md b/docs/en/core/fire.md index f9690534..5fab1ff5 100644 --- a/docs/en/core/fire.md +++ b/docs/en/core/fire.md @@ -355,7 +355,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Version Change diff --git a/docs/en/core/gray.md b/docs/en/core/gray.md index 1e54e35c..d23ce406 100644 --- a/docs/en/core/gray.md +++ b/docs/en/core/gray.md @@ -155,7 +155,7 @@ If you ever played with ESP8266, you would realize that ESP32 is a perfect upgra

Description:

-

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, SD card, screen, etc.

+

This case will perform hardware running tests for speakers, wifi, buttons, accelerometer, TF-card(microSD), screen, etc.

@@ -335,7 +335,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Example diff --git a/docs/en/core/m5go.md b/docs/en/core/m5go.md index 66023217..8bfad44d 100644 --- a/docs/en/core/m5go.md +++ b/docs/en/core/m5go.md @@ -339,7 +339,7 @@ To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Schematic diff --git a/docs/en/core/m5go_lite.md b/docs/en/core/m5go_lite.md index d8baa64e..6a6a4f22 100644 --- a/docs/en/core/m5go_lite.md +++ b/docs/en/core/m5go_lite.md @@ -332,7 +332,7 @@ For more information about Pin assignment and Pin Remapping, Please refer to [ES - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5core_api) ## Schematic diff --git a/docs/en/core/m5paper.md b/docs/en/core/m5paper.md index 8f9c3c85..a35cc4fe 100644 --- a/docs/en/core/m5paper.md +++ b/docs/en/core/m5paper.md @@ -4,7 +4,7 @@ ## Description -**M5Paper** is M5Stacks latest core device with a touch enabled E-ink display. Powered by the ESP32-D0WDQ6-V3 this is our first device to integrate a super sized 540*960 @4.7" E-ink display，which supports 16 grayscale levels. The display is a GT911 capacitive touch screen，which supports two point touch and a variety of gesture controls . Compared to a regular LCD，E-ink displays are easier on the eyes, which makes them a great choice for reading or viewing for longer periods. Other benefits are the low power consumption and the ability to retain the image even if power to the display is terminated. Integrated in the CoreInk are an multi-function button for operation, SHT30 temperature and moisture sensor, physical buttons and an SD card port for data storage. +**M5Paper** is M5Stacks latest core device with a touch enabled E-ink display. Powered by the ESP32-D0WDQ6-V3 this is our first device to integrate a super sized 540*960 @4.7" E-ink display，which supports 16 grayscale levels. The display is a GT911 capacitive touch screen，which supports two point touch and a variety of gesture controls . Compared to a regular LCD，E-ink displays are easier on the eyes, which makes them a great choice for reading or viewing for longer periods. Other benefits are the low power consumption and the ability to retain the image even if power to the display is terminated. Integrated in the CoreInk are an multi-function button for operation, SHT30 temperature and moisture sensor, physical buttons and an TF-card(microSD) port for data storage. Additionally the FM24C02 internal eeprom chip(256KB-EEPROM)can be used to store vital data even when the device is off. A 1150mAh lipo battery keeps the device going for long periods and battery life can be further preserved by using the RTC(BM8563)to set the device into deep sleep and wake it up again when needed。Three HY2.0-4P expansion ports are included which allow for building complex projects using the existing sensors in the M5Stack ecosystem. @@ -55,7 +55,7 @@ Additionally the FM24C02 internal eeprom chip(256KB-EEPROM)can be used to store Ports - TypeC*1, HY2.0-4P*3 , SD/TF card slot + TypeC*1, HY2.0-4P*3 , TF-card(microSD) slot E-Ink Display @@ -109,14 +109,14 @@ Additionally the FM24C02 internal eeprom chip(256KB-EEPROM)can be used to store ## PinMap -**E-INK & SD Card** +**E-INK & TF-card(microSD)** Resolution：540*960 - +
ESP32 ChipGPIO13GPIO12GPIO14GPIO15GPIO4
IT8951MISOMOSISCKCS/
SD CardMISOMOSISCK/CS
TF-card(microSD)MISOMOSISCK/CS
@@ -206,7 +206,6 @@ For more info on specific pin functions refer to the official ESP32 Docs[ESP32 d - [SHT30 Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/SHT3x_Datasheet_digital.pdf) - [BM8563](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BM8563_V1.1_cn.pdf) - [SY7088](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/SY7088-Silergy.pdf) - - [GT911-datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/m5paper/gt911_datasheet.pdf) - **API** diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index be71b236..b798cf52 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -263,7 +263,7 @@ Resolution：80 * 160 - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5stickc_api) ## structural-design-file diff --git a/docs/en/core/m5stickc_plus.md b/docs/en/core/m5stickc_plus.md index 35fb3047..7443dd89 100644 --- a/docs/en/core/m5stickc_plus.md +++ b/docs/en/core/m5stickc_plus.md @@ -269,7 +269,7 @@ Resolution：135 * 240 - **API** - - [Arduino API](en/arduino/arduino_home_page) + - [Arduino API](en/arduino/arduino_home_page?id=m5stickc_api) - **Arduino Library** - [M5StickC_PLUS Library](https://github.com/m5stack/M5StickC-Plus) diff --git a/docs/en/core/m5stickv.md b/docs/en/core/m5stickv.md index b82f757c..8b5318f2 100644 --- a/docs/en/core/m5stickv.md +++ b/docs/en/core/m5stickv.md @@ -121,7 +121,7 @@ It is able to perform convolutional neural network calculations at low power con External storage - TF Card/Micro SD + TF-card(microSD) MEMS @@ -150,9 +150,9 @@ It is able to perform convolutional neural network calculations at low power con -### SD card test +### TF-card(microSD) test -M5StickV does not currently recognize all types of SD cards. We have tested some common SD cards. The test results are as follows. +M5StickV does not currently recognize all types of TF-card(microSD). We have tested some common TF-card(microSD). The test results are as follows. diff --git a/docs/en/hat/hat_roverc_pro.md b/docs/en/hat/hat_roverc_pro.md index 7ca234dc..bf23b41f 100644 --- a/docs/en/hat/hat_roverc_pro.md +++ b/docs/en/hat/hat_roverc_pro.md @@ -70,13 +70,13 @@ The PRO version provides a gripping mechanism controlled by a servo for gripping Servo Gripper - ● - - + x1 + -//td> - 2 Servo Pin - ● - - + Servo Ext Port + x2 + / Battery @@ -124,8 +124,8 @@ MotorControl： - - + +
Servo numberAngle(Register address)Parameter valuePulse(Register address)Parameter value
010x100~180°0x20500~2500ms
020x110~180°0x21500~2500ms
010x100~180°0x20500~2500us
020x110~180°0x21500~2500us
## Example @@ -136,7 +136,7 @@ Use with JoyC HAT(without servo gripper), please click [here](https://github.com Before use, please make sure that the RoverC is fully charged. Charging method: insert M5StickC/M5StickC Plus into the RoverC, and connect the USB cable for charging.Burn the easyloader firmware of JoyC and RoverC with two M5StickC respectively. Insert JoyC and RoverC respectively after burning. After power on, RoverC will display the MAC address name and battery level. At the same time, JoyC will scan for the MAC address of RoverC. Long press the A key of M5StickC on Joyc, and the two will be paired. Left thumbstick controlls forward and back motion, left and right control translation, right thumbstick controls left and right steering. Independent(with servo gripper) usage [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Application/RoverC_PRO_Arduino_Alone) -0ppp + ### 2. UIFlow diff --git a/docs/en/unit/pbhub.md b/docs/en/unit/pbhub.md index 6a1d5ac6..03f6bbba 100644 --- a/docs/en/unit/pbhub.md +++ b/docs/en/unit/pbhub.md @@ -55,6 +55,71 @@ See the below picture for timing sequence of HX711: + +## Change I2C Address + +The I2C address of the unit is 0x40 (which can be changed by using solder resistors A0 ~ A2, the address range is 0x40~0x47). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
A0A1A2I2C Address
///0x40
Resistors//0x41
/Resistors/0x42
ResistorsResistors/0x43
//Resistors0x44
Resistors/Resistors0x45
/ResistorsResistors0x46
ResistorsResistorsResistors0x47
+ + ## EasyLoader diff --git a/docs/zh_CN/api/coreink/eink_api.md b/docs/zh_CN/api/coreink/eink_api.md index 07201f0b..b312a9df 100644 --- a/docs/zh_CN/api/coreink/eink_api.md +++ b/docs/zh_CN/api/coreink/eink_api.md @@ -20,6 +20,8 @@ Ink_Sprite InkPageSprite(&M5.M5Ink); **功能：创建图像区域，配置是否从屏幕驱动获取图像数据buff(默认为保存true)** +?>创建图像区域的`x`坐标必须为8的整数倍.（eg： 0 , 8 , 16...）否则会出现显示不正常的状况。 + **例程** ```arduino diff --git a/docs/zh_CN/api/coreink/system_api.md b/docs/zh_CN/api/coreink/system_api.md index d837a62a..9e1390d5 100644 --- a/docs/zh_CN/api/coreink/system_api.md +++ b/docs/zh_CN/api/coreink/system_api.md @@ -52,8 +52,6 @@ M5.update(); `M5.BtnPWR.wasPressed()` -?>RTC相关函数使用前请使用`M5.begin();`进行初始化 - ## Speaker **功能：蜂鸣器驱动** @@ -83,6 +81,32 @@ M5.update(); M5.Speaker.tone(2700); ``` +## RTC + +?>RTC相关函数使用前请使用`M5.begin();`进行初始化 + + +``` +typedef struct RTC_Time +{ + int8_t Hours; + int8_t Minutes; + int8_t Seconds; + RTC_Time() : Hours(),Minutes(),Seconds(){} + RTC_Time(int8_t h,int8_t m,int8_t s) : Hours(h),Minutes(m),Seconds(s){} +} RTC_TimeTypeDef; + +typedef struct RTC_Date +{ + int8_t WeekDay; + int8_t Month; + int8_t Date; + int16_t Year; + RTC_Date() : WeekDay(),Month(),Date(),Year(){} + RTC_Date(int8_t w,int8_t m,int8_t d, int16_t y) : WeekDay(w),Month(m),Date(d),Year(y){} +} RTC_DateTypeDef; +``` + ## SetTime() **函数原型:** diff --git a/docs/zh_CN/api/lcd.md b/docs/zh_CN/api/lcd.md index aeb762f4..80049756 100644 --- a/docs/zh_CN/api/lcd.md +++ b/docs/zh_CN/api/lcd.md @@ -369,6 +369,7 @@ Generate a QR code. M5.Lcd.drawBmpFile(SD, "/p2.bmp",0,0); ``` +?>我们提供一个可以用来转换`jpg`图像->`.c`文件的脚本，你可以使用它来转换一些个人图片，并使用下面的API将图像绘制到屏幕上。[bin2code.py](https://github.com/m5stack/M5Stack/tree/master/tools) ## drawJpg() diff --git a/docs/zh_CN/api/m5paper/epd_canvas.md b/docs/zh_CN/api/m5paper/epd_canvas.md new file mode 100644 index 00000000..0efd4309 --- /dev/null +++ b/docs/zh_CN/api/m5paper/epd_canvas.md @@ -0,0 +1,512 @@ +## EPD Driver + +>M5PAPER搭载了一块分辨率为540*960 @4.7"的电子墨水屏，支持16级灰度显示. 在`M5.begin()`初始化中，已经创建了实例`M5EPD_Driver EPD = M5EPD_Driver();`并进行了初始化.通过下面的屏幕驱动,你能够将内容绘制的数据推送至屏幕. + + +- `m5epd_err_t begin(int8_t sck, int8_t mosi, int8_t miso, int8_t cs, int8_t busy, int8_t rst = -1);` + +- `m5epd_err_t Clear(bool init = false);` + +- `m5epd_err_t WriteFullGram4bpp(const uint8_t *gram);` + +- `m5epd_err_t WritePartGram4bpp(uint16_t x, uint16_t y, uint16_t w, uint16_t h, const uint8_t *gram);` + +- `m5epd_err_t FillPartGram4bpp(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t data);` + +- `m5epd_err_t SetRotation(uint16_t rotate = IT8951_ROTATE_0);` + +- `m5epd_err_t SetArea(uint16_t x, uint16_t y, uint16_t w, uint16_t h);` + +- `m5epd_err_t UpdateFull(m5epd_update_mode_t mode);` + +- `m5epd_err_t UpdateArea(uint16_t x, uint16_t y, uint16_t w, uint16_t h, m5epd_update_mode_t mode);` + +- `uint16_t UpdateCount(void);` + +- `uint8_t GetRotate(void) {return _rotate;};` + +- `uint8_t GetDirection(void) {return _direction;};` + +- `void ResetUpdateCount(void);` + +- `m5epd_err_t CheckAFSR(void);` + +- `SPIClass* GetSPI(void) {return _epd_spi;}` + +- `void SetColorReverse(bool is_reverse);` + +## Canvas + +>该库使用`Canvas`类进行图案绘制，该类中提供了多种绘图API(其中包含绘制字符串，矩形，三角形，圆形，图片数据等). 使用前需要创建canvas实例并传入屏幕驱动，如下方代码所示。 + +``` +#include + +M5EPD_Canvas canvas(&M5.EPD); +``` + +## 创建/删除Canvas + +>在开始绘图前，我们需要使用Canvas实例创建一个绘制区域 + +- **功能：创建Canvas** +- `void *createCanvas(int16_t width, int16_t height, uint8_t frames = 1) { return TFT_eSprite::createSprite(width, height, frames); };` + +- **功能：删除Canvas** +- `void deleteCanvas(void) { TFT_eSprite::deleteSprite(); }` + +``` +#include + +M5EPD_Canvas canvas(&M5.EPD); + +M5.begin(); +M5.EPD.SetRotation(90); +canvas.createCanvas(400, 300); + +``` + +## 推送Canvas + +>在使用绘图API完成内容绘制后，我们需要使用`push`API将绘制区域推送到屏幕。 + +// Re-implement functions + +- `void *frameBuffer(int8_t f = 1);` + +- `void pushCanvas(int32_t x, int32_t y, m5epd_update_mode_t mode);` + +- `void pushCanvas(m5epd_update_mode_t mode);` + +- `void pushToCanvas(int32_t x, int32_t y, M5EPD_Canvas* canvas);` + +**例程：** + +``` +#include + +M5EPD_Canvas canvas(&M5.EPD); + +void setup() +{ + M5.begin(); + M5.EPD.SetRotation(90); + M5.EPD.Clear(true); + canvas.createCanvas(540, 960); + canvas.setTextSize(3); + canvas.drawString("Hello World!", 50, 350); + canvas.drawString("Hello M5Stack!", 45, 450); + canvas.pushCanvas(0,0,UPDATE_MODE_DU4); +} + +void loop() +{ + +} + +``` + +## 刷新模式 + +>在使用`pushCanvas`时，我们需要传入一个刷新模式参数，在该库中的`m5epd_update_mode_t`已经枚举了几种不同的刷新模式，下面为你说明它们分别有什么样的特点。 + +``` +typedef enum // Typical +{ // Ghosting Update Time Usage + UPDATE_MODE_INIT = 0, // * N/A 2000ms Display initialization, + UPDATE_MODE_DU = 1, // Low 260ms Monochrome menu, text input, and touch screen input 1bit黑白，存在残影 + UPDATE_MODE_GC16 = 2, // * Very Low 450ms High quality images + UPDATE_MODE_GL16 = 3, // * Medium 450ms Text with white background + UPDATE_MODE_GLR16 = 4, // Low 450ms Text with white background + UPDATE_MODE_GLD16 = 5, // Low 450ms Text and graphics with white background + UPDATE_MODE_DU4 = 6, // * Medium 120ms Fast page flipping at reduced contrast 1bit黑白 稍微比DU快一点，残影相对DU较大 + UPDATE_MODE_A2 = 7, // Medium 290ms Anti-aliased text in menus / touch and screen input 2bit灰度，残影 + UPDATE_MODE_NONE = 8 上传至8951缓存区 不刷新。 +} m5epd_update_mode_t; // The ones marked with * are more commonly used + + + + UPDATE_MODE_GC16 = 2, // * Very Low 450ms High quality images 先黑闪后刷新 + UPDATE_MODE_GL16 = 3, // * Medium 450ms Text with white background 不黑闪 + UPDATE_MODE_GLR16 = 4, // Low 450ms Text with white background 不黑闪 + UPDATE_MODE_GLD16 = 5, // Low 450ms Text and graphics with white background 不黑闪 + + 刷新质量较好 + +``` + + + + + +- `uint16_t readPixel(int32_t x, int32_t y);` + +- `void pushImage(int32_t x, int32_t y, int32_t w, int32_t h, const uint8_t *data);` + +- `void pushImage(int32_t x, int32_t y, int32_t w, int32_t h, uint8_t transp, const uint8_t *data);` + + + +- `void fillCanvas(uint32_t color);` + + +- `void drawPixel(int32_t x, int32_t y, uint32_t color);` + + +- `uint16_t alphaBlend16(uint8_t alpha, uint8_t fgc, uint8_t bgc);` + + +- `void drawFreetypeBitmap(int32_t cx, int32_t cy, uint16_t bw, uint16_t bh, uint8_t *bitmap);` + + + +**例程：** + + + + + + + + + + +- `void setDriver(M5EPD_Driver *driver);` + +- `void qrcode(const char *string, uint16_t x = 50, uint16_t y = 10, uint16_t width = 220, uint8_t version = 6);` + +- `void qrcode(const String &string, uint16_t x = 50, uint16_t y = 10, uint16_t width = 220, uint8_t version = 6);` + +- `void fillCenterSquare(int32_t cx, int32_t cy, uint16_t w, uint8_t color);` + +- `void drawLine(int32_t x0, int32_t y0, int32_t x1, int32_t y1, uint8_t thickness, uint8_t color);` + +- `void drawFastVLine(int32_t x, int32_t y, int32_t h, uint8_t thickness, uint8_t color);` + +- `void drawFastHLine(int32_t x, int32_t y, int32_t w, uint8_t thickness, uint8_t color);` + +- `void fillRect(int32_t x, int32_t y, int32_t w, int32_t h, uint32_t color);` + +- `uint32_t getBufferSize(void) {return _buffer_size;}` + +- `void ReverseColor(void);` + +- `void ReversePartColor(int32_t x, int32_t y, int32_t w, int32_t h);` + +- `void operator=(const M5EPD_Canvas &src);` + + + + +## JPG/BMP/PNG + +- **功能：使用Bmp文件数据绘制图像** +- `bool drawBmpFile(fs::FS &fs, const char *path, uint16_t x, uint16_t y); +- `bool drawBmpFile(fs::FS &fs, String path, uint16_t x, uint16_t y);` + + +- **功能：使用Jpg文件数据绘制图像** +- `bool drawJpgFile(fs::FS &fs, const char *path, uint16_t x = 0, + uint16_t y = 0, uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + jpeg_div_t scale = JPEG_DIV_NONE);` + +- `bool drawJpgFile(fs::FS &fs, String path, uint16_t x = 0, + uint16_t y = 0, uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + jpeg_div_t scale = JPEG_DIV_NONE);` + +- **功能：使用Png文件数据绘制图像** +- `bool drawPngFile(fs::FS &fs, const char *path, uint16_t x = 0, uint16_t y = 0, + uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + double scale = 1.0, uint8_t alphaThreshold = 127);` + +- `bool drawPngFile(fs::FS &fs, String path, uint16_t x = 0, uint16_t y = 0, + uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + double scale = 1.0, uint8_t alphaThreshold = 127);` + +- **功能：使用内存Jpg数据绘制图像** +- `bool drawJpg(const uint8_t *jpg_data, size_t jpg_len, uint16_t x = 0, + uint16_t y = 0, uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + jpeg_div_t scale = JPEG_DIV_NONE);` + +- **功能：使用Jpg的Url/网络资源数据绘制图像** +- `bool drawJpgUrl(String url, uint16_t x = 0, + uint16_t y = 0, uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, jpeg_div_t scale = JPEG_DIV_NONE);` + + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `bool drawPngUrl(const char *url, uint16_t x = 0, uint16_t y = 0, + uint16_t maxWidth = 0, uint16_t maxHeight = 0, + uint16_t offX = 0, uint16_t offY = 0, + double scale = 1.0, uint8_t alphaThreshold = 127);` + + + + + + + +- `uint32_t getExceedOffset(void) {return TFT_eSPI::getExceedOffset();}` + +- `void setTextArea(uint16_t x, uint16_t y, uint16_t w, uint16_t h) {TFT_eSprite::setTextArea(x,y,w,h);}` + +- `size_t write(uint8_t utf8){return TFT_eSprite::write(utf8);}` + +- `void *createCanvas(int16_t width, int16_t height, uint8_t frames = 1) { return TFT_eSprite::createSprite(width, height, frames); };` + +- `void deleteCanvas(void) { TFT_eSprite::deleteSprite(); }` + + + + +- `void setPivot(int16_t x, int16_t y) { TFT_eSprite::setPivot(x, y); }` + +- `int16_t getPivotX(void) { return _xpivot; }` + +- `int16_t getPivotY(void) { return _ypivot; }` + +- `int16_t width(void) { return _dwidth; }` + +- `int16_t height(void) { return _dheight; }` + +- `void setCursor(int16_t x, int16_t y) { TFT_eSPI::setCursor(x, y); }` + +- `void setCursor(int16_t x, int16_t y, uint8_t font) { TFT_eSPI::setCursor(x, y, font); }` + +- `int16_t getCursorX(void) { return TFT_eSPI::getCursorX(); }` + +- `int16_t getCursorY(void) { return TFT_eSPI::getCursorY(); }` + +- `uint16_t fontsLoaded(void) { return TFT_eSPI::fontsLoaded(); }` + + + + + + + + + +- `int16_t textWidth(const char *string, uint8_t font) {return TFT_eSPI::textWidth(string, font);}` + +- `int16_t textWidth(const char *string) {return TFT_eSPI::textWidth(string);}` + +- `int16_t textWidth(const String& string, uint8_t font) {return TFT_eSPI::textWidth(string, font);}` + +- `int16_t textWidth(const String& string) {return TFT_eSPI::textWidth(string);}` + + + + +## Drawing + + // Parent functions - drawing + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawCircle(int32_t x0, int32_t y0, int32_t r, uint32_t color) { TFT_eSPI::drawCircle(x0, y0, r, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawCircleHelper(int32_t x0, int32_t y0, int32_t r, uint8_t cornername, uint32_t color) { TFT_eSPI::drawCircleHelper(x0, y0, r, cornername, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void fillCircle(int32_t x0, int32_t y0, int32_t r, uint32_t color) { TFT_eSPI::fillCircle(x0, y0, r, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void fillCircleHelper(int32_t x0, int32_t y0, int32_t r, uint8_t cornername, int32_t delta, uint32_t color) { TFT_eSPI::fillCircleHelper(x0, y0, r, cornername, delta, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setWindow(int32_t x0, int32_t y0, int32_t x1, int32_t y1) { TFT_eSprite::setWindow(x0, y0, x1, y1); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void pushColor(uint32_t color) { TFT_eSprite::pushColor(color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void pushColor(uint32_t color, uint16_t len) { TFT_eSprite::pushColor(color, len); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void writeColor(uint16_t color) { TFT_eSprite::writeColor(color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawLine(int32_t x0, int32_t y0, int32_t x1, int32_t y1, uint32_t color) { TFT_eSprite::drawLine(x0, y0, x1, y1, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawFastVLine(int32_t x, int32_t y, int32_t h, uint32_t color) { TFT_eSprite::drawFastVLine(x, y, h, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawFastHLine(int32_t x, int32_t y, int32_t w, uint32_t color) { TFT_eSprite::drawFastHLine(x, y, w, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawChar(int32_t x, int32_t y, uint16_t c, uint32_t color, uint32_t bg, uint8_t size) { TFT_eSprite::drawChar(x, y, c, color, bg, size); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawChar(uint16_t uniCode, int32_t x, int32_t y) { return TFT_eSprite::drawChar(uniCode, x, y); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawChar(uint16_t uniCode, int32_t x, int32_t y, uint8_t font) { return TFT_eSprite::drawChar(uniCode, x, y, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawGlyph(uint16_t code) { TFT_eSprite::drawGlyph(code); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void printToSprite(String string) { TFT_eSprite::printToSprite(string); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void printToSprite(char *cbuffer, uint16_t len) { TFT_eSprite::printToSprite(cbuffer, len); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t printToSprite(int16_t x, int16_t y, uint16_t index) { return TFT_eSprite::printToSprite(x, y, index); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawEllipse(int16_t x0, int16_t y0, int32_t rx, int32_t ry, uint16_t color) { TFT_eSPI::drawEllipse(x0, y0, rx, ry, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void fillEllipse(int16_t x0, int16_t y0, int32_t rx, int32_t ry, uint16_t color) { TFT_eSPI::fillEllipse(x0, y0, rx, ry, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawRect(int32_t x, int32_t y, int32_t w, int32_t h, uint32_t color) { TFT_eSPI::drawRect(x, y, w, h, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawRoundRect(int32_t x0, int32_t y0, int32_t w, int32_t h, int32_t radius, uint32_t color) { TFT_eSPI::drawRoundRect(x0, y0, w, h, radius, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void fillRoundRect(int32_t x0, int32_t y0, int32_t w, int32_t h, int32_t radius, uint32_t color) { TFT_eSPI::fillRoundRect(x0, y0, w, h, radius, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void drawTriangle(int32_t x0, int32_t y0, int32_t x1, int32_t y1, int32_t x2, int32_t y2, uint32_t color) { TFT_eSPI::drawTriangle(x0, y0, x1, y1, x2, y2, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void fillTriangle(int32_t x0, int32_t y0, int32_t x1, int32_t y1, int32_t x2, int32_t y2, uint32_t color) { TFT_eSPI::fillTriangle(x0, y0, x1, y1, x2, y2, color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextColor(uint16_t color) { TFT_eSPI::setTextColor(color); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextColor(uint16_t fgcolor, uint16_t bgcolor) { TFT_eSPI::setTextColor(fgcolor, bgcolor); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextSize(uint8_t size) { TFT_eSPI::setTextSize(size); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextWrap(boolean wrapX, boolean wrapY = false) { TFT_eSPI::setTextWrap(wrapX, wrapY); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextDatum(uint8_t datum) { TFT_eSPI::setTextDatum(datum); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `void setTextPadding(uint16_t x_width) { TFT_eSPI::setTextPadding(x_width); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawNumber(long long_num, int32_t poX, int32_t poY, uint8_t font) { return TFT_eSPI::drawNumber(long_num, poX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawNumber(long long_num, int32_t poX, int32_t poY) { return TFT_eSPI::drawNumber(long_num, poX, poY); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawFloat(float floatNumber, uint8_t decimal, int32_t poX, int32_t poY, uint8_t font) { return TFT_eSPI::drawFloat(floatNumber, decimal, poX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawFloat(float floatNumber, uint8_t decimal, int32_t poX, int32_t poY) { return TFT_eSPI::drawFloat(floatNumber, decimal, poX, poY); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawString(const char *string, int32_t poX, int32_t poY, uint8_t font) { return TFT_eSPI::drawString(string, poX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawString(const char *string, int32_t poX, int32_t poY) { return TFT_eSPI::drawString(string, poX, poY); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawCentreString(const char *string, int32_t dX, int32_t poY, uint8_t font) { return TFT_eSPI::drawCentreString(string, dX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawRightString(const char *string, int32_t dX, int32_t poY, uint8_t font) { return TFT_eSPI::drawRightString(string, dX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawString(const String &string, int32_t poX, int32_t poY, uint8_t font) { return TFT_eSPI::drawString(string, poX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawString(const String &string, int32_t poX, int32_t poY) { return TFT_eSPI::drawString(string, poX, poY); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawCentreString(const String &string, int32_t dX, int32_t poY, uint8_t font) { return TFT_eSPI::drawCentreString(string, dX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `int16_t drawRightString(const String &string, int32_t dX, int32_t poY, uint8_t font) { return TFT_eSPI::drawRightString(string, dX, poY, font); }` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `uint16_t decodeUTF8(uint8_t *buf, uint16_t *index, uint16_t remaining) { return TFT_eSPI::decodeUTF8(buf, index, remaining); };` + +- **功能：使用Png的Url/网络资源数据绘制图像** +- `uint16_t decodeUTF8(uint8_t *buf, uint16_t *index, uint16_t remaining, uint8_t *length) { return TFT_eSPI::decodeUTF8(buf, index, remaining, length); };` + + + +// Parent functions - Print +- `size_t printf(const char * format, ...) __attribute__ ((format (printf, 2, 3)));` + +- `size_t print(const __FlashStringHelper *x){return Print::print(x);}` + +- `size_t print(const String &x){return Print::print(x);}` + +- `size_t print(const char x[]){return Print::print(x);}` + +- `size_t print(char x){return Print::print(x);}` + +- `size_t print(unsigned char x, int y = DEC){return Print::print(x, y);}` + +- `size_t print(int x, int y = DEC){return Print::print(x, y);}` + +- `size_t print(unsigned int x, int y = DEC){return Print::print(x, y);}` + +- `size_t print(long x, int y = DEC){return Print::print(x, y);}` + +- `size_t print(unsigned long x, int y = DEC){return Print::print(x, y);}` + +- `size_t print(double x, int y = 2){return Print::print(x, y);}` + +- `size_t print(const Printable& x){return Print::print(x);}` + +- `size_t print(struct tm * timeinfo, const char * format = NULL){return Print::print(timeinfo, format);}` + + +- `size_t println(const __FlashStringHelper *x){return Print::println(x);}` + +- `size_t println(const String &x){return Print::println(x);}` + +- `size_t println(const char x[]){return Print::println(x);}` + +- `size_t println(char x){return Print::println(x);}` + +- `size_t println(unsigned char x, int y = DEC){return Print::println(x, y);}` + +- `size_t println(int x, int y = DEC){return Print::println(x, y);}` + +- `size_t println(unsigned int x, int y = DEC){return Print::println(x, y);}` + +- `size_t println(long x, int y = DEC){return Print::println(x, y);}` + +- `size_t println(unsigned long x, int y = DEC){return Print::println(x, y);}` + +- `size_t println(double x, int y = 2){return Print::println(x, y);}` + +- `size_t println(const Printable& x){return Print::println(x);}` + +- `size_t println(struct tm * timeinfo, const char * format = NULL){return Print::println(timeinfo, format);}` + +- `size_t println(void){return Print::println();}` + + + + + + + + + + + + + diff --git a/docs/zh_CN/api/m5paper/system_api.md b/docs/zh_CN/api/m5paper/system_api.md new file mode 100644 index 00000000..fe627a46 --- /dev/null +++ b/docs/zh_CN/api/m5paper/system_api.md @@ -0,0 +1,349 @@ +# System & Button & SHT30 & POWER & RTC + +## begin() + +**函数原型：** + +`void begin(bool touchEnable = true, bool SDEnable = true, bool SerialEnable = true, bool BatteryADCEnable = true, bool I2CEnable = false);` + +**功能：初始化触摸屏 ，TF Card , UART , 电池ADC读取 ，I2C** + +**例程** + +```arduino +#include + +void setup() { + M5.begin(true,true,true,true,true); +} +``` + +## Button类 + +**功能：检测设备按键状态** + +``` + Button(uint8_t pin, uint8_t invert, uint32_t dbTime); + uint8_t read(); + uint8_t isPressed(); + uint8_t isReleased(); + uint8_t wasPressed(); + uint8_t wasReleased(); + uint8_t pressedFor(uint32_t ms); + uint8_t releasedFor(uint32_t ms); + uint8_t wasReleasefor(uint32_t ms); + uint32_t lastChange(); + +``` + +## update() + +**函数原型：** + +`void update();` + +**功能：刷新设备按键状态** + + +**例程：** + +```arduino + +if( M5.BtnL.wasPressed()) +{ + Serial.printf("BtnL wasPressed!"); +} +M5.update(); + +``` + +## SHT30 + +**功能：读取SHT30检测到的温湿度** + +``` + float GetTemperature(TemperatureScale Degree = Cel); + float GetRelHumidity(); + float GetAbsHumidity(AbsHumidityScale Scale = Torr); +``` + +**刷新检测数据(需要调用该API后才能获取新的检测数值)** + +`void UpdateData();` + +**例程：** + +```arduino +#include + +char temStr[10]; +char humStr[10]; + +float tem; +float hum; + +M5EPD_Canvas canvas(&M5.EPD); +void setup() +{ + M5.begin(); + M5.SHT30.Begin(); + M5.EPD.SetRotation(90); + M5.EPD.Clear(true); + canvas.createCanvas(400, 300); + canvas.setTextSize(2); +} + +void loop() +{ + + M5.SHT30.UpdateData(); + tem = M5.SHT30.GetTemperature(); + hum = M5.SHT30.GetRelHumidity(); + Serial.printf("Temperatura: %2.2f*C Humedad: %0.2f%%\r\n", tem, hum); + dtostrf(tem, 2, 2 , temStr); + dtostrf(hum, 2, 2 , humStr); + canvas.drawString("Temperatura:" + String(temStr) + "*C", 100, 100); + canvas.drawString("Humedad:" + String(humStr) , 100, 200); + canvas.pushCanvas(0,300,UPDATE_MODE_A2); + delay(1000); +} + +``` + +## 相关引脚定义 + +``` +#define M5EPD_MAIN_PWR_PIN 2 +#define M5EPD_CS_PIN 15 +#define M5EPD_SCK_PIN 14 +#define M5EPD_MOSI_PIN 12 +#define M5EPD_BUSY_PIN 27 +#define M5EPD_MISO_PIN 13 +#define M5EPD_EXT_PWR_EN_PIN 5 +#define M5EPD_EPD_PWR_EN_PIN 23 +#define M5EPD_KEY_RIGHT_PIN 39 +#define M5EPD_KEY_PUSH_PIN 38 +#define M5EPD_KEY_LEFT_PIN 37 +#define M5EPD_BAT_VOL_PIN 35 +#define M5EPD_PORTC_W_PIN 19 +#define M5EPD_PORTC_Y_PIN 18 +#define M5EPD_PORTB_W_PIN 33 +#define M5EPD_PORTB_Y_PIN 26 +#define M5EPD_PORTA_W_PIN 32 +#define M5EPD_PORTA_Y_PIN 25 +``` + +## Power + +- **功能：启用拓展端口电源** +- `void enableEXTPower() { digitalWrite(M5EPD_EXT_PWR_EN_PIN, 1); }` + +- **功能：关闭拓展端口电源** +- `void disableEXTPower() { digitalWrite(M5EPD_EXT_PWR_EN_PIN, 0); }` + +- **功能：启用墨水屏电源** +- `void enableEPDPower() { digitalWrite(M5EPD_EPD_PWR_EN_PIN, 1); }` + +- **功能：关闭墨水屏电源** +- `void disableEPDPower() { digitalWrite(M5EPD_EPD_PWR_EN_PIN, 0); }` + +- **功能：启用主电源** +- `void enableMainPower() { digitalWrite(M5EPD_MAIN_PWR_PIN, 1); }` + +- **功能：关闭主电源** +- `void disableMainPower() { digitalWrite(M5EPD_MAIN_PWR_PIN, 0); }` + +- **功能：初始化电池ADC检测** +- `void BatteryADCBegin();` + +- **功能：读取电池电压原生ADC值** +- `uint32_t getBatteryRaw();` + +- **功能：读取电池电压** +- `uint32_t getBatteryVoltage();` + +## RTC + +?>RTC相关函数使用前请使用`M5.RTC.begin();`进行初始化 + +``` +typedef struct RTC_Time +{ + int8_t hour; + int8_t min; + int8_t sec; + RTC_Time() : hour(), min(), sec() {} + RTC_Time(int8_t h, int8_t m, int8_t s) : hour(h), min(m), sec(s) {} +} rtc_time_t; + +typedef struct RTC_Date +{ + int8_t week; + int8_t mon; + int8_t day; + int16_t year; + RTC_Date() : week(), mon(), day(), year() {} + RTC_Date(int8_t w, int8_t m, int8_t d, int16_t y) : week(w), mon(m), day(d), year(y) {} +} rtc_date_t; + +``` + +## setTime() + +**函数原型:** + +`void setTime(rtc_time_t *time);` + +**函数参数:** + +设置结构体变量时间 + +## getTime() + +**函数原型:** + +`void getTime(rtc_time_t *time);` + +**函数参数:** + +获取结构体时间 + +## setDate() + +**函数原型:** + +`void setDate(rtc_date_t *date);` + +**函数参数:** + +设置结构体变量日期 + +## getDate() + +**函数原型:** + +`void getDate(rtc_date_t *date);` + +**函数参数:** + +获取结构体变量日期 + +**使用示例:** + + +``` +#include + +M5EPD_Canvas canvas(&M5.EPD); + +rtc_time_t RTCtime; +rtc_date_t RTCDate; + +char timeStrbuff[64]; + +void flushTime(){ + M5.RTC.getTime(&RTCtime); + M5.RTC.getDate(&RTCDate); + + sprintf(timeStrbuff,"%d/%02d/%02d %02d:%02d:%02d", + RTCDate.year,RTCDate.mon,RTCDate.day, + RTCtime.hour,RTCtime.min,RTCtime.sec); + + canvas.drawString(timeStrbuff, 0, 0); + canvas.pushCanvas(100,200,UPDATE_MODE_DU4); +} + +void setupTime(){ + + RTCtime.hour = 23; + RTCtime.min = 33; + RTCtime.sec = 33; + M5.RTC.setTime(&RTCtime); + + RTCDate.year = 2020; + RTCDate.mon = 11; + RTCDate.day = 27; + M5.RTC.setDate(&RTCDate); +} + +void setup() { + + M5.begin(); + M5.EPD.SetRotation(90); + M5.EPD.Clear(true); + M5.RTC.begin(); + canvas.createCanvas(400, 300); + canvas.setTextSize(3); + setupTime(); +} + +void loop() { + flushTime(); + delay(1000); +} +``` + + +## shutdown() + +### 函数重载1: + +关闭电源，再次启动需要通过PWR按键唤醒 + +`void shutdown();` + +### 函数重载2: + +关闭电源，根据传入的延时秒数，在延时结束后通过RTC唤醒设备。 + +`int shutdown( int seconds );` + +### 函数重载3: + +关闭电源，传入指定了某个时间点的RTC时间结构体，当符合该时间的`时`,`分`,`秒`的时候通过RTC唤醒设备。 + +`int shutdown( const rtc_time_t &RTC_TimeStruct);` + +### 函数重载4: + +关闭电源，传入指定了某个时间点的RTC时间结构体，当同时符合该时间点的`周数`,`天数`,`时间`的时通过RTC唤醒设备。 + +`int shutdown( const rtc_date_t &RTC_DateStruct, const rtc_time_t &RTC_TimeStruct);` + + +**使用示例:** + +``` +#include + +M5EPD_Canvas canvas(&M5.EPD); + +void setup() +{ + M5.begin(); + M5.EPD.SetRotation(90); + M5.TP.SetRotation(90); + M5.EPD.Clear(true); + M5.RTC.begin(); + canvas.createCanvas(540, 960); + canvas.setTextSize(3); + canvas.drawString("Press PWR Btn for sleep!", 45, 350); + canvas.drawString("after 5 sec wakeup!", 70, 450); + canvas.pushCanvas(0,0,UPDATE_MODE_DU4); + + +} + +void loop() +{ + if(M5.BtnP.wasPressed()){ + + canvas.drawString("I'm going to sleep.zzzZZZ~", 45, 550); + canvas.pushCanvas(0,0,UPDATE_MODE_DU4); + delay(1000); + M5.shutdown(5); + } + M5.update(); + delay(100); +} +``` \ No newline at end of file diff --git a/docs/zh_CN/api/m5paper/touch.md b/docs/zh_CN/api/m5paper/touch.md new file mode 100644 index 00000000..9ba91831 --- /dev/null +++ b/docs/zh_CN/api/m5paper/touch.md @@ -0,0 +1,103 @@ +# TOUCH-GT911 + +>这是M5Stack Paper触摸屏库。 + +## GT911类 + +>在`M5.begin()`初始化中，已经创建了实例`GT911 TP = GT911();`并进行了初始化. 你可以用该实例中的API获取触摸交互信息。 + +- 初始化I2C总线 +- `esp_err_t begin(uint8_t pin_sda, uint8_t pin_scl, uint8_t pin_int);` + +- 是否有新的屏幕触摸数据待读取 +- `bool avaliable();` + +- 刷新屏幕检测 +- `void update();` + +- 设置屏幕旋转角度 +- `void SetRotation(uint16_t rotate);` + +- 读取触摸手指X坐标 +- `uint16_t readFingerX(uint8_t num);` + +- 读取触摸手指Y坐标 +- `uint16_t readFingerY(uint8_t num);` + +- 读取触摸手指ID坐标 +- `uint16_t readFingerID(uint8_t num);` + +- 读取触摸手指作用区域矩形大小 +- `uint16_t readFingerSize(uint8_t num);` + +- 最后一次读取触摸手指数量 +- `uint8_t getFingerNum(void);` + +- 检测手指是否抬起 +- `bool isFingerUp(void);` + +- 将当前触摸状态清空 +- `void flush(void);` + +- 读取触摸手指信息,返回结构体实例 +- `tp_finger_t readFinger(uint8_t num);` + +``` +typedef struct +{ + uint16_t x; + uint16_t y; + uint16_t id; + uint16_t size; +}tp_finger_t; + +``` + +**例程：** + +```arduino +#include + +M5EPD_Canvas canvas(&M5.EPD); + +int point[2][2]; + +void setup() +{ + M5.begin(); + M5.EPD.SetRotation(90); + M5.TP.SetRotation(90); + M5.EPD.Clear(true); + canvas.createCanvas(540, 960); + canvas.setTextSize(5); + canvas.drawString("Touch The Screen!", 20, 400); + canvas.pushCanvas(0,0,UPDATE_MODE_DU4); +} + +void loop() +{ + + if(M5.TP.avaliable()){ + if(!M5.TP.isFingerUp()){ + M5.TP.update(); + canvas.fillCanvas(0); + bool is_upadte = false; + for(int i=0;i<2; i++){ + tp_finger_t FingerItem = M5.TP.readFinger(i); + if((point[i][0]!=FingerItem.x)||(point[i][1]!=FingerItem.y)){ + is_upadte = true; + point[i][0] = FingerItem.x; + point[i][1] = FingerItem.y; + canvas.fillRect(FingerItem.x-50, FingerItem.y-50, 100, 100, 15); + Serial.printf("Finger ID:%d-->X: %d*C Y: %d Size: %d\r\n", FingerItem.id, FingerItem.x, FingerItem.y , FingerItem.size); + } + } + if(is_upadte) + { + canvas.pushCanvas(0,0,UPDATE_MODE_DU4); + } + } + } +} + +``` diff --git a/docs/zh_CN/arduino/arduino_home_page.md b/docs/zh_CN/arduino/arduino_home_page.md index 7af45ad4..e11bef54 100644 --- a/docs/zh_CN/arduino/arduino_home_page.md +++ b/docs/zh_CN/arduino/arduino_home_page.md @@ -14,7 +14,7 @@
- +
{{item.title}} @@ -36,7 +36,8 @@ const quickstart = { 'M5Stick':'#/zh_CN/arduino/arduino_development', 'ATOM Lite / Matrix':'#/zh_CN/arduino/arduino_development', 'M5Core2':'#/zh_CN/arduino/arduino_core2_development' - } + }, + "id":"quickstart" }; const m5core_api = { @@ -54,7 +55,8 @@ const m5core_api = { 'I2C':'#/zh_CN/api/commutil', 'WIFI':'#/zh_CN/api/wifi', 'Timer':'#/zh_CN/api/ticker', - } + }, + "id":"m5core_api" }; const m5core2_api = { @@ -63,7 +65,8 @@ const m5core2_api = { 'AXP192':'#/zh_CN/api/axp192_core2', 'TFT-SCREEN':'#/zh_CN/api/lcd', 'TOUCH':'#/zh_CN/api/touch', - } + }, + "id":"m5core2_api" }; const m5stickc_api = { @@ -75,7 +78,8 @@ const m5stickc_api = { 'IMU':'#/zh_CN/api/imu', 'RTC':'#/zh_CN/api/rtc', 'PWM':'#/zh_CN/api/pwm', - } + }, + "id":"m5stickc_api" }; const coreink_api = { @@ -83,7 +87,8 @@ const coreink_api = { 'item':{ 'System & Button & RTC & Speaker':'#/zh_CN/api/coreink/system_api', 'E-Ink':'#/zh_CN/api/coreink/eink_api' - } + }, + "id":"coreink_api" }; diff --git a/docs/zh_CN/core/basic.md b/docs/zh_CN/core/basic.md index a8095004..0b663385 100644 --- a/docs/zh_CN/core/basic.md +++ b/docs/zh_CN/core/basic.md @@ -153,7 +153,7 @@ M5Stack Basic 由两个可分离部分堆叠组成. 顶部放置了电路板，

案例描述:

-

该案例将执行喇叭，wifi，按键，加速计，SD卡，屏幕等硬件运行测试.

+

该案例将执行喇叭，wifi，按键，加速计，TF-card(microSD)卡，屏幕等硬件运行测试.

@@ -296,7 +296,7 @@ TF 卡最大支持 16GB - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/core2.md b/docs/zh_CN/core/core2.md index 341c9b0e..abca380c 100644 --- a/docs/zh_CN/core/core2.md +++ b/docs/zh_CN/core/core2.md @@ -13,7 +13,7 @@ ## 描述 -**M5Core2** 是M5Stack开发套件系列中第二代主机，在原有一代主机基础上对功能进一步加强，硬件功能更加齐全。主控ESP32型号为D0WDQ6-V3，具有两个可以单独控制的 Xtensa® 32-bit LX6 处理器，主频高达240Mhz，支持WiFi与蓝牙功能，板载16MB Flash与8MB PSRAM，可通过TYPE-C接口下载程序，强劲的配置满足复杂应用的资源开销。正面搭载一块2.0寸一体化电容式触摸屏，为用户带来更流畅的人机交互体验。机身内置震动马达，可提供触觉回馈和震动提醒功能。内建的RTC模块可提供精准计时功能。电源部分搭载AXP192电源管理芯片可有效控制机身功耗，内置绿色电源指示灯，配备390mAh电池，续航时间更持久。同时机身内配备了SD卡槽与扬声器，为了保证获得更高质量的声音效果，采用I2S数字音频接口的功放芯片，能有效防止信号失真。在机身的左侧和底部配有独立的电源按键与重启(RST)按键，屏幕正面的3个圆点属于触摸屏的一部分，可通过编写程序设置热区映射为3个虚拟按键。机身背部有一块扩展小板，板上带有6轴IMU传感器与麦克风。 +**M5Core2** 是M5Stack开发套件系列中第二代主机，在原有一代主机基础上对功能进一步加强，硬件功能更加齐全。主控ESP32型号为D0WDQ6-V3，具有两个可以单独控制的 Xtensa® 32-bit LX6 处理器，主频高达240Mhz，支持WiFi与蓝牙功能，板载16MB Flash与8MB PSRAM，可通过TYPE-C接口下载程序，强劲的配置满足复杂应用的资源开销。正面搭载一块2.0寸一体化电容式触摸屏，为用户带来更流畅的人机交互体验。机身内置震动马达，可提供触觉回馈和震动提醒功能。内建的RTC模块可提供精准计时功能。电源部分搭载AXP192电源管理芯片可有效控制机身功耗，内置绿色电源指示灯，配备390mAh电池，续航时间更持久。同时机身内配备了TF-card(microSD)卡槽与扬声器，为了保证获得更高质量的声音效果，采用I2S数字音频接口的功放芯片，能有效防止信号失真。在机身的左侧和底部配有独立的电源按键与重启(RST)按键，屏幕正面的3个圆点属于触摸屏的一部分，可通过编写程序设置热区映射为3个虚拟按键。机身背部有一块扩展小板，板上带有6轴IMU传感器与麦克风。 M5Stack Core2支持的开发平台和程序语言：Arduino，[UIFlow](http://flow.m5stack.com) (采用Blockly ，MicroPython语言) 无论你的开发和编程能力处在何种水平，M5Stack 都将协助你，逐步的将想法变为现实。 **开关机操作：** @@ -185,7 +185,7 @@ M5Stack Core2支持的开发平台和程序语言：Arduino，[UIFlow](http://fl

案例描述:

-

该案例将执行喇叭，wifi，按键，加速计，SD卡，屏幕等硬件运行测试.

+

该案例将执行喇叭，wifi，按键，加速计，TF-card(microSD)，屏幕等硬件运行测试.

@@ -337,7 +337,7 @@ TF 卡最大支持 16GB - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core2_api) ## 原理图 diff --git a/docs/zh_CN/core/core2_aws.md b/docs/zh_CN/core/core2_aws.md index 2188c7a2..edf30f73 100644 --- a/docs/zh_CN/core/core2_aws.md +++ b/docs/zh_CN/core/core2_aws.md @@ -10,7 +10,7 @@ ### Core2 -**Core2** 是M5Stack开发套件系列中第二代主机，在原有一代主机基础上对功能进一步加强，硬件功能更加齐全。主控ESP32型号为D0WDQ6-V3，具有两个可以单独控制的 Xtensa® 32-bit LX6 处理器，主频高达240Mhz，支持WiFi与蓝牙功能，板载16MB Flash与8MB PSRAM，可通过TYPE-C接口下载程序，强劲的配置满足复杂应用的资源开销。正面搭载一块2.0寸一体化电容式触摸屏，为用户带来更流畅的人机交互体验。机身内置震动马达，可提供触觉回馈和震动提醒功能。内建的RTC模块可提供精准计时功能。电源部分搭载AXP192电源管理芯片可有效控制机身功耗，内置绿色电源指示灯。同时机身内配备了SD卡槽与扬声器，为了保证获得更高质量的声音效果，采用I2S数字音频接口的功放芯片，能有效防止信号失真。在机身的左侧和底部配有独立的电源按键与重启(RST)按键，屏幕正面的3个圆点属于触摸屏的一部分，可通过编写程序设置热区映射为3个虚拟按键。 +**Core2** 是M5Stack开发套件系列中第二代主机，在原有一代主机基础上对功能进一步加强，硬件功能更加齐全。主控ESP32型号为D0WDQ6-V3，具有两个可以单独控制的 Xtensa® 32-bit LX6 处理器，主频高达240Mhz，支持WiFi与蓝牙功能，板载16MB Flash与8MB PSRAM，可通过TYPE-C接口下载程序，强劲的配置满足复杂应用的资源开销。正面搭载一块2.0寸一体化电容式触摸屏，为用户带来更流畅的人机交互体验。机身内置震动马达，可提供触觉回馈和震动提醒功能。内建的RTC模块可提供精准计时功能。电源部分搭载AXP192电源管理芯片可有效控制机身功耗，内置绿色电源指示灯。同时机身内配备了TF-card(microSD)卡槽与扬声器，为了保证获得更高质量的声音效果，采用I2S数字音频接口的功放芯片，能有效防止信号失真。在机身的左侧和底部配有独立的电源按键与重启(RST)按键，屏幕正面的3个圆点属于触摸屏的一部分，可通过编写程序设置热区映射为3个虚拟按键。 ### M5GO-Bottom For AWS @@ -193,7 +193,7 @@

案例描述:

-

该案例将执行喇叭，wifi，按键，加速计，SD卡，屏幕等硬件运行测试.

+

该案例将执行喇叭，wifi，按键，加速计，TF-card(microSD)，屏幕等硬件运行测试.

@@ -364,7 +364,7 @@ TF 卡最大支持 16GB - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core2_api) ## 原理图 diff --git a/docs/zh_CN/core/face_kit.md b/docs/zh_CN/core/face_kit.md index 877608de..1c0dd071 100644 --- a/docs/zh_CN/core/face_kit.md +++ b/docs/zh_CN/core/face_kit.md @@ -267,7 +267,7 @@ - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/fire.md b/docs/zh_CN/core/fire.md index 74b73028..da6c94f9 100644 --- a/docs/zh_CN/core/fire.md +++ b/docs/zh_CN/core/fire.md @@ -355,7 +355,7 @@ BMM150 I2C address 0x10 - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/gray.md b/docs/zh_CN/core/gray.md index 93c326b7..7600e1ba 100644 --- a/docs/zh_CN/core/gray.md +++ b/docs/zh_CN/core/gray.md @@ -161,7 +161,7 @@

案例描述:

-

该案例将执行喇叭，wifi，按键，加速计，SD卡，屏幕等硬件运行测试.

+

该案例将执行喇叭，wifi，按键，加速计，TF-card(microSD)，屏幕等硬件运行测试.

@@ -326,7 +326,7 @@ BMM150 I2C 地址为 0x10 - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/m5go.md b/docs/zh_CN/core/m5go.md index e95c025b..3175eeb1 100644 --- a/docs/zh_CN/core/m5go.md +++ b/docs/zh_CN/core/m5go.md @@ -344,7 +344,7 @@ BMM150 I2C address 0x10 - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/m5go_lite.md b/docs/zh_CN/core/m5go_lite.md index 1c822e97..9284b97f 100644 --- a/docs/zh_CN/core/m5go_lite.md +++ b/docs/zh_CN/core/m5go_lite.md @@ -346,7 +346,7 @@ BMM150 I2C address 0x10 - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5core_api) ## 原理图 diff --git a/docs/zh_CN/core/m5paper.md b/docs/zh_CN/core/m5paper.md index 8996a266..7e48913e 100644 --- a/docs/zh_CN/core/m5paper.md +++ b/docs/zh_CN/core/m5paper.md @@ -2,7 +2,7 @@ ## 描述 -**M5Paper** 是M5Stack推出的一款可触控墨水屏主控设备，控制器采用ESP32-D0WD。正面嵌入了一块分辨率为540*960 @4.7"的电子墨水屏，支持16级灰度显示。搭配GT911电容式触控面板，支持两点触控与多种手势操作。相对于普通的LCD的屏幕，电子墨水屏能够提供用户更好的文本阅读体验， 同时具有低功耗，掉电图像保持等特性。 集成拨轮开关, SHT30温湿度传感器, 与物理按键。 数据储存方面预留了SD卡接口，并集成了FM24C02储存芯片(256KB-EEPROM)用于用户数据的断电存储。内置了1150mAh锂电池，结合内部的RTC(BM8563)可实现休眠与唤醒功能，能够为设备提供强大的续航能力。开放了3组HY2.0-4P外设接口能够拓展各式各样的传感器设备，为后续的应用功能开发提供无限可能。 +**M5Paper** 是M5Stack推出的一款可触控墨水屏主控设备，控制器采用ESP32-D0WD。正面嵌入了一块分辨率为540*960 @4.7"的电子墨水屏，支持16级灰度显示。搭配GT911电容式触控面板，支持两点触控与多种手势操作。相对于普通的LCD的屏幕，电子墨水屏能够提供用户更好的文本阅读体验， 同时具有低功耗，掉电图像保持等特性。 集成拨轮开关, SHT30温湿度传感器, 与物理按键。 数据储存方面预留了TF-card(microSD)接口，并集成了FM24C02储存芯片(256KB-EEPROM)用于用户数据的断电存储。内置了1150mAh锂电池，结合内部的RTC(BM8563)可实现休眠与唤醒功能，能够为设备提供强大的续航能力。开放了3组HY2.0-4P外设接口能够拓展各式各样的传感器设备，为后续的应用功能开发提供无限可能。 ## 产品特性 @@ -51,7 +51,7 @@ 接口 - TypeC*1, HY2.0-4P*3 , SD卡槽 + TypeC*1, HY2.0-4P*3 , TF-card(microSD)卡槽 墨水屏 @@ -105,14 +105,14 @@ ## 管脚映射 -**墨水屏幕 & SD Card** +**墨水屏幕 & TF-card(microSD)** 屏幕像素：540*960 - +
ESP32 ChipGPIO13GPIO12GPIO14GPIO15GPIO4
IT8951MISOMOSISCKCS/
SD CardMISOMOSISCK/CS
TF-card(microSD)MISOMOSISCK/CS
@@ -203,7 +203,6 @@ - [SHT30 Datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/unit/SHT3x_Datasheet_digital.pdf) - [BM8563](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BM8563_V1.1_cn.pdf) - [SY7088](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/SY7088-Silergy.pdf) - - [GT911-datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/m5paper/gt911_datasheet.pdf) - **API** diff --git a/docs/zh_CN/core/m5stickc.md b/docs/zh_CN/core/m5stickc.md index cf47492b..9aee3ea8 100644 --- a/docs/zh_CN/core/m5stickc.md +++ b/docs/zh_CN/core/m5stickc.md @@ -265,7 +265,7 @@ M5StickC 是 M5Stack 产品系列中的核心设备之一，该产品系列建 - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5stickc_api) ## 结构设计文件 diff --git a/docs/zh_CN/core/m5stickc_plus.md b/docs/zh_CN/core/m5stickc_plus.md index a75ce326..6c4d6214 100644 --- a/docs/zh_CN/core/m5stickc_plus.md +++ b/docs/zh_CN/core/m5stickc_plus.md @@ -273,7 +273,7 @@ setup() - **API** - - [Arduino API](zh_CN/arduino/arduino_home_page) + - [Arduino API](zh_CN/arduino/arduino_home_page?id=m5stickc_api) ## 案例程序 diff --git a/docs/zh_CN/core/m5stickv.md b/docs/zh_CN/core/m5stickv.md index adb32b52..9e5b1783 100644 --- a/docs/zh_CN/core/m5stickv.md +++ b/docs/zh_CN/core/m5stickv.md @@ -115,7 +115,7 @@ M5stickV AI 摄像头具备机器视觉能力，配备OmniVision OV7740图像传 外部存储 - TF Card/Micro SD + TF-card(microSD) MEMS六轴传感器 @@ -143,9 +143,9 @@ M5stickV AI 摄像头具备机器视觉能力，配备OmniVision OV7740图像传 -## SD卡测试 +## TF-card(microSD)测试 -M5StickV目前并不能识别所有类型的SD卡，我们对一些常见的SD卡进行了测试，测试结果如下. +M5StickV目前并不能识别所有类型的TF-card(microSD)，我们对一些常见的TF-card进行了测试，测试结果如下. diff --git a/docs/zh_CN/hat/hat_roverc_pro.md b/docs/zh_CN/hat/hat_roverc_pro.md index 4b5fd4fa..e19bfad7 100644 --- a/docs/zh_CN/hat/hat_roverc_pro.md +++ b/docs/zh_CN/hat/hat_roverc_pro.md @@ -14,7 +14,7 @@ - I2C地址0x38 - 可遥控 -- 带有夹持机构 +- 带有夹持结构 - 可编程 - 全方位灵活移动 - 四通道电机驱动器 @@ -65,7 +65,7 @@ - + @@ -73,13 +73,13 @@ - - + + - - - + + + @@ -128,8 +128,8 @@ MotorControl：
/ RoverC PRO RoverC
舵机爪手●-x1/
2路舵机接口●-舵机拓展接口x2/
电池
- - + +
舵机编号角度(寄存器地址)参数范围脉冲(寄存器地址)参数范围
010x100~180°0x20500~2500ms
020x110~180°0x21500~2500ms
010x100~180°0x20500~2500us
020x110~180°0x21500~2500us
## 案例程序 @@ -141,6 +141,10 @@ MotorControl： 单独使用参考(含夹持) [点击此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Application/RoverC_PRO_Arduino_Alone) +### 2. UIFlow + + + ### 引脚映射 diff --git a/docs/zh_CN/unit/pbhub.md b/docs/zh_CN/unit/pbhub.md index 78967e13..2fdeb5b8 100644 --- a/docs/zh_CN/unit/pbhub.md +++ b/docs/zh_CN/unit/pbhub.md @@ -12,8 +12,6 @@ Port B 中的两条数据总线与ESP32的**GPIO36**和**GPIO26**连接,可根 对于使用电平控制或是模拟值输入的项目，PbHUB 是一个不错的多设备控制的解决方案. -该 Unit 的 I2C 地址为0x40（可通过调整电阻进行更改）. - *注意1：编程时请注意通道顺序*
@@ -22,7 +20,7 @@ Port B 中的两条数据总线与ESP32的**GPIO36**和**GPIO26**连接,可根 *注意2: 并非所有带有黑色接口（PortB）的Unit都支持通过PbHUB扩展.PbHUB只能应用于基本的单总线通信，通过I2C协议（内置MEGA328）能够实现基本的数字读写，模拟读写.但对于像Weight（内置HX711）这种通信不仅需要进行anglog读取，还需要依赖于时序的Unit来说，PbHUB无法进行拓展.* 参考下图，了解HX711的时序:
- + ## 产品特性 @@ -60,6 +58,69 @@ Port B 中的两条数据总线与ESP32的**GPIO36**和**GPIO26**连接,可根
+## 修改I2C地址 + +该 Unit 的 I2C 地址为0x40（可通过焊接电阻A0~A2进行更改, 地址范围为0x40~0x47）. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
A0A1A2I2C Address
///0x40
焊接电阻//0x41
/焊接电阻/0x42
焊接电阻焊接电阻/0x43
//焊接电阻0x44
焊接电阻/焊接电阻0x45
/焊接电阻焊接电阻0x46
焊接电阻焊接电阻焊接电阻0x47
+ ## EasyLoader