Skip to content

Update README.md #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2025
Merged

Update README.md #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ A map is composed from downloaded OSM tiles and returned as a LGFX sprite.
The sprite can be pushed to the screen, saved to SD or used for further composing.
Downloaded tiles are cached in psram for reuse.

This library should work on any ESP32 type with psram and a LovyanGFX compatible display.
The downloaded tile cache gets large very quickly -128kB per tile- so psram is required.
This library should work on any ESP32 type with psram and a LovyanGFX compatible display.
OSM tiles are quite large -128kB per tile- so psram is required.
Tile fetching and decoding is performed concurrently across both cores on multicore ESP32 devices.

This project is not endorsed by or affiliated with the OpenStreetMap Foundation.

Expand Down Expand Up @@ -46,7 +47,7 @@ void setSize(uint16_t w, uint16_t h);
### Resize cache

```c++
bool resizeTilesCache(uint8_t numberOfTiles);
bool resizeTilesCache(uint16_t numberOfTiles);
```

- If the cache is not resized before the first call to `fetchMap`, it will auto initialize with space for 10 tiles on the first call.
Expand Down Expand Up @@ -201,7 +202,7 @@ void loop()

```bash
lib_deps =
CelliesProjects/OpenStreetMap-esp32@^1.0.1
celliesprojects/OpenStreetMap-esp32@^1.0.2
lovyan03/LovyanGFX@^1.2.0
bitbank2/PNGdec@^1.0.3
```