Struct LagerBox 

pub struct LagerBox { /* private fields */ }

A connection to one Lager box, over blocking HTTP.

Cheap to construct: no network traffic happens until the first call. Net handles borrow the client, so a typical test creates one LagerBox and any number of handles from it.

use lager::LagerBox;

fn main() -> lager::Result<()> {
    let lager = LagerBox::connect("192.168.1.42")?;
    let supply = lager.supply("supply1");
    supply.set_voltage(3.3)?;
    supply.enable()?;
    let v = lager.adc("vbat_sense").read()?;
    assert!((v - 3.3).abs() < 0.1);
    supply.disable()
}

Implementations

impl LagerBox

pub fn connect(host: impl Into<String>) -> Result<Self>

Connect to a box by host name, IP, host:port, or full URL. The port defaults to 9000 (the box HTTP server).

pub fn from_env() -> Result<Self>

Connect to the box named by the LAGER_BOX_HOST environment variable.

pub fn builder(host: impl Into<String>) -> LagerBoxBuilder

Start building a client with non-default settings.

pub fn base_url(&self) -> &str

The base URL this client talks to, e.g. http://192.168.1.42:9000.

pub fn nets(&self) -> Result<Vec<NetRecord>>

List every net configured on the box (full saved records).

Falls back to the older /uart/nets/list shape for box images that predate /nets/list, like the Lager CLI does.

pub fn health(&self) -> Result<Health>

Check that the box HTTP server is up.

pub fn status(&self) -> Result<BoxStatus>

Box status: version, configured nets, and endpoint capabilities.

pub fn supply(&self, name: impl Into<String>) -> Supply<'_>

Handle for a power-supply net.

pub fn battery(&self, name: impl Into<String>) -> Battery<'_>

Handle for a battery-simulator net.

pub fn eload(&self, name: impl Into<String>) -> Eload<'_>

Handle for an electronic-load net.

pub fn solar(&self, name: impl Into<String>) -> Solar<'_>

Handle for a solar-simulator net (EA PSB photovoltaic mode).

pub fn gpio(&self, name: impl Into<String>) -> Gpio<'_>

Handle for a GPIO net.

pub fn adc(&self, name: impl Into<String>) -> Adc<'_>

Handle for an ADC net.

pub fn dac(&self, name: impl Into<String>) -> Dac<'_>

Handle for a DAC net.

pub fn thermocouple(&self, name: impl Into<String>) -> Thermocouple<'_>

Handle for a thermocouple net.

pub fn watt_meter(&self, name: impl Into<String>) -> WattMeter<'_>

Handle for a watt-meter net.

pub fn energy_analyzer(&self, name: impl Into<String>) -> EnergyAnalyzer<'_>

Handle for an energy-analyzer net.

pub fn spi(&self, name: impl Into<String>) -> Spi<'_>

Handle for an SPI bus net.

pub fn i2c(&self, name: impl Into<String>) -> I2c<'_>

Handle for an I2C bus net.

pub fn usb(&self, name: impl Into<String>) -> UsbPort<'_>

Handle for a USB hub port net.

pub fn arm(&self, name: impl Into<String>) -> Arm<'_>

Handle for a robot-arm net (Rotrics Dexarm).

pub fn webcam(&self, name: impl Into<String>) -> Webcam<'_>

Handle for a webcam net (MJPEG streaming).

pub fn router(&self, name: impl Into<String>) -> Router<'_>

Handle for a router net (MikroTik RouterOS).

pub fn ble(&self) -> Ble<'_>

Handle for the box’s BLE adapter (box-level, not a saved net).

pub fn wifi(&self) -> Wifi<'_>

Handle for the box’s WiFi interface (box-level, not a saved net).

pub fn blufi(&self) -> Blufi<'_>

Handle for BluFi (ESP32 WiFi provisioning over BLE; box-level).

pub fn debug(&self, name: impl Into<String>) -> DebugNet<'_>

Handle for a debug-probe net (flash/erase/reset/read_memory/RTT). Talks to the box debug service on port 8765.

pub fn scope(&self, name: impl Into<String>) -> Scope

Handle for an oscilloscope net. Stub: see Scope.

pub fn uart(&self, name: impl Into<String>) -> Result<Uart>

Open a streaming UART session on a UART net.

Connects a Socket.IO session to the box’s /uart namespace and starts streaming. Only one session per net (box-enforced).