libscd 0.5.1

Rust drivers for various SCD devices such as scd30 and scd4x CO2 sensors
Documentation 
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
79
80
81
82
83
84
85

# Lib SCD

[![License](https://img.shields.io/crates/l/libscd)](https://opensource.org/licenses/MIT)
[![Version](https://img.shields.io/crates/v/libscd)](https://crates.io/crates/libscd)
[![Downloads](https://img.shields.io/crates/d/libscd)](https://crates.io/crates/libscd)
[![Docs](https://img.shields.io/docsrs/libscd)](https://docs.rs/libscd/latest/libscd/)
[![Build](https://img.shields.io/github/actions/workflow/status/SvetlinZarev/libscd/run_tests.yml)](https://github.com/SvetlinZarev/libscd/actions)

LibSCD is s Rust driver implementation for SCD30, SCD40, SCD41 and SCD43 sensors
using the `embedded-hal` and `embedded-hal-async` interfaces.

## Usage

Add the crate as a dependency in `Cargo.toml` and select the required features:

```toml
[dependencies.libscd]
version = "0.5"
features = ["defmt", "sync", "scd4x"]
```

Then we can start consuming data from SCD4x using blocking I2C communication:

```rust
#[embassy_executor::main]
async fn main(_spawner: Spawner) {
    let p = embassy_stm32::init(Default::default());
    let i2c = I2c::new_blocking(
        p.I2C2,
        p.PB10,
        p.PB3,
        Hertz(100_000),
        Default::default(),
    );

    let mut scd = Scd4x::new(i2c, Delay);

    // When re-programming, the controller will be restarted,
    // but not the sensor. We try to stop it in order to
    // prevent the rest of the commands failing.
    _ = scd.stop_periodic_measurement();

    info!("Sensor serial number: {:?}", scd.serial_number());
    if let Err(e) = scd.start_periodic_measurement() {
        defmt::panic!("Failed to start periodic measurement: {:?}", e);
    }

    loop {
        if scd.data_ready().unwrap() {
            let m = scd.read_measurement().unwrap();
            info!("CO2: {}\nHumidity: {}\nTemperature: {}", m.co2, m.humidity, m.temperature)
        }

        Delay.delay_ms(1000)
    }
}
```

## Migrating from v0.4

Version 0.5 contains breaking changes:

* The SCD4x family of sensors are exposed via common type - SCD4x. The old
  structures are no longer available.
* The `scd40` crate feature is renamed to `scd4x`
* SCD4x use `HPa` instead of `Pa` for setting/getting the ambient pressure
* The `Measurement` type is no longer reexported by each sensor. The
  common shared type should be used instead.

## Crate Feature Flags

The support for each sensor and sync/async mode is controlled by a feature:

| Feature | Description                                                                            |
|---------|----------------------------------------------------------------------------------------|
| sync    | Enables the blocking driver implementation for the selected sensors                    |
| async   | Enables the async driver implementation for the selected sensors                       |
| scd30   | Enables the driver for the SCD30 sensor                                                |
| scd4x   | Enables the driver for the SCD4x family of sensors                                     |
| scd41   | Enables additional SCD4x driver features available only on the SCD41 and SCD43 sensors |
| defmt   | Derive `defmt::Format` for the error type                                              |

## License

The project is licensed under [MIT](https://opensource.org/licenses/MIT) license