Struct deoxy::Pump

pub struct Pump {
    pub invert: bool,
    // some fields omitted
}

Represents a pump.

Notes

The pump is assumed to operate using an 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.

 +-----+-----+
 |     0     1
+V     +-----+
 |     2     3
 +-----+-----+

Fields

invert: bool

Whether directions should be reversed.

Methods

impl Pump

pub fn try_new(pins: [u16; 4]) -> Result<Self, PinError>

Attempts to create a new pump using the given GPIO pin numbers.

pub fn new(pins: [u16; 4]) -> Self

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.

pub fn set_direction<D>(
    &mut self,
    direction: D
) -> Result<Option<Direction>, PinError> where
    D: Into<Option<Direction>>, 

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 is true, direction will be inverted.

pub fn perfuse(&mut self) -> Result<Option<Direction>, PinError>

Switches the pump to the forward direction.

pub fn drain(&mut self) -> Result<Option<Direction>, PinError>

Switches the pump to the reverse direction.

pub fn stop(&mut self) -> Result<Option<Direction>, PinError>

Stops the pump.

pub fn is_stopped(&self) -> bool

Whether the pump is currently stopped.

Trait Implementations

impl Eq for Pump

impl PartialEq<Pump> for Pump

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Pump

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Actor for Pump

type Context = Context<Self>

Actor execution context type

fn started(&mut self, ctx: &mut Self::Context)

Method is called when actor get polled first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Method is called after an actor is in Actor::Stopping state. There could be several reasons for stopping. Context::stop get called by the actor itself. All addresses to current actor get dropped and no more evented objects left in the context.

fn stopped(&mut self, ctx: &mut Self::Context)

Method is called after an actor is stopped, it can be used to perform any needed cleanup work or spawning more actors. This is final state, after this call actor get dropped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start new asynchronous actor, returns address of newly created actor.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Start new asynchronous actor, returns address of newly created actor.

fn create<F>(f: F) -> Addr<Self> where
    F: FnOnce(&mut Context<Self>) -> Self + 'static,
    Self: Actor<Context = Context<Self>>, 

Use create method, if you need Context object during actor initialization.

impl Handler<Message> for Pump

type Result = Result<Option<Direction>, PinError>

The type of value that this handle will return

fn handle(
    &mut self,
    message: Message,
    _context: &mut Self::Context
) -> Self::Result

Method is called for every message received by this Actor