duds::hardware::devices::instruments::FXOS8700CQ::Settings Struct Reference

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

#include <FXOS8700CQ.hpp>

Public Attributes
unsigned int	accelerometer: 1
	Flag to use the accelerometer. More...
unsigned int	accelLowNoise: 1
	Use the low-noise mode of the accelerometer. More...
unsigned int	highPassFilter: 1
	Enables the high-pass filter. More...
unsigned int	highPassLowCutoff: 1
	Adjusts the cut-off frequency of the high-pass filter to be lower. More...
unsigned int	magnetometer: 1
	Flag to use the magnetometer. More...
Magnitude	maxMagnitude: 2
	The maximum magnetude for the accelerometer. More...
OversampleMode	oversampleMode: 2
	The oversample mode to use when in the active non-sleep state. More...
unsigned int	oversampleRatio: 3
	Affects how many samples are taken by the magnetometer to produce a single output sample. More...
OversampleMode	oversampleSleepMode: 2
	The oversample mode to use when in the sleep state. More...
unsigned int	threadedSample: 1
	Uses a thread to periodically read samples from the device. More...

Detailed Description

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

Definition at line 104 of file FXOS8700CQ.hpp.

Member Data Documentation

accelerometer

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::accelerometer

Flag to use the accelerometer.

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

Definition at line 109 of file FXOS8700CQ.hpp.

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

accelLowNoise

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::accelLowNoise

Use the low-noise mode of the accelerometer.

This cannot be used with the Magnitude8g rage.

Definition at line 119 of file FXOS8700CQ.hpp.

Referenced by duds::hardware::devices::instruments::FXOS8700CQ::configure(), and duds::hardware::devices::instruments::FXOS8700CQ::start().

highPassFilter

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::highPassFilter

Enables the high-pass filter.

Definition at line 123 of file FXOS8700CQ.hpp.

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

highPassLowCutoff

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::highPassLowCutoff

Adjusts the cut-off frequency of the high-pass filter to be lower.

Definition at line 127 of file FXOS8700CQ.hpp.

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

magnetometer

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

Flag to use the magnetometer.

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

Definition at line 114 of file FXOS8700CQ.hpp.

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

maxMagnitude

Magnitude duds::hardware::devices::instruments::FXOS8700CQ::Settings::maxMagnitude

The maximum magnetude for the accelerometer.

Definition at line 131 of file FXOS8700CQ.hpp.

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

oversampleMode

OversampleMode duds::hardware::devices::instruments::FXOS8700CQ::Settings::oversampleMode

The oversample mode to use when in the active non-sleep state.

Definition at line 135 of file FXOS8700CQ.hpp.

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

oversampleRatio

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::oversampleRatio

Affects how many samples are taken by the magnetometer to produce a single output sample.

Lower values decrease power consumption. Higher values decrease noise. The higher the sampling rate, the less this value makes a difference.

Definition at line 147 of file FXOS8700CQ.hpp.

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

oversampleSleepMode

OversampleMode duds::hardware::devices::instruments::FXOS8700CQ::Settings::oversampleSleepMode

The oversample mode to use when in the sleep state.

Note

Use of the sleep mode is not yet supported by this driver.

Definition at line 140 of file FXOS8700CQ.hpp.

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

threadedSample

unsigned int duds::hardware::devices::instruments::FXOS8700CQ::Settings::threadedSample

Uses a thread to periodically read samples from the device.

Note

UnimplementedError.

Todo:

Implement a thread for reading.

Definition at line 153 of file FXOS8700CQ.hpp.

---

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

• FXOS8700CQ.hpp