LSM303AGR

https://docs.rs/lsm303agr/latest/lsm303agr/
Admin
Platform-agnostic Rust driver for the LSM303AGR ultra-compact high-performance 3D accelerometer and...
Tokens:18,285
Snippets:218
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Initialize LSM303AGR Registers

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Performs the initial setup of the LSM303AGR device's internal registers.

```rust
pub fn init(&mut self) -> Result<(), Error<CommE>>
```

--------------------------------

### Get Measured Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Reads and returns the current acceleration measurements from the accelerometer.

```rust
pub fn acceleration(&mut self) -> Result<Acceleration, Error<CommE>>
```

--------------------------------

### Get Temperature Sensor Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Retrieves the status of the temperature sensor.

```rust
pub fn temperature_status(&mut self) -> Result<TemperatureStatus, Error<CommE>>
```

--------------------------------

### Get Measured Temperature

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Reads and returns the current temperature measurement from the integrated temperature sensor.

```rust
pub fn temperature(&mut self) -> Result<Temperature, Error<CommE>>
```

--------------------------------

### Get Magnetometer Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Retrieves the current status of the magnetometer, indicating its operational state.

```rust
pub fn mag_status(&mut self) -> Result<Status, Error<CommE>>
```

--------------------------------

### Change Magnetometer to One-Shot Mode

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Transitions the magnetometer from continuous mode to one-shot mode. After this, the magnetometer enters an idle state until a new measurement is explicitly started.

```rust
pub fn into_mag_one_shot(self) -> Result<Lsm303agr<DI, MagOneShot>, ModeChangeError<CommE, Self>>
```

--------------------------------

### Get XYZ-Axis Acceleration in milli-g

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the acceleration values for all three axes (X, Y, and Z) in milli-g units as a tuple. This method is part of the Acceleration struct implementation.

```rust
pub const fn xyz_mg(&self) -> (i32, i32, i32)
```

--------------------------------

### Get Accelerometer Scale

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Retrieves the current scaling factor of the accelerometer.

```rust
pub fn get_accel_scale(&self) -> AccelScale
```

--------------------------------

### Get Magnetic Field XYZ in nT

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Retrieves the magnetic field measurements for the X, Y, and Z directions in nano-Tesla (nT) as a tuple of i32 values.

```rust
pub const fn xyz_nt(&self) -> (i32, i32, i32)
```

--------------------------------

### Get Accelerometer Mode

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Retrieves the current operating mode of the accelerometer.

```rust
pub fn get_accel_mode(&mut self) -> AccelMode
```

--------------------------------

### Get Magnetic Field X in nT

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Retrieves the magnetic field measurement for the X-direction in nano-Tesla (nT). This value is an i32.

```rust
pub const fn x_nt(&self) -> i32
```

--------------------------------

### Get Magnetometer Device ID

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Fetches the device identification register value for the magnetometer.

```rust
pub fn magnetometer_id(&mut self) -> Result<MagnetometerId, Error<CommE>>
```

--------------------------------

### Get Raw XYZ-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the raw acceleration values for all three axes (X, Y, and Z) as a tuple. This method is part of the Acceleration struct implementation.

```rust
pub const fn xyz_raw(&self) -> (u16, u16, u16)
```

--------------------------------

### Get Accelerometer Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Retrieves the current status of the accelerometer, indicating its operational state.

```rust
pub fn accel_status(&mut self) -> Result<Status, Error<CommE>>
```

--------------------------------

### Get Accelerometer Device ID

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Fetches the device identification register value for the accelerometer.

```rust
pub fn accelerometer_id(&mut self) -> Result<AccelerometerId, Error<CommE>>
```

--------------------------------

### Get Magnetic Field Z in nT

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Retrieves the magnetic field measurement for the Z-direction in nano-Tesla (nT). This value is an i32.

```rust
pub const fn z_nt(&self) -> i32
```

--------------------------------

### Get X-Axis Acceleration in milli-g

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the acceleration value for the X-direction in milli-g units. This method is part of the Acceleration struct implementation.

```rust
pub const fn x_mg(&self) -> i32
```

--------------------------------

### Get Raw X-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the raw acceleration value for the X-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn x_raw(&self) -> u16
```

--------------------------------

### Get Raw Z-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the raw acceleration value for the Z-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn z_raw(&self) -> u16
```

--------------------------------

### Get Magnetic Field Y in nT

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Retrieves the magnetic field measurement for the Y-direction in nano-Tesla (nT). This value is an i32.

```rust
pub const fn y_nt(&self) -> i32
```

--------------------------------

### Get Z-Axis Acceleration in milli-g

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the acceleration value for the Z-direction in milli-g units. This method is part of the Acceleration struct implementation.

```rust
pub const fn z_mg(&self) -> i32
```

--------------------------------

### Get Raw Temperature Value

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Retrieves the raw, unscaled integer value of the temperature measurement. This is useful for direct sensor readings.

```rust
pub const fn raw(&self) -> u16
```

--------------------------------

