api/cpp/ove_8hpp_source.html

/*

 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>

 *

 * SPDX-License-Identifier: GPL-3.0-or-later

 *

 * This file is part of oveRTOS.

 */


#pragma once


#include <ove/types.hpp>

#include <ove/error.hpp>

#include <ove/sync.hpp>

#include <ove/eventgroup.hpp>

#include <ove/queue.hpp>

#include <ove/timer.hpp>

#include <ove/thread.hpp>

#include <ove/console.hpp>

#include <ove/time.hpp>

#include <ove/nvs.hpp>

#include <ove/shell.hpp>

#include <ove/board.hpp>

#include <ove/gpio.hpp>

#include <ove/led.hpp>

#include <ove/bsp.hpp>

#include <ove/audio.hpp>

#include <ove/watchdog.hpp>

#include <ove/fs.hpp>

#include <ove/stream.hpp>

#include <ove/workqueue.hpp>

#include <ove/app.hpp>

#include <ove/net.hpp>

#include <ove/net_tls.hpp>

#include <ove/net_http.hpp>

#include <ove/net_mqtt.hpp>

#include <ove/net_httpd.hpp>

#include <ove/pm.hpp>


/* Zephyr's <zephyr/kernel_structs.h> defines `_current` and `_kernel`

 * as global object-like macros (`#define _current _kernel.cpus[0].current`).

 * Both leak into every TU that pulls in any Zephyr header (i.e. anything

 * including ove.hpp on Zephyr).  Third-party C++ libraries — notably

 * ETL's <etl/ranges.h>, used by lvgl_gallery_cpp — declare members

 * named `_current`, which the preprocessor then mangles into

 * `_kernel.cpus[0].current` before C++ parses, producing a torrent of

 * "expected unqualified-id" errors.

 *

 * Undef both AT THE END of the umbrella header.  oveRTOS's C++ bindings

 * never call into raw Zephyr scheduler internals from app code; the

 * affected macros are only used inside Zephyr's own static-inline

 * accessors, which have already been parsed by this point. */

#ifdef __ZEPHYR__

#undef _current

#undef _kernel

#endif

app.hpp
Application entry point macro and scheduler start.

audio.hpp
Audio graph engine C++ wrappers.

board.hpp
Board initialisation and identification functions.

bsp.hpp
Legacy BSP compatibility shim.

console.hpp
Console serial I/O functions.

error.hpp
Strong ove::Error type, Result<T> alias, and std::error_code interop for the oveRTOS C++ binding.

eventgroup.hpp
Multi-bit event group with RAII lifecycle.

fs.hpp
RAII file and directory handles with VFS operations.

gpio.hpp
GPIO pin configuration and control functions.

led.hpp
On-board LED control functions.

net.hpp
RAII networking: sockets, network interface, DNS.

net_http.hpp
RAII C++ wrappers for the oveRTOS HTTP client API.

net_httpd.hpp
C++ wrappers for the oveRTOS embedded HTTP server API.

net_mqtt.hpp
RAII C++ wrappers for the oveRTOS MQTT client API.

net_tls.hpp
RAII wrapper for TLS/SSL sessions (mbedTLS)

nvs.hpp
Non-volatile key-value storage functions.

pm.hpp
Power management framework — state machine, wake sources, peripheral domains, and runtime statistics.

queue.hpp
Type-safe, fixed-depth message queue with RAII lifecycle.

shell.hpp
Interactive shell command registration.

stream.hpp
Byte-stream ring buffer with RAII lifecycle.

sync.hpp
RAII wrappers for mutexes, semaphores, events, condition variables, and lock guards.

thread.hpp
Compile-time stack-sized thread with move semantics.

time.hpp
Monotonic clock queries and delay utilities.

timer.hpp
Software timer with RAII lifecycle.

types.hpp
Common type definitions and concepts for the C++ wrapper layer.

watchdog.hpp
Hardware watchdog timer with RAII lifecycle.

workqueue.hpp
Deferred work queue and work items with RAII lifecycle.