Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eldruin/max3010x-rs
Platform agnostic Rust driver for the MAX3010x high-sensitivity pulse oximeter and heart-rate sensor for wearable health
https://github.com/eldruin/max3010x-rs
embedded embedded-hal embedded-hal-driver health heart-rate no-std oximeter rust sensor spi spo2 wearable
Last synced: 12 days ago
JSON representation
Platform agnostic Rust driver for the MAX3010x high-sensitivity pulse oximeter and heart-rate sensor for wearable health
- Host: GitHub
- URL: https://github.com/eldruin/max3010x-rs
- Owner: eldruin
- License: apache-2.0
- Created: 2019-02-20T18:47:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-06T21:31:18.000Z (over 3 years ago)
- Last Synced: 2024-10-16T05:28:59.335Z (23 days ago)
- Topics: embedded, embedded-hal, embedded-hal-driver, health, heart-rate, no-std, oximeter, rust, sensor, spi, spo2, wearable
- Language: Rust
- Homepage:
- Size: 104 KB
- Stars: 13
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Rust MAX3010x High-Sensitivity Pulse Oximeter and Heart-Rate Sensor for Wearable Health Driver
[](https://crates.io/crates/max3010x)
[](https://docs.rs/max3010x)
[](https://github.com/eldruin/max3010x-rs/actions?query=workflow%3ABuild)
[](https://coveralls.io/github/eldruin/max3010x-rs?branch=master)
This is a platform agnostic Rust driver for the MAX3010x high-sensitivity
pulse oximeter and heart-rate sensor for wearable health, based on the
[`embedded-hal`](https://github.com/rust-embedded/embedded-hal) traits.
This driver allows you to:
- Get the number of samples available on the FIFO. See `get_available_sample_count()`.
- Get the number of samples lost from the FIFO. See `get_overflow_sample_count()`.
- Read samples from the FIFO. See `read_fifo()`.
- Perform a temperature measurement. See `read_temperature()`.
- Change into heart-rate, oximeter or multi-LED modes. See `into_multi_led()`.
- Set the sample averaging. See `set_sample_averaging()`.
- Set the LED pulse amplitude. See `set_pulse_amplitude()`.
- Set the LED pulse width. See `set_pulse_width()`.
- Set the sampling rate. See `set_sampling_rate()`.
- Set the ADC range. See `set_adc_range()`.
- Set the LED time slots in multi-LED mode. `set_led_time_slots()`.
- Enable/disable the FIFO rollover. See `enable_fifo_rollover()`.
- Clear the FIFO. See `clear_fifo()`.
- Wake-up and shutdown the device. See `shutdown()`.
- Perform a software reset. See `reset()`.
- Get the device part and revision id. See `get_part_id()`.
- Interrupts:
- Read the status of all interrupts. See `read_interrupt_status()`.
- Set FIFO-almost-full level interrupt. See `set_fifo_almost_full_level_interrupt()`.
- Enable/disable the FIFO-almost-full interrupt. See `enable_fifo_almost_full_interrupt()`.
- Enable/disable the ambient-light-cancellation overflow interrupt. See `enable_alc_overflow_interrupt()`.
- Enable/disable the temperature-ready interrupt. See `enable_temperature_ready_interrupt()`.
- Enable/disable the new-FIFO-data-ready interrupt. See `enable_new_fifo_data_ready_interrupt()`.
## The device
The MAX30102 is an integrated pulse oximetry and heart-rate monitor module.
It includes internal LEDs, photodetectors, optical elements, and low-noise
electronics with ambient light rejection. The MAX30102 provides a complete
system solution to ease the design-in process for mobile and
wearable devices.
The MAX30102 operates on a single 1.8V power supply and a separate 3.3V
power supply for the internal LEDs. Communication is through a standard
I2C-compatible interface. The module can be shut down through software
with zero standby current, allowing the power rails to remain
powered at all times.
Datasheet:
- [MAX30102](https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf)
This driver should be compatible at least with the devices: MAX30102.
### Usage
Please find additional examples using hardware in this repository: [driver-examples]
[driver-examples]: https://github.com/eldruin/driver-examples
```rust
extern crate linux_embedded_hal as hal;
extern crate max3010x;
use max3010x::{Max3010x, Led, SampleAveraging};
fn main() {
let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Max3010x::new_max30102(dev);
let mut sensor = sensor.into_heart_rate().unwrap();
sensor.set_sample_averaging(SampleAveraging::Sa4).unwrap();
sensor.set_pulse_amplitude(Led::All, 15).unwrap();
sensor.enable_fifo_rollover().unwrap();
let mut data = [0; 3];
let samples_read = sensor.read_fifo(&mut data).unwrap();
// get the I2C device back
let dev = sensor.destroy();
}
```
## Status
- [x] Compatibility with MAX30102
- [ ] Compatibility with MAX30101
- [ ] Compatibility with MAX30105
## Support
For questions, issues, feature requests, and other changes, please file an
[issue in the github project](https://github.com/eldruin/max3010x-rs/issues).
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](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.