Struct plm::Modem

pub struct Modem { /* fields omitted */ }

A Modem is a connection to an INSTEON Modem. It can be used to send Messages and manage device links (e.g. Modem::link_device).

Implementations

impl Modem

pub fn from_path(path: impl AsRef<Path> + Send + 'static) -> Result<Self>

Constructs a new Modem given a path to a serial port

Arguments

• path - The path to a serial port with an INSTEON modem attached.

pub fn new(
    handle: impl AsyncReadExt + AsyncWriteExt + Unpin + Send + 'static
) -> Modem

Constructs a new Modem from an arbitrary I/O modem

Arguments

• handle - An async readable, writable modem

pub async fn send_message<'_>(
    &'_ mut self,
    message: Message
) -> Result<Message, Error>

Sends a Message. This uses the default timeout duration defined by DEFAULT_TIMEOUT_DURATION.

Returns an acknowledged Message or an error.

pub async fn send_message_with_timeout<'_>(
    &'_ mut self,
    message: Message,
    duration: Duration
) -> Result<Message, Error>

Sends a Message with the specified timeout duration.

Returns an acknowledged Message or an error.

pub async fn get_info<'_>(&'_ mut self) -> Result<ModemInfo, Error>

Retrieve information about the attached modem.

pub async fn get_links<'_>(
    &'_ mut self
) -> Result<impl Iterator<Item = AllLinkRecord>, Error>

Return the link database stored in the modem.

pub async fn listen<'_>(
    &'_ mut self
) -> Result<impl Stream<Item = Message> + Sync + Send + Unpin, Error>

Listens for incoming Messages and delivers them on the returned Stream.

pub async fn link_device<'_>(
    &'_ mut self,
    address: Option<Address>,
    mode: AllLinkMode,
    group: u8
) -> Result<AllLinkComplete, Error>

Link a new device to the modem.