Struct kxcj9::Kxcj9

pub struct Kxcj9<I2C, IC> { /* fields omitted */ }

KXCJ9/KXCJB device driver

Methods

impl<I2C, E> Kxcj9<I2C, G8Device> where
    I2C: WriteRead<Error = E> + Write<Error = E>, 

pub fn new_kxcj9_1008(i2c: I2C, address: SlaveAddr) -> Self

Create new instance of the KXCJ9-1008 device.

pub fn new_kxcjb_1041(i2c: I2C, address: SlaveAddr) -> Self

Create new instance of the KXCJB-1041 device.

impl<I2C, E> Kxcj9<I2C, G16Device> where
    I2C: WriteRead<Error = E> + Write<Error = E>, 

pub fn new_kxcj9_1018(i2c: I2C, address: SlaveAddr) -> Self

Create new instance of the KXCJ9-1018 device.

impl<I2C, E, IC> Kxcj9<I2C, IC> where
    I2C: WriteRead<Error = E> + Write<Error = E>, 

pub fn destroy(self) -> I2C

Destroy driver instance, return I²C bus instance.

pub fn enable(&mut self) -> Result<(), Error<E>>

Enable the device (starts taking measurements).

pub fn disable(&mut self) -> Result<(), Error<E>>

Disable the device.

impl<I2C, E, IC> Kxcj9<I2C, IC> where
    I2C: WriteRead<Error = E> + Write<Error = E>,
    IC: ScaledDevice, 

pub fn read(&mut self) -> Result<Measurement, Error<E>>

Read acceleration sensor data scaled to the configured G range.

impl<I2C, E, IC> Kxcj9<I2C, IC> where
    I2C: WriteRead<Error = E> + Write<Error = E>,
    IC: ScaledDevice, 

pub fn read_unscaled(&mut self) -> Result<UnscaledMeasurement, Error<E>>

Read unscaled acceleration sensor data.

pub fn who_am_i(&mut self) -> Result<u8, Error<E>>

Read the WHO_AM_I register. Depending on the device this should return:

• 0x0A for KXCJ9-1008
• 0x1D for KXCJ9-1018
• 0x21 for KXCJB-1041

pub fn set_resolution(&mut self, resolution: Resolution) -> Result<(), Error<E>>

Set resolution.

Returns Err(Error::InvalidSetting) if setting Resolution::Low but the configured output data rate is greater or equal to 400 Hz.

pub fn set_output_data_rate(
    &mut self,
    odr: OutputDataRate
) -> Result<(), Error<E>>

Set output data rate.

Setting a rate higher than or equal to 400Hz sets the resolution to high.

pub fn enable_data_ready_interrupt(&mut self) -> Result<(), Error<E>>

Enable new acceleration data ready interrupt.

pub fn disable_data_ready_interrupt(&mut self) -> Result<(), Error<E>>

Disable new acceleration data ready interrupt.

pub fn enable_wake_up_interrupt(
    &mut self,
    config: WakeUpInterruptConfig
) -> Result<(), Error<E>>

Configure and enable wake-up motion detected interrupt.

pub fn disable_wake_up_interrupt(&mut self) -> Result<(), Error<E>>

Disable wake-up motion detected interrupt.

pub fn enable_interrupt_pin(&mut self) -> Result<(), Error<E>>

Enable physical interrupt pin.

pub fn disable_interrupt_pin(&mut self) -> Result<(), Error<E>>

Disable physical interrupt pin.

pub fn set_interrupt_pin_polarity(
    &mut self,
    polarity: InterruptPinPolarity
) -> Result<(), Error<E>>

Set physical interrupt pin polarity.

pub fn set_interrupt_pin_latching(
    &mut self,
    latching: InterruptPinLatching
) -> Result<(), Error<E>>

Set physical interrupt pin latching behavior.

pub fn has_interrupt_happened(&mut self) -> Result<bool, Error<E>>

Check if any interrupt has happened.

pub fn read_interrupt_info(&mut self) -> Result<InterruptInfo, Error<E>>

Read interrupt source information.

pub fn clear_interrupts(&mut self) -> Result<(), Error<E>>

Clear interrupts.

This clears all interrupt source registers and changes the physical interrupt pin to its inactive state.

pub fn reset(&mut self) -> Result<(), Error<E>>

Perform software reset.

This method offers a non-blocking interface. While the reset is in progress and when the reset was first triggered this will return nb::Error::WouldBlock.

pub fn communication_self_test(&mut self) -> Result<(), Error<E>>

Perform a digital communication self-test.

pub fn enable_mems_self_test(&mut self) -> Result<(), Error<E>>

Enable the MEMS self-test function.

pub fn disable_mems_self_test(&mut self) -> Result<(), Error<E>>

Disable the MEMS self-test function.

impl<I2C, E> Kxcj9<I2C, G16Device> where
    I2C: WriteRead<Error = E> + Write<Error = E>, 

pub fn set_scale(&mut self, scale: GScale16) -> Result<(), Error<E>>

Set G scale.

impl<I2C, E> Kxcj9<I2C, G8Device> where
    I2C: WriteRead<Error = E> + Write<Error = E>, 

pub fn set_scale(&mut self, scale: GScale8) -> Result<(), Error<E>>

Set G scale.

Trait Implementations

impl<I2C: Debug, IC: Debug> Debug for Kxcj9<I2C, IC>

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

Formats the value using the given formatter.