2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
# LilyBook - ePaper Reader for ESP32
|
2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
Ebook reader firmware designed for LilyGO T5 v2.4 (ESP32 with 2.9" eInk display).
|
2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
## How to build
|
2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
Configure your esp32 build environment as for [**esp-idf examples**](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/)
|
2020-01-29 17:30:50 +00:00
|
|
|
|
|
|
|
|
Clone the repository
|
|
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
`git clone https://github.com/Dejvino/lilybook.git`
|
2020-01-29 17:30:50 +00:00
|
|
|
|
|
|
|
|
Execute menuconfig and configure your Serial flash config and other settings. Included *sdkconfig.defaults* sets some defaults to be used.
|
|
|
|
|
|
|
|
|
|
`make menuconfig`
|
|
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
Make and flash the firmware.
|
2020-01-29 17:30:50 +00:00
|
|
|
|
|
|
|
|
`make all && make flash`
|
|
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
Optionally run a serial output monitor to see debug messages.
|
2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
`make monitor`
|
2020-01-29 17:30:50 +00:00
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
Note: pres `CTRL + ]` to exit the monitor.
|
2020-01-29 17:30:50 +00:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2020-01-29 22:04:19 +00:00
|
|
|
## Built Thanks To
|
|
|
|
|
* Display Driver: https://github.com/loboris/ESP32_ePaper_example
|
|
|
|
|
* SD Card Sample: https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card
|
|
|
|
|
* Pinout: https://github.com/Xinyuan-LilyGO/T5-Ink-Screen-Series
|
