components/
dfrobot_rainfall_sensor.rs

Help
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 DFRobot Rainfall Sensor.
6//! <https://wiki.dfrobot.com/SKU_SEN0575_Gravity_Rainfall_Sensor>
7//!
8//! Usage
9//! -----
10//! ```rust
11//!     let dfrobot_rainfall =
12//!         components::dfrobot_rainfall_sensor::DFRobotRainFallSensorComponent::new(mux_i2c, 0x1D)
13//!             .finalize(components::dfrobot_rainfall_sensor_component_static!(
14//!                 apollo3::iom::Iom<'static>
15//!             ));
16//! ```
17
18use capsules_core::virtualizers::virtual_alarm::MuxAlarm;
19use capsules_core::virtualizers::virtual_alarm::VirtualMuxAlarm;
20use capsules_core::virtualizers::virtual_i2c::{I2CDevice, MuxI2C};
21use capsules_extra::dfrobot_rainfall_sensor::{DFRobotRainFall, BUFFER_SIZE};
22use core::mem::MaybeUninit;
23use kernel::component::Component;
24use kernel::hil::i2c;
25use kernel::hil::time;
26use kernel::hil::time::Alarm;
27
28// Setup static space for the objects.
29#[macro_export]
30macro_rules! dfrobot_rainfall_sensor_component_static {
31    ($A:ty, $I:ty $(,)?) => {{
32        let i2c_device =
33            kernel::static_buf!(capsules_core::virtualizers::virtual_i2c::I2CDevice<'static, $I>);
34        let i2c_buffer =
35            kernel::static_buf!([u8; capsules_extra::dfrobot_rainfall_sensor::BUFFER_SIZE]);
36        let dfrobot_rainfall_sensor = kernel::static_buf!(
37            capsules_extra::dfrobot_rainfall_sensor::DFRobotRainFall<
38                'static,
39                VirtualMuxAlarm<'static, $A>,
40                capsules_core::virtualizers::virtual_i2c::I2CDevice<$I>,
41            >
42        );
43        let alarm = kernel::static_buf!(
44            capsules_core::virtualizers::virtual_alarm::VirtualMuxAlarm<'static, $A>
45        );
46
47        (i2c_device, i2c_buffer, dfrobot_rainfall_sensor, alarm)
48    };};
49}
50
51pub type DFRobotRainFallSensorComponentType<A, I> =
52    capsules_extra::dfrobot_rainfall_sensor::DFRobotRainFall<'static, A, I>;
53
54pub struct DFRobotRainFallSensorComponent<
55    A: 'static + time::Alarm<'static>,
56    I: 'static + i2c::I2CMaster<'static>,
57> {
58    i2c_mux: &'static MuxI2C<'static, I>,
59    i2c_address: u8,
60    alarm_mux: &'static MuxAlarm<'static, A>,
61}
62
63impl<A: 'static + time::Alarm<'static>, I: 'static + i2c::I2CMaster<'static>>
64    DFRobotRainFallSensorComponent<A, I>
65{
66    pub fn new(
67        i2c: &'static MuxI2C<'static, I>,
68        i2c_address: u8,
69        alarm_mux: &'static MuxAlarm<'static, A>,
70    ) -> Self {
71        DFRobotRainFallSensorComponent {
72            i2c_mux: i2c,
73            i2c_address,
74            alarm_mux,
75        }
76    }
77}
78
79impl<A: 'static + time::Alarm<'static>, I: 'static + i2c::I2CMaster<'static>> Component
80    for DFRobotRainFallSensorComponent<A, I>
81{
82    type StaticInput = (
83        &'static mut MaybeUninit<I2CDevice<'static, I>>,
84        &'static mut MaybeUninit<[u8; BUFFER_SIZE]>,
85        &'static mut MaybeUninit<
86            DFRobotRainFall<'static, VirtualMuxAlarm<'static, A>, I2CDevice<'static, I>>,
87        >,
88        &'static mut MaybeUninit<VirtualMuxAlarm<'static, A>>,
89    );
90    type Output =
91        &'static DFRobotRainFall<'static, VirtualMuxAlarm<'static, A>, I2CDevice<'static, I>>;
92
93    fn finalize(self, s: Self::StaticInput) -> Self::Output {
94        let dfrobot_rainfall_sensor_i2c = s.0.write(I2CDevice::new(self.i2c_mux, self.i2c_address));
95        let i2c_buffer = s.1.write([0; BUFFER_SIZE]);
96        let alarm = s.3.write(VirtualMuxAlarm::new(self.alarm_mux));
97        alarm.setup();
98
99        let dfrobot_rainfall_sensor = s.2.write(DFRobotRainFall::new(
100            dfrobot_rainfall_sensor_i2c,
101            i2c_buffer,
102            alarm,
103        ));
104
105        alarm.set_alarm_client(dfrobot_rainfall_sensor);
106        dfrobot_rainfall_sensor_i2c.set_client(dfrobot_rainfall_sensor);
107        dfrobot_rainfall_sensor.startup();
108        dfrobot_rainfall_sensor
109    }
110}
components/dfrobot_rainfall_sensor.rs

components/
dfrobot_rainfall_sensor.rs
