HF-BNO08x  0.1.0-dev
Loading...
Searching...
No Matches
Sensor Types and Data Structures

Enumerations, value containers, and callback types. More...

Classes

struct  Vector3
 Three-axis vector with sensor accuracy indicator. More...
 
struct  Quaternion
 Unit quaternion with sensor accuracy indicator. More...
 
struct  TapEvent
 Tap detector event details. More...
 
struct  RawVector3
 Raw integer 3-axis sample (ADC counts) with optional metadata. More...
 
struct  ActivityClassifierEvent
 Personal activity classifier payload. More...
 
struct  RawOpticalFlowEvent
 Raw optical flow payload from SH2_RAW_OPTICAL_FLOW. More...
 
struct  DeadReckoningPoseEvent
 Dead reckoning position/orientation/velocity payload. More...
 
struct  WheelEncoderEvent
 Wheel encoder payload. More...
 
struct  SensorEvent
 Container for a single decoded SH-2 sensor report. More...
 
struct  RvcSensorEvent
 Raw RVC frame data in integer fixed-point format. More...
 
struct  RvcSensorValue
 Decoded RVC frame data in floating-point natural units. More...
 
struct  DfuProgress
 Progress sample emitted during DFU transfers. More...
 
struct  DfuOptions
 Controls DFU validation and transfer behavior. More...
 
struct  DfuMemoryImage
 Firmware image descriptor for class-aware memory DFU. More...
 

Typedefs

using SensorCallback = std::function<void(const SensorEvent&)>
 Callback invoked when a new SH-2 sensor event is received.
 
using RvcCallback = std::function<void(const RvcSensorValue&)>
 Callback invoked when a decoded RVC frame is available.
 
using DfuProgressCallback = std::function<void(const DfuProgress&)>
 Callback for DFU progress updates.
 

Enumerations

enum class  BNO085Sensor : uint8_t {
  BNO085Sensor::Accelerometer = 0x01 , BNO085Sensor::Gyroscope = 0x02 , BNO085Sensor::Magnetometer = 0x03 , BNO085Sensor::LinearAcceleration = 0x04 ,
  BNO085Sensor::RotationVector = 0x05 , BNO085Sensor::Gravity = 0x06 , BNO085Sensor::GyroUncalibrated = 0x07 , BNO085Sensor::GameRotationVector = 0x08 ,
  BNO085Sensor::GeomagneticRotationVector = 0x09 , BNO085Sensor::Pressure = 0x0A , BNO085Sensor::AmbientLight = 0x0B , BNO085Sensor::Humidity = 0x0C ,
  BNO085Sensor::Proximity = 0x0D , BNO085Sensor::Temperature = 0x0E , BNO085Sensor::MagneticFieldUncalibrated = 0x0F , BNO085Sensor::TapDetector = 0x10 ,
  BNO085Sensor::StepCounter = 0x11 , BNO085Sensor::SignificantMotion = 0x12 , BNO085Sensor::StabilityClassifier = 0x13 , BNO085Sensor::RawAccelerometer = 0x14 ,
  BNO085Sensor::RawGyroscope = 0x15 , BNO085Sensor::RawMagnetometer = 0x16 , BNO085Sensor::StepDetector = 0x18 , BNO085Sensor::ShakeDetector = 0x19 ,
  BNO085Sensor::FlipDetector = 0x1A , BNO085Sensor::PickupDetector = 0x1B , BNO085Sensor::StabilityDetector = 0x1C , BNO085Sensor::PersonalActivityClassifier = 0x1E ,
  BNO085Sensor::SleepDetector = 0x1F , BNO085Sensor::TiltDetector = 0x20 , BNO085Sensor::PocketDetector = 0x21 , BNO085Sensor::CircleDetector = 0x22 ,
  BNO085Sensor::HeartRateMonitor = 0x23 , BNO085Sensor::ARVRStabilizedRV = 0x28 , BNO085Sensor::ARVRStabilizedGameRV = 0x29 , BNO085Sensor::GyroIntegratedRV = 0x2A ,
  BNO085Sensor::IZroMotionRequest = 0x2B , BNO085Sensor::RawOpticalFlow = 0x2C , BNO085Sensor::DeadReckoningPose = 0x2D , BNO085Sensor::WheelEncoder = 0x2E
}
 Identifiers for all SH-2 sensor reports supported by the BNO08x. More...
 
