Rust KXCJ9/KXCJB Ultra-Low-Power Tri-Axis Accelerometer Driver

This is a platform agnostic Rust driver for the KXCJ9 and KXCJB ultra-low-power tri-axis accelerometers (up to +/-16g) using the embedded-hal traits.

This driver allows you to:

• Enable/disable the device. See enable().
• Read the acceleration measurement. See read().
• Read the unscaled acceleration measurement. See read_unscaled().
• Set resolution. See set_resolution().
• Set output data rate. See set_output_data_rate().
• Set +/- G range. See set_scale().
• Read WHO_AM_I register. See who_am_i().
• Perform a software reset. See reset().
• Run a communication self-test. See communication_self_test().
• Enable/disable MEMS self-test function. See enable_mems_self_test().
• Interrupt support:
  • Enable/disable new acceleration data ready interrupt. See enable_data_ready_interrupt().
  • Enable/disable and configure wake-up motion detected interrupt. See enable_wake_up_interrupt().
  • Enable/disable physical interrupt pin. See enable_interrupt_pin().
  • Set physical interrupt pin polarity. See set_interrupt_pin_polarity().
  • Set physical interrupt pin latching behavior. See set_interrupt_pin_latching().
  • Check if any interrupt has happened. See has_interrupt_happened().
  • Clear interrupts. See clear_interrupts().
  • Read interrupt source information. See read_interrupt_info().

Introductory blog post

The devices

The KXCJ9 is a high-performance, ultra-low-power, tri-axis accelerometer designed for mobile applications. It offers our best power performance along with an embedded wake-up feature, Fast-mode I²C and up to 14-bit resolution. The KXCJ9 sensor offers improved shock, reflow, and temperature performance, and the ASIC has internal voltage regulators that allow operation from 1.8 V to 3.6 V within the specified product performance.

The KXCJB is the thinnest tri-axis accelerometer available on the market today. This ultra-thin 3x3x0.45mm low-power accelerometer is also one of our most full-featured products. The KXCJB offers up to 14-bit resolution for greater precision. User-selectable parameters include ± 2g, 4g or 8g ranges and Output Data Rates (ODR) with programmable low-pass filter. The KXCJB also features the Kionix XAC sense element, our most advanced sense element, for outstanding stability over temperature, shock and post-reflow performance.

The communication is done through an I2C bidirectional bus.

Datasheets:

• KXCJ9-1008
• KXCJ9-1018
• KXCJB-1041

Application Note:

• Getting started with the KXCJ9 and KXCJB

Usage

To use this driver, import this crate and an embedded_hal implementation, then instantiate the appropriate device.

Please find additional examples using hardware in this repository: driver-examples

extern crate kxcj9;
extern crate linux_embedded_hal as hal;
use kxcj9::{Kxcj9, SlaveAddr};

fn main() {
    let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
    let address =  SlaveAddr::default();
    let mut sensor = Kxcj9::new_kxcj9_1018(dev, address);
    sensor.enable().unwrap();
    loop {
      let acc = sensor.read().unwrap();
      println!("X: {:2}, Y: {:2}, Z: {:2}", acc.x, acc.y, acc.z);
    }
}

Support

For questions, issues, feature requests, and other changes, please file an issue in the github project.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.