### Get Raw Y-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the raw acceleration value for the Y-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn y_raw(&self) -> u16
```

--------------------------------

### Get Y-Axis Acceleration in milli-g

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the acceleration value for the Y-direction in milli-g units. This method is part of the Acceleration struct implementation.

```rust
pub const fn y_mg(&self) -> i32
```

--------------------------------

### Get Unscaled XYZ-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the unscaled acceleration values for all three axes (X, Y, and Z) as a tuple. This method is part of the Acceleration struct implementation.

```rust
pub const fn xyz_unscaled(&self) -> (i16, i16, i16)
```

--------------------------------

### Initialization and Connection

Source: https://docs.rs/crate/lsm303agr

Demonstrates how to connect to the LSM303AGR sensor using I2C and initialize the device.

```APIDOC
## Connect through I2C

### Description
Initializes the LSM303AGR sensor via I2C.

### Method
`new_with_i2c()`

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let mut lsm = lsm303agr::Lsm303agr::new_with_i2c(i2c_interface).unwrap();
```

### Response
#### Success Response
An initialized LSM303AGR device instance.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Initialize the device

### Description
Initializes the LSM303AGR device after connection.

### Method
`init()`

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
lsm.init().unwrap();
```

### Response
#### Success Response
Indicates successful initialization.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```
```

--------------------------------

### Get TypeId of MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Gets the TypeId of the MagOutputDataRate.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Initialize and Read Acceleration Data

Source: https://docs.rs/crate/lsm303agr

Demonstrates how to initialize the LSM303AGR sensor over I2C, set its mode and output data rate, and continuously read acceleration data.

```rust
use linux_embedded_hal::{Delay, I2cdev};
use lsm303agr::{AccelMode, AccelOutputDataRate, Lsm303agr};

fn main() {
    let dev = I2cdev::new("/dev/i2c-1").unwrap();
    let mut sensor = Lsm303agr::new_with_i2c(dev);
    sensor.init().unwrap();
    sensor
        .set_accel_mode_and_odr(&mut Delay, AccelMode::Normal, AccelOutputDataRate::Hz50)
        .unwrap();
    loop {
        if sensor.accel_status().unwrap().xyz_new_data() {
            let data = sensor.acceleration().unwrap();
            println!(
                "Acceleration: x {} y {} z {}",
                data.x_mg(),
                data.y_mg(),
                data.z_mg()
            );
        }
    }
}
```

--------------------------------

### Connect via SPI, Initialize, and Read Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/index.html

Demonstrates how to connect to the LSM303AGR sensor using SPI interfaces for both accelerometer and magnetometer, initialize it, set the accelerometer mode and output data rate, and continuously read acceleration data. Requires `linux-embedded-hal` and `lsm303agr` crates.

```rust
use linux_embedded_hal::{Delay, SpidevDevice};
use lsm303agr::{AccelMode, AccelOutputDataRate, Lsm303agr};

let accel_dev = SpidevDevice::open("/dev/spidev0.0").unwrap();
let mag_dev = SpidevDevice::open("/dev/spidev0.1").unwrap();
let mut sensor = Lsm303agr::new_with_spi(accel_dev, mag_dev);

sensor.init().unwrap();
sensor.set_accel_mode_and_odr(&mut Delay, AccelMode::Normal, AccelOutputDataRate::Hz10).unwrap();

loop {
    if sensor.accel_status().unwrap().xyz_new_data() {
        let data = sensor.acceleration().unwrap();
        println!("Acceleration: x {} y {} z {}", data.x_mg(), data.y_mg(), data.z_mg());
    }
}
```

--------------------------------

### Create LSM303AGR with SPI

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Initializes a new LSM303AGR device instance using SPI interfaces for both accelerometer and magnetometer.

```rust
pub fn new_with_spi(spi_accel: SPIXL, spi_mag: SPIMAG) -> Self
```

--------------------------------

### Lsm303agr Initialization and Configuration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Provides methods for initializing the LSM303AGR sensor, setting accelerometer modes, scales, and interrupts, as well as configuring magnetometer settings.

