Struct Client 

pub struct Client<T: Transport> { /* private fields */ }

High-level DongLoRa client, generic over transport.

Works with any Transport: direct USB serial, Unix socket mux, or TCP mux.

Implementations

impl<T: Transport> Client<T>

pub fn new(transport: T) -> Self

Create a new client wrapping the given transport.

pub fn send(&mut self, cmd: Command) -> Result<Response>

Send a command and wait for the solicited response.

Any unsolicited RxPacket frames encountered while waiting are buffered and retrievable via recv or drain_rx.

pub fn recv(&mut self) -> Result<Option<Response>>

Return the next RxPacket from the buffer or the wire.

Returns Ok(None) on timeout (no packet available).

pub fn drain_rx(&mut self) -> Result<Vec<Response>>

Drain all buffered and pending RxPacket frames.

Temporarily reduces the read timeout to quickly drain any frames still in flight, then restores the original timeout.

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

Validate the connection by pinging the device.

Uses a short timeout to fail fast on non-DongLoRa devices (e.g. USB-UART bridges that happen to match known VID:PIDs). Called automatically by the connect family of functions.

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

Send a Ping and verify the Pong response.

Examples found in repository

examples/ping.rs (line 12)

fn main() -> anyhow::Result<()> {
    let mut client = try_connect(Duration::from_secs(2))?;
    println!("connected!");

    client.ping()?;
    println!("ping ok");

    let mac = client.get_mac()?;
    println!("MAC: {:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);

    let config = client.get_config()?;
    println!("current config: {config:?}");

    client.set_config(RadioConfig::default())?;
    println!("config set to defaults");

    Ok(())
}

pub fn set_config(&mut self, config: RadioConfig) -> Result<()>

Set the radio configuration.

Examples found in repository

examples/ping.rs (line 21)

fn main() -> anyhow::Result<()> {
    let mut client = try_connect(Duration::from_secs(2))?;
    println!("connected!");

    client.ping()?;
    println!("ping ok");

    let mac = client.get_mac()?;
    println!("MAC: {:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);

    let config = client.get_config()?;
    println!("current config: {config:?}");

    client.set_config(RadioConfig::default())?;
    println!("config set to defaults");

    Ok(())
}

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

Start receiving LoRa packets.

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

Stop receiving LoRa packets.

pub fn transmit( &mut self, payload: &[u8], config: Option<RadioConfig>, ) -> Result<()>

Transmit a LoRa packet.

pub fn get_mac(&mut self) -> Result<[u8; 6]>

Get the board’s MAC address.

Examples found in repository

examples/ping.rs (line 15)

fn main() -> anyhow::Result<()> {
    let mut client = try_connect(Duration::from_secs(2))?;
    println!("connected!");

    client.ping()?;
    println!("ping ok");

    let mac = client.get_mac()?;
    println!("MAC: {:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);

    let config = client.get_config()?;
    println!("current config: {config:?}");

    client.set_config(RadioConfig::default())?;
    println!("config set to defaults");

    Ok(())
}

pub fn get_config(&mut self) -> Result<RadioConfig>

Get the current radio configuration from the device.

Examples found in repository

examples/ping.rs (line 18)

fn main() -> anyhow::Result<()> {
    let mut client = try_connect(Duration::from_secs(2))?;
    println!("connected!");

    client.ping()?;
    println!("ping ok");

    let mac = client.get_mac()?;
    println!("MAC: {:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);

    let config = client.get_config()?;
    println!("current config: {config:?}");

    client.set_config(RadioConfig::default())?;
    println!("config set to defaults");

    Ok(())
}

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

Turn on the display (if present).

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

Turn off the display (if present).

pub fn into_inner(self) -> T

Consume the client and return the inner transport.

pub fn transport(&self) -> &T

Get a reference to the inner transport.

pub fn transport_mut(&mut self) -> &mut T

Get a mutable reference to the inner transport.