Skip to content

Commit 7a52ed1

Browse files
authored
Suggest using M5Unified instead
1 parent 5a9f504 commit 7a52ed1

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55

66
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
77

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+
**<span style="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:
915
- 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.
1016
- Power control, including device shutoff and battery level detection via `M5.Power` and the IP5306 power management chip
1117
- Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`
@@ -21,7 +27,7 @@ Additional optional include files:
2127
- `M5Faces.h` for access to M5Stack Faces accessories (EOL)
2228
- `LoRaWan.h`
2329

24-
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/gray/gray_01.webp" alt="gray" width="350" height="350"><img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350">
30+
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350"><img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/gray/gray_01.webp" alt="gray" width="350" height="350">
2531

2632
* **Hardware documentation for [Gray v1.0 (EOL)](https://docs.m5stack.com/en/core/gray)**
2733

@@ -32,7 +38,7 @@ Additional optional include files:
3238
*[Comparison of M5Stack controllers](https://docs.m5stack.com/en/products_selector)*
3339

3440
### M-BUS
35-
![image](docs/M-BUS.jpg)
41+
<img src="docs/M-BUS.jpg" width="300" />
3642

3743
## More Information
3844

0 commit comments

Comments
 (0)