Struct Serial

pub struct Serial { /* private fields */ }

Represents an IoTransport layer based on a serial connection.

Uses serialport crate.

Implementations

impl Serial

pub fn new<P: Into<String>>(port: P) -> Self

Constructs a new Serial transport layer instance for communication through the specified port.

Example

use hermes_five::hardware::Board;
use hermes_five::io::RemoteIo;

#[hermes_five::runtime]
async fn main() {
    let protocol = RemoteIo::new("/dev/ttyACM0");
    let board = Board::new(protocol).open();
}

pub fn get_port(&self) -> String

Returns the configured port.

Trait Implementations

impl Clone for Serial

fn clone(&self) -> Serial

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Serial

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

Formats the value using the given formatter.

impl Default for Serial

fn default() -> Self

Creates a new serial transport connection with the first available port or an empty string if no ports are available.

Notes

The first available port will be used, None otherwise, which will probably lead to an error during the open phase.

impl Display for Serial

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

Formats the value using the given formatter.

impl IoTransport for Serial

fn open(&mut self) -> Result<(), Error>

Opens communication (in a blocking way) using the transport layer.

fn close(&mut self) -> Result<(), Error>

Gracefully shuts down the transport layer.

fn set_timeout(&mut self, duration: Duration) -> Result<(), Error>

Sets a timeout for the transport layer

fn write(&mut self, buf: &[u8]) -> Result<(), Error>

Write bytes to the internal connection. For more details see std::io::Write::write.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads from the internal connection. For more details see std::io::Read::read_exact.