```APIDOC
## Lsm303agr Initialization and Configuration

### Description
Methods for initializing the LSM303AGR sensor, configuring its accelerometer and magnetometer.

### Methods

#### `init()`
Initializes the sensor registers.

#### `set_accel_mode_and_odr()`
Sets the accelerometer power/resolution mode and output data rate. Requires a delay implementation to wait for sensor state changes.

#### `get_accel_mode()`
Retrieves the current accelerometer mode.

#### `set_accel_scale()`
Sets the accelerometer scaling factor, affecting the range of acceleration values that can be read.

#### `get_accel_scale()`
Retrieves the current accelerometer scaling factor.

#### `acc_set_fifo_mode()`
Configures the accelerometer's FIFO mode and sets the full threshold.

#### `acc_enable_interrupt()`
Enables a specific accelerometer interrupt.

#### `acc_disable_interrupt()`
Disables a specific accelerometer interrupt.

#### `mag_enable_int()`
Configures the DRDY pin as a digital output for magnetometer interrupts.

#### `mag_enable_low_pass_filter()`
Enables the magnetometer's low-pass filter.

#### `mag_disable_low_pass_filter()`
Disables the magnetometer's low-pass filter.

### Parameters

- `set_accel_mode_and_odr`:
  - `delay`: A mutable reference to a `DelayNs` implementation for timing sensor operations.
  - `mode`: The desired `AccelMode` for the accelerometer.
  - `odr`: An `impl Into<Option<AccelOutputDataRate>>` for the output data rate.
- `set_accel_scale`:
  - `scale`: The desired `AccelScale` for the accelerometer.
- `acc_set_fifo_mode`:
  - `mode`: The desired `FifoMode` for the accelerometer.
  - `fth`: The FIFO threshold value (clamped to [0, 31]).
- `acc_enable_interrupt`:
  - `interrupt`: The `Interrupt` to enable.
- `acc_disable_interrupt`:
  - `interrupt`: The `Interrupt` to disable.

### Returns

- `Result<(), Error<CommE>>`: Ok on success, or an error if an operation fails. `set_accel_mode_and_odr` can return `Error::InvalidInputData` for incompatible mode/ODR combinations.
```

--------------------------------

### Connect via I2C, Initialize, and Read Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/index.html

Demonstrates how to connect to the LSM303AGR sensor using an I2C interface, initialize it, set the accelerometer mode and output data rate, and continuously read acceleration data. Requires `linux-embedded-hal` and `lsm303agr` crates.

```rust
use linux_embedded_hal::{Delay, I2cdev};
use lsm303agr::{AccelMode, AccelOutputDataRate, Lsm303agr};

let dev = I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Lsm303agr::new_with_i2c(dev);

sensor.init().unwrap();
sensor.set_accel_mode_and_odr(&mut Delay, AccelMode::Normal, AccelOutputDataRate::Hz10).unwrap();

loop {
    if sensor.accel_status().unwrap().xyz_new_data() {
        let data = sensor.acceleration().unwrap();
        println!("Acceleration: x {} y {} z {}", data.x_mg(), data.y_mg(), data.z_mg());
    }
}
```

--------------------------------

### Create LSM303AGR with I2C

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Initializes a new LSM303AGR device instance using an I2C interface.

```rust
pub fn new_with_i2c(i2c: I2C) -> Self
```

--------------------------------

### PartialEq Implementation for Temperature

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Allows comparison of two Temperature values for equality or inequality. This is essential for checking if two readings are the same.

```rust
fn eq(&self, other: &Temperature) -> bool
```

```rust
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### Generic Blanket Implementations for Any Type T

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Demonstrates common blanket implementations that apply to any type T, including Any, Borrow, BorrowMut, CloneToUninit, From, Into, TryFrom, and TryInto.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
```

```rust
fn type_id(&self) -> TypeId
```

```rust
impl<T> Borrow<T> for T
where T: ?Sized,
```

```rust
fn borrow(&self) -> &T
```

```rust
impl<T> BorrowMut<T> for T
where T: ?Sized,
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

```rust
impl<T: Clone> CloneToUninit for T
where T: Clone,
```

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

```rust
impl<T, U> Into<U> for T
where U: From<T>,
```

```rust
fn into(self) -> U
```

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>,
```

```rust
type Error = Infallible
```

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

```rust
impl<T, U> TryInto<U> for T
where U: TryFrom<T>,
```

```rust
type Error = <U as TryFrom<T>>::Error
```

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### Acceleration Struct Methods

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

This section details the methods available on the Acceleration struct to retrieve raw, unscaled, and scaled acceleration values.

```APIDOC
## Acceleration Struct

An acceleration measurement.

### Methods

#### `x_raw(&self) -> u16`
Raw acceleration in X-direction.

#### `y_raw(&self) -> u16`
Raw acceleration in Y-direction.

#### `z_raw(&self) -> u16`
Raw acceleration in Z-direction.

#### `xyz_raw(&self) -> (u16, u16, u16)`
Raw acceleration in X-, Y- and Z-directions.

#### `x_unscaled(&self) -> i16`
Unscaled acceleration in X-direction.

#### `y_unscaled(&self) -> i16`
Unscaled acceleration in Y-direction.

#### `z_unscaled(&self) -> i16`
Unscaled acceleration in Z-direction.

#### `xyz_unscaled(&self) -> (i16, i16, i16)`
Unscaled acceleration in X-, Y- and Z-directions.

#### `x_mg(&self) -> i32`
Acceleration in X-direction in m g (milli-g).

#### `y_mg(&self) -> i32`
Acceleration in Y-direction in m g (milli-g).

#### `z_mg(&self) -> i32`
Acceleration in Z-direction in m g (milli-g).

#### `xyz_mg(&self) -> (i32, i32, i32)`
Acceleration in X-, Y- and Z-directions in m g (milli-g).
```

--------------------------------

### Clone to Uninit MagOutputDataRate (Nightly)

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Performs copy-assignment from MagOutputDataRate to an uninitialized memory location. This is a nightly-only experimental API.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### LSM303AGR Constructor and Destructor

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Methods for creating and destroying instances of the LSM303AGR driver, supporting both I2C and SPI interfaces.

```APIDOC
## LSM303AGR Constructor and Destructor

### Description
Provides methods to instantiate and clean up the LSM303AGR driver for different communication interfaces.

### Methods

#### `new_with_i2c(i2c: I2C)`
Creates a new instance of the LSM303AGR device communicating via I2C.

#### `new_with_spi(spi_accel: SPIXL, spi_mag: SPIMAG)`
Creates a new instance of the LSM303AGR device communicating via SPI for both accelerometer and magnetometer.

#### `destroy()`
Destroys the driver instance, returning the underlying communication bus (I2C or SPI) and chip select pins.

### Parameters

- `new_with_i2c`:
  - `i2c`: The I2C bus instance.
- `new_with_spi`:
  - `spi_accel`: The SPI bus instance for the accelerometer.
  - `spi_mag`: The SPI bus instance for the magnetometer.

### Returns

- `Self`: A new instance of the `Lsm303agr` driver.
- `I2C`: The original I2C bus instance when `destroy()` is called on an I2C-based driver.
- `(SPIXL, SPIMAG)`: The original SPI bus instances when `destroy()` is called on an SPI-based driver.
```

--------------------------------

### From MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Returns the argument unchanged. This is a generic implementation for From<T> for T.

```rust
fn from(t: T) -> T
```

--------------------------------

### Get Unscaled Z-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the unscaled acceleration value for the Z-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn z_unscaled(&self) -> i16
```

--------------------------------

### Compare Acceleration Structs for Equality

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Tests if two Acceleration values are equal. This is a standard implementation for the PartialEq trait.

```rust
fn eq(&self, other: &Acceleration) -> bool
```

--------------------------------

### Get Unscaled Y-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the unscaled acceleration value for the Y-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn y_unscaled(&self) -> i16
```

--------------------------------

### Enable Magnetometer Data Ready Pin

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Configures the DRDY pin to function as a digital output, typically used for signaling data readiness.

```rust
pub fn mag_enable_int(&mut self) -> Result<(), Error<CommE>>
```

--------------------------------

### Get Unscaled X-Axis Acceleration

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Retrieves the unscaled acceleration value for the X-direction. This method is part of the Acceleration struct implementation.

```rust
pub const fn x_unscaled(&self) -> i16
```

--------------------------------

### Check X, Y, and Z-axis New Data Availability

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Use this method to determine if new data is available for all three axes (X, Y, and Z).

```rust
pub const fn xyz_new_data(&self) -> bool
```

--------------------------------

### Set Accelerometer FIFO Mode

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Configures the accelerometer's FIFO buffer mode and sets the full threshold. The threshold is clamped between 0 and 31.

```rust
pub fn acc_set_fifo_mode(
    &mut self,
    mode: FifoMode,
    fth: u8,
) -> Result<(), Error<CommE>>
```

--------------------------------

### Magnetometer Operations

Source: https://docs.rs/crate/lsm303agr

Provides functions for reading magnetometer data, status, and configuring its settings.

```APIDOC
## Get the magnetometer status

### Description
Retrieves the status information for the magnetometer.

### Method
`mag_status()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let status = lsm.mag_status().unwrap();
```

### Response
#### Success Response
- **status** (enum/struct) - The status of the magnetometer.

#### Response Example
```rust
// Example status representation
```

## Change into continuous/one-shot mode

### Description
Switches the magnetometer between continuous measurement mode and one-shot measurement mode.

### Method
`into_mag_continuous()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **mode** (enum) - The desired mode for the magnetometer (Continuous or OneShot).

### Request Example
```rust
lsm.into_mag_continuous(lsm303agr::MagMode::Continuous).unwrap();
```

### Response
#### Success Response
Indicates successful mode change.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Read measured magnetic field

### Description
Reads the current magnetic field measurements from the magnetometer.

### Method
`magnetic_field()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let magnetic_field = lsm.magnetic_field().unwrap();
```

### Response
#### Success Response (200)
- **magnetic_field** (struct) - A structure containing the measured magnetic field values (x, y, z).

#### Response Example
```rust
// Example response structure (actual type may vary)
// MagneticField { x: 123, y: 456, z: 789 }
```

## Set magnetometer mode and output data rate

### Description
Configures the operating mode and output data rate for the magnetometer.

