rohi-hal 0.1.0

Robonomics Open Hardware Abstraction Layer
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

///////////////////////////////////////////////////////////////////////////////
//
//  Copyright 2025 Akagi Engineering <admin@akagi.dev>
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////
//! Robonomics sensors collection provide different kinds of measures via same
//! async interface. For example, access sensor data for board instance will
//! looks like:
//!
//!   let board = ...
//!   let sensor = Sensor(&board);
//!   let temp = sensor.temperature().await;
//!   println!("{}", temp);
//!

pub(crate) mod bus;
use bus::*;

/// Generic sensor data interface.
pub struct Sensor<'a, T>(pub &'a mut T);

impl<T: ParticulateMatter> Sensor<'_, T> {
    /// A measurement of PM2.5 fine dust pollution.
    pub async fn pm10(&mut self) -> Option<u16> {
        self.0.pm10().await
    }

    /// A measurement of PM10 fine dust pollution.
    pub async fn pm25(&mut self) -> Option<u16> {
        self.0.pm25().await
    }
}

impl<T: Humidity> Sensor<'_, T> {
    /// The measured humidity in tenths of a percent.
    pub async fn humidity(&mut self) -> Option<u16> {
        self.0.humidity().await
    }
}

impl<T: Temperature> Sensor<'_, T> {
    /// The measured temperature in tenths of degrees **Celsius**.
    pub async fn temperature(&mut self) -> Option<i16> {
        self.0.temperature().await
    }
}

impl<T: Pressure> Sensor<'_, T> {
    /// The measured pressure in **Pascals**.
    pub async fn pressure(&mut self) -> Option<u32> {
        self.0.pressure().await
    }
}