You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,13 @@
5
5
6
6
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
7
7
8
-
The M5Stack library provides access to the built-in hardware of the M5Stack Basic and Gray controllers through the M5Stack class, referenced as `M5`, including:
8
+
The M5Stack library provides access to the built-in hardware of the M5Stack Core (including Basic and Gray) controllers.
9
+
10
+
## Recommendation
11
+
**<spanstyle="font-size: larger">This library is not recommended for new projects, nor for projects using M5Stack products other than _Basic_ and _Gray_. See [M5Unified](https://github.com/M5Stack/M5Unified) and [M5GFX](https://github.com/M5Stack/M5GFX) for libraries that are more up-to-date and with support for many newer M5Stack products.</span>**
12
+
13
+
## Usage
14
+
This library's functionality is available through the M5Stack class, referenced as `M5`, including:
9
15
- LCD display via `M5.Lcd`, a customized version of the [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) LCD library, adapted for Basic and Gray. The display resolution is 320x240 supporting 262K colors. Several fonts, graphics primitives, QR code rendering, and PNG/BMP/JPEG support are included.
10
16
- Power control, including device shutoff and battery level detection via `M5.Power` and the IP5306 power management chip
11
17
- Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`
@@ -21,7 +27,7 @@ Additional optional include files:
21
27
-`M5Faces.h` for access to M5Stack Faces accessories (EOL)
0 commit comments