-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2da7339
commit f127e35
Showing
68 changed files
with
1,116 additions
and
799 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| <p align="center"> | ||
| <a href="https://arduinojson.org/"><img alt="ArduinoJson" src="https://arduinojson.org/images/logo.svg" width="200" /></a> | ||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| [](https://github.com/bblanchon/ArduinoJson/actions?query=workflow%3A%22Continuous+Integration%22+branch%3A6.x) | ||
| [](https://ci.appveyor.com/project/bblanchon/arduinojson/branch/6.x) | ||
| [](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:arduinojson) | ||
| [](https://coveralls.io/github/bblanchon/ArduinoJson?branch=6.x) | ||
| [](https://www.ardu-badge.com/ArduinoJson/6.21.3) | ||
| [](https://registry.platformio.org/packages/libraries/bblanchon/ArduinoJson?version=6.21.3) | ||
| [](https://components.espressif.com/components/bblanchon/arduinojson) | ||
| [](https://github.com/bblanchon/ArduinoJson/stargazers) | ||
| [](https://github.com/sponsors/bblanchon) | ||
|
|
||
| ArduinoJson is a C++ JSON library for Arduino and IoT (Internet Of Things). | ||
|
|
||
| ## Features | ||
|
|
||
| * [JSON deserialization](https://arduinojson.org/v6/api/json/deserializejson/) | ||
| * [Optionally decodes UTF-16 escape sequences to UTF-8](https://arduinojson.org/v6/api/config/decode_unicode/) | ||
| * [Optionally stores links to the input buffer (zero-copy)](https://arduinojson.org/v6/api/json/deserializejson/) | ||
| * [Optionally supports comments in the input](https://arduinojson.org/v6/api/config/enable_comments/) | ||
| * [Optionally filters the input to keep only desired values](https://arduinojson.org/v6/api/json/deserializejson/#filtering) | ||
| * Supports single quotes as a string delimiter | ||
| * Compatible with [NDJSON](http://ndjson.org/) and [JSON Lines](https://jsonlines.org/) | ||
| * [JSON serialization](https://arduinojson.org/v6/api/json/serializejson/) | ||
| * [Can write to a buffer or a stream](https://arduinojson.org/v6/api/json/serializejson/) | ||
| * [Optionally indents the document (prettified JSON)](https://arduinojson.org/v6/api/json/serializejsonpretty/) | ||
| * [MessagePack serialization](https://arduinojson.org/v6/api/msgpack/serializemsgpack/) | ||
| * [MessagePack deserialization](https://arduinojson.org/v6/api/msgpack/deserializemsgpack/) | ||
| * Efficient | ||
| * [Twice smaller than the "official" Arduino_JSON library](https://arduinojson.org/2019/11/19/arduinojson-vs-arduino_json/) | ||
| * [Almost 10% faster than the "official" Arduino_JSON library](https://arduinojson.org/2019/11/19/arduinojson-vs-arduino_json/) | ||
| * [Consumes roughly 10% less RAM than the "official" Arduino_JSON library](https://arduinojson.org/2019/11/19/arduinojson-vs-arduino_json/) | ||
| * [Fixed memory allocation, no heap fragmentation](https://arduinojson.org/v6/api/jsondocument/) | ||
| * [Optionally works without heap memory (zero malloc)](https://arduinojson.org/v6/api/staticjsondocument/) | ||
| * [Deduplicates strings](https://arduinojson.org/news/2020/08/01/version-6-16-0/) | ||
| * Versatile | ||
| * Supports [custom allocators (to use external RAM chip, for example)](https://arduinojson.org/v6/how-to/use-external-ram-on-esp32/) | ||
| * Supports [`String`](https://arduinojson.org/v6/api/config/enable_arduino_string/), [`std::string`](https://arduinojson.org/v6/api/config/enable_std_string/), and [`std::string_view`](https://arduinojson.org/v6/api/config/enable_string_view/) | ||
| * Supports [`Stream`](https://arduinojson.org/v6/api/config/enable_arduino_stream/) and [`std::istream`/`std::ostream`](https://arduinojson.org/v6/api/config/enable_std_stream/) | ||
| * Supports [Flash strings](https://arduinojson.org/v6/api/config/enable_progmem/) | ||
| * Supports [custom readers](https://arduinojson.org/v6/api/json/deserializejson/#custom-reader) and [custom writers](https://arduinojson.org/v6/api/json/serializejson/#custom-writer) | ||
| * Supports [custom converters](https://arduinojson.org/news/2021/05/04/version-6-18-0/) | ||
| * Portable | ||
| * Usable on any C++ project (not limited to Arduino) | ||
| * Compatible with C++11, C++14 and C++17 | ||
| * Support for C++98/C++03 available on [ArduinoJson 6.20.x](https://github.com/bblanchon/ArduinoJson/tree/6.20.x) | ||
| * Zero warnings with `-Wall -Wextra -pedantic` and `/W4` | ||
| * [Header-only library](https://en.wikipedia.org/wiki/Header-only) | ||
| * Works with virtually any board | ||
| * Arduino boards: [Uno](https://amzn.to/38aL2ik), [Due](https://amzn.to/36YkWi2), [Micro](https://amzn.to/35WkdwG), [Nano](https://amzn.to/2QTvwRX), [Mega](https://amzn.to/36XWhuf), [Yun](https://amzn.to/30odURc), [Leonardo](https://amzn.to/36XWjlR)... | ||
| * Espressif chips: [ESP8266](https://amzn.to/36YluV8), [ESP32](https://amzn.to/2G4pRCB) | ||
| * Lolin (WeMos) boards: [D1 mini](https://amzn.to/2QUpz7q), [D1 Mini Pro](https://amzn.to/36UsGSs)... | ||
| * Teensy boards: [4.0](https://amzn.to/30ljXGq), [3.2](https://amzn.to/2FT0EuC), [2.0](https://amzn.to/2QXUMXj) | ||
| * Particle boards: [Argon](https://amzn.to/2FQHa9X), [Boron](https://amzn.to/36WgLUd), [Electron](https://amzn.to/30vEc4k), [Photon](https://amzn.to/387F9Cd)... | ||
| * Texas Instruments boards: [MSP430](https://amzn.to/30nJWgg)... | ||
| * Soft cores: [Nios II](https://en.wikipedia.org/wiki/Nios_II)... | ||
| * Tested on all major development environments | ||
| * [Arduino IDE](https://www.arduino.cc/en/Main/Software) | ||
| * [Atmel Studio](http://www.atmel.com/microsite/atmel-studio/) | ||
| * [Atollic TrueSTUDIO](https://atollic.com/truestudio/) | ||
| * [Energia](http://energia.nu/) | ||
| * [IAR Embedded Workbench](https://www.iar.com/iar-embedded-workbench/) | ||
| * [Keil uVision](http://www.keil.com/) | ||
| * [MPLAB X IDE](http://www.microchip.com/mplab/mplab-x-ide) | ||
| * [Particle](https://www.particle.io/) | ||
| * [PlatformIO](http://platformio.org/) | ||
| * [Sloeber plugin for Eclipse](https://eclipse.baeyens.it/) | ||
| * [Visual Micro](http://www.visualmicro.com/) | ||
| * [Visual Studio](https://www.visualstudio.com/) | ||
| * [Even works with online compilers like wandbox.org](https://wandbox.org/permlink/RlZSKy17DjJ6HcdN) | ||
| * [CMake friendly](https://arduinojson.org/v6/how-to/use-arduinojson-with-cmake/) | ||
| * Well designed | ||
| * [Elegant API](http://arduinojson.org/v6/example/) | ||
| * [Thread-safe](https://en.wikipedia.org/wiki/Thread_safety) | ||
| * Self-contained (no external dependency) | ||
| * `const` friendly | ||
| * [`for` friendly](https://arduinojson.org/v6/api/jsonobject/begin_end/) | ||
| * [TMP friendly](https://en.wikipedia.org/wiki/Template_metaprogramming) | ||
| * Handles [integer overflows](https://arduinojson.org/v6/api/jsonvariant/as/#integer-overflows) | ||
| * Well tested | ||
| * [Unit test coverage close to 100%](https://coveralls.io/github/bblanchon/ArduinoJson?branch=6.x) | ||
| * Continuously tested on | ||
| * [Visual Studio 2017, 2019, 2022](https://ci.appveyor.com/project/bblanchon/arduinojson/branch/6.x) | ||
| * [GCC 5, 6, 7, 8, 9, 10, 11](https://github.com/bblanchon/ArduinoJson/actions?query=workflow%3A%22Continuous+Integration%22) | ||
| * [Clang 3.8, 3.9, 4.0, 5.0, 6.0, 7, 8, 9, 10](https://github.com/bblanchon/ArduinoJson/actions?query=workflow%3A%22Continuous+Integration%22) | ||
| * [Continuously fuzzed with Google OSS Fuzz](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:arduinojson) | ||
| * Passes all default checks of [clang-tidy](https://releases.llvm.org/10.0.0/tools/clang/tools/extra/docs/clang-tidy/) | ||
| * Well documented | ||
| * [Tutorials](https://arduinojson.org/v6/doc/deserialization/) | ||
| * [Examples](https://arduinojson.org/v6/example/) | ||
| * [How-tos](https://arduinojson.org/v6/example/) | ||
| * [FAQ](https://arduinojson.org/v6/faq/) | ||
| * [Troubleshooter](https://arduinojson.org/v6/troubleshooter/) | ||
| * [Book](https://arduinojson.org/book/) | ||
| * [Changelog](CHANGELOG.md) | ||
| * Vibrant user community | ||
| * Most popular of all Arduino libraries on [GitHub](https://github.com/search?o=desc&q=arduino+library&s=stars&type=Repositories) | ||
| * [Used in hundreds of projects](https://www.hackster.io/search?i=projects&q=arduinojson) | ||
| * [Responsive support](https://github.com/bblanchon/ArduinoJson/issues?q=is%3Aissue+is%3Aclosed) | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ### Deserialization | ||
|
|
||
| Here is a program that parses a JSON document with ArduinoJson. | ||
|
|
||
| ```c++ | ||
| char json[] = "{\"sensor\":\"gps\",\"time\":1351824120,\"data\":[48.756080,2.302038]}"; | ||
|
|
||
| DynamicJsonDocument doc(1024); | ||
| deserializeJson(doc, json); | ||
|
|
||
| const char* sensor = doc["sensor"]; | ||
| long time = doc["time"]; | ||
| double latitude = doc["data"][0]; | ||
| double longitude = doc["data"][1]; | ||
| ``` | ||
| See the [tutorial on arduinojson.org](https://arduinojson.org/v6/doc/deserialization/) | ||
| ### Serialization | ||
| Here is a program that generates a JSON document with ArduinoJson: | ||
| ```c++ | ||
| DynamicJsonDocument doc(1024); | ||
| doc["sensor"] = "gps"; | ||
| doc["time"] = 1351824120; | ||
| doc["data"][0] = 48.756080; | ||
| doc["data"][1] = 2.302038; | ||
| serializeJson(doc, Serial); | ||
| // This prints: | ||
| // {"sensor":"gps","time":1351824120,"data":[48.756080,2.302038]} | ||
| ``` | ||
|
|
||
| See the [tutorial on arduinojson.org](https://arduinojson.org/v6/doc/serialization/) | ||
|
|
||
| ## Sponsors | ||
|
|
||
| ArduinoJson is thankful to its sponsors. Please give them a visit; they deserve it! | ||
|
|
||
| <p> | ||
| <a href="https://www.programmingelectronics.com/" rel="sponsored"> | ||
| <img src="https://arduinojson.org/images/2021/10/programmingeleactronicsacademy.png" alt="Programming Electronics Academy" width="200"> | ||
| </a> | ||
| </p> | ||
| <p> | ||
| <a href="https://github.com/1technophile" rel="sponsored"> | ||
| <img alt="1technophile" src="https://avatars.githubusercontent.com/u/12672732?s=40&v=4"> | ||
| </a> | ||
| </p> | ||
|
|
||
| If you run a commercial project that embeds ArduinoJson, think about [sponsoring the library's development](https://github.com/sponsors/bblanchon): it ensures the code that your products rely on stays actively maintained. It can also give your project some exposure to the makers' community. | ||
|
|
||
| If you are an individual user and want to support the development (or give a sign of appreciation), consider purchasing the book [Mastering ArduinoJson](https://arduinojson.org/book/) ❤, or simply [cast a star](https://github.com/bblanchon/ArduinoJson/stargazers) ⭐. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Macros | ||
| JSON_ARRAY_SIZE KEYWORD2 | ||
| JSON_OBJECT_SIZE KEYWORD2 | ||
| JSON_STRING_SIZE KEYWORD2 | ||
|
|
||
| # Free functions | ||
| deserializeJson KEYWORD2 | ||
| deserializeMsgPack KEYWORD2 | ||
| serialized KEYWORD2 | ||
| serializeJson KEYWORD2 | ||
| serializeJsonPretty KEYWORD2 | ||
| serializeMsgPack KEYWORD2 | ||
| measureJson KEYWORD2 | ||
| measureJsonPretty KEYWORD2 | ||
| measureMsgPack KEYWORD2 | ||
|
|
||
| # Methods | ||
| add KEYWORD2 | ||
| as KEYWORD2 | ||
| createNestedArray KEYWORD2 | ||
| createNestedObject KEYWORD2 | ||
| get KEYWORD2 | ||
| set KEYWORD2 | ||
| to KEYWORD2 | ||
|
|
||
| # Type names | ||
| DeserializationError KEYWORD1 DATA_TYPE | ||
| DynamicJsonDocument KEYWORD1 DATA_TYPE | ||
| JsonArray KEYWORD1 DATA_TYPE | ||
| JsonArrayConst KEYWORD1 DATA_TYPE | ||
| JsonDocument KEYWORD1 DATA_TYPE | ||
| JsonFloat KEYWORD1 DATA_TYPE | ||
| JsonInteger KEYWORD1 DATA_TYPE | ||
| JsonObject KEYWORD1 DATA_TYPE | ||
| JsonObjectConst KEYWORD1 DATA_TYPE | ||
| JsonString KEYWORD1 DATA_TYPE | ||
| JsonUInt KEYWORD1 DATA_TYPE | ||
| JsonVariant KEYWORD1 DATA_TYPE | ||
| JsonVariantConst KEYWORD1 DATA_TYPE | ||
| StaticJsonDocument KEYWORD1 DATA_TYPE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| name=ArduinoJson | ||
| version=6.21.3 | ||
| author=Benoit Blanchon <blog.benoitblanchon.fr> | ||
| maintainer=Benoit Blanchon <blog.benoitblanchon.fr> | ||
| sentence=A simple and efficient JSON library for embedded C++. | ||
| paragraph=ArduinoJson supports ✔ serialization, ✔ deserialization, ✔ MessagePack, ✔ fixed allocation, ✔ zero-copy, ✔ streams, ✔ filtering, and more. It is the most popular Arduino library on GitHub ❤❤❤❤❤. Check out arduinojson.org for a comprehensive documentation. | ||
| category=Data Processing | ||
| url=https://arduinojson.org/?utm_source=meta&utm_medium=library.properties | ||
| architectures=* | ||
| repository=https://github.com/bblanchon/ArduinoJson.git | ||
| license=MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.