enum class  BNO085DriverState : uint8_t { BNO085DriverState::Closed = 0 , BNO085DriverState::Sh2Active , BNO085DriverState::RvcActive , BNO085DriverState::DfuInProgress }
 Current top-level operating state of the driver. More...
 

Detailed Description

Enumerations, value containers, and callback types.

Typedef Documentation

◆ DfuProgressCallback

using DfuProgressCallback = std::function<void(const DfuProgress&)>

Callback for DFU progress updates.

◆ RvcCallback

using RvcCallback = std::function<void(const RvcSensorValue&)>

Callback invoked when a decoded RVC frame is available.

◆ SensorCallback

using SensorCallback = std::function<void(const SensorEvent&)>

Callback invoked when a new SH-2 sensor event is received.

Enumeration Type Documentation

◆ BNO085DriverState

enum class BNO085DriverState : uint8_t
strong

Current top-level operating state of the driver.

The class is a monolith but enforces mode-safe operations via this state:

  • Closed : no active session.
  • Sh2Active : SH-2 protocol session is open.
  • RvcActive : RVC UART parser is active.
  • DfuInProgress : DFU transfer is running.
Enumerator
Closed 
Sh2Active 
RvcActive 
DfuInProgress 

◆ BNO085Sensor

enum class BNO085Sensor : uint8_t
strong

Identifiers for all SH-2 sensor reports supported by the BNO08x.

Pass these to EnableSensor() / DisableSensor() / HasNewData() / GetLatest(). Values correspond to the SH-2 sensor ID bytes defined in the CEVA datasheet.

Enumerator
Accelerometer 

Calibrated acceleration vector (m/s^2)

Gyroscope 

Calibrated angular velocity (rad/s)

Magnetometer 

Calibrated magnetic field (uT)

LinearAcceleration 

Acceleration minus gravity (m/s^2)

RotationVector 

Fused absolute orientation quaternion.

Gravity 

Gravity vector (m/s^2)

GyroUncalibrated 

Raw angular velocity (rad/s)

GameRotationVector 

Orientation without magnetometer heading.

GeomagneticRotationVector 

Orientation using magnetometer for heading.

Pressure 

Barometric pressure (hPa)

AmbientLight 

Ambient light level (lux)

Humidity 

Relative humidity (%)

Proximity 

Proximity detector (cm)

Temperature 

Temperature (deg C)

MagneticFieldUncalibrated 

Raw magnetic field (uT)

TapDetector 

Single or double tap event.

StepCounter 

Cumulative step count.

SignificantMotion 

Significant motion detected.

StabilityClassifier 

Device stability state (on table, in hand, etc.)

RawAccelerometer 

Raw accelerometer ADC counts.

RawGyroscope 

Raw gyroscope ADC counts.

RawMagnetometer 

Raw magnetometer ADC counts.

StepDetector 

Individual step detected.

ShakeDetector 

Shake gesture detected.

FlipDetector 

Flip gesture detected.

PickupDetector 

Pickup gesture detected.

StabilityDetector 

Stability change detected.

PersonalActivityClassifier 

Activity classification (walking, running, etc.)

SleepDetector 

Sleep state detected.

TiltDetector 

Tilt event detected.

PocketDetector 

Device-in-pocket detected.

CircleDetector 

Circular motion detected.

HeartRateMonitor 

Heart rate data.

ARVRStabilizedRV 

AR/VR stabilised rotation vector.

ARVRStabilizedGameRV 

AR/VR stabilised game rotation vector.

GyroIntegratedRV 

High-rate gyro-integrated rotation vector.

IZroMotionRequest 

Interactive ZRO motion intent/request.

RawOpticalFlow 

Raw optical flow report.

DeadReckoningPose 

Dead reckoning pose estimate.

WheelEncoder 

Wheel encoder report.