accelerometer.rs

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

• Rust 1.31+

Supported Crates

The following dependent crates providing platform-agnostic accelerometer drivers built on embedded-hal which also implement this crate's [Accelerometer] trait:

| Device Name | Description | Crate + Docs | |-------------|-------------|--------------| | [ADXL343] | Analog Devices 3-axis accelerometer | | | [LIS2DH12] | ST 3-Axis MEMS Accelerometer | | | [MMA7660FC] | Grove 3-Axis Digital Accelerometer | |

Orientation Tracking (3-axis accelerometers only)

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 [CODEOFCONDUCT.md].

License

Copyright © 2019 NeoBirth Developers

Dual licensed under your choice of 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)