mirror of
https://github.com/bblanchon/ArduinoJson.git
synced 2025-08-09 15:44:42 +02:00
Moved migration guide to arduinojson.org
1
Home.md
1
Home.md
@@ -1,6 +1,5 @@
|
||||
:warning: Most of the content of the wiki is now in [arduinojson.org](http://arduinojson.org).
|
||||
|
||||
- ~~[[Migrating code to the new API]]~~ (obsolete)
|
||||
- [[Bag of Tricks]]
|
||||
- [[Projects using ArduinoJson]]
|
||||
- [Donations](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=donate%40benoitblanchon%2efr&lc=GB&item_name=Benoit%20Blanchon&item_number=Arduino%20JSON¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) :beers:
|
||||
|
@@ -1,77 +0,0 @@
|
||||
Arduino JSON v4 was a major rewrite of the library, and the API changed significantly.
|
||||
|
||||
## Includes
|
||||
|
||||
Arduino JSON v3 had two include files:
|
||||
|
||||
#include <JsonParser.h>
|
||||
#include <JsonGenerator.h>
|
||||
|
||||
Arduino JSON v4 only has one:
|
||||
|
||||
#include <ArduinoJson.h>
|
||||
|
||||
## Namespaces
|
||||
|
||||
Arduino JSON v3 had two namespaces:
|
||||
|
||||
using namespace ArduinoJson::Parser;
|
||||
using namespace ArduinoJson::Generator;
|
||||
|
||||
Arduino JSON v4 doesn't require the `using namespace` statement.
|
||||
It has a namespace but the `using namespace` is done in the header file.
|
||||
|
||||
## StaticJsonBuffer
|
||||
|
||||
Arduino JSON v3 had different memory allocation models for the parser:
|
||||
|
||||
JsonParser<16> parser; // 16 being the capacity in "tokens"
|
||||
|
||||
and for the generator:
|
||||
|
||||
JsonArray<4> array; // 4 being the number of element
|
||||
JsonObject<4> object;
|
||||
|
||||
Arduino JSON v4 only has one memory allocation model:
|
||||
|
||||
StaticJsonBuffer<128> buffer; // 128 being the capacity in bytes
|
||||
|
||||
## Return values for the parser
|
||||
|
||||
Arduino JSON v3 returned value types:
|
||||
|
||||
JsonArray array = parser.parseArray(json);
|
||||
JsonObject object = parser.parseObject(json);
|
||||
|
||||
Arduino JSON v4 returns references types:
|
||||
|
||||
JsonArray& array = buffer.parseArray(json);
|
||||
JsonObject& object = buffer.parseObject(json);
|
||||
|
||||
Everything else is compatible
|
||||
|
||||
## Creating arrays and objects
|
||||
|
||||
Arduino JSON v3 allowed to create `JsonArray` and `JsonObject` directly:
|
||||
|
||||
JsonArray<4> array;
|
||||
JsonObject<4> object;
|
||||
|
||||
Arduino JSON v4 requires that you use a `StaticJsonBuffer` for that:
|
||||
|
||||
JsonArray& array = buffer.createArray();
|
||||
JsonObject& object = buffer.createObject();
|
||||
|
||||
Note: you don't have to specify the capacity anymore.
|
||||
|
||||
## Printable interface
|
||||
|
||||
Arduino JSON v3 used to implement the Printable interface, which allowed statements like:
|
||||
|
||||
Serial.print(array);
|
||||
|
||||
But Arduino JSON v4 doesn't, instead you need to write this:
|
||||
|
||||
array.printTo(Serial);
|
||||
|
||||
Note: there was a good reason for removing that feature, and it's reducing the size of `JsonArray` and `JsonObject`.
|
Reference in New Issue
Block a user