sen5x 0.2.0

Rust driver for the Sensirion SEN5x series. All-in-one sensor solution platform for the accurate measurement of various environmental parameters, such as particulate matter, volatile organic compounds (VOCs), oxidizing gases, such as nitrogen oxide compounds (NOx), as well as humidity & temperature
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Types for the SEN5x sensor.

/// Scaled sensor measurement data (floating point).
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SensorData {
    /// Mass concentration PM1.0 in µg/m³
    pub mass_concentration_pm1p0: f32,
    /// Mass concentration PM2.5 in µg/m³
    pub mass_concentration_pm2p5: f32,
    /// Mass concentration PM4.0 in µg/m³
    pub mass_concentration_pm4p0: f32,
    /// Mass concentration PM10.0 in µg/m³
    pub mass_concentration_pm10p0: f32,
    /// Relative humidity in %
    pub ambient_humidity: f32,
    /// Temperature in °C
    pub ambient_temperature: f32,
    /// VOC index (1–500)
    pub voc_index: f32,
    /// NOx index (1–500)
    pub nox_index: f32,
}

/// Raw integer sensor data (ticks, before scaling).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct RawSensorData {
    /// Mass concentration PM1.0 (raw ticks, divide by 10 for µg/m³)
    pub mass_concentration_pm1p0: u16,
    /// Mass concentration PM2.5 (raw ticks, divide by 10 for µg/m³)
    pub mass_concentration_pm2p5: u16,
    /// Mass concentration PM4.0 (raw ticks, divide by 10 for µg/m³)
    pub mass_concentration_pm4p0: u16,
    /// Mass concentration PM10.0 (raw ticks, divide by 10 for µg/m³)
    pub mass_concentration_pm10p0: u16,
    /// Ambient humidity (raw ticks, divide by 100 for %)
    pub ambient_humidity: i16,
    /// Ambient temperature (raw ticks, divide by 200 for °C)
    pub ambient_temperature: i16,
    /// VOC index (raw ticks, divide by 10 for index value)
    pub voc_index: i16,
    /// NOx index (raw ticks, divide by 10 for index value)
    pub nox_index: i16,
}

/// Raw unscaled sensor ticks from ReadMeasuredRawValues.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct RawMeasurementValues {
    /// Raw humidity ticks
    pub raw_humidity: i16,
    /// Raw temperature ticks
    pub raw_temperature: i16,
    /// Raw VOC ticks (unprocessed, no algorithm applied)
    pub raw_voc: u16,
    /// Raw NOx ticks (unprocessed, no algorithm applied)
    pub raw_nox: u16,
}

/// Extended PM values including number concentrations and typical particle size.
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct PmValues {
    /// Mass concentration PM1.0 in µg/m³
    pub mass_pm1p0: f32,
    /// Mass concentration PM2.5 in µg/m³
    pub mass_pm2p5: f32,
    /// Mass concentration PM4.0 in µg/m³
    pub mass_pm4p0: f32,
    /// Mass concentration PM10.0 in µg/m³
    pub mass_pm10p0: f32,
    /// Number concentration PM0.5 in #/cm³
    pub number_pm0p5: f32,
    /// Number concentration PM1.0 in #/cm³
    pub number_pm1p0: f32,
    /// Number concentration PM2.5 in #/cm³
    pub number_pm2p5: f32,
    /// Number concentration PM4.0 in #/cm³
    pub number_pm4p0: f32,
    /// Number concentration PM10.0 in #/cm³
    pub number_pm10p0: f32,
    /// Typical particle size in µm
    pub typical_particle_size: f32,
}

/// Temperature compensation parameters.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TemperatureOffsetParameters {
    /// Constant temperature offset scaled by 200 (T [°C] = offset / 200)
    pub offset: i16,
    /// Normalized temperature offset slope (factor = slope / 10000)
    pub slope: i16,
    /// Time constant in seconds (0 = immediate)
    pub time_constant: u16,
}

/// VOC/NOx algorithm tuning parameters.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct AlgorithmTuningParameters {
    /// Index representing "typical" conditions (range 1–250)
    pub index_offset: i16,
    /// Learning time for offset estimation in hours (range 1–1000)
    pub learning_time_offset_hours: i16,
    /// Learning time for gain estimation in hours (range 1–1000)
    pub learning_time_gain_hours: i16,
    /// Maximum gating duration in minutes (0 = disabled, range 0–3000)
    pub gating_max_duration_minutes: i16,
    /// Initial estimate for standard deviation
    pub std_initial: i16,
    /// Gain factor to amplify/attenuate output (range 1–1000)
    pub gain_factor: i16,
}

/// Firmware, hardware, and protocol version information.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct VersionInfo {
    /// Firmware major version
    pub firmware_major: u8,
    /// Firmware minor version
    pub firmware_minor: u8,
    /// Firmware debug mode enabled
    pub firmware_debug: bool,
    /// Hardware major version
    pub hardware_major: u8,
    /// Hardware minor version
    pub hardware_minor: u8,
    /// I2C protocol major version
    pub protocol_major: u8,
    /// I2C protocol minor version
    pub protocol_minor: u8,
}