|
modm API documentation
|
#include <modm/driver/inertial/hmc58x3.hpp>
Classes | |
| struct | Data |
Public Types | |
| enum | ConfigA : uint8_t |
| Configuration Register A. | |
| enum | ConfigB : uint8_t |
| Configuration Register B. | |
| enum | Mode : uint8_t |
| Mode Register. | |
| enum | Status : uint8_t |
| Status Register. | |
| enum | OperationMode : uint8_t |
| Operation modes. | |
Public Member Functions | |
| MODM_FLAGS8 (ConfigA) | |
| MODM_FLAGS8 (ConfigB) | |
| MODM_FLAGS8 (Mode) | |
| MODM_FLAGS8 (Status) | |
| modm::ResumableResult< bool > | setOperationMode (OperationMode mode) |
| modm::ResumableResult< bool > | readMagneticField () |
| Status_t | getStatus () |
| modm::ResumableResult< bool > | readStatus () |
| Data & | getData () |
| Get the data object for this sensor. | |
| void | attachConfigurationHandler (I2c::ConfigurationHandler handler) |
| modm::ResumableResult< bool > | ping () |
| void | setAddress (uint8_t address) |
Protected Member Functions | |
| Hmc58x3 (Data &data, uint8_t address=0x1e) | |
| Constructor, requires a hmc58x3::Data object, sets address to default of 0x1e. | |
| modm::ResumableResult< bool > | updateConfigA (ConfigA_t setMask, ConfigA_t clearMask=ConfigA_t (0x7f)) |
| modm::ResumableResult< bool > | updateConfigB (ConfigB_t setMask, ConfigB_t clearMask=ConfigB_t (0xe0)) |
| modm::ResumableResult< bool > | updateMode (Mode_t setMask, Mode_t clearMask=Mode::MD_Mask) |
| ConfigA_t | getConfigA () |
| ConfigB_t | getConfigB () |
| Mode_t | getMode () |
| modm::ResumableResult< ReturnType > resumable | function (...) |
| int8_t | getResumableDepth () const |
| bool | isResumableRunning () const |
| bool | isTransactionRunning () |
| modm::ResumableResult< bool > | runTransaction () |
| Starts our own transaction and waits until finished. | |
| bool | startRead (uint8_t *buffer, std::size_t size) |
| Configures the transaction with a read operation and starts it. | |
| bool | startTransaction () |
| Starts the transaction with our own transaction object. | |
| bool | startTransaction (modm::I2cTransaction *transaction) |
| Starts the transaction with a seperate transaction object. | |
| bool | startWrite (const uint8_t *buffer, std::size_t size) |
| Configures the transaction with a write operation and starts it. | |
| bool | startWriteRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize) |
| Configures the transaction with a write/read operation and starts it. | |
| void | stopResumable () |
| Force all resumable functions to stop running at the current nesting level. | |
| bool | wasTransactionSuccessful () |
Protected Attributes | |
| I2cWriteReadTransaction | transaction |
|
inheritedinline |
Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.
|
inherited |
Run the resumable function.
You need to implement this method in you subclass yourself.
NestingError if still running, <=NestingError if it has finished.
|
inheritedinline |
|
inheritedinline |
true if a resumable function is running at the current nesting level, else false
|
inheritedinlineprotected |
true when transaction is busy.
|
inheritedinline |
| true | device responds to address |
| false | no device with address found |
|
inheritedinline |
Sets a new address of the slave device.
| address | the slave address not yet shifted left (address < 128). |
|
inheritedinlineprotected |
true when transaction did not return an error. 
1.4.2