|
| MMC5983MA_SPI (uint32_t spiClockSpeed, uint8_t spiSS, SPIClass *spiObj, SPI_CONF spiConfAtEndTransaction) |
|
| MMC5983MA_SPI (const MMC5983MA_SPI &other)=default |
|
MMC5983MA_SPI & | operator= (const MMC5983MA_SPI &other)=default |
|
| MMC5983MA_SPI (MMC5983MA_SPI &&other) noexcept=default |
|
MMC5983MA_SPI & | operator= (MMC5983MA_SPI &&other) noexcept=default |
|
bool | begin () override |
|
void | readTemp () override |
|
void | readMag () override |
|
uint8_t | whoAmI () override |
|
void | setMagOdrBw (MMC5983MA_ENUM::ODR magFreq, MMC5983MA_ENUM::BW magBw) |
| Sets the magnetometer output data rate (ODR) and bandwidth (BW).
|
|
void | setPeriodicSetTime (MMC5983MA_ENUM::PERIODIC_SET_TIME time) |
| Sets the periodic set time for the MMC5983MA sensor.
|
|
void | setPeriodicSetState (bool state) |
| Will enable or disable the periodic set feature of the MMC5983MA sensor.
|
|
void | setAutoSetResetState (bool state) |
| Enable the automatic set/reset feauture of the MMC5983MA sensor.
|
|
void | softResetSensor () |
| Performs a soft reset of the sensor.
|
|
void | setCurrent () |
| Manually apply set current degaussing.
|
|
void | resetCurrent () |
| Manually reset current degaussing.
|
|
void | askForOneMagMeasure () |
| Asks for one magnetic measurement.
|
|
void | askForOneTempMeasure () |
| Asks for one temperature measurement.
|
|
void | activateAxis (bool activeX, bool activeYZ) |
| Activates or deactivates the specified axes.
|
|
void | updateBridgeOffset () |
| Updates the bridge offset.
|
|
void | setMeasCheckStates (bool magCheck, bool tempCheck) |
| Sets the measurement check states for the magnetometer and temperature sensor.
|
|
◆ activateAxis()
void MMC5983MA_SPI::activateAxis |
( |
bool |
activeX, |
|
|
bool |
activeYZ |
|
) |
| |
Activates or deactivates the specified axes.
- Parameters
-
activeX | Flag indicating whether to activate or deactivate the X-axis. |
activeYZ | Flag indicating whether to activate or deactivate the Y and Z axes. |
◆ setAutoSetResetState()
void MMC5983MA_SPI::setAutoSetResetState |
( |
bool |
state | ) |
|
Enable the automatic set/reset feauture of the MMC5983MA sensor.
- Parameters
-
state | The desired state of the automatic set/reset feature. |
◆ setMagOdrBw()
void MMC5983MA_SPI::setMagOdrBw |
( |
MMC5983MA_ENUM::ODR |
magFreq, |
|
|
MMC5983MA_ENUM::BW |
magBw |
|
) |
| |
Sets the magnetometer output data rate (ODR) and bandwidth (BW).
- Parameters
-
magFreq | The desired magnetometer output data rate. |
magBw | The desired magnetometer bandwidth. |
◆ setMeasCheckStates()
void MMC5983MA_SPI::setMeasCheckStates |
( |
bool |
magCheck, |
|
|
bool |
tempCheck |
|
) |
| |
Sets the measurement check states for the magnetometer and temperature sensor.
- Parameters
-
magCheck | Flag indicating whether to verify magnetometer measurement status before doing a measurement. |
tempCheck | Flag indicating whether to verify temperature measurement status before doing a measurement. |
◆ setPeriodicSetState()
void MMC5983MA_SPI::setPeriodicSetState |
( |
bool |
state | ) |
|
Will enable or disable the periodic set feature of the MMC5983MA sensor.
- Parameters
-
state | The desired state of the periodic setting. |
◆ setPeriodicSetTime()
void MMC5983MA_SPI::setPeriodicSetTime |
( |
MMC5983MA_ENUM::PERIODIC_SET_TIME |
time | ) |
|
Sets the periodic set time for the MMC5983MA sensor.
- Parameters
-
time | The periodic set time to be set. |
◆ updateBridgeOffset()
void MMC5983MA_SPI::updateBridgeOffset |
( |
| ) |
|
Updates the bridge offset.
The bridge offset is the value that is added to the raw magnetic measurements. The idea is to force the internal magnetization in the direction of SET field, do a measure and repeat the maneuver in the opposite direction with a RESET. The substraction of the two measurements gives the offset.
The documentation for this class was generated from the following files:
- /builds/code/embedded/sensors/no_dependency/appdm_ins_minimal/tools/lib/libDM_no_dep_mmc5983ma/src/libDM_mmc5983ma.hpp
- /builds/code/embedded/sensors/no_dependency/appdm_ins_minimal/tools/lib/libDM_no_dep_mmc5983ma/src/libDM_mmc5983ma.cpp