updated readme
This commit is contained in:
parent
5dc2599e55
commit
25b0aa09e2
48
README.md
48
README.md
@ -1,30 +1,58 @@
|
|||||||
# Overview
|
## Overview
|
||||||
|
|
||||||
NanoBake is a front-end application platform.
|
NanoBake is a front-end application platform for ESP32. It provides an application framework that is based code from the [Flipper Zero](https://github.com/flipperdevices/flipperzero-firmware/) project.
|
||||||
|
|
||||||
The main goals are to install and run multiple front-end applications on a single ESP32 device,
|
Nanobake provides:
|
||||||
and to simplify hardware support for such apps.
|
- A hardware abstraction layer
|
||||||
|
- UI capabilities (via LVGL)
|
||||||
|
- An application platform that can run apps and services
|
||||||
|
|
||||||
**Status: pre-alpha**
|
**Status: pre-alpha**
|
||||||
|
|
||||||
# Technologies
|
## Technologies
|
||||||
|
|
||||||
LCD and input drivers are based on `esp_lcd` from esp-idf
|
LCD and input drivers are based on [esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/lcd.html)
|
||||||
and `esp_lcd_touch` from the [ESP Registry](https://components.espressif.com/components/espressif/esp_lcd_touch).
|
and [esp_lcd_touch](https://components.espressif.com/components/espressif/esp_lcd_touch).
|
||||||
Drawing is done by `lvgl` via `esp_lvgl_port`.
|
|
||||||
|
|
||||||
# Supported Devices
|
UI is created with [lvgl](https://github.com/lvgl/lvgl) via [esp_lvgl_port](https://github.com/espressif/esp-bsp/tree/master/components/esp_lvgl_port).
|
||||||
|
|
||||||
|
## Supported Hardware
|
||||||
|
|
||||||
|
### Devices
|
||||||
|
|
||||||
In theory, all hardware from the [Board Support Packages](https://github.com/espressif/esp-bsp/) project is supported.
|
In theory, all hardware from the [Board Support Packages](https://github.com/espressif/esp-bsp/) project is supported.
|
||||||
|
|
||||||
In practice, there are pre-configured drivers available for these boards:
|
In practice, there are pre-configured drivers available for these boards:
|
||||||
- Yellow Board / 2432S024
|
- Yellow Board / 2432S024
|
||||||
|
|
||||||
# Guide
|
### Drivers
|
||||||
|
|
||||||
|
**Displays** (see [esp-bsp](https://github.com/espressif/esp-bsp/blob/master/LCD.md) and [Espressif Registry](https://components.espressif.com/components?q=esp_lcd)):
|
||||||
|
- GC9503
|
||||||
|
- GC9A01
|
||||||
|
- ILI9341
|
||||||
|
- RA8875
|
||||||
|
- RM68120
|
||||||
|
- SH1107
|
||||||
|
- SSD1306
|
||||||
|
- SSD1963
|
||||||
|
- ST7262E43
|
||||||
|
- ST7789
|
||||||
|
|
||||||
|
**Touch** (see [Espressif Registry](https://components.espressif.com/components?q=esp_lcd_touch)):
|
||||||
|
- CST8xx
|
||||||
|
- FT5X06
|
||||||
|
- GT1151
|
||||||
|
- GT911
|
||||||
|
- STMPE610
|
||||||
|
- TT2100
|
||||||
|
|
||||||
|
## Guide
|
||||||
|
|
||||||
Until there is proper documentation, here are some pointers:
|
Until there is proper documentation, here are some pointers:
|
||||||
- [Sample application](main/src/main.c)
|
- [Sample application](main/src/main.c)
|
||||||
- [NanoBake](./components/nanobake/inc)
|
- [NanoBake](./components/nanobake/inc)
|
||||||
|
- [Furi](./components/furi/src)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user