ism330dhcx

Crates.ioism330dhcx
lib.rsism330dhcx
version0.6.0
sourcesrc
created_at2021-02-14 02:08:49.403355
updated_at2024-06-05 18:28:38.477076
descriptionSimple driver for ST ism330dhcx sensor
homepage
repositoryhttps://github.com/sousandrei/ism330dhcx
max_upload_size
id354917
size51,561
Andrei Sousa (sousandrei)

documentation

https://docs.rs/ism330dhcx

README

Build Status Docs.rs Crates.io

Table of Contents

About the Project 📃

This is a simple driver for ST's ism330dhcx sensor.

Documentation for that sensor can be found at ST's website

Usage 👀

Check out the examples folder for simple implementation

To declare a sensor is pretty simple:

let sensor = Ism330Dhcx::new(&mut i2c).unwrap()

If you want to use another address for the chip, you can do:

let sensor = Ism330Dhcx::new_with_address(&mut i2c, 0x6au8).unwrap()

Or alter it after the fact

sensor.set_address(0x6au8);

All registers have the bits addressed by their function, for example here se set the BOOT register in the CTRL_3C register to 1

sensor.ctrl3c.set_boot(i2c, true).unwrap();

For bits that operate together, they have their custom type abstracted. For example, to set the accelerometer data rate you have to operate 4 bits. But here you just have to specify your desired data rate and the driver takes care of it.

// Sets the following bits
// ODR_XL3 to 0
// ODR_XL2 to 0
// ODR_XL1 to 1
// ODR_XL0 to 1

sensor
    .ctrl1xl
    .set_accelerometer_data_rate(i2c, ctrl1xl::Odr_Xl::Hz52)
    .unwrap();

Help wanted 🤝

All contributions are welcome!

If you are using or plan to use this create don't hesitate to open an issue or a PR.

Multiple registers are yet to be referenced!

License

See LICENSE for more details.

Commit count: 107

cargo fmt