Repository files navigation

This library implements a first in, first outcircular buffer, methods are provided for writing to and reading from the buffer. This library is compatible with Arduino and with CMake build systems.

• License
• Changelog
• Contributing guide

Use the Arduino Library Manager to install this library or clone to your Arduino/libraries folder. The library is added as:

#include"circle_buf.h"

An example Arduino executable is located atexamples/arduino/circle_buf_example/circle_buf_example.ino. Teensy 3.x, 4.x, and LC devices are used for testing under Arduino and this library should be compatible with other devices.

CMake is used to build this library, which is exported as a library target calledcircle_buf. The header is added as:

#include"circle_buf.h"

The library can be also be compiled stand-alone using the CMake idiom of creating abuild directory and then, from within that directory issuing:

cmake ..make

This will build the library, an example executable calledcircle_buf_example, and an executable for testing using the Google Test framework, calledcircle_buf_test. The example executable source file is located atexamples/cmake/circle_buf_example.cc.

This library is within the namespacebfs

This class implements the circular buffer.

CircleBuf<typename T, std::size_t N> Creates a circular buffer object, of typeT with buffer sizeN.

/* Create a 10 byte circular buffer of uint8_t*/bfs::CircleBuf<uint8_t,10> buff;

bool Write(const T val) Writes a single value to the buffer. Note the buffer prevents over-writing data. This method returns true on success or false on failure.

bool status = buff.Write(3);

std::size_t Write(T const * const data, const std::size_t len) Writes data into the buffer given a pointer to the data and the number of elements to write. Returns the number of elements written into the buffer. Note that the buffer prevents over-writing data, so the number of elements written may be less than the number of elements to write.

uint8_t test[] = {1,2,3,4,5};std::size_t ret = buff.Write(test,sizeof(test));

bool Read(T * const data) Reads a single value from the buffer given a pointer to store the data. True is returned if a value is returned through the pointer. A value would not be returned if the buffer is empty (i.e size = 0).

uint8_t val;bool ret = buff.Read(&val);if (ret) {   std::cout <<std::to_string(val) << std::endl;}

std::size_t Read(T * const data, std::size_t len) Reads elements from the buffer given a pointer to store the data and the maximum number of elements to read. Returns the number of elements read off the buffer.

uint8_t read_val[20];std::size_t ret = buff.Read(read_val,sizeof(read_val));

std::size_t capacity() Returns the capacity of the circular buffer. This will always be equal toN used during construction.

std::cout << buff.capacity() << std::endl;

std::size_t size() Returns the number of elements currently stored in the buffer.

std::cout << buff.size() << std::endl;

void Clear() Empties the buffer.

buff.Clear();