|
BNO08X Driver 0.1.0
API reference
|
Typed codecs of the FRS records whose layout the documents give (RM S4), the 24 mounting quaternions of the data sheet and the calibration procedure helper. More...
#include <array>#include <cstddef>#include <cstdint>#include "bno08x_detail.hpp"#include "bno08x_registers.hpp"#include "bno08x_types.hpp"Go to the source code of this file.
Classes | |
| struct | bno08x::Quat30 |
| A unit quaternion in Q30 (the orientation records, RM S4.1). More... | |
| struct | bno08x::PowerManagement |
| MotionEngine power management and stability classifier record 0xD3E2 (RM S4.3.1). More... | |
| struct | bno08x::ArvrStabilization |
| AR/VR stabilisation records 0x3E2D and 0x3E2E (RM S4.2). More... | |
| struct | bno08x::SignificantMotionConfig |
| Significant motion detector configuration record 0xC274. More... | |
| struct | bno08x::ShakeConfig |
| Shake detector configuration record 0x7D7D. More... | |
| struct | bno08x::EnvCalibration |
| Environmental sensor calibration records 0x39AF, 0x4D20, 0x1AC9, 0x39B1, 0x4DA2. More... | |
| struct | bno08x::GyroRvConfig |
| Gyro-integrated rotation vector configuration record 0xA1A2 (RM S4.3.12). More... | |
| class | bno08x::CalibrationHelper |
A state object that turns the calibration procedure into steps. It sends nothing: it follows what you tell it (Advance(), Observe()) and says what to do next. More... | |
Namespaces | |
| namespace | bno08x |
The BNO08x driver: everything it declares lives here; internals in detail. | |
Enumerations | |
| enum class | bno08x::CalStep : uint8_t { bno08x::EnableSensors = 0 , bno08x::MovePoses = 1 , bno08x::SetDown = 2 , bno08x::RotateAxes = 3 , bno08x::WaitAccuracy = 4 , bno08x::Save = 5 , bno08x::Done = 6 } |
| Steps of the calibration procedure (CAL 1000-4044, DS S3.1). More... | |
Functions | |
| constexpr std::array< uint32_t, kOrientationWords > | bno08x::EncodeOrientation (const Quat30 &q) noexcept |
| Words of an orientation record (x, y, z, w; RM S4.1). | |
| constexpr Quat30 | bno08x::DecodeOrientation (const std::array< uint32_t, kOrientationWords > &w) noexcept |
| The quaternion of an orientation record. | |
| constexpr std::array< uint32_t, kPowerMgmtWords > | bno08x::EncodePowerManagement (const PowerManagement &p) noexcept |
| Words of record 0xD3E2. | |
| constexpr PowerManagement | bno08x::DecodePowerManagement (const std::array< uint32_t, kPowerMgmtWords > &w) noexcept |
| The record 0xD3E2 of its words. | |
| constexpr std::array< uint32_t, kArvrWords > | bno08x::EncodeArvr (const ArvrStabilization &a) noexcept |
| Words of an AR/VR stabilisation record. | |
| constexpr ArvrStabilization | bno08x::DecodeArvr (const std::array< uint32_t, kArvrWords > &w) noexcept |
| The AR/VR record of its words. | |
| constexpr std::array< uint32_t, kSigMotionWords > | bno08x::EncodeSignificantMotion (const SignificantMotionConfig &s) noexcept |
| Words of record 0xC274. | |
| constexpr SignificantMotionConfig | bno08x::DecodeSignificantMotion (const std::array< uint32_t, kSigMotionWords > &w) noexcept |
| The record 0xC274 of its words. | |
| constexpr std::array< uint32_t, kShakeWords > | bno08x::EncodeShake (const ShakeConfig &s) noexcept |
| Words of record 0x7D7D (the enable word has bit 0 X, bit 1 Y, bit 2 Z). | |
| constexpr ShakeConfig | bno08x::DecodeShake (const std::array< uint32_t, kShakeWords > &w) noexcept |
| The record 0x7D7D of its words. | |
| constexpr std::array< uint32_t, kEnvCalWords > | bno08x::EncodeEnvCalibration (const EnvCalibration &e) noexcept |
| Words of an environmental calibration record. | |
| constexpr EnvCalibration | bno08x::DecodeEnvCalibration (const std::array< uint32_t, kEnvCalWords > &w) noexcept |
| The environmental calibration of its words. | |
| constexpr std::array< uint32_t, kGyroRvConfigWords > | bno08x::EncodeGyroRvConfig (const GyroRvConfig &g) noexcept |
| Words of record 0xA1A2. | |
| constexpr GyroRvConfig | bno08x::DecodeGyroRvConfig (const std::array< uint32_t, kGyroRvConfigWords > &w) noexcept |
| The record 0xA1A2 of its words. | |
| constexpr Quat30 | bno08x::MountingQuaternion (std::size_t row) noexcept |
The mapping quaternion of row row of DS Figure 4-3 (p41), the system orientation for a device mounted with the listed physical axes aligned to East, North, Up. | |
Variables | |
| constexpr std::size_t | bno08x::kOrientationWords = 4 |
| Words of each typed record. | |
| constexpr std::size_t | bno08x::kPowerMgmtWords = 3 |
| Record 0xD3E2. | |
| constexpr std::size_t | bno08x::kArvrWords = 4 |
| Records 0x3E2D and 0x3E2E. | |
| constexpr std::size_t | bno08x::kSigMotionWords = 2 |
| Record 0xC274. | |
| constexpr std::size_t | bno08x::kShakeWords = 5 |
| Record 0x7D7D. | |
| constexpr std::size_t | bno08x::kEnvCalWords = 2 |
| Environmental calibration records. | |
| constexpr std::size_t | bno08x::kGyroRvConfigWords = 7 |
| Record 0xA1A2. | |
| constexpr std::size_t | bno08x::kMountingCount = 24 |
| Number of mounting rows in DS Figure 4-3. | |
Typed codecs of the FRS records whose layout the documents give (RM S4), the 24 mounting quaternions of the data sheet and the calibration procedure helper.
Every codec turns a record into its 32-bit words and back, with the Q points of the reference manual. Records whose layout is proprietary (DCD, static calibration, simple calibration configuration) or not yet transcribed (the detector configurations RM S4.3.13 to S4.3.20) stay raw words: read and write them with Bno08x::ReadFrs() and Bno08x::WriteFrs().