Skip to content

API Reference

oveRTOS exposes its public API through a set of C headers, a C++20 wrapper layer, a Rust crate, and Zig bindings. This page maps each module to its header and gives a function count so you know where to look.

Language references

Module map

Including ove/ove.h pulls in every subsystem listed below. Individual headers can be included separately when only a subset of the API is needed.

Module Header Functions Description
Types ove/types.h — Common error codes, opaque handle typedefs, and OVE_WAIT_FOREVER
App ove/app.h 4 Application entry (ove_main), scheduler start (ove_run), platform bootstrap (ove_app_run), and zero-heap allocation lock (ove_heap_lock).
Thread ove/thread.h 16 Thread lifecycle, sleep, yield, suspend/resume, state query, stack usage, runtime stats, thread enumeration, plus ove_sys_get_mem_stats. Guide
Sync ove/sync.h 31 Mutex, recursive mutex, semaphore, binary event, condition variable. Guide
Queue ove/queue.h 8 Fixed-size item FIFO with ISR-safe variants. Guide
Containers (per-binding) — General-purpose fixed-capacity vectors, strings, and hashmaps for C++ (ETL), Rust (heapless), and Zig (hybrid). Guide
Timer ove/timer.h 7 Periodic and one-shot software timers. Guide
EventGroup ove/eventgroup.h 9 Multi-bit event flags with ISR-safe set. Guide
WorkQueue ove/workqueue.h 9 Deferred work on a dedicated thread. Guide
Stream ove/stream.h 10 Byte-stream ring buffer with trigger threshold. Guide
Audio ove/audio.h ove/audio_node.h ove/audio_device.h 19 Graph-based audio engine with pluggable nodes and transports (13 graph + 4 built-in nodes + 2 device factories). Guide
FS ove/fs.h 18 VFS layer: mount, file I/O, directory enumeration, unlink, rename. Guide
Console ove/console.h 4 Serial I/O: init, getchar, putchar, write. Guide
Time ove/time.h 4 Monotonic clock: get microseconds, get nanoseconds, delay milliseconds, delay microseconds.
Board ove/board.h 3 Board lifecycle: init, name query, descriptor.
GPIO ove/gpio.h 6 Pin configure, set, get, interrupt register/enable/disable. Guide
LED ove/led.h 3 On-board LEDs: set, toggle, count. Guide
NVS ove/nvs.h 5 Non-volatile key-value store. Guide
Watchdog ove/watchdog.h 7 Hardware watchdog with feed timeout. Guide
Shell ove/shell.h 5 Interactive CLI: init, register command, process character/line, install output hook. Guide
Infer ove/infer.h 8 ML inference engine for TFLite Micro models. Guide
Net ove/net.h 21 BSD-like sockets, network interface, DNS resolution. Guide
Net HTTP ove/net_http.h 9 HTTP/1.1 client (GET/POST/PUT/DELETE/PATCH). Guide
Net TLS ove/net_tls.h 8 TLS sessions over TCP (mbedTLS). Guide
Net MQTT ove/net_mqtt.h 10 MQTT 3.1.1 client with QoS 0/1. Guide
Net HTTPD ove/net_httpd.h 26 Embedded HTTP server with routing, WebSocket, built-in dashboard, and gzip response support. Guide
Net SNTP ove/net_sntp.h 3 Simple NTP time sync (sync, get_utc, get_offset_us). Guide
PM ove/pm.h 18 Power management: sleep states, wake sources, power domains, statistics. Guide
UART ove/uart.h 9 UART serial bus driver with interrupt RX buffering and thread-safe TX. Guide
SPI ove/spi.h 8 SPI master driver with configurable clock/mode and GPIO chip-select. Guide
I2C ove/i2c.h 10 I2C master driver with probe and register-level convenience APIs. Guide
I2S ove/i2s.h 15 I2S / SAI audio bus driver with DMA double-buffered streaming. Guide
Profiler ove/profiler.h — Statistical PC sampling profiler with symbol export, drained by the sim and trace tooling.
Trace ove/trace.h — Lightweight state/event trace points consumed by the sim trace viewer.
Log ove/log.h — Compile-time filtered macros: OVE_LOG_ERR, OVE_LOG_WRN, OVE_LOG_INF, OVE_LOG_DBG, and OVE_LOG.
LVGL ove/lvgl.h — Unified LVGL include: abstraction API (lvgl_internal.h) plus upstream LVGL library headers.
LVGL Internal ove/lvgl_internal.h — Internal LVGL display integration hooks (lock/unlock/tick/handler/init).
Storage ove/storage.h — Backend-specific opaque storage types (ove_*_storage_t) and OVE_*_DEFINE_STATIC() macros for every subsystem.
BSP ove/bsp.h — Legacy BSP compatibility shim for older board support packages.

Allocation strategies

oveRTOS exposes two distinct allocation APIs, sharing the same _init() foundation:

  • Heap mode (default) — _create() / _destroy() allocate and free from the RTOS heap. These declarations are gated behind OVE_HEAP_* macros and are unavailable when CONFIG_OVE_ZERO_HEAP=y.
  • Zero-heap mode (CONFIG_OVE_ZERO_HEAP=y) — _create() / _destroy() are not declared. Apps use _init() / _deinit() with caller-supplied storage, or OVE_*_DEFINE_STATIC() for file-scope objects. Calling a _create() symbol in a zero-heap build is a link error.

_init() / _deinit() work in both modes and are the right choice for objects living in arrays, loops, or structs where the caller decides storage placement.

The OVE_*_DEFINE_STATIC() macros (e.g. OVE_QUEUE_DEFINE_STATIC, OVE_THREAD_DEFINE_STATIC) declare a static storage object plus a handle, and register a constructor that calls _init() before main(). They expand to the same code in both modes, so file-scope objects compile portably across the heap/zero-heap split. Size parameters (item_size, max_items, stream size, stack size) must be compile-time constants.

Error codes

All functions that can fail return int. A return value of OVE_OK (0) indicates success; negative values are errors:

Constant Value Meaning
OVE_OK 0 Success
OVE_ERR_NOT_REGISTERED -1 Backend not registered
OVE_ERR_INVALID_PARAM -2 Invalid argument
OVE_ERR_NO_MEMORY -3 Heap exhausted or unavailable
OVE_ERR_TIMEOUT -4 Deadline expired
OVE_ERR_NOT_SUPPORTED -5 Feature not supported by backend
OVE_ERR_QUEUE_FULL -6 Queue at maximum capacity
OVE_ERR_ML_FAILED -7 ML inference or model loading failed
OVE_ERR_NET_REFUSED -8 Connection refused by remote host
OVE_ERR_NET_UNREACHABLE -9 Network or host unreachable
OVE_ERR_NET_ADDR_IN_USE -10 Local address already bound
OVE_ERR_NET_RESET -11 Connection reset by peer
OVE_ERR_NET_DNS_FAIL -12 DNS name resolution failed
OVE_ERR_NET_CLOSED -13 Connection closed by peer
OVE_ERR_BUS_NACK -14 Bus device did not acknowledge (I2C NACK)
OVE_ERR_BUS_BUSY -15 Bus arbitration lost (multi-master)
OVE_ERR_BUS_ERROR -16 Framing, parity, or hardware error on a serial bus