SensorLib 0.5.0
Multi-platform sensor driver library for Arduino, PlatformIO, and ESP-IDF
Loading...
Searching...
No Matches
SensorBHI360 Class Referencefinal

#include <SensorBHI360.hpp>

Inheritance diagram for SensorBHI360:
[legend]

Public Member Functions

 ~SensorBHI360 ()=default
 
 SensorBHI360 ()=default
 
bool getStepCounterConfig (StepCounterConfig &config)
 Get the current configuration of the Step Counter algorithm.
 
bool setStepCounterConfig (const StepCounterConfig &config)
 Set the configuration for the Step Counter algorithm.
 
bool getMultiTapDetectorConfig (MultiTapDetectorConfig &config)
 Get the current configuration of the Multi Tap Detector algorithm.
 
bool setMultiTapDetectorConfig (const MultiTapDetectorConfig &config)
 Set the configuration for the Multi Tap Detector algorithm.
 
bool getMultiTapParamConfig (MultiTapDataType(&config)[8])
 Get the current configuration of the Multi Tap parameters.
 
bool setMultiTapParamConfig (const MultiTapDataType &config)
 Set the configuration for the Multi Tap parameters.
 

Protected Member Functions

uint16_t getConfirmationIDImpl () override
 Get the confirmation ID for the sensor.
 

Detailed Description

Definition at line 53 of file sensor/imu/bhi360/SensorBHI360.hpp.

Constructor & Destructor Documentation

◆ ~SensorBHI360()

SensorBHI360::~SensorBHI360 ( )
default

◆ SensorBHI360()

SensorBHI360::SensorBHI360 ( )
default

Member Function Documentation

◆ getConfirmationIDImpl()

uint16_t SensorBHI360::getConfirmationIDImpl ( )
overrideprotected

Get the confirmation ID for the sensor.

Note
This ID is used to confirm the sensor's identity during communication.
Return values
Theconfirmation ID.

Definition at line 35 of file SensorBHI360.cpp.

◆ getMultiTapDetectorConfig()

bool SensorBHI360::getMultiTapDetectorConfig ( MultiTapDetectorConfig config)

Get the current configuration of the Multi Tap Detector algorithm.

Parameters
configReference to a MultiTapDetectorConfig structure to store the retrieved configuration.
Returns
true if the configuration was successfully retrieved, false otherwise.

Definition at line 60 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().

◆ getMultiTapParamConfig()

bool SensorBHI360::getMultiTapParamConfig ( MultiTapDataType(&)  config[8])

Get the current configuration of the Multi Tap parameters.

Parameters
configReference to an array of MultiTapDataType to store the retrieved configuration.
Note
The array should have a size of 8 to accommodate all possible Multi Tap parameters.
Returns
true if the configuration was successfully retrieved, false otherwise.

Definition at line 80 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().

◆ getStepCounterConfig()

bool SensorBHI360::getStepCounterConfig ( StepCounterConfig config)

Get the current configuration of the Step Counter algorithm.

Parameters
configReference to a StepCounterConfig structure to store the retrieved configuration.
Returns
true if the configuration was successfully retrieved, false otherwise.

Definition at line 40 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().

◆ setMultiTapDetectorConfig()

bool SensorBHI360::setMultiTapDetectorConfig ( const MultiTapDetectorConfig config)

Set the configuration for the Multi Tap Detector algorithm.

Parameters
configReference to a MultiTapDetectorConfig structure containing the desired configuration.
Returns
true if the configuration was successfully set, false otherwise.

Definition at line 70 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().

◆ setMultiTapParamConfig()

bool SensorBHI360::setMultiTapParamConfig ( const MultiTapDataType config)

Set the configuration for the Multi Tap parameters.

Parameters
configReference to a MultiTapDataType containing the desired configuration.
Returns
true if the configuration was successfully set, false otherwise.

Definition at line 90 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().

◆ setStepCounterConfig()

bool SensorBHI360::setStepCounterConfig ( const StepCounterConfig config)

Set the configuration for the Step Counter algorithm.

Parameters
configReference to a StepCounterConfig structure containing the desired configuration.
Returns
true if the configuration was successfully set, false otherwise.

Definition at line 50 of file SensorBHI360.cpp.

References SENSORLIB_LOG_E.

Referenced by setup().


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