API Reference

This is the detailed documentation of every class and function of the ArduinoJson library. Some parts have been simplified to be easier to understand, so if you look at the source code, you might see some differences.

Main classes

JsonArray

A reference to a JSON array in a JsonDocument

JsonObject

A reference to a JSON object in a JsonDocument

JsonVariant

A reference to a JSON value (array, object, integer…) in a JsonDocument

JsonDocument

Owns the memory for JsonArray, JsonObject and JsonVariant

JSON serialization / deserialization

deserializeJson()

Deserialize a JSON document into a JsonDocument.

serializeJson()

Serializes a JsonDocument into a minified JSON document

serializeJsonPretty()

Serializes a JsonDocument into a prettyfied JSON document

measureJson()

Computes the size of the document that serializeJson() produces

measureJsonPretty()

Computes the size of the document that serializeJsonPretty() produces

MessagePack serialization / deserialization

deserializeMsgPack()

Deserialize a MessagePack document into a JsonDocument

serializeMsgPack()

Serializes a JsonDocument into a MessagePack document

measureMsgPack()

Computes the size of the document that serializeMsgPack() produces

MsgPackBinary 🆕

Allows you to read or write MessagePack binary data

MsgPackExtension 🆕

Allows you to read or write MessagePack extension data

Misc

ARDUINOJSON_VERSION

Tells which version of ArduinoJson is installed

copyArray()

Copies values between a JsonArray and a regular array.

JsonString

The string type returned by some functions.

serialized()

Allows inserting preformatted pieces of JSON or MsgPack in a document