DUDS
Distributed Update of Data from Something
duds::hardware::devices::instruments::LSM9DS1Mag::Settings Struct Reference

The various settings for the device packed into an integer to avoid passing a lot of parameters. More...

#include <LSM9DS1.hpp>

Public Attributes

unsigned int magLowPower: 1
 A low-power mode that forces the 0.625Hz sample rate. More...
 
unsigned int magnetometer: 1
 Flag to use the magnetometer. More...
 
MagRange magRange: 2
 The maximum magnetude setting. More...
 
unsigned int magTempComp: 1
 Enables temperature compensation using a temperature sensor inside the device. More...
 
MagAxesMode xyMagMode: 2
 Operating mode for the X and Y axes. More...
 
MagAxesMode zMagMode: 2
 Operating mode for the Z axis. More...
 

Detailed Description

The various settings for the device packed into an integer to avoid passing a lot of parameters.

Definition at line 336 of file LSM9DS1.hpp.

Member Data Documentation

◆ magLowPower

unsigned int duds::hardware::devices::instruments::LSM9DS1Mag::Settings::magLowPower

A low-power mode that forces the 0.625Hz sample rate.

It is separate from the low-power mode on the axes, but the documentation makes it unclear if the axes mode makes any difference if this device low-power mode is used.

Definition at line 352 of file LSM9DS1.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1Mag::configure().

◆ magnetometer

unsigned int duds::hardware::devices::instruments::LSM9DS1Mag::Settings::magnetometer

Flag to use the magnetometer.

At least the accelerometer or magnetometer must be selected for use.

Definition at line 341 of file LSM9DS1.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1Mag::configure(), and duds::hardware::devices::instruments::LSM9DS1Mag::sample().

◆ magRange

MagRange duds::hardware::devices::instruments::LSM9DS1Mag::Settings::magRange

◆ magTempComp

unsigned int duds::hardware::devices::instruments::LSM9DS1Mag::Settings::magTempComp

Enables temperature compensation using a temperature sensor inside the device.

Definition at line 365 of file LSM9DS1.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1Mag::configure().

◆ xyMagMode

MagAxesMode duds::hardware::devices::instruments::LSM9DS1Mag::Settings::xyMagMode

Operating mode for the X and Y axes.

Definition at line 356 of file LSM9DS1.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1Mag::configure().

◆ zMagMode

MagAxesMode duds::hardware::devices::instruments::LSM9DS1Mag::Settings::zMagMode

Operating mode for the Z axis.

Definition at line 360 of file LSM9DS1.hpp.

Referenced by duds::hardware::devices::instruments::LSM9DS1Mag::configure().


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