Skip to content

Commit

Permalink
fixup! feat: introduce a sensor abstraction
Browse files Browse the repository at this point in the history
  • Loading branch information
ROMemories committed Oct 23, 2024
1 parent da6aea5 commit 6f2eff7
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/riot-rs-sensors/src/category.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
///
/// # For sensor driver implementors
///
/// Many mechanical sensor devices (e.g., accelerometers) include a temperature sensor as
/// temperature may slightly affect the measurement results.
/// If temperature readings are not exposed by the sensor driver, the sensor driver must not be
/// considered part of a category that includes temperature ([`Category::Temperature`] or
/// [`Category::AccelerometerTemperature`] in the case of an accelerometer).
///
/// Missing variants can be added when required.
/// Please open an issue to discuss it.
// Built upon https://doc.riot-os.org/group__drivers__saul.html#ga8f2dfec7e99562dbe5d785467bb71bbb
Expand All @@ -13,6 +19,10 @@
pub enum Category {
/// Accelerometer.
Accelerometer,
/// Accelerometer & temperature sensor.
AccelerometerTemperature,
/// Accelerometer & magnetometer & temperature sensor.
AccelerometerMagnetometerTemperature,
/// Ammeter (ampere meter).
Ammeter,
/// CO₂ gas sensor.
Expand All @@ -23,7 +33,7 @@ pub enum Category {
Gyroscope,
/// Humidity sensor.
Humidity,
/// Humidity and temperature sensor.
/// Humidity temperature sensor.
HumidityTemperature,
/// Light sensor.
Light,
Expand Down

0 comments on commit 6f2eff7

Please sign in to comment.