Skip to main content

LatchRelay

Struct LatchRelay 

Source
pub struct LatchRelay<I2C> { /* private fields */ }
Expand description

Driver for the Modulino Latch Relay module.

A latching relay maintains its state (on/off) even when power is removed.

§Example

use modulino::LatchRelay;

let mut relay = LatchRelay::new(i2c)?;

// Turn on the relay
relay.on()?;

// Check state
if relay.is_on()? == Some(true) {
    println!("Relay is ON");
}

// Turn off the relay
relay.off()?;

Implementations§

Source§

impl<I2C, E> LatchRelay<I2C>
where I2C: I2c<Error = E>,

Source

pub fn new(i2c: I2C) -> Result<Self, E>

Create a new LatchRelay instance with the default address.

Source

pub fn new_with_address(i2c: I2C, address: u8) -> Result<Self, E>

Create a new LatchRelay instance with a custom address.

Source

pub fn address(&self) -> u8

Get the I2C address.

Source

pub fn on(&mut self) -> Result<(), E>

Turn the relay on.

Source

pub fn off(&mut self) -> Result<(), E>

Turn the relay off.

Source

pub fn set(&mut self, on: bool) -> Result<(), E>

Set the relay state.

Source

pub fn toggle(&mut self) -> Result<(), E>

Toggle the relay state.

Source

pub fn is_on(&mut self) -> Result<Option<bool>, E>

Check if the relay is currently on.

Returns:

  • Some(true) if the relay is on
  • Some(false) if the relay is off
  • None if the state is unknown (e.g., after power cycle before first command)
Source

pub fn release(self) -> I2C

Release the I2C bus.

Auto Trait Implementations§

§

impl<I2C> Freeze for LatchRelay<I2C>
where I2C: Freeze,

§

impl<I2C> RefUnwindSafe for LatchRelay<I2C>
where I2C: RefUnwindSafe,

§

impl<I2C> Send for LatchRelay<I2C>
where I2C: Send,

§

impl<I2C> Sync for LatchRelay<I2C>
where I2C: Sync,

§

impl<I2C> Unpin for LatchRelay<I2C>
where I2C: Unpin,

§

impl<I2C> UnwindSafe for LatchRelay<I2C>
where I2C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.