seam-lib

Reusable C++ primitives for SEAM ecosystem firmware.

Contents

• src/rtos/OwningQueue.h — FreeRTOS queue for heap-allocated objects
• src/rtos/ValueQueue.h — FreeRTOS queue for plain structs
• src/rtos/RingBuffer.h — FreeRTOS ring buffer for raw bytes

Requirements

• FreeRTOS
• C++23
• ESP32 Arduino core v3.x or equivalent

Running tests on Seeed XIAO ESP32-C6

arduino-cli may auto-detect the board as the hidden esp32:esp32:esp32_family target, which does not compile this test sketch correctly. Use the explicit XIAO ESP32-C6 FQBN instead:

make test BOARD=esp32:esp32:XIAO_ESP32C6 TEST_PORT=/dev/cu.usbmodem2101

Adjust TEST_PORT for your machine as needed.

Adding to a project

git submodule add https://github.com/tarasfilonenko/seam-lib lib/seam-lib
git add .gitmodules lib/seam-lib
git commit -m "chore: add seam-lib submodule"

Add the include path to your Makefile:

EXTRA_FLAGS = -I$(shell pwd)/lib/seam-lib/src

Cloning a project that uses seam-lib

git clone --recurse-submodules <repo-url>

# or if already cloned
git submodule update --init --recursive

Usage

#include "rtos/OwningQueue.h"
#include "rtos/ValueQueue.h"
#include "rtos/RingBuffer.h"

seam::rtos::OwningQueue<MyEvent> eventQueue(32);
seam::rtos::ValueQueue<MyStruct> valueQueue(16);
seam::rtos::RingBuffer           ringBuffer(4096);