BNO08X Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces | Macros | Functions
bno08x_kconfig.hpp File Reference

Optional ESP-IDF layer: a Config and the buffer Limits built from CONFIG_BNO08X_* options. More...

#include "bno08x.hpp"

Go to the source code of this file.

Classes

struct  bno08x::KconfigLimits
 The buffer sizes menuconfig selected; pass it as the second template argument of Bno08x. More...
 

Namespaces

namespace  bno08x
 The BNO08x driver: everything it declares lives here; internals in detail.
 

Macros

#define CONFIG_BNO08X_RX_CARGO   1024
 
#define CONFIG_BNO08X_TX_CARGO   128
 
#define CONFIG_BNO08X_OP_QUEUE   8
 
#define CONFIG_BNO08X_EVENT_QUEUE   32
 
#define CONFIG_BNO08X_STARTUP_TIMEOUT_MS   500
 
#define CONFIG_BNO08X_OP_TIMEOUT_MS   1000
 

Functions

constexpr Config bno08x::KconfigDefaults () noexcept
 The configuration menuconfig selected, on top of the driver defaults.
 

Detailed Description

Optional ESP-IDF layer: a Config and the buffer Limits built from CONFIG_BNO08X_* options.

Include this header only where you want menuconfig to choose the defaults; the driver never includes it and no driver signature depends on it. Under ESP-IDF the values come from sdkconfig.h. Without Kconfig every option falls back to the driver's default, so KconfigDefaults() equals Config{} and KconfigLimits equals DefaultLimits.

Kconfig writes a bool option set to "n" as an absent macro, so an absent option means off.

One configuration per program: the inline functions below depend on the CONFIG_ macros, so every translation unit of one program must see the same values (ESP-IDF has one sdkconfig.h per build; each host test is its own program). No driver or library header includes this one.

Macro Definition Documentation

◆ CONFIG_BNO08X_EVENT_QUEUE

#define CONFIG_BNO08X_EVENT_QUEUE   32

Queued events when Kconfig does not set it.

◆ CONFIG_BNO08X_OP_QUEUE

#define CONFIG_BNO08X_OP_QUEUE   8

Pending operations when Kconfig does not set it.

◆ CONFIG_BNO08X_OP_TIMEOUT_MS

#define CONFIG_BNO08X_OP_TIMEOUT_MS   1000

Operation limit in milliseconds when Kconfig does not set it.

◆ CONFIG_BNO08X_RX_CARGO

#define CONFIG_BNO08X_RX_CARGO   1024

Largest cargo received, in bytes, when Kconfig does not set it.

◆ CONFIG_BNO08X_STARTUP_TIMEOUT_MS

#define CONFIG_BNO08X_STARTUP_TIMEOUT_MS   500

Start-up wait limit in milliseconds when Kconfig does not set it.

◆ CONFIG_BNO08X_TX_CARGO

#define CONFIG_BNO08X_TX_CARGO   128

Largest cargo sent, in bytes, when Kconfig does not set it.