Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bakercp/bufferutils
An Arduino library to facilitate working with raw byte arrays.
https://github.com/bakercp/bufferutils
arduino buffers bytes c-plus-plus communication
Last synced: 3 months ago
JSON representation
An Arduino library to facilitate working with raw byte arrays.
- Host: GitHub
- URL: https://github.com/bakercp/bufferutils
- Owner: bakercp
- License: mit
- Created: 2014-07-06T05:17:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-22T00:53:00.000Z (about 7 years ago)
- Last Synced: 2024-10-11T00:28:20.432Z (3 months ago)
- Topics: arduino, buffers, bytes, c-plus-plus, communication
- Language: C++
- Size: 188 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
BufferUtils
===========
[](https://travis-ci.org/bakercp/BufferUtils)
## Description
An Arduino library to facilitate working with raw byte arrays.
## Features
- Javascript `DataView` style byte buffer access for reading (`BufferReader`) and writing (`BufferWriter`).
- A `Print` interface for a raw byte buffer via `BufferPrinter`
- A circular buffer (aka ring buffer or cyclic buffer) implementation for data arrays of any type in `CircularBuffer`.
## Background
When working with memory constrained systems, low-level communication protocols and other specialized code, it is very useful to be able to reduce everything down to an array of bytes, (aka byte buffers). Just about all quantitative data can be interpreted as arrays of bytes and this library will help you do that without too much complex C/C++ syntax.
## Use
### BufferReader
Say you have an array of bytes representing a communication packet with the form
```
PACKET TYPE uint16_t
PACKET LENGTH uint32_t
PACKET DATA variable array of uint8_t
CRC32 CHECKSUM uint32_t
```
One could read this data from the buffer like so:
```c++
uint8_t rawData[128] = { 0x00, 0x01, ..., 0x22 };
uint16_t packetType;
uint32_t packetLength;
uint8_t data[256];
uint32_t checksum;
BufferReader reader(rawData, 128);
// Fill packetType with the correct value.
reader.read(packetType);
// Fill packet length with the correct value.
reader.read(packetLength);
// Fill the data with the correct data using the variable packet length.
reader.read(data, packetLength);
// Fill the checksum.
reader.read(checksum);
```
The `BufferReader` keeps track of the current read position based on the sizes of the data types read. Each `read` operation returns the number of bytes read, or zero if there is a read error (e.g. running out of buffer to read). Note the above example doesn't have any error checking.
### BufferWriter
Similarly, if we want to write a packet like that described above we might do the following:
```c++
uint8_t sendBuffer[128];
uint16_t packetType = 13;
uint32_t packetLength = 11;
uint8_t data[11] = { 'H', 'e', 'l', 'l', 'o', ' ', 'W', 'o', 'r', 'l', 'd' };
uint32_t checksum = 0x4A17B156;
BufferWriter writer(sendBuffer, 128);
// Write the packetType to the send buffer.
writer.write(packetType);
// Write the packetLength to the send buffer.
writer.write(packetLength);
// Write the data to the send buffer.
reader.read(data, packetLength);
// Write the checksum.
reader.read(checksum);
// Send the data that was written to the buffer.
Serial.write(sendBuffer, reader.getOffset());
```
### BufferPrinter
`BufferPrinter` is much like `BufferWriter` but implements the Arduino `Print` interface.
```c++
uint8_t bufferToFill[128];
BufferPrinter printer(bufferToFill, 128);
// Write the packetType to the send buffer.
printer.println("Hello there.");
// All Print commands are available.
printer.print(".");
// Print commands including ASCII translations.
printer.print(99, HEX);
// Send the data that was written to the buffer.
Serial.write(bufferToFill, printer.getOffset());
```
### CircularBuffer
See the `CircularBuffer` example.
## Examples
See the included examples and tests for further usage examples.
## Changelog
See [CHANGELOG.md](CHANGELOG.md)
## License
See [LICENSE.md](LICENSE.md)