Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eldruin/isl29125-rs
Platform-agnostic Rust driver for the ISL29125 low-power digital RGB color light sensor with IR blocking filter
https://github.com/eldruin/isl29125-rs
color driver embedded-hal-driver i2c ir light rgb rust sensor
Last synced: 18 days ago
JSON representation
Platform-agnostic Rust driver for the ISL29125 low-power digital RGB color light sensor with IR blocking filter
- Host: GitHub
- URL: https://github.com/eldruin/isl29125-rs
- Owner: eldruin
- License: apache-2.0
- Created: 2020-04-05T09:23:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-27T13:45:40.000Z (over 3 years ago)
- Last Synced: 2024-10-16T05:28:54.718Z (3 months ago)
- Topics: color, driver, embedded-hal-driver, i2c, ir, light, rgb, rust, sensor
- Language: Rust
- Size: 49.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Rust ISL29125 Digital RGB Color Light Sensor with IR Blocking Filter Driver
[](https://crates.io/crates/isl29125)
[](https://docs.rs/isl29125)
[](https://github.com/eldruin/isl29125-rs/actions?query=workflow%3ABuild)
[](https://coveralls.io/github/eldruin/isl29125-rs?branch=master)
This is a platform agnostic Rust driver for the low-power digital RGB color
light sensor with IR blocking filter using the [`embedded-hal`] traits.
This driver allows you to:
- Read all colors. See: `read()`.
- Read red/green/blue colors individually. See: `red()`.
- Set operating mode. See: `set_operating_mode()`.
- Set ADC resolution. See: `set_resolution()`.
- Set RGB data sensing range. See: `set_range()`.
- Set IR filtering. See: `set_ir_filtering()`.
- Read the status flags. See: `status()`.
- Clear the status flags. See: `clear_status()`.
- Read the device ID. See: `device_id()`.
- Perform a software reset. See: `reset()`.
- Interrupts:
- Set interrupt thresholds. See: `set_interrupt_thresholds()`.
- Set interrupt threshold assignment. See: `set_interrupt_threshold_assignment()`.
- Set the fault count. See: `set_fault_count()`.
- Set interrupt pin mode. See: `set_interrupt_pin_mode()`.
- Enable/Disable generating an interrupt after a conversion is done. See: `enable_interrupt_on_conversion_done()`.
## The device
The ISL29125 is a low power, high sensitivity, RED, GREEN and BLUE color
light sensor (RGB) with an I2C (SMBus compatible) interface. Its
state-of-the-art photodiode array provides an accurate RGB spectral
response and excellent light source to light source variation (LS2LS).
The ISL29125 is designed to reject IR in light sources allowing the device
to operate in environments from sunlight to dark rooms. The integrating
ADC rejects 50Hz and 60Hz flicker caused by artificial light sources.
A selectable range allows the user to optimize sensitivity suitable for
the specific application. In normal operation mode the device consumes
56μA, which reduces to 0.5μA in power-down mode.
The ISL29125 supports hardware and software user programmable interrupt
thresholds. The Interrupt persistency feature reduces false trigger
notification.
Datasheet: [ISL29125](https://www.renesas.com/eu/en/www/doc/datasheet/isl29125.pdf)
## Usage
To use this driver, import this crate and an `embedded_hal` implementation,
then instantiate the device.
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;
use isl29125::{Isl29125, OperatingMode};
fn main() {
let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Isl29125::new(dev);
sensor
.set_operating_mode(OperatingMode::RedGreenBlue)
.unwrap();
loop {
let m = sensor.read().unwrap();
println!("R: {}, G: {}, B: {}", m.red, m.green, m.blue);
}
}
```
## Support
For questions, issues, feature requests, and other changes, please file an
[issue in the github project](https://github.com/eldruin/isl29125-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.
[`embedded-hal`]: https://github.com/rust-embedded/embedded-hal