Struct Odk

pub struct Odk<P: SerialPort, B: SignBus> { /* private fields */ }

Connects to a real ODK over the specified serial port and uses it to drive a SignBus.

Typically this will be used to drive a VirtualSignBus in order to study the bus traffic or inspect the pages of pixel data sent by the ODK.

Examples

use flipdot_core::PageFlipStyle;
use flipdot_serial::SerialSignBus;
use flipdot_testing::{Address, Odk, VirtualSign, VirtualSignBus};

// Populate bus with signs from addresses 2 to 126
// (which seems to be the possible range for actual signs).
let signs = (2..127).map(Address).map(|addr| VirtualSign::new(addr, PageFlipStyle::Manual));
let bus = VirtualSignBus::new(signs);

// Hook up ODK to virtual bus.
let port = serial::open("/dev/ttyUSB0")?;
let mut odk = Odk::try_new(port, bus)?;
loop {
    // ODK communications are forwarded to/from the virtual bus.
    odk.process_message()?;
}

Implementations

impl<P: SerialPort, B: SignBus> Odk<P, B>

pub fn try_new(port: P, bus: B) -> Result<Self, Error>

Create a new Odk that connects the specified serial port and bus.

Errors

Returns the underlying serial_core::Error if the serial port cannot be configured.

Examples

let bus = VirtualSignBus::new(vec![VirtualSign::new(Address(3), PageFlipStyle::Manual)]);
let port = serial::open("COM3")?;
let odk = Odk::try_new(port, bus)?;

Note: You would typically use the env_logger crate and run with RUST_LOG=debug to watch the bus messages go by.

pub fn process_message(&mut self) -> Result<(), OdkError>

Reads the next frame from the ODK over the serial port, forwards it to the attached bus, and sends the response, if any, back to the ODK.

Errors

Returns:

• OdkError::Communication if there was an error reading or writing the data.
• OdkError::Bus if the bus failed to process the message.

Examples

let bus = VirtualSignBus::new(vec![VirtualSign::new(Address(3), PageFlipStyle::Manual)]);
let port = serial::open("/dev/ttyUSB0")?;
let mut odk = Odk::try_new(port, bus)?;
loop {
    odk.process_message()?;
}

Trait Implementations

impl<P: Debug + SerialPort, B: Debug + SignBus> Debug for Odk<P, B>

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

Formats the value using the given formatter.

impl<P: Hash + SerialPort, B: Hash + SignBus> Hash for Odk<P, B>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P: PartialEq + SerialPort, B: PartialEq + SignBus> PartialEq for Odk<P, B>

fn eq(&self, other: &Odk<P, B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: Eq + SerialPort, B: Eq + SignBus> Eq for Odk<P, B>

impl<P: SerialPort, B: SignBus> StructuralPartialEq for Odk<P, B>