components/
bme280.rs

1// Licensed under the Apache License, Version 2.0 or the MIT License.
2// SPDX-License-Identifier: Apache-2.0 OR MIT
3// Copyright Tock Contributors 2022.
4
5//! Components for the BME280 Humidity, Pressure and Temperature Sensor.
6//!
7//! Usage
8//! -----
9//! ```rust
10//!     let bme280 =
11//!         Bme280Component::new(mux_i2c, 0x77).finalize(components::bme280_component_static!());
12//!     let temperature = components::temperature::TemperatureComponent::new(
13//!         board_kernel,
14//!         capsules_extra::temperature::DRIVER_NUM,
15//!         bme280,
16//!     )
17//!     .finalize(components::temperature_component_static!());
18//!     let humidity = components::humidity::HumidityComponent::new(
19//!         board_kernel,
20//!         capsules_extra::humidity::DRIVER_NUM,
21//!         bme280,
22//!     )
23//!     .finalize(components::humidity_component_static!());
24//! ```
25
26use capsules_core::virtualizers::virtual_i2c::{I2CDevice, MuxI2C};
27use capsules_extra::bme280::Bme280;
28use core::mem::MaybeUninit;
29use kernel::component::Component;
30use kernel::hil::i2c;
31
32// Setup static space for the objects.
33#[macro_export]
34macro_rules! bme280_component_static {
35    ($I:ty $(,)?) => {{
36        let i2c_device =
37            kernel::static_buf!(capsules_core::virtualizers::virtual_i2c::I2CDevice<'static, $I>);
38        let i2c_buffer = kernel::static_buf!([u8; 26]);
39        let bme280 = kernel::static_buf!(
40            capsules_extra::bme280::Bme280<
41                'static,
42                capsules_core::virtualizers::virtual_i2c::I2CDevice<$I>,
43            >
44        );
45
46        (i2c_device, i2c_buffer, bme280)
47    };};
48}
49
50pub type Bme280ComponentType<I> = capsules_extra::bme280::Bme280<'static, I>;
51
52pub struct Bme280Component<I: 'static + i2c::I2CMaster<'static>> {
53    i2c_mux: &'static MuxI2C<'static, I>,
54    i2c_address: u8,
55}
56
57impl<I: 'static + i2c::I2CMaster<'static>> Bme280Component<I> {
58    pub fn new(i2c: &'static MuxI2C<'static, I>, i2c_address: u8) -> Self {
59        Bme280Component {
60            i2c_mux: i2c,
61            i2c_address,
62        }
63    }
64}
65
66impl<I: 'static + i2c::I2CMaster<'static>> Component for Bme280Component<I> {
67    type StaticInput = (
68        &'static mut MaybeUninit<I2CDevice<'static, I>>,
69        &'static mut MaybeUninit<[u8; 26]>,
70        &'static mut MaybeUninit<Bme280<'static, I2CDevice<'static, I>>>,
71    );
72    type Output = &'static Bme280<'static, I2CDevice<'static, I>>;
73
74    fn finalize(self, s: Self::StaticInput) -> Self::Output {
75        let bme280_i2c = s.0.write(I2CDevice::new(self.i2c_mux, self.i2c_address));
76        let i2c_buffer = s.1.write([0; 26]);
77
78        let bme280 = s.2.write(Bme280::new(bme280_i2c, i2c_buffer));
79
80        bme280_i2c.set_client(bme280);
81        bme280.startup();
82        bme280
83    }
84}
components/bme280.rs

components/
bme280.rs
