- Fix
cannot convert 'pgm_p' to 'const void*'
(issue #1707)
- Fix crash when adding an object member in a too small
JsonDocument
- Fix filter not working in zero-copy mode (issue #1697)
- Remove
ARDUINOJSON_EMBEDDED_MODE
and assume we run on an embedded platform.
Dependent settings (likeARDUINOJSON_DEFAULT_NESTING_LIMIT
) must be set individually. - Change the default of
ARDUINOJSON_USE_DOUBLE
to1
- Change the default of
ARDUINOJSON_USE_LONG_LONG
to1
on 32-bit platforms - Add
as<JsonString>()
andis<JsonString>()
- Add safe bool idiom in
JsonString
- Add support for NUL in string values (issue #1646)
- Add support for arbitrary array rank in
copyArray()
- Add support for
char[][]
incopyArray()
- Remove
DeserializationError == bool
andDeserializationError != bool
- Renamed undocumented function
isUndefined()
toisUnbound()
- Fix
JsonVariant::memoryUsage()
for raw strings - Fix
call of overloaded 'swap(BasicJsonDocument&, BasicJsonDocument&)' is ambiguous
(issue #1678) - Fix inconsistent pool capacity between
BasicJsonDocument
's copy and move constructors - Fix inconsistent pool capacity between
BasicJsonDocument
's copy and move assignments - Fix return type of
StaticJsonDocument::operator=
- Avoid pool reallocation in
BasicJsonDocument
's copy assignment if capacity is the same - Avoid including
Arduino.h
when all its features are disabled (issue #1692, PR #1693 by @paulocsanz) - Assume
PROGMEM
is available as soon asARDUINO
is defined (consequence of #1693)
- Set
ARDUINOJSON_EMBEDDED_MODE
to1
on Nios II (issue #1657)
- Fixed error
'dummy' may be used uninitialized
on GCC 11 - Fixed error
expected unqualified-id before 'const'
on GCC 11 (issue #1622) - Filter: exact match takes precedence over wildcard (issue #1628)
- Fixed deserialization of
\u0000
(issue #1646)
- Changed return type of
convertToJson()
andConverter<T>::toJson()
tovoid
- Added
as<std::string_view>()
andis<std::string_view>()
- Removed a symlink because the Arduino Library Specification forbids it
- Fixed support for
volatile float
andvolatile double
(issue #1557) - Fixed error
[Pe070]: incomplete type is not allowed
on IAR (issue #1560) - Fixed
serializeJson(doc, String)
when allocation fails (issue #1572) - Fixed clang-tidy warnings (issue #1574, PR #1577 by @armandas)
- Added fake class
InvalidConversion<T1,T2>
to easily identify invalid conversions (issue #1585) - Added support for
std::string_view
(issue #1578, PR #1554 by @0xFEEDC0DE64) - Fixed warning
definition of implicit copy constructor for 'MsgPackDeserializer' is deprecated because it has a user-declared copy assignment operator
- Added
JsonArray::clear()
(issue #1597) - Fixed
JsonVariant::as<unsigned>()
(issue #1601) - Added support for ESP-IDF component build (PR #1562 by @qt1, PR #1599 by @andreaskuster)
- Added support for custom converters (issue #687)
- Added support for
Printable
(issue #1444) - Removed support for
char
values, see below (issue #1498) deserializeJson()
leaves\uXXXX
unchanged instead of returningNotSupported
deserializeMsgPack()
insertsnull
instead of returningNotSupported
- Removed
DeserializationError::NotSupported
- Added
JsonVariant::is<JsonArrayConst/JsonObjectConst>()
(issue #1412) - Added
JsonVariant::is<JsonVariant/JsonVariantConst>()
(issue #1412) - Changed
JsonVariantConst::is<JsonArray/JsonObject>()
to returnfalse
(issue #1412) - Simplified
JsonVariant::as<T>()
to always returnT
(see below) - Updated folders list in
.mbedignore
(PR #1515 by @AGlass0fMilk) - Fixed member-call-on-null-pointer in
getMember()
when array is empty serializeMsgPack(doc, buffer, size)
doesn't add null-terminator anymore (issue #1545)serializeJson(doc, buffer, size)
adds null-terminator only if there is enough room- PlatformIO: set
build.libArchive
tofalse
(PR #1550 by @askreet)
We cannot cast a
JsonVariant
to achar
anymore, so the following will break:char age = doc["age"]; // error: no matching function for call to 'variantAs(VariantData*&)'Instead, you must use another integral type, such as
int8_t
:int8_t age = doc["age"]; // OKSimilarly, we cannot assign from a
char
anymore, so the following will break:char age; doc["age"] = age; // error: no matching function for call to 'VariantRef::set(const char&)'Instead, you must use another integral type, such as
int8_t
:int8_t age; doc["age"] = age; // OKA deprecation warning with the message "Support for
char
is deprecated, useint8_t
oruint8_t
instead" was added to allow a smooth transition.Previously,
JsonVariant::as<T>()
could return a type different fromT
. The most common example isas<char*>()
that returned aconst char*
. While this feature simplified a few use cases, it was confusing and complicated the implementation of custom converters.Starting from this version,
as<T>
doesn't try to auto-correct the return type and always returnT
, which means that you cannot write this anymore:Serial.println(doc["sensor"].as<char*>()); // error: invalid conversion from 'const char*' to 'char*' [-fpermissive]Instead, you must write:
Serial.println(doc["sensor"].as<const char*>()); // OKA deprecation warning with the message "Replace
as<char*>()
withas<const char*>()
" was added to allow a smooth transition.On a different topic,
DeserializationError::NotSupported
has been removed. Instead of returning this error:
deserializeJson()
leaves\uXXXX
unchanged (only whenARDUINOJSON_DECODE_UNICODE
is0
)deserializeMsgPack()
replaces unsupported values withnull
sLastly, a very minor change concerns
JsonVariantConst::is<T>()
. It used to returntrue
forJsonArray
andJsonOject
, but now it returnsfalse
. Instead, you must useJsonArrayConst
andJsonObjectConst
.
- Made
JsonDocument
's destructor protected (issue #1480) - Added missing calls to
client.stop()
inJsonHttpClient.ino
(issue #1485) - Fixed error
expected ')' before 'char'
whenisdigit()
is a macro (issue #1487) - Fixed error
definition of implicit copy constructor is deprecated
on Clang 10 - PlatformIO: set framework compatibility to
*
(PR #1490 by @maxgerhardt)
- Fixed invalid conversion error in
operator|(JsonVariant, char*)
(issue #1432) - Changed the default value of
ARDUINOJSON_ENABLE_PROGMEM
(issue #1433). It now checks that thepgm_read_XXX
macros are defined before enablingPROGMEM
.
- Fixed error
ambiguous overload for 'operator|'
(issue #1411) - Fixed
operator|(MemberProxy, JsonObject)
(issue #1415) - Allowed more than 32767 values in non-embedded mode (issue #1414)
- Added a build failure when nullptr is defined as a macro (issue #1355)
- Added
JsonDocument::overflowed()
which tells if the memory pool was too small (issue #1358) - Added
DeserializationError::EmptyInput
which tells if the input was empty - Added
DeserializationError::f_str()
which returns aconst __FlashStringHelper*
(issue #846) - Added
operator|(JsonVariantConst, JsonVariantConst)
- Added filtering for MessagePack (issue #1298, PR #1394 by Luca Passarella)
- Moved float convertion tables to PROGMEM
- Fixed
JsonVariant::set((char*)0)
which returned false instead of true (issue #1368) - Fixed error
No such file or directory #include <WString.h>
(issue #1381)
- Fixed
deserializeJson()
that stopped reading after{}
(issue #1335)
- Added comparisons (
>
,>=
,==
,!=
,<
, and<=
) betweenJsonVariant
s - Added string deduplication (issue #1303)
- Added
JsonString::operator!=
- Added wildcard key (
*
) for filters (issue #1309) - Set
ARDUINOJSON_DECODE_UNICODE
to1
by default - Fixed
copyArray()
not working withString
,ElementProxy
, andMemberProxy
- Fixed error
getOrAddElement is not a member of ElementProxy
(issue #1311) - Fixed excessive stack usage when compiled with
-Og
(issues #1210 and #1314) - Fixed
Warning[Pa093]: implicit conversion from floating point to integer
on IAR compiler (PR #1328 by @stawiski)
- CMake: don't build tests when imported in another project
- CMake: made project arch-independent
- Visual Studio: fixed error C2766 with flag
/Zc:__cplusplus
(issue #1250) - Added support for
JsonDocument
tocopyArray()
(issue #1255) - Added support for
enum
s inas<T>()
andis<T>()
(issue #1256) - Added
JsonVariant
as an input type fordeserializeXxx()
For example, you can do:deserializeJson(doc2, doc1["payload"])
- Break the build if using 64-bit integers with ARDUINOJSON_USE_LONG_LONG==0
- Fixed "maybe-uninitialized" warning (issue #1217)
- Fixed "statement is unreachable" warning on IAR (issue #1233)
- Fixed "pointless integer comparison" warning on IAR (issue #1233)
- Added CMake "install" target (issue #1209)
- Disabled alignment on AVR (issue #1231)
- Added
DeserializationOption::Filter
(issue #959) - Added example
JsonFilterExample.ino
- Changed the array subscript operator to automatically add missing elements
- Fixed "deprecated-copy" warning on GCC 9 (fixes #1184)
- Fixed
MemberProxy::set(char[])
not duplicating the string (issue #1191) - Fixed enums serialized as booleans (issue #1197)
- Fixed incorrect string comparison on some platforms (issue #1198)
- Added move-constructor and move-assignment to
BasicJsonDocument
- Added
BasicJsonDocument::garbageCollect()
(issue #1195) - Added
StaticJsonDocument::garbageCollect()
- Changed copy-constructor of
BasicJsonDocument
to preserve the capacity of the source. - Removed copy-constructor of
JsonDocument
(issue #1189)
In previous versions, the copy constructor of
BasicJsonDocument
looked at the source'smemoryUsage()
to choose its capacity. Now, the copy constructor ofBasicJsonDocument
uses the same capacity as the source.Example:
DynamicJsonDocument doc1(64); doc1.set(String("example")); DynamicJsonDocument doc2 = doc1; Serial.print(doc2.capacity()); // 8 with ArduinoJson 6.14 // 64 with ArduinoJson 6.15I made this change to get consistent results between copy-constructor and move-constructor, and whether RVO applies or not.
If you use the copy-constructor to optimize your documents, you can use
garbageCollect()
orshrinkToFit()
instead.In previous versions, it was possible to create a function that take a
JsonDocument
by value.void myFunction(JsonDocument doc) {}This function gives the wrong clues because it doesn't receive a copy of the
JsonDocument
, only a sliced version. It worked because the copy constructor copied the internal pointers, but it was an accident.From now, if you need to pass a
JsonDocument
to a function, you must use a reference:void myFunction(JsonDocument& doc) {}
- Fixed regression in UTF16 decoding (issue #1173)
- Fixed
containsKey()
onJsonVariantConst
- Added
getElement()
andgetMember()
toJsonVariantConst
- Added
BasicJsonDocument::shrinkToFit()
- Added support of
uint8_t
forserializeJson()
,serializeJsonPretty()
, andserializeMsgPack()
(issue #1142) - Added
ARDUINOJSON_ENABLE_COMMENTS
to enable support for comments (defaults to 0) - Auto enable support for
std::string
andstd::stream
on modern compilers (issue #1156) (No need to defineARDUINOJSON_ENABLE_STD_STRING
andARDUINOJSON_ENABLE_STD_STREAM
anymore) - Improved decoding of UTF-16 surrogate pairs (PR #1157 by @kaysievers) (ArduinoJson now produces standard UTF-8 instead of CESU-8)
- Added
measureJson
,measureJsonPretty
, andmeasureMsgPack
tokeywords.txt
(This file is used for syntax highlighting in the Arduino IDE) - Fixed
variant.is<nullptr_t>()
- Fixed value returned by
serializeJson()
,serializeJsonPretty()
, andserializeMsgPack()
when writing to aString
- Improved speed of
serializeJson()
,serializeJsonPretty()
, andserializeMsgPack()
when writing to aString
Support for comments in input is now optional and disabled by default.
If you need support for comments, you must defined
ARDUINOJSON_ENABLE_COMMENTS
to1
; otherwise, you'll receiveInvalidInput
errors.#define ARDUINOJSON_ENABLE_COMMENTS 1 #include <ArduinoJson.h>
- Added support for custom writer/reader classes (issue #1088)
- Added conversion from
JsonArray
andJsonObject
tobool
, to be consistent withJsonVariant
- Fixed
deserializeJson()
when input contains duplicate keys (issue #1095) - Improved
deserializeMsgPack()
speed by reading several bytes at once - Added detection of Atmel AVR8/GNU C Compiler (issue #1112)
- Fixed deserializer that stopped reading at the first
0xFF
(PR #1118 by @mikee47) - Fixed dangling reference in copies of
MemberProxy
andElementProxy
(issue #1120)
- Use absolute instead of relative includes (issue #1072)
- Changed
JsonVariant::as<bool>()
to returntrue
for any non-null value (issue #1005) - Moved ancillary files to
extras/
(issue #1011)
- Added fallback implementations of
strlen_P()
,strncmp_P()
,strcmp_P()
, andmemcpy_P()
(issue #1073)
- Added
measureJson()
to theArduinoJson
namespace (PR #1069 by @nomis) - Added support for
basic_string<char, traits, allocator>
(issue #1045) - Fixed example
JsonConfigFile.ino
for ESP8266 - Include
Arduino.h
ifARDUINO
is defined (PR #1071 by @nomis)
- Added operators
==
and!=
forJsonDocument
,ElementProxy
, andMemberProxy
- Fixed comparison of
JsonVariant
when one contains a linked string and the other contains an owned string (issue #1051)
- Fixed assignment of
JsonDocument
toJsonVariant
(issue #1023) - Fix invalid conversion error on Particle Argon (issue #1035)
- Fixed
serialized()
not working with Flash strings (issue #1030)
- Fixed
deserializeJson()
silently accepting aStream*
(issue #978) - Fixed invalid result from
operator|
(issue #981) - Made
deserializeJson()
more picky about trailing characters (issue #980) - Added
ARDUINOJSON_ENABLE_NAN
(default=0) to enable NaN in JSON (issue #973) - Added
ARDUINOJSON_ENABLE_INFINITY
(default=0) to enable Infinity in JSON - Removed implicit conversion in comparison operators (issue #998)
- Added lexicographical comparison for
JsonVariant
- Added support for
nullptr
(issue #998)
The JSON specification allows neither NaN not Infinity, but previous versions of ArduinoJson supported it. Now, ArduinoJson behaves like most other libraries: a NaN or and Infinity in the
JsonDocument
, becomes anull
in the output JSON. Also,deserializeJson()
returnsInvalidInput
if the JSON document contains NaN or Infinity.This version still supports NaN and Infinity in JSON documents, but it's disabled by default to be compatible with other JSON parsers. If you need the old behavior back, define
ARDUINOJSON_ENABLE_NAN
andARDUINOJSON_ENABLE_INFINITY
to1
;:#define ARDUINOJSON_ENABLE_NAN 1 #define ARDUINOJSON_ENABLE_INFINITY 1 #include <ArduinoJson.h>This version slightly changes the behavior of the | operator when the variant contains a float and the user requests an integer.
Older versions returned the floating point value truncated. Now, it returns the default value.
// suppose variant contains 1.2 int value = variant | 3; // old behavior: value == 1 // new behavior value == 3If you need the old behavior, you must add
if (variant.is<float>())
.
- Fixed error "attributes are not allowed on a function-definition"
- Fixed
deserializeJson()
not being picky enough (issue #969) - Fixed error "no matching function for call to write(uint8_t)" (issue #972)
- Fixed an integer overflow in the JSON deserializer
- Added overflow handling in
JsonVariant::as<T>()
andJsonVariant::is<T>()
.as<T>()
returns0
if the integerT
overflowsis<T>()
returnsfalse
if the integerT
overflows
- Added
BasicJsonDocument
to support custom allocator (issue #876) - Added
JsonDocument::containsKey()
(issue #938) - Added
JsonVariant::containsKey()
- Fixed warning "unused variable" with GCC 4.4 (issue #912)
- Fixed warning "cast increases required alignment" (issue #914)
- Fixed warning "conversion may alter value" (issue #914)
- Fixed naming conflict with "CAPACITY" (issue #839)
- Muted warning "will change in GCC 7.1" (issue #914)
- Added a clear error message for
StaticJsonBuffer
andDynamicJsonBuffer
- Marked ArduinoJson.h as a "system header"
- Decode escaped Unicode characters like \u00DE (issue #304, PR #791) Many thanks to Daniel Schulte (aka @trilader) who implemented this feature.
- Added option ARDUINOJSON_DECODE_UNICODE to enable it
- Converted
JsonArray::copyFrom()/copyTo()
to free functionscopyArray()
- Renamed
JsonArray::copyFrom()
andJsonObject::copyFrom()
toset()
- Renamed
JsonArray::get()
togetElement()
- Renamed
JsonArray::add()
(without arg) toaddElement()
- Renamed
JsonObject::get()
togetMember()
- Renamed
JsonObject::getOrCreate()
togetOrAddMember()
- Fixed
JsonVariant::isNull()
not returningtrue
afterset((char*)0)
- Fixed segfault after
variant.set(serialized((char*)0))
- Detect
IncompleteInput
infalse
,true
, andnull
- Added
JsonDocument::size()
- Added
JsonDocument::remove()
- Added
JsonVariant::clear()
- Added
JsonVariant::remove()
- Import functions in the ArduinoJson namespace to get clearer errors
- Improved syntax highlighting in Arduino IDE
- Removed default capacity of
DynamicJsonDocument
JsonArray::copyFrom()
acceptsJsonArrayConst
JsonVariant::set()
acceptsJsonArrayConst
andJsonObjectConst
JsonDocument
was missing in the ArduinoJson namespace- Added
memoryUsage()
toJsonArray
,JsonObject
, andJsonVariant
- Added
nesting()
toJsonArray
,JsonDocument
,JsonObject
, andJsonVariant
- Replaced
JsonDocument::nestingLimit
with an additional parameter todeserializeJson()
anddeserializeMsgPack()
- Fixed uninitialized variant in
JsonDocument
- Fixed
StaticJsonDocument
copy constructor and copy assignment - The copy constructor of
DynamicJsonDocument
chooses the capacity according to the memory usage of the source, not from the capacity of the source. - Added the ability to create/assign a
StaticJsonDocument
/DynamicJsonDocument
from aJsonArray
/JsonObject
/JsonVariant
- Added
JsonDocument::isNull()
- Added
JsonDocument::operator[]
- Added
ARDUINOJSON_TAB
to configure the indentation character - Reduced the size of the pretty JSON serializer
- Added
add()
,createNestedArray()
andcreateNestedObject()
toJsonVariant
JsonVariant
automatically promotes toJsonObject
orJsonArray
on write. CallingJsonVariant::to<T>()
is not required anymore.JsonDocument
now support the same operations asJsonVariant
. CallingJsonDocument::as<T>()
is not required anymore.- Fixed example
JsonHttpClient.ino
- User can now use a
JsonString
as a key or a value
The parameter to the constructor of
DynamicJsonDocument
is now mandatoryOld code:
DynamicJsonDocument doc;New code:
DynamicJsonDocument doc(1024);
JsonDocument::nestingLimit
was replaced with a new parameter todeserializeJson()
anddeserializeMsgPack()
.Old code:
doc.nestingLimit = 15; deserializeJson(doc, input);New code:
deserializeJson(doc, input, DeserializationOption::NestingLimit(15));
- Removed the automatic expansion of
DynamicJsonDocument
, it now has a fixed capacity. - Restored the monotonic allocator because the code was getting too big
- Reduced the memory usage
- Reduced the code size
- Renamed
JsonKey
toJsonString
- Removed spurious files in the Particle library
- Removed
JsonArray::is<T>(i)
andJsonArray::set(i,v)
- Removed
JsonObject::is<T>(k)
andJsonObject::set(k,v)
- Replaced
T JsonArray::get<T>(i)
withJsonVariant JsonArray::get(i)
- Replaced
T JsonObject::get<T>(k)
withJsonVariant JsonObject::get(k)
- Added
JSON_STRING_SIZE()
Replacing or removing a value now releases the memory- Added
DeserializationError::code()
to be used in switch statements (issue #846)
- Added implicit conversion from
JsonArray
andJsonObject
toJsonVariant
- Allow mixed configuration in compilation units (issue #809)
- Fixed object keys not being duplicated
JsonPair::key()
now returns aJsonKey
- Increased the default capacity of
DynamicJsonDocument
- Fixed
JsonVariant::is<String>()
(closes #763) - Added
JsonArrayConst
,JsonObjectConst
, andJsonVariantConst
- Added copy-constructor and copy-assignment-operator for
JsonDocument
(issue #827)
- Copy
JsonArray
andJsonObject
, instead of storing pointers (issue #780) - Added
JsonVariant::to<JsonArray>()
andJsonVariant::to<JsonObject>()
- Implemented reference semantics for
JsonVariant
- Replaced
JsonPair
'skey
andvalue
withkey()
andvalue()
- Fixed
serializeJson(obj[key], dst)
(issue #794)
JsonVariant
now has a semantic similar toJsonObject
andJsonArray
. It's a reference to a value stored in theJsonDocument
. As a consequence, aJsonVariant
cannot be used as a standalone variable anymore.Old code:
JsonVariant myValue = 42;
New code:
DynamicJsonDocument doc; JsonVariant myValue = doc.to<JsonVariant>(); myValue.set(42);
Old code:
for(JsonPair p : myObject) { Serial.println(p.key); Serial.println(p.value.as<int>()); }New code:
for(JsonPair p : myObject) { Serial.println(p.key()); Serial.println(p.value().as<int>()); }CAUTION: the key is now read only!
- Fixed exception when using Flash strings as object keys (issue #784)
- Fixed
invalid application of 'sizeof' to incomplete type '__FlashStringHelper'
(issue #783) - Fixed
char[]
not duplicated when passed toJsonVariant::operator[]
- Fixed
JsonObject
not inserting keys of typeString
(issue #782)
- Disabled lazy number deserialization (issue #772)
- Fixed
JsonVariant::is<int>()
that returned true for empty strings - Improved float serialization when
-fsingle-precision-constant
is used - Renamed function
RawJson()
toserialized()
serializeMsgPack()
now supports values marked withserialized()
Non quoted strings are now forbidden in values, but they are still allowed in keys. For example,
{key:"value"}
is accepted, but{key:value}
is not.Old code:
object["values"] = RawJson("[1,2,3,4]");New code:
object["values"] = serialized("[1,2,3,4]");
- Return
JsonArray
andJsonObject
by value instead of reference (issue #309) - Replaced
success()
withisNull()
Old code:
JsonObject& obj = doc.to<JsonObject>(); JsonArray& arr = obj.createNestedArray("key"); if (!arr.success()) { Serial.println("Not enough memory"); return; }New code:
JsonObject obj = doc.to<JsonObject>(); JsonArray arr = obj.createNestedArray("key"); if (arr.isNull()) { Serial.println("Not enough memory"); return; }
- Fixed conflicts with
isnan()
andisinf()
macros (issue #752)
- Added
DynamicJsonDocument
andStaticJsonDocument
- Added
deserializeJson()
- Added
serializeJson()
andserializeJsonPretty()
- Added
measureJson()
andmeasureJsonPretty()
- Added
serializeMsgPack()
,deserializeMsgPack()
andmeasureMsgPack()
(issue #358) - Added example
MsgPackParser.ino
(issue #358) - Added support for non zero-terminated strings (issue #704)
- Removed
JsonBuffer::parseArray()
,parseObject()
andparse()
- Removed
JsonBuffer::createArray()
andcreateObject()
- Removed
printTo()
andprettyPrintTo()
- Removed
measureLength()
andmeasurePrettyLength()
- Removed all deprecated features
Old code:
DynamicJsonBuffer jb; JsonObject& obj = jb.parseObject(json); if (obj.success()) { }
New code:
DynamicJsonDocument doc; DeserializationError error = deserializeJson(doc, json); if (error) { } JsonObject& obj = doc.as<JsonObject>();
Old code:
DynamicJsonBuffer jb; JsonObject& obj = jb.createObject(); obj["key"] = "value"; obj.printTo(Serial);New code:
DynamicJsonDocument obj; JsonObject& obj = doc.to<JsonObject>(); obj["key"] = "value"; serializeJson(doc, Serial);