### Method
`set_mag_mode_and_odr()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **mode** (enum) - The desired operating mode for the magnetometer.
- **odr** (enum) - The desired output data rate for the magnetometer.

### Request Example
```rust
lsm.set_mag_mode_and_odr(lsm303agr::MagMode::Continuous, lsm303agr::MagOutputDataRate::Hz10).unwrap();
```

### Response
#### Success Response
Indicates successful configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Get magnetometer ID

### Description
Retrieves the device ID of the magnetometer.

### Method
`magnetometer_id()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let id = lsm.magnetometer_id().unwrap();
```

### Response
#### Success Response
- **id** (u8) - The device ID of the magnetometer.

#### Response Example
```rust
// Example ID: 0x03
```

## Enable/disable magnetometer built-in offset cancellation

### Description
Enables or disables the built-in offset cancellation feature for the magnetometer.

### Method
`enable_mag_offset_cancellation()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **enable** (bool) - `true` to enable, `false` to disable.

### Request Example
```rust
lsm.enable_mag_offset_cancellation(true).unwrap();
```

### Response
#### Success Response
Indicates successful configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Enable/disable magnetometer low-pass filter

### Description
Enables or disables the low-pass filter for the magnetometer.

### Method
`mag_enable_low_pass_filter()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **enable** (bool) - `true` to enable, `false` to disable.

### Request Example
```rust
lsm.mag_enable_low_pass_filter(true).unwrap();
```

### Response
#### Success Response
Indicates successful filter configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```
```

--------------------------------

### Get Unscaled Temperature Value

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Retrieves the unscaled integer representation of the temperature. This value may require further processing or scaling.

```rust
pub const fn unscaled(&self) -> i16
```

--------------------------------

### Status Struct Methods

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Provides methods to check the status of data availability and overrun for the X, Y, and Z axes.

```APIDOC
## Status Struct Methods

### Description
Provides methods to check the status of data availability and overrun for the X, Y, and Z axes.

### Methods

#### `x_new_data()`
Checks if new data is available for the X-axis.

- **Returns**: `bool` - `true` if new X-axis data is available, `false` otherwise.

#### `y_new_data()`
Checks if new data is available for the Y-axis.

- **Returns**: `bool` - `true` if new Y-axis data is available, `false` otherwise.

#### `z_new_data()`
Checks if new data is available for the Z-axis.

- **Returns**: `bool` - `true` if new Z-axis data is available, `false` otherwise.

#### `xyz_new_data()`
Checks if new data is available for the X, Y, and Z axes.

- **Returns**: `bool` - `true` if new data is available for all axes, `false` otherwise.

#### `x_overrun()`
Checks if the X-axis data has overrun.

- **Returns**: `bool` - `true` if X-axis data has overrun, `false` otherwise.

#### `y_overrun()`
Checks if the Y-axis data has overrun.

- **Returns**: `bool` - `true` if Y-axis data has overrun, `false` otherwise.

#### `z_overrun()`
Checks if the Z-axis data has overrun.

- **Returns**: `bool` - `true` if Z-axis data has overrun, `false` otherwise.

#### `xyz_overrun()`
Checks if the X, Y, and Z axes data have overrun.

- **Returns**: `bool` - `true` if data has overrun for all axes, `false` otherwise.
```

--------------------------------

### Compare TemperatureStatus for Equality

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.TemperatureStatus.html

Tests if two TemperatureStatus values are equal. This is part of the PartialEq trait implementation.

```rust
fn eq(&self, other: &TemperatureStatus) -> bool
```

--------------------------------

### PartialEq Implementation for Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Enables equality comparison between Status instances.

```rust
fn eq(&self, other: &Status) -> bool
```

```rust
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### Enable Magnetometer Low-Pass Filter

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Activates the low-pass filter for the magnetometer readings to reduce noise.

```rust
pub fn mag_enable_low_pass_filter(&mut self) -> Result<(), Error<CommE>>
```

--------------------------------

### Into MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Calls U::from(self) for conversion. This is a generic implementation for Into<U> for T where U: From<T>.

```rust
fn into(self) -> U
```

--------------------------------

### Compare MagOutputDataRate for Inequality

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Tests for inequality between two MagOutputDataRate values.

```rust
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### Borrow MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Immutably borrows the MagOutputDataRate.

```rust
fn borrow(&self) -> &T
```

--------------------------------

### Get Raw Accelerometer ID

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.AccelerometerId.html

Retrieves the raw 8-bit unsigned integer value of the accelerometer ID. This is useful for direct hardware interaction or debugging.

```rust
pub const fn raw(&self) -> u8
```

--------------------------------

### PartialEq Implementation for MagneticField

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Implements the PartialEq trait for MagneticField, enabling equality comparisons between MagneticField instances.

```rust
fn eq(&self, other: &MagneticField) -> bool
```

--------------------------------

### Clone From MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Performs copy-assignment from a source MagOutputDataRate.

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### TryInto MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Performs the conversion from T to U. The associated Error type is defined by U's TryFrom implementation.

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### Check Z-axis New Data Availability

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Use this method to determine if new data is available for the Z-axis.

```rust
pub const fn z_new_data(&self) -> bool
```

--------------------------------

### Borrow Mutably MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Mutably borrows the MagOutputDataRate.

```rust
fn borrow_mut(&mut self) -> &mut T
```

--------------------------------

### SpiInterface Write Operations

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.SpiInterface.html

Provides methods for writing data to the LSM303AGR sensor via SPI. This includes writing to individual accelerometer and magnetometer registers.

```APIDOC
## SpiInterface Write Operations

