NeoBirth / accelerometer.rs

Generic Rust accelerometer support, including traits and types for taking readings from 2 or 3-axis accelerometers
Apache License 2.0
26 stars 10 forks source link

accelerometer.rs

Crate Docs Build Status Safety Dance MSRV LGPL 3.0 licensed Gitter Chat

Generic Rust accelerometer support, including traits and types for taking readings from 2 or 3-axis accelerometers, intended for use with platform-agnostic accelerometer drivers written using embedded-hal.

Uses no_std-oriented 2D and 3D vector types from the micromath.rs crate.

Additionally includes support for tracking device orientations using accelerometer data.

Documentation

Requirements

Supported Crates

The following dependent crates providing platform-agnostic accelerometer drivers built on embedded-hal which also implement the Accelerometer and/or the RawAccelerometer traits from this crate:

Device Name Description Crate + Docs
ADXL313 Analog Devices 3-axis accelerometer crates.io docs.rs
ADXL343 Analog Devices 3-axis accelerometer crates.io docs.rs
ADXL355 Analog Devices 3-axis accelerometer crates.io docs.rs
LIS2DH12 ST 3-Axis MEMS Accelerometer crates.io docs.rs
LIS3DH High Performance ST 3-Axis MEMS "nano" Accelerometer crates.io docs.rs
MMA7660FC Grove 3-Axis Digital Accelerometer crates.io docs.rs
STK8BA58 SENSORTEK 3-Axis MEMS Accelerometer crates.io docs.rs
KXTJ31057 Silicon Micromachined 3-axis accelerometer crates.io docs.rs

Orientation Tracking (3-axis accelerometers only)

ezgif-1-16e98d9b86ad

One of the main features of this crate is device orientation tracking for 3-axis accelerometers, which is gated under the orientation cargo feature (enabled-by-default). This provides smartphone-like device position sensing using an accelerometer alone, returned as one of the variants of the accelerometer::Orientation enum.

See the accelerometer::Tracker documentation for more information.

Code of Conduct

We abide by the Contributor Covenant and ask that you do as well.

For more information, please see CODE_OF_CONDUCT.md.

License

Copyright © 2019-2020 NeoBirth Developers

Dual licensed under your choice of either of: