diff --git a/src/riot-rs-sensors/src/category.rs b/src/riot-rs-sensors/src/category.rs index fa6a5998b..309ca41d1 100644 --- a/src/riot-rs-sensors/src/category.rs +++ b/src/riot-rs-sensors/src/category.rs @@ -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 @@ -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. @@ -23,7 +33,7 @@ pub enum Category { Gyroscope, /// Humidity sensor. Humidity, - /// Humidity and temperature sensor. + /// Humidity & temperature sensor. HumidityTemperature, /// Light sensor. Light,