Struct fdcanusb::FdCanUSB

pub struct FdCanUSB<T>
where
    T: Write + Read,
{ /* private fields */ }

FdCanUSB communications struct

Can be used with any transport type that implements std::io::Write and std::io::Read The baud rate is unused, as the FdCanUSB communicates via USB CDC

Example

use fdcanusb::{FdCanUSB, serial2};
let transport = serial2::SerialPort::open("/dev/fdcanusb", serial2::KeepSettings)?;
let mut fdcanusb = FdCanUSB::new(transport);

serial2 Integration

To use the FdCanUSB with a serial2::SerialPort, you can use the FdCanUSB::open method.

Example

use fdcanusb::FdCanUSB;

let mut fdcanusb = FdCanUSB::open("/dev/fdcanusb", serial2::KeepSettings).expect("Failed to open serial port");

Implementations

impl FdCanUSB<SerialPort>

pub fn open<P: AsRef<Path>>( path: P, serial_settings: impl IntoSettings, ) -> Result<Self>

For convenience, we provide a FdCanUSB implementation for serial2::SerialPort. Enable with the serial2 feature.

pub fn flush(&mut self) -> Result<()>

impl<T> FdCanUSB<T>

where T: Write + Read,

pub fn new(transport: T) -> Self

Create a new FdCanUSB instance

pub fn transfer_single( &mut self, frame: CanFdFrame, response: bool, ) -> Result<Option<CanFdFrame>>

Transfer a single frame. If response is true, the function will wait for a response frame. Otherwise, it will return None.

pub fn write_frame(&mut self, frame: FdCanUSBFrame) -> Result<()>

Write a frame to the FdCanUSB

Frames are logged at the trace level by default.

pub fn read_ok(&mut self) -> Result<()>

The FdCanUSB responds with OK after a correct frame is parsed. read_ok waits for this response, and returns an error if it is not received.

pub fn read_response(&mut self) -> Result<CanFdFrame>

Read a response frame from the FdCanUSB. Responses are logged at the trace level by default.

Trait Implementations

impl<T> Debug for FdCanUSB<T>

where T: Write + Read + Debug,

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

Formats the value using the given formatter.