afe4404 0.2.4

AFE4404 driver for Rust embedded-hal.
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! This module contains the system related functions.

use embedded_hal::i2c::I2c;
use embedded_hal::i2c::SevenBitAddress;

use crate::{device::AFE4404, errors::AfeError, modes::LedMode, register_structs::R00h};

pub use configuration::{DynamicConfiguration, State};

mod configuration;

impl<I2C, MODE> AFE4404<I2C, MODE>
where
    I2C: I2c<SevenBitAddress>,
    MODE: LedMode,
{
    /// Software resets the [`AFE4404`].
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn sw_reset(&mut self) -> Result<(), AfeError<I2C::Error>> {
        self.registers.r00h.write(R00h::new().with_sw_reset(true))?;

        Ok(())
    }

    /// Software powers down the entire [`AFE4404`].
    ///
    /// # Notes
    ///
    /// To resume the entire [`AFE4404`] call `sw_power_up()` function.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn sw_power_down(&mut self) -> Result<(), AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        self.registers.r23h.write(r23h_prev.with_pdnafe(true))?;

        Ok(())
    }

    /// Software powers up the entire [`AFE4404`].
    ///
    /// # Notes
    ///
    /// After calling this function, a wait time of `tCHANNEL` should be applied before high-accuracy readings.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn sw_power_up(&mut self) -> Result<(), AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        self.registers.r23h.write(r23h_prev.with_pdnafe(false))?;

        Ok(())
    }

    /// Software powers down the RX portion of the [`AFE4404`].
    ///
    /// # Notes
    ///
    /// To resume the RX portion of the [`AFE4404`] call `sw_power_up_rx()` function.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn sw_power_down_rx(&mut self) -> Result<(), AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        self.registers.r23h.write(r23h_prev.with_pdnrx(true))?;

        Ok(())
    }

    /// Software powers up the RX portion of the [`AFE4404`].
    ///
    /// # Notes
    ///
    /// After calling this function, a wait time of `tCHANNEL` should be applied before high-accuracy readings.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn sw_power_up_rx(&mut self) -> Result<(), AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        self.registers.r23h.write(r23h_prev.with_pdnrx(false))?;

        Ok(())
    }

    /// Sets the functional blocks to disable during dynamic power down.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn set_dynamic(
        &mut self,
        configuration: &DynamicConfiguration,
    ) -> Result<DynamicConfiguration, AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        self.registers.r23h.write(
            r23h_prev
                .with_dynamic1(configuration.transmitter.into())
                .with_dynamic2(configuration.adc.into())
                .with_dynamic3(configuration.tia.into())
                .with_dynamic4(configuration.rest_of_adc.into()),
        )?;

        Ok(*configuration)
    }

    /// Gets the functional blocks to disable during dynamic power down.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn get_dynamic(&mut self) -> Result<DynamicConfiguration, AfeError<I2C::Error>> {
        let r23h_prev = self.registers.r23h.read()?;

        Ok(DynamicConfiguration {
            transmitter: r23h_prev.dynamic1().into(),
            adc: r23h_prev.dynamic2().into(),
            tia: r23h_prev.dynamic3().into(),
            rest_of_adc: r23h_prev.dynamic4().into(),
        })
    }

    /// Sets the photodiode state.
    ///
    /// # Notes
    ///
    /// When the photodiode is disabled, the readings are determined only by the offset currents.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn set_photodiode(&mut self, state: State) -> Result<State, AfeError<I2C::Error>> {
        let r31h_prev = self.registers.r31h.read()?;

        self.registers
            .r31h
            .write(r31h_prev.with_pd_disconnect(state.into()))?;

        Ok(state)
    }

    /// Gets the photodiode state.
    ///
    /// # Notes
    ///
    /// When the photodiode is disabled, the readings are determined only by the offset currents.
    ///
    /// # Errors
    ///
    /// This function returns an error if the I2C bus encounters an error.
    pub fn get_photodiode(&mut self) -> Result<State, AfeError<I2C::Error>> {
        let r31h_prev = self.registers.r31h.read()?;

        Ok(r31h_prev.pd_disconnect().into())
    }
}