|
5 | 5 |
|
6 | 6 | English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
|
7 | 7 |
|
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: |
| 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: |
9 | 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 | 10 | - Power control via `M5.Power` and the IP5306 power management chip
|
11 | 11 | - Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`
|
12 | 12 | - Speaker, via `M5.Speaker`, supporting tones, volume control, and basic wave audio playback
|
13 | 13 | - Accelerometer, via `M5.Imu`, `M5.Mpu6886`, or `M5.Sh200Q` (accelerometer type depends on version of Basic/Gray)
|
14 | 14 |
|
15 |
| -Additional include files: |
16 |
| -- `M5Faces.h` for access to M5Stack Faces products (EOL) |
| 15 | +To use the M5Stack library, `#include "M5Stack.h"` must appear at the top of your sketch. |
| 16 | + |
| 17 | +Additional optional include files: |
| 18 | +- `M5Faces.h` for access to M5Stack Faces accessories (EOL) |
17 | 19 | - `LoRaWan.h`
|
18 | 20 |
|
19 | 21 | <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">
|
@@ -46,8 +48,6 @@ Additional include files:
|
46 | 48 | * [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD
|
47 | 49 | card
|
48 | 50 |
|
49 |
| -* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips |
50 |
| - |
51 | 51 | * [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack
|
52 | 52 |
|
53 | 53 | * [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32)
|
|
0 commit comments