### Description
Methods for writing data to the LSM303AGR sensor via SPI.

### Methods
- `write_accel_register<R: RegWrite>( &mut self, reg: R, ) -> Result<(), Self::Error>`: Write to an u8 accelerometer register.
- `write_mag_register<R: RegWrite>(&mut self, reg: R) -> Result<(), Self::Error>`: Write to an u8 magnetometer register.

### Error Type
`Error<CommE>`: The error type for SPI communication, where `CommE` is the underlying SPI device error type.
```

--------------------------------

### Compare MagOutputDataRate for Equality

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Tests for equality between two MagOutputDataRate values.

```rust
fn eq(&self, other: &MagOutputDataRate) -> bool
```

--------------------------------

### Change Magnetometer to Continuous Mode

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Transitions the magnetometer from one-shot mode to continuous measurement mode. This operation may return an error if the mode change fails.

```rust
pub fn into_mag_continuous(self) -> Result<Lsm303agr<DI, MagContinuous>, ModeChangeError<CommE, Self>>
```

--------------------------------

### Check X-axis New Data Availability

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Use this method to determine if new data is available for the X-axis.

```rust
pub const fn x_new_data(&self) -> bool
```

--------------------------------

### Clone Implementation for Temperature

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Allows creating a duplicate of a Temperature value. This is a standard trait for data structures that can be copied.

```rust
fn clone(&self) -> Temperature
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### MagneticField Scaled (nT) Accessors

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

These methods provide access to the magnetic field measurements in nano-Tesla (nT) for each axis (X, Y, Z) and combined.

```APIDOC
## MagneticField Scaled (nT) Accessors

### Description
Provides access to the magnetic field measurements in nano-Tesla (nT) for each axis (X, Y, Z) and combined.

### Methods

- `x_nt()`: Returns the magnetic field in the X-direction in nT (nano-Tesla) as an i32.
- `y_nt()`: Returns the magnetic field in the Y-direction in nT (nano-Tesla) as an i32.
- `z_nt()`: Returns the magnetic field in the Z-direction in nT (nano-Tesla) as an i32.
- `xyz_nt()`: Returns a tuple `(i32, i32, i32)` representing the magnetic field in the X, Y, and Z directions in nT (nano-Tesla).
```

--------------------------------

### SpiInterface Read Operations

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.SpiInterface.html

Provides methods for reading data from the LSM303AGR sensor via SPI. This includes reading individual registers, double registers, and multiple double registers for both accelerometer and magnetometer.

```APIDOC
## SpiInterface Read Operations

### Description
Methods for reading data from the LSM303AGR sensor via SPI.

### Methods
- `read_accel_register<R: RegRead>(&mut self) -> Result<R::Output, Self::Error>`: Read an u8 accelerometer register.
- `read_mag_register<R: RegRead>(&mut self) -> Result<R::Output, Self::Error>`: Read an u8 magnetometer register.
- `read_accel_double_register<R: RegRead<u16>>( &mut self, ) -> Result<R::Output, Self::Error>`: Read an u16 accelerometer register.
- `read_accel_3_double_registers<R: RegRead<(u16, u16, u16)>>( &mut self, ) -> Result<R::Output, Self::Error>`: Read 3 u16 accelerometer registers.
- `read_mag_3_double_registers<R: RegRead<(u16, u16, u16)>>( &mut self, ) -> Result<R::Output, Self::Error>`: Read 3 u16 magnetometer registers.

### Error Type
`Error<CommE>`: The error type for SPI communication, where `CommE` is the underlying SPI device error type.
```

--------------------------------

### Set Accelerometer Mode and ODR

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Configures the accelerometer's power/resolution mode and output data rate. Uses a provided delay to manage sensor warm-up times. Returns an error if the mode and ODR are incompatible.

```rust
pub fn set_accel_mode_and_odr<D: DelayNs>(
    &mut self,
    delay: &mut D,
    mode: AccelMode,
    odr: impl Into<Option<AccelOutputDataRate>>,
) -> Result<(), Error<CommE>>
```

--------------------------------

### Check for New Temperature Data Availability

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.TemperatureStatus.html

Checks if new temperature data is available. This method is const and takes an immutable reference to self.

```rust
pub const fn new_data(&self) -> bool
```

--------------------------------

### Read Magnetometer Data

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.I2cInterface.html

Provides methods to read magnetometer data, including single 8-bit registers and multiple 16-bit registers.

```APIDOC
## Read Magnetometer Data

### Description
Methods for reading magnetometer data from an I2C interface.

### Methods

#### `read_mag_register<R: RegRead>(&mut self) -> Result<R::Output, Self::Error>`
Reads a single 8-bit magnetometer register.

#### `read_mag_3_double_registers<R: RegRead<(u16, u16, u16)>>(&mut self) -> Result<R::Output, Self::Error>`
Reads three 16-bit magnetometer registers.

### Error Type
`Error<E>` where `E` is the underlying I2C error type.
```

