Struct lsm303agr::Lsm303agr

pub struct Lsm303agr<DI, MODE> { /* fields omitted */ }

LSM303AGR device driver

Implementations

impl<DI, CommE, PinE, MODE> Lsm303agr<DI, MODE> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

pub fn set_accel_odr(
    &mut self,
    odr: AccelOutputDataRate
) -> Result<(), Error<CommE, PinE>>

Set accelerometer output data rate.

This changes the power mode if the current one is not appropriate. When changing from a low-power-only output data rate setting into a high-resolution or normal power mode, it changes into normal mode.

pub fn set_accel_mode(
    &mut self,
    mode: AccelMode
) -> Result<(), Error<CommE, PinE>>

Set accelerometer power/resolution mode

Returns Error::InvalidInputData if the mode is incompatible with the current accelerometer output data rate.

pub fn get_accel_mode(&mut self) -> AccelMode

Get the accelerometer mode

pub fn set_accel_scale(
    &mut self,
    scale: AccelScale
) -> Result<(), Error<CommE, PinE>>

Set accelerometer scaling factor

This changes the scale at which the acceleration is read. AccelScale::G2 for example can return values between -2g and +2g where g is the gravity of the earth (~9.82 m/s²).

pub fn get_accel_scale(&self) -> AccelScale

Get accelerometer scaling factor

impl<I2C> Lsm303agr<I2cInterface<I2C>, MagOneShot>

pub fn new_with_i2c(i2c: I2C) -> Self

Create new instance of the LSM303AGR device communicating through I2C.

impl<I2C, MODE> Lsm303agr<I2cInterface<I2C>, MODE>

pub fn destroy(self) -> I2C

Destroy driver instance, return I2C bus.

impl<SPI, CSXL, CSMAG> Lsm303agr<SpiInterface<SPI, CSXL, CSMAG>, MagOneShot>

pub fn new_with_spi(
    spi: SPI,
    chip_select_accel: CSXL,
    chip_select_mag: CSMAG
) -> Self

Create new instance of the LSM303AGR device communicating through SPI.

impl<SPI, CSXL, CSMAG, MODE> Lsm303agr<SpiInterface<SPI, CSXL, CSMAG>, MODE>

pub fn destroy(self) -> (SPI, CSXL, CSMAG)

Destroy driver instance, return SPI bus instance and chip select pin.

impl<DI, CommE, PinE, MODE> Lsm303agr<DI, MODE> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

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

Initialize registers

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

Accelerometer status

pub fn accel_data(&mut self) -> Result<Measurement, Error<CommE, PinE>>

Accelerometer data

Returned in mg (milli-g) where 1g is 9.8m/s².

If you need the raw unscaled measurement see Lsm303agr::accel_data_unscaled.

pub fn accel_data_unscaled(
    &mut self
) -> Result<UnscaledMeasurement, Error<CommE, PinE>>

Unscaled accelerometer data

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

Magnetometer status

pub fn accelerometer_id(&mut self) -> Result<u8, Error<CommE, PinE>>

Get accelerometer device ID

pub fn accelerometer_is_detected(&mut self) -> Result<bool, Error<CommE, PinE>>

Read and verify the accelerometer device ID

pub fn magnetometer_id(&mut self) -> Result<u8, Error<CommE, PinE>>

Get magnetometer device ID

pub fn magnetometer_is_detected(&mut self) -> Result<bool, Error<CommE, PinE>>

Read and verify the magnetometer device ID

impl<DI, CommE, PinE> Lsm303agr<DI, MagOneShot> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

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

Change the magnetometer to continuous measurement mode

impl<DI, CommE, PinE> Lsm303agr<DI, MagContinuous> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

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

Change the magnetometer to one-shot mode

After this the magnetometer is in idle mode until a one-shot measurement is started.

impl<DI, CommE, PinE, MODE> Lsm303agr<DI, MODE> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

pub fn set_mag_odr(
    &mut self,
    odr: MagOutputDataRate
) -> Result<(), Error<CommE, PinE>>

Set magnetometer output data rate

impl<DI, CommE, PinE> Lsm303agr<DI, MagContinuous> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

pub fn mag_data(&mut self) -> Result<Measurement, Error<CommE, PinE>>

Magnetometer data

Returned in nT (nanotesla)

If you need the raw unscaled measurement see Lsm303agr::mag_data_unscaled.

pub fn mag_data_unscaled(
    &mut self
) -> Result<UnscaledMeasurement, Error<CommE, PinE>>

Unscaled magnetometer data

impl<DI, CommE, PinE> Lsm303agr<DI, MagOneShot> where
    DI: ReadData<Error = Error<CommE, PinE>> + WriteData<Error = Error<CommE, PinE>>, 

pub fn mag_data(&mut self) -> Result<Measurement, Error<CommE, PinE>>

Magnetometer data in nT (nanoteslas)

pub fn mag_data_unscaled(
    &mut self
) -> Result<UnscaledMeasurement, Error<CommE, PinE>>

Unscaled magnetometer data

Trait Implementations

impl<DI: Debug, MODE: Debug> Debug for Lsm303agr<DI, MODE>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.