Skip to content

Commit c0ceb31

Browse files
authored
Update README.md
continued edits
1 parent 58c49a2 commit c0ceb31

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@
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, including:
9-
- 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, and JPEG support are included.
10-
- Power management via `M5.Power`
8+
The M5Stack library is included with `#include <M5Stack.h>`, and provides access to the built-in hardware of the M5Stack Basic and Gray controllers through the M5Stack class, referenced as `M5`, including:
9+
- 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+
- Power control via `M5.Power` and the IP5306 power management chip
1111
- Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`
1212
- Speaker, via `M5.Speaker`, supporting tones, volume control, and basic wave audio playback
1313
- Accelerometer, via `M5.Imu`, `M5.Mpu6886`, or `M5.Sh200Q` (accelerometer type depends on version of Basic/Gray)
1414

15+
Additional include files:
16+
- `M5Faces.h` for access to M5Stack Faces products (EOL)
17+
- `LoRaWan.h`
18+
1519
<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">
1620

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

0 commit comments

Comments
 (0)