https://github.com/robtillaart/xmlwriter
Arduino Library to create simple XML (messages, files, print, ...)
https://github.com/robtillaart/xmlwriter
arduino writer xml
Last synced: 2 months ago
JSON representation
Arduino Library to create simple XML (messages, files, print, ...)
- Host: GitHub
- URL: https://github.com/robtillaart/xmlwriter
- Owner: RobTillaart
- License: mit
- Created: 2020-04-25T14:40:56.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T09:15:02.000Z (over 1 year ago)
- Last Synced: 2024-08-07T18:27:15.624Z (11 months ago)
- Topics: arduino, writer, xml
- Language: C++
- Homepage:
- Size: 65.4 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/marketplace/actions/arduino_ci)
[](https://github.com/RobTillaart/XMLWriter/actions/workflows/arduino-lint.yml)
[](https://github.com/RobTillaart/XMLWriter/actions/workflows/jsoncheck.yml)
[](https://github.com/RobTillaart/XMLWriter/issues)
[](https://github.com/RobTillaart/XMLWriter/blob/master/LICENSE)
[](https://github.com/RobTillaart/XMLWriter/releases)
[](https://registry.platformio.org/libraries/robtillaart/XMLWriter)
# XMLWriter
Arduino Library to create simple XML (messages, files, print, ...).
## Description
The XMLWriter class supports generating XML files and send these over a stream
like Ethernet SD.File or Serial.
When instantiating an XMLWriter one can define the internal buffer size.
A bigger buffer will make the output faster, especially for Ethernet and SD.File.
The buffer size should be at least 2 bytes and max 250.
How much faster depends on the properties of the stream and the platform used.
E.g. the baud rate and internal buffer of Serial, packet behaviour of Ethernet,
or paging of SD cards.
If performance is low one should do test runs with different sizes for the buffer
and choose one that is appropriate.
Indicative sizes based upon the examples.
Run your tests to find your application optimum.
| STREAM | SIZE |
|:-----------|:-----------|
| Ethernet | 20-30 |
| Serial | 5 |
| SD File | 10-16 |
**IMPORTANT:** When using buffering you should always call **XML.flush()**
at the end of the XML generation. This will flush the last bytes in the internal buffer into the output stream.
As always, feedback or improvements are welcome.
Please open an issue.
### Related
- https://github.com/RobTillaart/printHelpers Formatting incl scientific notation (large floats)
- https://github.com/RobTillaart/PrintString Make a string representation
- https://github.com/RobTillaart/MultiPlex send stream to multiple destinations (e.g. File and Screen)
## Interface
```cpp
#include "XMLWriter.h"
```
### Constructor
- **XMLWriter(Print\* stream = &Serial, uint8_t bufferSize = 10)** Constructor defines
the stream and the buffer size to optimize performance vs memory usage.
Note the default bufferSize of 10 can be optimized.
See table in description above.
- **~XMLWriter()** destructor
### Functions for manual layout control
- **void setIndentSize(uint8_t size = 2)** preferred a multiple of 2; no limit.
For compact XML with no indents set size to zero.
- **uint8_t getIndentSize()** returns set indent size.
- **void incrIndent()** increments indent by defined spaces (default 2).
- **void decrIndent()** decrements indent by defined spaces (default 2).
- **void indent()** manually indent output.
- **void raw(char\* str)** inject any string into XML, use with care!
### General settings
- **void setConfig(uint8_t config)** used to show/strip comment, indent, newLine.
To minimize the output, use **setConfig(0);**, see table below.
- **void newLine(uint8_t n = 1)** add a number of newlines to the output, default = 1.
#### Configuration flags
| setConfig flags | Value | Notes |
|:---------------------------|:-------:|:--------|
| XMLWRITER_NONE | 0x00 | minimizes the output size, smaller and faster.
| XMLWRITER_COMMENT | 0x01 | enable comments
| XMLWRITER_INDENT | 0x02 | enable indents
| XMLWRITER_NEWLINE | 0x04 | enable newlines
| XMLWRITER_CONFIG_DEFAULT | 0x07 | enable all, default after reset()
```cpp
setConfig(XMLWRITER_NONE); // minimize the output in bytes.
setConfig(XMLWRITER_NEWLINE); // "break up" an XML stream in logic lines.
setConfig(XMLWRITER_NEWLINE | XMLWRITER_INDENT); // show XML structure. (pretty print)
setConfig(XMLWRITER_NEWLINE | XMLWRITER_INDENT | XMLWRITER_COMMENT); // show XML structure + comments.
setConfig(XMLWRITER_CONFIG_DEFAULT); // show XML structure + comments.
```
### Functions
- **void header()** injects standard XML header string, must be first line.
- **void reset()** resets internal state, to be called before new XML is written.
- **void comment(char\* text, bool multiLine = false)** \