https://github.com/glitchedpanda/dontpanic

Offline wikipedia reader for the CYD inspired by The Hitchhiker's Guide to The Galaxy
https://github.com/glitchedpanda/dontpanic

cheap-yellow-display cyd esp32 esp32-2432s028 esp32-arduino hitchhiker hitchhikers-guide lvgl lvgl-esp32 microsd sqlite3 sqlite3-database wikipedia

Last synced: about 1 month ago
JSON representation

Offline wikipedia reader for the CYD inspired by The Hitchhiker's Guide to The Galaxy

• Host: GitHub
• URL: https://github.com/glitchedpanda/dontpanic
• Owner: GlitchedPanda
• Created: 2024-09-03T19:10:11.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-04T14:05:06.000Z (4 months ago)
• Last Synced: 2024-11-21T17:07:00.944Z (about 1 month ago)
• Topics: cheap-yellow-display, cyd, esp32, esp32-2432s028, esp32-arduino, hitchhiker, hitchhikers-guide, lvgl, lvgl-esp32, microsd, sqlite3, sqlite3-database, wikipedia
• Language: C++
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Don't Panic

Offline wikipedia reader for the CYD inspired by [The Hitchhiker's Guide to The Galaxy](https://en.wikipedia.org/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy)

## How to compile

- Open `DontPanic.ino` with the Arduino Ide. Make sure you have lvgl, TFT_eSPI, XPT2046_Bitbang, SD and Sqlite3Esp32 installed.

- Plug in your CYD into any usb port and choose it in the arduino ide. Set the type as `ESP32 Dev Module`.

- Click `Tools` on the top, then click `Partition Scheme` and select `Huge APP`.

- Click upload.

## How to Use

- Download and run [MediaWiki Parser](https://github.com/GlitchedPanda/MediaWikiParser).

- It will generate a .db file. Run the SQL Statement `CREATE VIRTUAL TABLE IF NOT EXISTS pages_fts USING fts4(title, content); INSERT INTO pages_fts (title, content) SELECT title, content FROM pages;` on it with the SQLite3 cli.

- Rename it to `data.db` if it isn't called that already.

- Put `data.db` onto a MicroSD card and plug it in to your CYD (Cheap Yellow Display)

- After you have started it, click anywhere on the screen and you will be able to search.

## Limitations

The CYD does not have a lot of memory. It only has 256MB of it. This means that with large databaes (Like a wikipedia dump), it will often run out of memory. Therefore you should try to search in a way that doesn't make the CYD search too much. Any help to solve this issue would be greatly appreciated :).

## Resources

https://github.com/TheNitek/XPT2046_Bitbang_Arduino_Library

https://github.com/Bodmer/TFT_eSPI

https://github.com/siara-cc/esp32_arduino_sqlite3_lib

https://github.com/arduino-libraries/SD

https://www.sqlite.org/fts5.html

https://www.sqlite.org/cintro.html

https://www.sqlite.org/amalgamation.html

https://docs.lvgl.io/master/