l293x 0.3.0

Platform agnostic library for the L293 and L293D motor drivers using 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

use core::fmt::Debug;
use embedded_hal::pwm::ErrorKind;

/// Error returned by the [L293x](crate::L293x) and [HalfH](crate::HalfH) implementations.
///
/// This enumeration combines the possible errors returned by the input pin and the enable pin.
///
/// Depending on the source of the error, either an [InputPinError](OutputStateError::InputPinError)
/// or a [EnablePinError](OutputStateError::EnablePinError) will be returned by the functions
/// implemented in the [OutputPin](embedded_hal::digital::OutputPin) traits.
///
/// # Examples
///
/// ```
/// use embedded_hal::digital::OutputPin;
/// use l293x::{HalfH, OutputStateError};
///
/// let mut bridge = HalfH::new(input, enable);
///
/// bridge.set_high().unwrap_or(|error| {
///     match error {
///         OutputStateError::InputPinError(e) => println!("Error setting the input pin high: {e}"),
///         OutputStateError::EnablePinError(e) => println!("Error in enable pin: {e}"),
///     }
/// });
/// ```
#[derive(Debug)]
pub enum OutputStateError<I, E> {
    /// An error occurred while setting the state of the input pin. The contained error
    //     /// may contain additional information.
    InputPinError(I),
    /// An error occurred while setting the state of the enable pin. The contained error
    /// may contain additional information.
    EnablePinError(E),
    /// Error returned by the `is_set_[high|low]` methods of the
    /// [StatefulOutputPin](embedded_hal::digital::StatefulOutputPin) trait, if the output checked
    /// is not enabled.
    NotEnabled,
}

impl<I, E> embedded_hal::digital::Error for OutputStateError<I, E>
where
    I: embedded_hal::digital::Error,
    E: embedded_hal::digital::Error,
{
    fn kind(&self) -> embedded_hal::digital::ErrorKind {
        match self {
            OutputStateError::InputPinError(e) => e.kind(),
            OutputStateError::EnablePinError(e) => e.kind(),
            OutputStateError::NotEnabled => embedded_hal::digital::ErrorKind::Other,
        }
    }
}

impl<I, E> embedded_hal::pwm::Error for OutputStateError<I, E>
where
    I: embedded_hal::pwm::Error,
    E: Debug,
{
    fn kind(&self) -> ErrorKind {
        match self {
            OutputStateError::InputPinError(e) => e.kind(),
            _ => embedded_hal::pwm::ErrorKind::Other,
        }
    }
}

impl<I, E> PartialEq for OutputStateError<I, E>
where
    I: PartialEq,
    E: PartialEq,
{
    fn eq(&self, other: &Self) -> bool {
        match self {
            OutputStateError::EnablePinError(e1) => match other {
                OutputStateError::EnablePinError(e2) => e1 == e2,
                _ => false,
            },
            OutputStateError::InputPinError(e1) => match other {
                OutputStateError::InputPinError(e2) => e1 == e2,
                _ => false,
            },
            OutputStateError::NotEnabled => matches!(other, OutputStateError::NotEnabled),
        }
    }
}

impl<I, E> Eq for OutputStateError<I, E>
where
    I: Eq,
    E: Eq,
{
}

#[cfg(test)]
mod tests {
    use crate::mock::{DigitalError, PwmError};
    use embedded_hal::digital::{Error, ErrorKind};
    use embedded_hal::pwm::{Error as _, ErrorKind as PwmErrorKind};

    use super::*;

    #[test]
    fn test_output_state_error_kind() {
        let input_error: OutputStateError<DigitalError, DigitalError> =
            OutputStateError::InputPinError(DigitalError());
        assert_eq!(input_error.kind(), DigitalError().kind());

        let enable_error: OutputStateError<DigitalError, DigitalError> =
            OutputStateError::EnablePinError(DigitalError());
        assert_eq!(enable_error.kind(), DigitalError().kind());

        let not_enabled: OutputStateError<DigitalError, DigitalError> =
            OutputStateError::NotEnabled;
        assert_eq!(not_enabled.kind(), ErrorKind::Other);
    }

    #[test]
    fn test_output_state_pwm_error_kind() {
        let input_error: OutputStateError<PwmError, DigitalError> =
            OutputStateError::InputPinError(PwmError());
        assert_eq!(input_error.kind(), PwmError().kind());

        let enable_error: OutputStateError<PwmError, DigitalError> =
            OutputStateError::EnablePinError(DigitalError());
        assert_eq!(enable_error.kind(), PwmErrorKind::Other);

        let not_enabled: OutputStateError<PwmError, DigitalError> = OutputStateError::NotEnabled;
        assert_eq!(not_enabled.kind(), PwmErrorKind::Other);
    }

    #[test]
    fn test_output_state_error_equality() {
        let i: OutputStateError<DigitalError, DigitalError> =
            OutputStateError::InputPinError(DigitalError());
        let e: OutputStateError<DigitalError, DigitalError> =
            OutputStateError::EnablePinError(DigitalError());
        let ne: OutputStateError<DigitalError, DigitalError> = OutputStateError::NotEnabled;

        assert_eq!(i, i);
        assert_eq!(e, e);
        assert_eq!(ne, ne);

        assert_ne!(e, i);
        assert_ne!(e, ne);
        assert_ne!(i, e);
        assert_ne!(i, ne);
        assert_ne!(ne, e);
        assert_ne!(ne, i);
    }
}