bienxanh1901/xiao_round_display

uploaded 5 months ago
Xiao round display driver

readme

# XIAO ROUND DISPLAY Driver


This repository contains an ESP-IDF driver for a Xiao Round display module. This module uses GC9A01 controller for LCD and CST816S controller for touch screen. Refer [Xiao Documentation](https://wiki.seeedstudio.com/seeedstudio_round_display_usage/) for more detailed.


## Using the component

Run the following command in your ESP-IDF project to install this component:
```bash
idf.py add-dependency "bienxanh1901/xiao_round_display"
```

## Example

To run the provided example, create it as follows:

```bash
idf.py create-project-from-example "bienxanh1901/xiao_round_display:xiao-round-display-example"
```

Then build as usual:
```bash
cd xiao-round-display-example
idf.py build
```

And flash it to the board:
```bash
idf.py -p PORT flash monitor
```

The example uses show the hardware test for LCD, touch and SD card.

## License

This component is provided under Apache 2.0 license, see [LICENSE](LICENSE.md) file for details.

## Contributing

Please check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

changelog

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [1.0.1] - 2023-11-21

- Fix upload component workflow


## [1.0.0] - 2023-11-21

- First release

Links

Supports all targets

Maintainer

  • Hai Pham <pthanhhaiai@gmail.com>

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "bienxanh1901/xiao_round_display^1.0.1"

or download archive

Dependencies

  • espressif/esp_lcd_gc9a01 ^1.2.0
  • espressif/esp_lcd_touch_cst816s ^1.0.3
  • espressif/esp_lvgl_port ^1.3.0
  • ESP-IDF >=5.0.0
  • Examples:

    xiao-round-display-example

    To create a project from this example, run:

    idf.py create-project-from-example "bienxanh1901/xiao_round_display^1.0.1:xiao-round-display-example"

    or download archive

    Stats

    • Downloaded in total
      Downloaded in total 3 times
    • Downloaded this version
      This version: 1 time

    Badge

    bienxanh1901/xiao_round_display version: 1.0.1
    |