Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mzyy94/m5dial-lvgl

LVGL porting for M5Dial
https://github.com/mzyy94/m5dial-lvgl

lvgl lvgl-esp32-port m5dial m5stack-dial

Last synced: 8 days ago
JSON representation

LVGL porting for M5Dial

Awesome Lists containing this project

README

        

# M5Dial-LVGL
[![PlatformIO CI](https://github.com/mzyy94/M5Dial-LVGL/actions/workflows/ci.yml/badge.svg)](https://github.com/mzyy94/M5Dial-LVGL/actions/workflows/ci.yml)

LVGL porting for M5Dial

## Environments

- PlatformIO 6.1 with [[email protected]]
- [ESP-IDF 5.1.2]

[[email protected]]: https://github.com/platformio/platform-espressif32/releases/tag/v6.5.0
[ESP-IDF 5.1.2]: https://github.com/espressif/esp-idf/releases/tag/v5.1.2

## Setup

### PlatformIO

Specify M5Dial-LVGL git repo in [`lib_deps`] option.

```ini
lib_deps =
M5Dial-LVGL=https://github.com/mzyy94/M5Dial-LVGL.git#v0.0.1
```

[`lib_deps`]: https://docs.platformio.org/en/latest/projectconf/sections/env/options/library/lib_deps.html

### ESP-IDF

Create [`idf_component.yml`] in **main** directory and put item in dependencies section.

```yaml
dependencies:
mzyy94/M5Dial-LVGL:
git: https://github.com/mzyy94/M5Dial-LVGL.git
version: v0.0.1
```

[`idf_component.yml`]: https://espressif-docs.readthedocs-hosted.com/projects/idf-component-manager/en/v1.4.0/reference/manifest_file.html

## Usage

Call `m5dial_lvgl_init()` first, `m5dial_lvgl_next()` in a loop.
Please refer to examples for more details.

## Examples

| [hello_world]| [touch_button]| [dial_number]|
|:------------:|:-------------:|:------------:|
|![hello-world]|![touch-button]|![dial-number]|
|Simple drawing| Touch input | Encoder input|

| [qr_code] | [new_font] | [native_sdl]|
|:-----------:|:-----------:|:-----------:|
| ![qr-code] | ![new-font] |![native-sdl]|
|Custom config|External font| PC preview |

[hello_world]: ./examples/hello_world
[touch_button]: ./examples/touch_button
[dial_number]: ./examples/dial_number
[qr_code]: ./examples/qr_code
[new_font]: ./examples/new_font
[native_sdl]: ./examples/native_sdl

[hello-world]: ./examples/hello_world/preview.png
[touch-button]: ./examples/touch_button/preview.png
[dial-number]: ./examples/dial_number/preview.png
[qr-code]: ./examples/qr_code/preview.png
[new-font]: ./examples/new_font/preview.png
[native-sdl]: ./examples/native_sdl/preview.png

## License

[MIT](LICENSE)