renamed project files

Author: tobozo

ReadMe.md

@@ -1,21 +1,23 @@
-# esp32-yaml
+# ArduinoYaml
 
 This library is based on [libyaml](https://github.com/yaml/libyaml).
 It provides two ways to convert YAML strings to JSON (cJSON or ArduinoJson) objects.
 
-Fun fact: the yml parser from libyaml can also deserialize JSON.
+Supported platforms (some untested):
 
-Although there's obviously no use to have a JSON to JSON converter, it can offer a single endpoint for both types of inputs.
+- esp32
+- esp8266
+- samd
+- rp2040
 
-e.g. Provide either JSON or YML as input string, libyml understands both and will treat them as equal.
 
 ### Usage
 
 #### cJSON
 
 ```cpp
-#include <cJSON.h> // built-in with esp32
-#include <esp32-yaml.hpp>
+#include <cJSON.h> // note: cJSON is built-in with esp32
+#include <ArduinoYaml.h>
 
   // cJSON object to YAML string
   size_t serializeYml( cJSON* src_obj, String &dest_string );
@@ -36,7 +38,7 @@ e.g. Provide either JSON or YML as input string, libyml understands both and wil
 ```cpp
 
 #include <ArduinoJson.h>
-#include <esp32-yaml.hpp>
+#include <ArduinoYaml.h>
 
   // ArduinoJSON object to YAML string
   size_t serializeYml( JsonVariant src_obj, String &dest_string );
@@ -48,6 +50,10 @@ e.g. Provide either JSON or YML as input string, libyml understands both and wil
   DeserializationError deserializeYml( JsonObject &dest_obj, const char* src_yaml_str );
   // Deserialize YAML stream to ArduinoJSON object
   DeserializationError deserializeYml( JsonObject &dest_obj, Stream &src_stream );
+  // Deserialize YAML string to ArduinoJSON document
+  DeserializationError deserializeYml( JsonDocument &dest_doc, Stream &src_stream );
+  // Deserialize YAML string to ArduinoJSON document
+  DeserializationError deserializeYml( JsonDocument &dest_doc, const char *src_yaml_str) ;
 
 ```
 

examples/test/test.ino

@@ -1,6 +1,6 @@
 #include <ArduinoJson.h> // optional
 //#include <cJSON.h>       // implicit with esp32, otherwise optional
-#include <esp32-yaml.hpp>
+#include <ArduinoYaml.h>
 
 
 // sorry about the notation, but it looks nicer than chunk-splitting+quoting
@@ -83,28 +83,29 @@ void setup()
     YAML_LOG_n("YAML=>JSON and JSON=>YAML using ArduinoJson\n\n");
 
     {
-      YAML_LOG_n( "[TEST #%d] YAML stream to JsonObject -> deserializeYml(json_obj, yaml_stream):", test_number++ );
-      JsonObject json_obj;
+      YAML_LOG_n( "[TEST #%d] YAML stream to JsonObject -> deserializeYml(json_doc, yaml_stream):", test_number++ );
+      DynamicJsonDocument json_doc(yaml_str_size*2);
       String yaml_str = String( yaml_example_str );
       StringStream yaml_stream( yaml_str );
-      auto err = deserializeYml( json_obj, yaml_stream ); // deserialize yaml stream to JsonObject
+      auto err = deserializeYml( json_doc, yaml_stream ); // deserialize yaml stream to JsonDocument
       if( err ) {
         YAML_LOG_n("Unable to deserialize demo YAML to JsonObject: %s", err.c_str() );
         return;
       }
-      const size_t bytes_out = serializeJsonPretty( json_obj, Serial ); // print deserialized JsonObject
+      const size_t bytes_out = serializeJsonPretty( json_doc, Serial ); // print deserialized JsonObject
       YAML_LOG_n("[YAML=>JsonObject] yaml bytes in=%d, json bytes out=%d\n\n", yaml_str_size, bytes_out);
     }
 
 
     {
-      YAML_LOG_n( "[TEST #%d] YAML string to JsonObject -> deserializeYml(json_obj, yaml_example_str):", test_number++ );
-      JsonObject json_obj;
-      auto err = deserializeYml( json_obj, yaml_example_str ); // deserialize yaml string to JsonObject
+      YAML_LOG_n( "[TEST #%d] YAML string to JsonObject -> deserializeYml(json_doc, yaml_example_str):", test_number++ );
+      DynamicJsonDocument json_doc(yaml_str_size*2);
+      auto err = deserializeYml( json_doc, yaml_example_str ); // deserialize yaml string to JsonDocument
       if( err ) {
         YAML_LOG_n("Unable to deserialize demo YAML to JsonObject: %s", err.c_str() );
         return;
       }
+      JsonObject json_obj = json_doc.as<JsonObject>();
       const size_t bytes_out = serializeJsonPretty( json_obj, Serial ); // print deserialized JsonObject
       YAML_LOG_n("[YAML=>JsonObject] yaml bytes in=%d, json bytes out=%d\n\n", yaml_str_size, bytes_out);
     }
@@ -151,13 +152,15 @@ void setup()
     }
 
 
+    #if defined USE_STREAM_TO_STREAM // stream to stream unavailable on esp8266 (not enough memory)
     {
       YAML_LOG_n( "[TEST #%d] JSON stream to JsonObject to YAML stream -> serializeYml(stream_in, Serial):", test_number++ );
       String str_json = String( json_example_str );
       StringStream stream_in( str_json );
       const size_t bytes_out = serializeYml( stream_in, Serial );
       YAML_LOG_n("[JSON=>JsonObject=>YAML] json bytes in=%d, yaml bytes out=%d\n", json_str_size, bytes_out);
     }
+    #endif
 
 
     YAML_LOG_n("ArduinoJson tests complete");