Skip to content

Commit 1356b30

Browse files
lovyan03lovyan03
committed
initial commit.
0 parents  commit 1356b30

31 files changed

+3438
-0
lines changed

‎CMakeLists.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
set(COMPONENT_ADD_INCLUDEDIRS
2+
src
3+
)
4+
file(GLOB SRCS
5+
src/*.cpp
6+
src/utility/*.cpp
7+
)
8+
set(COMPONENT_SRCS ${SRCS})
9+
10+
register_component()
11+

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 M5Stack
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# M5Unified
2+
### M5Stack Series unified library .
3+
4+
# Support framework
5+
- ESP-IDF
6+
- Arduino for ESP32
7+
8+
# Support device
9+
- M5Stack BASIC / GRAY / GO / FIRE
10+
- M5Stack Core2 / Tough
11+
- M5Stick C / CPlus
12+
- M5Stack CoreInk
13+
- M5Paper
14+
15+
16+
# H/W infomation
17+
18+
### ESP32 GPIO list
19+
| |M5Stack<BR>BASIC<BR>GRAY |M5Stack<BR>GO/FIRE |M5Stack<BR>Core2<BR>Tough |M5Stick<BR>C/CPlus |M5Stack<BR>CoreInk |M5Paper |M5Station |M5ATOM | |
20+
|:------------------:|:---------------------------------:|:---------------------------------:|:-------------------------------------:|:----------------------------:|:----------------------:|:---------------------:|:---------------------:|:----------------------:|:------------------:|
21+
|GPIO 0<BR>`ADC2_CH1`|`M-Bus`<BR>IIS_MK |`M-Bus`<BR>IIS_MK |`M-Bus`<BR>**SPK_LRCK<BR>PDM_C**(Core2)|`HAT`<BR>`PAD`<BR>**PDM_C** |**EPD_RST** | --- | | |GPIO 0<BR>`ADC2_CH1`|
22+
|GPIO 1<BR>`USB_TX` |`M-Bus`<BR>**Serial** |`M-Bus`<BR>**Serial** |`M-Bus`<BR>**Serial** |**Serial** |**Serial** |**Serial** |**Serial** |**Serial** |GPIO 1<BR>`USB_TX` |
23+
|GPIO 2<BR>`ADC2_CH2`|`M-Bus`<BR> |`M-Bus`<BR> |`M-Bus`<BR>**SPK D** |`PAD`<BR>**Beep**(CPlus) |**Beep** |**PW_Hold** | REn? | |GPIO 2<BR>`ADC2_CH2`|
24+
|GPIO 3<BR>`USB_RX` |`M-Bus`<BR>**Serial** |`M-Bus`<BR>**Serial** |`M-Bus`<BR>**Serial** |**Serial** |**Serial** |**Serial** |**Serial** |**Serial** |GPIO 3<BR>`USB_RX` |
25+
|GPIO 4<BR>`ADC2_CH0`|**TF_CS** |**TF_CS** |**TF_CS** | --- |**EPD_BUSY** |**TF_CS** |**NEOPIXEL** | |GPIO 4<BR>`ADC2_CH0`|
26+
|GPIO 5 |`M-Bus` |`M-Bus` |**LCD_CS** |**LCD_CS** |**BTN_HAT** |**EXT_5V** |**LCD_CS** | |GPIO 5 |
27+
|GPIO 9 | --- | --- | --- |**InfraRed** |**EPD_CS** | --- | --- | |GPIO 9 |
28+
|GPIO10 | --- | --- | --- |**LED** |**LED** | --- | --- | |GPIO10 |
29+
|GPIO12<BR>`ADC2_CH5`|`M-Bus`<BR>IIS_SK |`M-Bus`<BR>IIS_SK |**SPK BCLK** | --- |**PW_Hold** |**SPI_MOSI** | USB? |**InfraRed** |GPIO12<BR>`ADC2_CH5`|
30+
|GPIO13<BR>`ADC2_CH4`|`M-Bus`<BR>IIS_WS |`M-Bus`<BR>IIS_WS |`M-Bus`<BR>RXD2 |**SPI_SCLK** |`MI-Bus`<BR>RXD2 |**SPI_MISO** |`PORT.C1` | |GPIO13<BR>`ADC2_CH4`|
31+
|GPIO14<BR>`ADC2_CH6`|**LCD_CS** |**LCD_CS** |`M-Bus`<BR>TXD2 | --- |`MI-Bus`<BR>TXD2 |**SPI_SCLK** |`PORT.C1` | |GPIO14<BR>`ADC2_CH6`|
32+
|GPIO15<BR>`ADC2_CH3`|`M-Bus`<BR>IIS_OUT |`M-Bus`<BR>**NEOPIXEL** |**LCD_D/C** |**SPI_MOSI** |**EPD_D/C** |**EPD_CS** |**LCD_RST** | |GPIO15<BR>`ADC2_CH3`|
33+
|GPIO16<BR>`PSRAM` |`M-Bus`<BR>RXD2 |`M-Bus`<BR>`PORT.C`<BR>RXD2 | --- | --- | --- | --- |`PORT.C2`<BR>RXD2 | |GPIO16<BR>`PSRAM` |
34+
|GPIO17<BR>`PSRAM` |`M-Bus`<BR>TXD2 |`M-Bus`<BR>`PORT.C`<BR>TXD2 | --- | --- | --- | --- |`PORT.C2`<BR>TXD2 | |GPIO17<BR>`PSRAM` |
35+
|GPIO18 |`M-Bus`<BR>**SPI_SCLK** |`M-Bus`<BR>**SPI_SCLK** |**SPI_SCLK** |**LCD_RST** |`MI-Bus`<BR>**SPI_SCLK**|`PORT.C` |**SPI_SCLK** | |GPIO18 |
36+
|GPIO19 |`M-Bus`<BR>**SPI_MISO** |`M-Bus`<BR>**SPI_MISO** |`M-Bus` | --- |**RTC_INT** |`PORT.C` |LCD_D/C |`Bus`<BR>**SPK_C**(ECHO)|GPIO19 |
37+
|GPIO21 |`M-Bus`<BR>`PORT.A`<BR>**I2C0_SDA**|`M-Bus`<BR>`PORT.A`<BR>**I2C0_SDA**|**I2C1_SDA** |**I2C1_SDA** |`MI-Bus`<BR>**I2C1_SDA**|**I2C1_SDA** |**I2C1_SDA** |`Bus`<BR>**I2C1_SCL** |GPIO21 |
38+
|GPIO22 |`M-Bus`<BR>`PORT.A`<BR>**I2C0_SCL**|`M-Bus`<BR>`PORT.A`<BR>**I2C0_SCL**|**I2C1_SCL** |**I2C1_SCL** |`MI-Bus`<BR>**I2C1_SCL**|**I2C1_SCL** |**I2C1_SCL** |`Bus`<BR>**SPK_D**(ECHO)|GPIO22 |
39+
|GPIO23 |`M-Bus`<BR>**SPI_MOSI** |`M-Bus`<BR>**SPI_MOSI** |**SPI_MOSI** |**LCD_D/C** |`MI-Bus`<BR>**SPI_MOSI**|**EPD_RST** |**SPI_MOSI** |`Bus`<BR>**PDM_D**(ECHO)|GPIO23 |
40+
|GPIO25<BR>`DAC1` |`M-Bus`<BR>**SPK_DAC** |`M-Bus`<BR>**SPK_DAC** |`M-Bus` |`HAT`(CPlus)<BR>`PAD` |`MI-Bus`<BR>`HAT` |`PORT.A`<BR>I2C0_SDA |`PORT.B1` |`Bus`<BR>**I2C1_SDA** |GPIO25<BR>`DAC1` |
41+
|GPIO26<BR>`DAC2` |`M-Bus` |`M-Bus`<BR>`PORT.B` |`M-Bus` |`HAT`<BR>`PAD` |`MI-Bus`<BR>`HAT` |`PORT.B` |`PORT.B2` |`PORT.A`<BR>**I2C0_SDA**|GPIO26<BR>`DAC2` |
42+
|GPIO27<BR>`ADC2_CH7`|**LCD_D/C** |**LCD_D/C** |`M-Bus` |**AXP192 VBUSEN** |**BTN_PWR** |**EPD_BUSY** |**IMU_INT** |**NEOPIXEL** |GPIO27<BR>`ADC2_CH7`|
43+
|GPIO32<BR>`ADC1_CH4`|**LCD_BL** |**LCD_BL** |`M-Bus`<BR>`PORT.A`<BR>I2C0_SDA |`PORT.A`<BR>I2C0_SDA |`PORT.A`<BR>I2C0_SDA |`PORT.A`<BR>I2C0_SCL |`PORT.A`<BR>SDA |`PORT.A`<BR>**I2C0_SCL**|GPIO32<BR>`ADC1_CH4`|
44+
|GPIO33<BR>`ADC1_CH5`|**LCD_RST** |**LCD_RST** |`M-Bus`<BR>`PORT.A`<BR>I2C0_SCL |`PORT.A`<BR>I2C0_SCL |`PORT.A`<BR>I2C0_SCL |`PORT.B` |`PORT.A`<BR>SCL |`Bus`<BR>**PDM_C**(ECHO)|GPIO33<BR>`ADC1_CH5`|
45+
|GPIO34<BR>`ADC1_CH6`|`M-Bus`<BR>IIS_IN |`M-Bus`<BR>**MIC_ADC**<BR>IIS_IN |`M-Bus`<BR>**PDM_D**(Core2) |**PDM_D** |`MI-Bus`<BR>**SPI_MISO**| --- | USB Current? | |GPIO34<BR>`ADC1_CH6`|
46+
|GPIO35<BR>`ADC1_CH7`|`M-Bus` |`M-Bus` |`M-Bus` |**RTC_INT** |**BAT_V** |**BAT_V** |`PORT.B1` | |GPIO35<BR>`ADC1_CH7`|
47+
|GPIO36<BR>`ADC1_CH0`|`M-Bus` |`M-Bus`<BR>`PORT.B` |`M-Bus` |`HAT`<BR>`PAD` |`MI-Bus`<BR>`HAT` |**TP_INT** |`PORT.B2` | |GPIO36<BR>`ADC1_CH0`|
48+
|GPIO37<BR>`ADC1_CH1`|**BTN_C** |**BTN_C** | --- |**BTN_A** |**SW_Up** |**SW_Up** |**BTN_A** | |GPIO37<BR>`ADC1_CH1`|
49+
|GPIO38<BR>`ADC1_CH2`|**BTN_B** |**BTN_B** |`M-Bus`<BR>**SPI_MISO** |`PAD` |**SW_Press** |**SW_Press** |**BTN_B** | |GPIO38<BR>`ADC1_CH2`|
50+
|GPIO39<BR>`ADC1_CH3`|**BTN_A** |**BTN_A** |**TP_INT** |**BTN_B** |**SW_Down** |**SW_Down** |**BTN_C** |**BTN** |GPIO39<BR>`ADC1_CH3`|
51+
| |M5Stack<BR>BASIC<BR>GRAY |M5Stack<BR>GO/FIRE |M5Stack<BR>Core2<BR>Tough |M5Stick<BR>C/CPlus |M5Stack<BR>CoreInk |M5Paper |M5Station |M5ATOM | |
52+
53+
### AXP192 IO list
54+
| |M5Stack<BR>Core2 |M5Stack<BR>Tough |M5Stick<BR>C |M5Stick<BR>CPlus| |
55+
|:------------:|:-----------------:|:-----------------:|:--------------:|:--------------:|:------------:|
56+
|GPIO0<br>LDO0 |BUS PW EN |BUS PW EN |MIC VCC |MIC VCC |GPIO0<br>LDO0 |
57+
| GPIO1 |SYS LED |TP RST | --- | --- | GPIO1 |
58+
| GPIO2 |SPK EN |SPK EN | --- | --- | GPIO2 |
59+
| GPIO3 | --- | --- | --- | --- | GPIO3 |
60+
| GPIO4 |LCD RST<BR>TP RST |LCD RST | --- | --- | GPIO4 |
61+
| EXTEN |PORT 5V EN |PORT 5V EN |PORT 5V EN |PORT 5V EN | EXTEN |
62+
| BACKUP |RTC BAT |RTC BAT |RTC BAT |RTC BAT | BACKUP |
63+
| LDO1 |RTC VDD |RTC VDD |RTC VDD |RTC VDD | LDO1 |
64+
| LDO2 |LCD PW<BR>Periph PW|LCD PW<BR>Periph PW|LCD BL |LCD BL | LDO2 |
65+
| LDO3 |VIB MOTOR |LCD BL |LCD PW |LCD PW | LDO3 |
66+
| DCDC1 |ESP32 VDD |ESP32 VDD |ESP32 VDD |ESP32 VDD | DCDC1 |
67+
| DCDC2 | --- | --- | --- | --- | DCDC2 |
68+
| DCDC3 |LCD BL | --- | --- | --- | DCDC3 |
69+
70+
71+
### PinMap
72+
73+
| |M5Stack<BR>BASIC<BR>GRAY|M5Stack<BR>GO/FIRE<BR>FACES II|M5Stack<BR>Core2<BR>Tough |M5Stick<BR>C |M5Stick<BR>CPlus |M5Stack<BR>CoreInk |M5Paper | |
74+
|:-------------:|:----------------------:|:----------------------------:|:------------------------:|:----------------------:|:----------------------:|:---------------------:|:---------------------:|:--------------:|
75+
| PORT.A |GND<BR>5V<BR>G21<BR>G22 |GND<BR>5V<BR>G21<BR>G22 |GND<BR>5V<BR>G32<BR>G33 |GND<BR>5V<BR>G32<BR>G33 |GND<BR>5V<BR>G32<BR>G33 |GND<BR>5V<BR>G32<BR>G33|GND<BR>5V<BR>G25<BR>G32| PORT.A |
76+
| PORT.B | --- |GND<BR>5V<BR>G26<BR>G36 | --- | --- | --- | --- |GND<BR>5V<BR>G26<BR>G33| PORT.B |
77+
| PORT.C | --- |GND<BR>5V<BR>G17<BR>G16 | --- | --- | --- | --- |GND<BR>5V<BR>G18<BR>G19| PORT.C |
78+
| HAT |---|---|---|GND<BR>5VOut<BR>G26<BR>G36<BR>G0<BR>BAT<BR>3V3<BR>5VIn|GND<BR>5VOut<BR>G26<BR>G25/G36<BR>G0<BR>BAT<BR>3V3<BR>5VIn|GND<BR>5VOut<BR>G26<BR>G36<BR>G25<BR>BAT<BR>3V3<BR>5VIn| --- | HAT |
79+
|M-Bus<BR>MI-Bus|GND G35<BR>GND G36<BR>GND EN<BR>G23 G25<BR>G19 G26<BR>G18 3v3<BR>G3 G1<BR>G16 G17<BR>G21 G22<BR>G2 G5<BR>G12 G13<BR>G15 G0<BR>HPWR G34<BR>HPWR 5V<BR>HPWR BAT|GND G35<BR>GND G36<BR>GND EN<BR>G23 G25<BR>G19 G26<BR>G18 3v3<BR>G3 G1<BR>G16 G17<BR>G21 G22<BR>G2 G5<BR>G12 G13<BR>G15 G0<BR>HPWR G34<BR>HPWR 5V<BR>HPWR BAT|GND G35<BR>GND G36<BR>GND EN<BR>G23 G25<BR>G38 G26<BR>G18 3v3<BR>G3 G1<BR>G13 G14<BR>G21 G22<BR>G32 G33<BR>G27 G19<BR>G2 G0<BR>NC G34<BR>NC 5V<BR>NC BAT|---|---|G25 G23<BR>G26 G34<BR>G36 G18<BR>G22 G21<BR>G14 G13<BR>3v3 RST<BR>5Vout 5Vin<BR>BAT GND|---|M-Bus<BR>MI-Bus|
80+
81+
82+
83+
84+
### SPI device
85+
86+
| |M5Stack<BR>BASIC<BR>GRAY<BR>GO/FIRE|M5Stack<BR>Core2<BR>Tough |M5Stick<BR>C |M5Stick<BR>CPlus |M5Stack<BR>CoreInk |M5Paper | |
87+
|:--------------:|:---------------------------------:|:-----------------------------:|:---------------------------:|:-----------------------------:|:--------------------------------:|:----------------------------:|:--------------:|
88+
| Display |`ILI9342C`<BR>320×240<BR>CS:G14 |`ILI9342C`<BR>320×240<BR>CS:G5|`ST7735S`<BR>80×160<BR>CS:G5|`ST7789V2`<BR>135×240<BR>CS:G5|`GDEW0154M09`<BR>200×200<BR>CS:G9|`IT8951`<BR>960×540<BR>CS:G15| Display |
89+
| TF Card |CS:4 |CS:4 | --- | --- | --- |CS:4 | TF Card |
90+
91+
92+
### I2C device
93+
94+
| |M5Stack<BR>BASIC/GRAY<BR>GO/FIRE |M5Stack<BR>Core2 |M5Stack<BR>Tough |M5Stick<BR>C<BR>CPlus|M5Stack<BR>CoreInk |M5Paper | |
95+
|:--------------:|:---------------------------------:|:--------------------:|:------------------:|:-------------------:|:-----------------:|:-------------------:|:--------------:|
96+
|Touch<BR>Panel | --- |`FT6336U`<BR>38h |`CHSC6540`<BR>2Eh | --- | --- |`GT911`<BR>14h or 5Dh|Touch<BR>Panel |
97+
|RTC | --- |`BM8563`<BR>51h |`BM8563`<BR>51h |`BM8563`<BR>51h |`BM8563`<BR>51h |`BM8563`<BR>51h |RTC |
98+
|Power<BR>Manage |`IP5306`<BR>75h |`AXP192`<BR>34h |`AXP192`<BR>34h |`AXP192`<BR>34h | --- | --- |Power<BR>Manage |
99+
|IMU |`MPU6886`<BR>68h |`MPU6886`<BR>68h (Ext)| --- |`MPU6886`<BR>68h | --- | --- |IMU |
100+
|IMU<BR>(old lot)|`SH200Q`<BR>6Ch | --- | --- |`SH200Q`<BR>6Ch | --- | --- |IMU<BR>(old lot)|
101+
|ENV | --- | --- | --- | --- | --- |`SHT30`<BR>44h |ENV |
102+
|EEPROM | --- | --- | --- | --- | --- |`FM24C02`<BR>50h |EEPROM |
103+
104+

‎component.mk

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#
2+
# Main Makefile. This is basically the same as a component makefile.
3+
#
4+
# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
5+
6+
COMPONENT_SRCDIRS := src
7+
COMPONENT_ADD_INCLUDEDIRS := src

0 commit comments

Comments
 (0)