From 322d13de0d9e42862321af458a7438c0e7aa15a2 Mon Sep 17 00:00:00 2001 From: Benoit Blanchon Date: Mon, 25 Jan 2021 09:26:29 +0100 Subject: [PATCH] Examples: add a note about performance issues with streams (#1476) --- examples/JsonConfigFile/JsonConfigFile.ino | 6 ++++++ examples/JsonHttpClient/JsonHttpClient.ino | 6 ++++++ examples/JsonServer/JsonServer.ino | 9 ++++++++- examples/JsonUdpBeacon/JsonUdpBeacon.ino | 6 ++++++ 4 files changed, 26 insertions(+), 1 deletion(-) diff --git a/examples/JsonConfigFile/JsonConfigFile.ino b/examples/JsonConfigFile/JsonConfigFile.ino index 74d4ee97..1c056a09 100644 --- a/examples/JsonConfigFile/JsonConfigFile.ino +++ b/examples/JsonConfigFile/JsonConfigFile.ino @@ -140,6 +140,12 @@ void loop() { // not used in this example } +// Performance issue? +// ------------------ +// +// File is an unbuffered stream, which is not optimal for ArduinoJson. +// See: https://arduinojson.org/v6/how-to/improve-speed/ + // See also // -------- // diff --git a/examples/JsonHttpClient/JsonHttpClient.ino b/examples/JsonHttpClient/JsonHttpClient.ino index 12113f4d..b8c2d665 100644 --- a/examples/JsonHttpClient/JsonHttpClient.ino +++ b/examples/JsonHttpClient/JsonHttpClient.ino @@ -101,6 +101,12 @@ void loop() { // not used in this example } +// Performance issue? +// ------------------ +// +// EthernetClient is an unbuffered stream, which is not optimal for ArduinoJson. +// See: https://arduinojson.org/v6/how-to/improve-speed/ + // See also // -------- // diff --git a/examples/JsonServer/JsonServer.ino b/examples/JsonServer/JsonServer.ino index 5eab8ec7..56ecc9b3 100644 --- a/examples/JsonServer/JsonServer.ino +++ b/examples/JsonServer/JsonServer.ino @@ -46,7 +46,8 @@ void loop() { EthernetClient client = server.available(); // Do we have a client? - if (!client) return; + if (!client) + return; Serial.println(F("New client")); @@ -96,6 +97,12 @@ void loop() { client.stop(); } +// Performance issue? +// ------------------ +// +// EthernetClient is an unbuffered stream, which is not optimal for ArduinoJson. +// See: https://arduinojson.org/v6/how-to/improve-speed/ + // See also // -------- // diff --git a/examples/JsonUdpBeacon/JsonUdpBeacon.ino b/examples/JsonUdpBeacon/JsonUdpBeacon.ino index 225ddc4d..6beca600 100644 --- a/examples/JsonUdpBeacon/JsonUdpBeacon.ino +++ b/examples/JsonUdpBeacon/JsonUdpBeacon.ino @@ -86,6 +86,12 @@ void loop() { delay(10000); } +// Performance issue? +// ------------------ +// +// EthernetUDP is an unbuffered stream, which is not optimal for ArduinoJson. +// See: https://arduinojson.org/v6/how-to/improve-speed/ + // See also // -------- //