--------------------------------

### Clone Implementation for Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Provides a way to create a duplicate of a Status value.

```rust
fn clone(&self) -> Status
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Accelerometer Operations

Source: https://docs.rs/crate/lsm303agr

Provides functions for reading accelerometer data, status, and configuring its settings.

```APIDOC
## Read measured acceleration

### Description
Reads the current acceleration measurements from the accelerometer.

### Method
`acceleration()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let acceleration = lsm.acceleration().unwrap();
```

### Response
#### Success Response (200)
- **acceleration** (struct) - A structure containing the measured acceleration values (x, y, z).

#### Response Example
```rust
// Example response structure (actual type may vary)
// Acceleration { x: 123, y: 456, z: 789 }
```

## Get accelerometer status

### Description
Retrieves the status information for the accelerometer.

### Method
`accel_status()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let status = lsm.accel_status().unwrap();
```

### Response
#### Success Response
- **status** (enum/struct) - The status of the accelerometer.

#### Response Example
```rust
// Example status representation
```

## Set accelerometer mode and output data rate

### Description
Configures the operating mode and output data rate for the accelerometer.

### Method
`set_accel_mode_and_odr()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **mode** (enum) - The desired operating mode for the accelerometer.
- **odr** (enum) - The desired output data rate for the accelerometer.

### Request Example
```rust
lsm.set_accel_mode_and_odr(lsm303agr::AccelMode::Normal, lsm303agr::AccelOutputDataRate::Hz50).unwrap();
```

### Response
#### Success Response
Indicates successful configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Set accelerometer scale

### Description
Sets the full-scale range for the accelerometer.

### Method
`set_accel_scale()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **scale** (enum) - The desired full-scale range for the accelerometer.

### Request Example
```rust
lsm.set_accel_scale(lsm303agr::AccelScale::G16).unwrap();
```

### Response
#### Success Response
Indicates successful scale configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Get accelerometer ID

### Description
Retrieves the device ID of the accelerometer.

### Method
`accelerometer_id()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let id = lsm.accelerometer_id().unwrap();
```

### Response
#### Success Response
- **id** (u8) - The device ID of the accelerometer.

#### Response Example
```rust
// Example ID: 0x0F
```

## Get temperature sensor status

### Description
Retrieves the status information for the temperature sensor.

### Method
`temperature_status()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let status = lsm.temperature_status().unwrap();
```

### Response
#### Success Response
- **status** (enum/struct) - The status of the temperature sensor.

#### Response Example
```rust
// Example status representation
```

## Read measured temperature

### Description
Reads the current temperature measurement.

### Method
`temperature()`

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```rust
let temperature = lsm.temperature().unwrap();
```

### Response
#### Success Response
- **temperature** (i16) - The measured temperature value.

#### Response Example
```rust
// Example temperature value: 250 (representing 25.0 degrees Celsius)
```

## Configure FIFO

### Description
Configures the First-In, First-Out (FIFO) buffer for the accelerometer.

### Method
`acc_set_fifo_mode()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **mode** (enum) - The desired FIFO mode.

### Request Example
```rust
lsm.acc_set_fifo_mode(lsm303agr::FifoMode::Stream).unwrap();
```

### Response
#### Success Response
Indicates successful FIFO configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```

## Enable/disable interrupts

### Description
Enables or disables interrupt generation for specific accelerometer events.

### Method
`acc_enable_interrupt()`

### Endpoint
N/A (SDK method)

### Parameters
#### Request Body
- **interrupt** (enum) - The type of interrupt to enable/disable.
- **enable** (bool) - `true` to enable, `false` to disable.

### Request Example
```rust
lsm.acc_enable_interrupt(lsm303agr::Interrupt::FreeFall, true).unwrap();
```

### Response
#### Success Response
Indicates successful interrupt configuration.

#### Response Example
```rust
// Success is indicated by the absence of an error.
```
```

--------------------------------

### enable_mag_offset_cancellation (OneShot Mode)

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Enables the magnetometer's offset cancellation in single measurement (OneShot) mode. This requires the user to manage offset cancellation by averaging two consecutive measurements.

```APIDOC
## enable_mag_offset_cancellation (OneShot Mode)

### Description
Enable the magnetometer’s built in offset cancellation.
Offset cancellation has to be **managed by the user** in **single measurement** (OneShot) mode averaging two consecutive measurements Hn and Hn-1.
To later disable offset cancellation, use the `disable_mag_offset_cancellation` function

