BNO08X Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
bno08x::CalibrationHelper Class Reference

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...

#include <bno08x_records.hpp>

Public Member Functions

CalStep Step () const noexcept
 
void Advance () noexcept
 The user finished the current step; go to the next one (WaitAccuracy needs Observe()).
 
void Observe (Accuracy a) noexcept
 Tell the helper the latest magnetometer accuracy (the status of a magnetic field sample).
 
bool ReadyToSave () const noexcept
 
void Reset () noexcept
 Start again.
 

Static Public Member Functions

static constexpr uint32_t MinRateHz () noexcept
 The slowest report rate the procedure allows, in Hz (DS p38).
 

Detailed Description

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.

Member Function Documentation

◆ MinRateHz()

static constexpr uint32_t bno08x::CalibrationHelper::MinRateHz ( )
inlinestaticconstexprnoexcept

The slowest report rate the procedure allows, in Hz (DS p38).

Returns
50.

◆ Observe()

void bno08x::CalibrationHelper::Observe ( Accuracy  a)
inlinenoexcept

Tell the helper the latest magnetometer accuracy (the status of a magnetic field sample).

Parameters
aThe accuracy.

◆ ReadyToSave()

bool bno08x::CalibrationHelper::ReadyToSave ( ) const
inlinenoexcept
Returns
true once the magnetometer accuracy is medium or high.

◆ Step()

CalStep bno08x::CalibrationHelper::Step ( ) const
inlinenoexcept
Returns
The current step.

The documentation for this class was generated from the following file: