deoxy 0.2.1

//! Pump management.
use std::ops::Not;
use std::thread;

use crate::actix::*;
use crate::pin::{Error as PinError, Pin};

/// Messages that can be sent to the pump to change its direction or turn it off.
#[derive(Clone, Copy, Debug)]
pub enum Message {
    /// Asks the pump to run in the forward direction.
    Perfuse,
    /// Asks the pump to run in the backward direction.
    Drain,
    /// Asks the pump to stop.
    Stop,
}

impl ActixMessage for Message {
    type Result = Result<Option<Direction>>;
}

/// The direction of a pump.
#[derive(Clone, Copy, Debug)]
pub enum Direction {
    /// The pump should run in the forward direction (toward the sample), perfusing any sample.
    Forward,
    /// The pump should run in the backward direction (toward waste), draining any sample.
    Backward,
}

impl Not for Direction {
    type Output = Self;
    fn not(self) -> Self {
        match self {
            Direction::Forward => Direction::Backward,
            Direction::Backward => Direction::Forward,
        }
    }
}

/// Pump movement result type.
pub type Result<T> = std::result::Result<T, PinError>;

/// Represents a pump.
///
/// ## Notes
/// The pump is assumed to operate using an [H-bridge](https://en.wikipedia.org/wiki/H_bridge), and
/// so requires four pins.
///
/// We assume there's a single pump elsewhere in the architecture, although this code could be used
/// to control multiple pumps concurrently.
///
/// ### Diagram
/// Here is a circuit diagram showing the meaning of each pin number.
/// Each pin controls a relay/transistor in the H-bridge.
/// ```plaintext
///  +-----+-----+
///  |     0     1
/// +V     +-----+
///  |     2     3
///  +-----+-----+
/// ```
#[derive(Debug)]
pub struct Pump {
    /// The GPIO pins to use for the H-bridge.
    pins: [Pin; 4],
    /// The direction the pump should run in (if running).
    direction: Option<Direction>,
    /// Whether directions should be reversed.
    pub invert: bool,
}

impl PartialEq for Pump {
    fn eq(&self, other: &Self) -> bool {
        self.pins[0].number == other.pins[0].number
            && self.pins[1].number == other.pins[1].number
            && self.pins[2].number == other.pins[2].number
            && self.pins[3].number == other.pins[3].number
    }
}

impl Eq for Pump {}

impl Pump {
    /// Attempts to create a new pump using the given GPIO pin numbers.
    pub fn try_new(pins: [u16; 4]) -> Result<Self> {
        let pins = [
            Pin::try_new(pins[0])?,
            Pin::try_new(pins[1])?,
            Pin::try_new(pins[2])?,
            Pin::try_new(pins[3])?,
        ];
        Ok(Self {
            direction: None,
            pins,
            invert: false,
        })
    }
    /// Creates a new pump using the given GPIO pin numbers.
    ///
    /// ## Panics
    /// This method will panic if opening any of the pins fails. For a fallible initializer, see
    /// [`Pump::try_new`](#method.try_new).
    pub fn new(pins: [u16; 4]) -> Self {
        Self::try_new(pins).expect("Pump construction failed.")
    }
    /// Changes the pump direction to the specified direction.
    ///
    /// If the pump is not already stopped, it will be stopped and a wait of 20 ms will be added to
    /// prevent sparks, short-circuits, etc.
    ///
    /// ## Notes
    /// If [`invert`](#structfield.invert) is `true`, `direction` will be inverted.
    pub fn set_direction<D>(&mut self, direction: D) -> Result<Option<Direction>>
    where
        D: Into<Option<Direction>>,
    {
        let direction = direction.into();
        if let Some(direction) = direction {
            if !self.is_stopped() {
                self.stop()?;
                // Sleep to make sure we avoid Bad Things™️
                thread::sleep(std::time::Duration::from_millis(20));
            }
            let direction = if self.invert { !direction } else { direction };
            let pins = match direction {
                Direction::Forward => (0, 3),
                Direction::Backward => (1, 2),
            };
            let (top, bottom) = (pins.0, pins.1);
            self.pins[top].set_high();
            self.pins[bottom].set_high();
        } else {
            for i in 0..4 {
                self.pins[i].set_low();
            }
        }
        self.direction = direction;
        Ok(direction)
    }
    /// Switches the pump to the forward direction.
    pub fn perfuse(&mut self) -> Result<Option<Direction>> {
        log::trace!("Setting pump to perfuse");
        self.set_direction(Direction::Forward)
    }
    /// Switches the pump to the reverse direction.
    pub fn drain(&mut self) -> Result<Option<Direction>> {
        log::trace!("Setting pump to drain");
        self.set_direction(Direction::Backward)
    }
    /// Stops the pump.
    pub fn stop(&mut self) -> Result<Option<Direction>> {
        log::trace!("Stopping pump");
        self.set_direction(None)
    }
    /// Whether the pump is currently stopped.
    pub fn is_stopped(&self) -> bool {
        self.direction.is_none()
    }
}

impl Actor for Pump {
    type Context = Context<Self>;
}

impl Handle<Message> for Pump {
    type Result = Result<Option<Direction>>;
    fn handle(&mut self, message: Message, _context: &mut Self::Context) -> Self::Result {
        match message {
            Message::Perfuse => self.perfuse(),
            Message::Drain => self.drain(),
            Message::Stop => self.stop(),
        }
    }
}