|
BNO08X Driver 0.1.0
API reference
|
Public types of the BNO08x driver: errors, Result<T>, configuration, events and the integer unit helpers.
More...
#include <array>#include <cstddef>#include <cstdint>#include "bno08x_detail.hpp"#include "bno08x_registers.hpp"#include "bno08x_version.h"Go to the source code of this file.
Classes | |
| struct | bno08x::Result< T > |
| The value of a call, or why there is none. More... | |
| struct | bno08x::Result< void > |
| The result of a call that returns no value. More... | |
| struct | bno08x::Event |
One thing the driver reports, taken with Bno08x::PopEvent(). More... | |
| struct | bno08x::Stats |
| Counters of everything the driver dropped, repaired or noticed. Never reset by the driver. More... | |
| struct | bno08x::FeatureConfig |
| The common feature report of one sensor (RM S6.5.2). More... | |
| struct | bno08x::ProductId |
| Product ID response (RM S6.3.2). More... | |
| struct | bno08x::Metadata |
| Sensor metadata record (RM Figures 28 and 29, record IDs 0xE301 to 0xE325). More... | |
| struct | bno08x::FrsBuffer |
A caller-owned buffer for ReadFrs(); it must outlive the operation. More... | |
| struct | bno08x::MeCal |
| The motion engine's calibration enables (RM S6.4.6). More... | |
| struct | bno08x::Quat14 |
| A quaternion in Q14 (RM S6.4.3.3): the set-reorientation argument. More... | |
| struct | bno08x::WheelSample |
| One wheel measurement for dead reckoning (RM S6.4.13). More... | |
| struct | bno08x::RvcFrame |
| A decoded UART-RVC frame (DS p21). More... | |
| struct | bno08x::Config |
The configuration of a session. Config{} is the recommended setup for a BNO085. More... | |
| struct | bno08x::EulerCentiDeg |
| Yaw, pitch and roll in centidegrees. More... | |
Namespaces | |
| namespace | bno08x |
The BNO08x driver: everything it declares lives here; internals in detail. | |
Typedefs | |
| using | bno08x::OpId = uint16_t |
An operation number returned by every call that completes later with an OpDone event. | |
Functions | |
| constexpr const char * | bno08x::ToString (Error error) noexcept |
| The name of an error, for logs. | |
| constexpr bool | bno08x::ToSensorId (uint8_t raw, SensorId &out) noexcept |
Whether raw is one of the sensor IDs of SensorId, and if so which. | |
| constexpr int32_t | bno08x::ToMmPerS2 (int32_t q8) noexcept |
| A Q8 acceleration (m/s2) in millimetres per second squared. | |
| constexpr int32_t | bno08x::ToMilliRadPerS (int32_t q9) noexcept |
| A Q9 angular rate (rad/s) in milliradians per second. | |
| constexpr int32_t | bno08x::ToNanoTesla (int32_t q4) noexcept |
| A Q4 magnetic field (uT) in nanotesla. | |
| constexpr int32_t | bno08x::ToMicroRad (int32_t q12) noexcept |
| A Q12 angle (rad), such as a rotation vector's accuracy, in microradians. | |
| constexpr int32_t | bno08x::ToPpm (int32_t q14) noexcept |
| A Q14 quaternion component in parts per million of unity. | |
| constexpr const char * | bno08x::GetDriverVersion () noexcept |
| constexpr uint32_t | bno08x::GetDriverVersionMajor () noexcept |
| constexpr uint32_t | bno08x::GetDriverVersionMinor () noexcept |
| constexpr uint32_t | bno08x::GetDriverVersionPatch () noexcept |
Variables | |
| constexpr std::size_t | bno08x::kSensorSlots = 0x2F |
| Number of slots of the per-sensor tables: sensor IDs 0x01 to 0x2E. | |
| constexpr std::size_t | bno08x::kEventValues = 16 |
Number of values an Event carries. | |
| constexpr std::size_t | bno08x::kFrsMaxWords = 128 |
| Largest FRS record the driver reads or writes, in 32-bit words (Kconfig-free constant). | |
Public types of the BNO08x driver: errors, Result<T>, configuration, events and the integer unit helpers.
Everything here is plain data with no platform dependency. The driver is integer-only: sensor values keep the Q point the SH-2 reference manual gives them (RM S6.5), and the helpers at the end of this file convert them to whole units (millimetres per second squared, milliradians per second, nanotesla, microradians, centidegrees).