|  | 
| 9 | 9 | This library provides a [OpenStreetMap](https://www.openstreetmap.org/) (OSM) map fetching and tile caching system for ESP32-based devices.   | 
| 10 | 10 | Under the hood it uses [LovyanGFX](https://github.com/lovyan03/LovyanGFX) and [PNGdec](https://github.com/bitbank2/PNGdec) to do the heavy lifting. | 
| 11 | 11 | 
 | 
| 12 |  | -A map is composed from downloaded OSM tiles and returned as a LGFX sprite. | 
| 13 |  | - | 
| 14 |  | -Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices.   | 
| 15 |  | - | 
| 16 |  | -This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.   | 
| 17 |  | -Use [the latest Arduino ESP32 Core version](https://github.com/pioarduino/platform-espressif32/releases/latest) from [pioarduino](https://github.com/pioarduino/platform-espressif32) to compile this library.  | 
| 18 |  | - | 
| 19 | 12 | [](https://www.openstreetmap.org/) | 
| 20 | 13 | 
 | 
| 21 |  | -The returned map can be pushed to the screen, saved to SD or used for further composing.   | 
|  | 14 | +A map is composed from downloaded OSM tiles and returned as a LGFX sprite.   | 
|  | 15 | +Tile fetching and decoding is performed concurrently across both cores on dualcore ESP32 devices.   | 
|  | 16 | +A composed map can be pushed to the screen, saved to SD or used for further composing.   | 
| 22 | 17 | Downloaded tiles are cached in psram for reuse. | 
| 23 | 18 | 
 | 
| 24 | 19 | This library should work on any ESP32 type with psram and a LovyanGFX compatible display.   | 
| 25 |  | -OSM tiles are quite large -128kB per tile- so psram is required.    | 
|  | 20 | +OSM tiles are quite large -128kB per tile- so psram is required. | 
| 26 | 21 | 
 | 
| 27 |  | -This project is not endorsed by or affiliated with the OpenStreetMap Foundation. | 
|  | 22 | +This project is not endorsed by or affiliated with the OpenStreetMap Foundation.   | 
|  | 23 | +Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use). | 
| 28 | 24 | 
 | 
| 29 |  | -## License differences between this library and the map data | 
|  | 25 | +## How to use | 
| 30 | 26 | 
 | 
| 31 |  | -### This library has a MIT license | 
|  | 27 | +This library is **PlatformIO only** due to use of modern C++ features. The Arduino IDE is **not** supported.   | 
|  | 28 | +Use [the latest Arduino ESP32 Core version](https://github.com/pioarduino/platform-espressif32/releases/latest) from [pioarduino](https://github.com/pioarduino/platform-espressif32) to compile this library.   | 
|  | 29 | +See the example PIO settings and example code to get started. | 
| 32 | 30 | 
 | 
| 33 |  | -The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE). | 
|  | 31 | +### Example `platformio.ini` settings | 
| 34 | 32 | 
 | 
| 35 |  | -### The downloaded tile data has a ODbL license | 
|  | 33 | +These settings use `Arduino Release v3.2.0 based on ESP-IDF v5.4.1` from pioarduino. | 
| 36 | 34 | 
 | 
| 37 |  | -OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF). | 
|  | 35 | +```bash | 
|  | 36 | +[env] | 
|  | 37 | +platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.20/platform-espressif32.zip | 
|  | 38 | +framework = arduino | 
| 38 | 39 | 
 | 
| 39 |  | -Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use). | 
| 40 |  | - | 
| 41 |  | -## Functions | 
|  | 40 | +lib_deps = | 
|  | 41 | +    celliesprojects/OpenStreetMap-esp32@^1.0.6 | 
|  | 42 | +    lovyan03/LovyanGFX@^1.2.7 | 
|  | 43 | +    https://github.com/bitbank2/PNGdec@^1.1.3 | 
|  | 44 | +``` | 
| 42 | 45 | 
 | 
| 43 | 46 | ### Set map size | 
| 44 | 47 | 
 | 
| @@ -201,3 +204,15 @@ void loop() | 
| 201 | 204 |     delay(1000); | 
| 202 | 205 | } | 
| 203 | 206 | ``` | 
|  | 207 | + | 
|  | 208 | +## License differences between this library and the map data | 
|  | 209 | + | 
|  | 210 | +### This library has a MIT license | 
|  | 211 | + | 
|  | 212 | +The `OpenstreetMap-esp32` library -this library- is licensed under the [MIT license](/LICENSE). | 
|  | 213 | + | 
|  | 214 | +### The downloaded tile data has a ODbL license | 
|  | 215 | + | 
|  | 216 | +OpenStreetMap® is open data, licensed under the [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/) by the OpenStreetMap Foundation (OSMF). | 
|  | 217 | + | 
|  | 218 | +Use of any OSMF provided service is governed by the [OSMF Terms of Use](https://osmfoundation.org/wiki/Terms_of_Use). | 
0 commit comments