iaq-core

Crates.ioiaq-core
lib.rsiaq-core
version0.1.0
sourcesrc
created_at2020-01-27 21:44:28.547316
updated_at2020-01-27 21:44:28.547316
descriptionPlatform-agnostic Rust driver for the iAQ-Core indoor air quality sensor. Compatible with iAQ-Core-C and iAQ-Core-P.
homepagehttps://github.com/eldruin/iaq-core-rs
repositoryhttps://github.com/eldruin/iaq-core-rs
max_upload_size
id202518
size37,148
Diego Barrios Romero (eldruin)

documentation

https://docs.rs/iaq-core

README

Rust iAQ-Core Indoor Air Quality Sensor Driver

crates.io Docs Build Status Coverage Status

This is a platform agnostic Rust driver for the iAQ-Core indoor air quality sensors using the embedded-hal traits.

This driver allows you to:

  • Read all the sensor data at once. See: data().
  • Read the CO2 equivalent prediction value in ppm. See: co2().
  • Read the TVOC equivalent prediction value in ppb. See: tvoc().
  • Read the sensor resistance in Ohm. See: resistance().

The ams iAQ-core Indoor Air Quality Module is a low-cost, ultracompact solution for detecting poor air quality. It is equipped with an MOS sensor element for the detection of a broad range of reducing gases such as CO and VOCs. A change of resistance in the presence of these gases generates a signal that is translated into parts per million (ppm) CO2 equivalent or parts per billion (ppb) TVOC equivalent units.

When defined threshold limits are exceeded, the module signals the system to initiate activities such as increasing ventilation, releasing fragrance, providing a message to open a window, switching on an air cleaner, etc. When VOC levels are minimized, the module instructs the system to return to standby, thereby saving energy, lowering operating costs and maintaining a healthy environment.

In any demand-controlled ventilation/actuation environment where air quality is important, including commercial and residential facilities (offices, classrooms, kitchens, bathrooms, living and bedrooms etc.) the iAQ-core Indoor Air Quality Module performs accurately and reliably. Plus, the module’s small size opens up a wide variety of new applications where space is at a premium.

Documentation:

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

use iaq_core::IaqCore;
use linux_embedded_hal::I2cdev;
use nb::block;

fn main() {
    let dev = I2cdev::new("/dev/i2c-1").unwrap();
    let mut sensor = IaqCore::new(dev);
    loop {
        let data = block!(sensor.data()).unwrap();
        println!("CO2: {} ppm, TVOC: {} ppb", data.co2, data.tvoc);
    }
}

Support

For questions, issues, feature requests, and other changes, please file an issue in the github project.

License

Licensed under either of

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.

Commit count: 28

cargo fmt