1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

/*
MIT License

Copyright (c) 2021 Crispin Tschirky <ct@fhr.ch>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */

//! Library to communicate with the I2C SCD30 CO2, temperature and humidity sensor
//! made by Sensirion.
//!
//! Provides basic functionality according the [SCD30 Reference] from Sensirion.
//!
//!
//! The target platform is a Raspberry pi so either you compile it on an rpi or use crosscompiling.
//! It is based on Raspberry Pi Peripheral Access Library [RPPAL]. The
//! physical SCD30 connection to i2c can be done by wiring the device to the first i2c ports of the GPIO
//! connector.
//!
//!
//! Connect to RaspberryPi GPIO:
//! - pin 1 (3.3V/VCC)
//! - pin 3 (SDA)
//! - pin 5 (SCL)
//! - pin 6 (GND).
//!
//! # Examples
//!
//!  ```no_run
//! use scd30pi::i2c::SCD30;
//! use std::{thread, time};
//!
//! fn main() {
//!     let mut sensor = SCD30::new().unwrap();
//!     let speed = sensor.get_bus_speed().unwrap();
//!     println!("bus Speed: {}", speed);
//!
//!     sensor.start().unwrap();
//!     sensor.set_measure_interval(2).unwrap();
//!
//!     let version = sensor.read_firmware_version().unwrap();
//!     println!("Current firmware version {}", version);
//!
//!     while !sensor.data_available().unwrap() {
//!         thread::sleep(time::Duration::from_millis(200));
//!     }
//!
//!     let temperature = sensor.temperature().unwrap();
//!     let co2 = sensor.co2().unwrap();
//!     let humidity = sensor.humidity().unwrap();
//!
//!     println!(
//!         "co2 = {:.0} ppm, temp = {:.2} °C, humidity = {:.0} %",
//!         co2, temperature, humidity
//!     );
//! }
//!  ```
//!
//! [RPPAL]: https://crates.io/crates/rppal
//! [SCD30 Reference]: https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9.5_CO2/Sensirion_CO2_Sensors_SCD30_Interface_Description.pdf
//!
pub mod i2c;