Skip to content

Update README.md #66

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 2 commits into from
May 23, 2025
Merged

Update README.md #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c11a5a
Update README.md
CelliesProjects May 23, 2025
438d38b
Update README.md
CelliesProjects May 23, 2025
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
18 changes: 6 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@
This library provides a [OpenStreetMap](https://www.openstreetmap.org/) (OSM) map fetching and tile caching system for ESP32-based devices.
Under the hood it uses [LovyanGFX](https://github.com/lovyan03/LovyanGFX) and [PNGdec](https://github.com/bitbank2/PNGdec) to do the heavy lifting.

A map is composed from downloaded OSM tiles and returned as a LGFX sprite.

Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices.

This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.

[![map](https://github.com/user-attachments/assets/39a7f287-c59d-4365-888a-d4c3f77a1dd1 "Click to visit OpenStreetMap.org")](https://www.openstreetmap.org/)

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.
The returned map 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.
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 All @@ -29,7 +31,7 @@ This project is not endorsed by or affiliated with the OpenStreetMap Foundation.

The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE).

### The downloaded tile data has a Open Data Commons Open Database License (ODbL)
### The downloaded tile data has a ODbL license

OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF).

Expand Down Expand Up @@ -199,11 +201,3 @@ void loop()
}
```

### PlatformIO setup

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