Struct DeviceGuard

Source

pub struct DeviceGuard { /* private fields */ }

Expand description

A guard that automatically disconnects from the device when dropped.

This provides RAII-style management of BLE connections. When the guard is dropped, it will attempt to disconnect from the device.

§Example

use aranet_core::{Device, DeviceGuard};

async fn read_with_guard() -> Result<(), Box<dyn std::error::Error>> {
    let device = Device::connect("Aranet4 12345").await?;
    let guard = DeviceGuard::new(device);

    // Use the device through the guard
    let reading = guard.read_current().await?;
    println!("CO2: {}", reading.co2);

    // Device is automatically disconnected when guard goes out of scope
    Ok(())
}

Implementations§

Source §

impl DeviceGuard

Source

pub fn new(device: Device) -> Self

Create a new device guard.

Source

pub fn into_inner(self) -> Device

Take ownership of the device, preventing automatic disconnect.

After calling this, you are responsible for disconnecting the device.

Source

pub fn device(&self) -> &Device

Get a reference to the device.

Source

pub fn device_mut(&mut self) -> &mut Device

Get a mutable reference to the device.

Methods from Deref<Target = Device>§

Source

pub async fn is_connected(&self) -> bool

Check if the device is connected.

Source

pub async fn disconnect(&self) -> Result<()>

Disconnect from the device.

This will:

Abort all active notification handlers
Disconnect from the BLE peripheral

Important: You MUST call this method before dropping the Device to ensure proper cleanup of BLE resources.

Source

pub fn name(&self) -> Option<&str>

Get the device name.

Source

pub fn address(&self) -> &str

Get the device address or identifier.

On Linux and Windows, this returns the Bluetooth MAC address (e.g., “AA:BB:CC:DD:EE:FF”). On macOS, this returns a UUID identifier since MAC addresses are not exposed.

Source

pub fn device_type(&self) -> Option<DeviceType>

Get the detected device type.

Source

pub async fn read_rssi(&self) -> Result<i16>

Read the current RSSI (signal strength) of the connection.

Returns the RSSI in dBm. More negative values indicate weaker signals. Typical values range from -30 (strong) to -90 (weak).

Source

pub async fn read_characteristic(&self, uuid: Uuid) -> Result<Vec<u8>>

Read a characteristic value by UUID.

This method includes a timeout to prevent indefinite hangs on BLE operations. The default timeout is 10 seconds.

Source

pub async fn write_characteristic(&self, uuid: Uuid, data: &[u8]) -> Result<()>

Write a value to a characteristic.

This method includes a timeout to prevent indefinite hangs on BLE operations. The default timeout is 10 seconds.

Source

pub async fn read_current(&self) -> Result<CurrentReading>

Read current sensor measurements.

Automatically selects the correct characteristic UUID based on device type:

Aranet4 uses f0cd3001
Aranet2, Radon, Radiation use f0cd3003

Source

pub async fn read_battery(&self) -> Result<u8>

Read the battery level (0-100).

Source

pub async fn read_device_info(&self) -> Result<DeviceInfo>

Read device information.

This method reads all device info characteristics in parallel for better performance.

Source

pub async fn subscribe_to_notifications<F>( &self, uuid: Uuid, callback: F, ) -> Result<()>
where F: Fn(&[u8]) + Send + Sync + 'static,

Subscribe to notifications on a characteristic.

The callback will be invoked for each notification received. The notification handler task is tracked and will be aborted when disconnect() is called.

Source

pub async fn unsubscribe_from_notifications(&self, uuid: Uuid) -> Result<()>

Unsubscribe from notifications on a characteristic.

Source

pub async fn get_history_info(&self) -> Result<HistoryInfo>

Get information about the stored history.

Source

pub async fn download_history(&self) -> Result<Vec<HistoryRecord>>

Download all historical readings from the device.

Source

pub async fn download_history_with_options( &self, options: HistoryOptions, ) -> Result<Vec<HistoryRecord>>

Download historical readings with custom options.

§Device Support

Aranet4: Downloads CO₂, temperature, pressure, humidity
Aranet2: Downloads temperature, humidity
AranetRn+ (Radon): Downloads radon, temperature, pressure, humidity
Aranet Radiation: Not yet supported - will return Aranet4-style records with placeholder values. The radiation_rate and radiation_total fields in the returned records will be None.