### Returns
- Result<(), Error<CommE>> - Ok(()) on success, or an Error<CommE> on failure.
```

--------------------------------

### StructuralPartialEq Trait Implementation for Temperature

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

A trait related to structural equality, often used in generic contexts.

```rust
impl StructuralPartialEq for Temperature
```

--------------------------------

### Clone Acceleration Struct

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Acceleration.html

Returns a duplicate of the Acceleration value. This is a standard implementation for the Clone trait.

```rust
fn clone(&self) -> Acceleration
```

--------------------------------

### Auto Trait Implementations for Temperature

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Lists various auto-implemented traits for the Temperature struct, indicating thread safety and memory management characteristics.

```rust
impl Freeze for Temperature
```

```rust
impl RefUnwindSafe for Temperature
```

```rust
impl Send for Temperature
```

```rust
impl Sync for Temperature
```

```rust
impl Unpin for Temperature
```

```rust
impl UnwindSafe for Temperature
```

--------------------------------

### Write Magnetometer Data

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.I2cInterface.html

Provides a method to write data to a magnetometer register.

```APIDOC
## Write Magnetometer Data

### Description
Method for writing data to a magnetometer register via an I2C interface.

### Method

#### `write_mag_register<R: RegWrite>(&mut self, reg: R) -> Result<(), Self::Error>`
Writes to a single 8-bit magnetometer register.

### Error Type
`Error<E>` where `E` is the underlying I2C error type.
```

--------------------------------

### TryFrom MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Performs the conversion from U to T. The associated Error type is Infallible.

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

--------------------------------

### Read Magnetometer Register

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.SpiInterface.html

Reads an 8-bit register from the magnetometer. Requires the SPIMAG device to implement SpiDevice and the register to implement RegRead.

```rust
fn read_mag_register<R: RegRead>(&mut self) -> Result<R::Output, Self::Error>
```

--------------------------------

### Convert Temperature to Degrees Celsius

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Temperature.html

Converts the temperature measurement to a floating-point value representing degrees Celsius. This provides a human-readable temperature.

```rust
pub fn degrees_celsius(&self) -> f32
```

--------------------------------

### Default Implementation for Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Provides a default value for the Status struct.

```rust
fn default() -> Status
```

--------------------------------

### Clone MagOutputDataRate

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.MagOutputDataRate.html

Returns a duplicate of the MagOutputDataRate value.

```rust
fn clone(&self) -> MagOutputDataRate
```

--------------------------------

### StructuralPartialEq Trait Implementation for MagneticField

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.MagneticField.html

Indicates that MagneticField implements the StructuralPartialEq trait.

```rust
impl StructuralPartialEq for MagneticField
```

--------------------------------

### Auto Trait Implementations for Status

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Lists auto trait implementations for Status, including Freeze, RefUnwindSafe, Send, Sync, Unpin, and UnwindSafe.

```rust
impl Freeze for Status
```

```rust
impl RefUnwindSafe for Status
```

```rust
impl Send for Status
```

```rust
impl Sync for Status
```

```rust
impl Unpin for Status
```

```rust
impl UnwindSafe for Status
```

--------------------------------

### Status Struct Definition

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Defines the Status struct used for tracking sensor data status. It has private fields.

```rust
pub struct Status {
    /* private fields */ 
}
```

--------------------------------

### Compare AccelOutputDataRate for Equality

Source: https://docs.rs/lsm303agr/latest/lsm303agr/enum.AccelOutputDataRate.html

Tests if two AccelOutputDataRate enum variants are equal. This is part of the PartialEq trait implementation.

```rust
fn eq(&self, other: &AccelOutputDataRate) -> bool
```

--------------------------------

### Check Y-axis New Data Availability

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Status.html

Use this method to determine if new data is available for the Y-axis.

```rust
pub const fn y_new_data(&self) -> bool
```

--------------------------------

### Write Magnetometer Register

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.SpiInterface.html

Writes to an 8-bit magnetometer register. Requires the SPIMAG device to implement SpiDevice and the register to implement RegWrite.

```rust
fn write_mag_register<R: RegWrite>(&mut self, reg: R) -> Result<(), Self::Error>
```

--------------------------------

### Read 3 Magnetometer Double Registers

Source: https://docs.rs/lsm303agr/latest/lsm303agr/interface/struct.SpiInterface.html

Reads three 16-bit registers (triple double) from the magnetometer. Requires the SPIMAG device to implement SpiDevice and the register to implement RegRead.

```rust
fn read_mag_3_double_registers<R: RegRead<(u16, u16, u16)>>( &mut self, ) -> Result<R::Output, Self::Error>
```

--------------------------------

### enable_mag_offset_cancellation (Continuous Mode)

Source: https://docs.rs/lsm303agr/latest/lsm303agr/struct.Lsm303agr.html

Enables the magnetometer's built-in offset cancellation feature. In continuous mode, this is managed automatically by the device.

```APIDOC
## enable_mag_offset_cancellation (Continuous Mode)

### Description
Enable the magnetometer’s built in offset cancellation.
Offset cancellation is **automatically** managed by the device in **continuous** mode.
To later disable offset cancellation, use the `disable_mag_offset_cancellation` function

### Returns
- Result<(), Error<CommE>> - Ok(()) on success, or an Error<CommE> on failure.
```
Tokens:
Raw