Struct ReconnectingDevice

pub struct ReconnectingDevice { /* private fields */ }

A device wrapper that automatically handles reconnection.

This wrapper caches the device name and type upon initial connection so they can be accessed synchronously via the AranetDevice trait, even while reconnecting.

Implementations

impl ReconnectingDevice

pub async fn connect( identifier: &str, options: ReconnectOptions, ) -> Result<Self>

Create a new reconnecting device wrapper.

pub async fn connect_with_events( identifier: &str, options: ReconnectOptions, event_sender: EventSender, ) -> Result<Self>

Create with an event sender for notifications.

pub fn cancel_reconnect(&self)

Cancel any ongoing reconnection attempts.

This will cause the reconnect loop to exit on its next iteration.

pub fn is_cancelled(&self) -> bool

Check if reconnection has been cancelled.

pub fn reset_cancellation(&self)

Reset the cancellation flag.

Call this before starting a new reconnection attempt if you want to clear a previous cancellation. The reconnect() method will check if cancelled at the start of each iteration, so this allows re-using a previously cancelled ReconnectingDevice.

pub async fn state(&self) -> ConnectionState

Get the current connection state.

pub async fn is_connected(&self) -> bool

Check if currently connected.

pub fn identifier(&self) -> &str

Get the identifier.

pub async fn with_device<F, Fut, T>(&self, f: F) -> Result<T>

where F: Fn(&Device) -> Fut, Fut: Future<Output = Result<T>>,

Execute an operation, reconnecting if necessary.

The closure is called with a reference to the device. If the operation fails due to a connection issue, the device will attempt to reconnect and retry the operation.

Example

let reading = device.with_device(|d| async { d.read_current().await }).await?;

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

Attempt to reconnect to the device.

This loop can be cancelled by calling cancel_reconnect() from another task. When cancelled, returns Error::Cancelled.

Note: If cancel_reconnect() was called before this method, reconnection will still proceed. Call reset_cancellation() explicitly if you want to clear a previous cancellation before starting a new reconnection attempt.

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

Disconnect from the device.

pub async fn attempt_count(&self) -> u32

Get the number of reconnection attempts made.

pub async fn name(&self) -> Option<String>

Get the device name, if available and connected.

pub async fn address(&self) -> String

Get the device address (returns identifier if not connected).

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

Get the detected device type, if available.

Trait Implementations

impl AranetDevice for ReconnectingDevice

fn is_connected<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if the device is connected.

fn connect<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Connect to the device.

fn disconnect<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disconnect from the device.

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

Get the device name, if available.

fn address(&self) -> &str

Get the device address or identifier.

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

Get the detected device type, if available.

fn read_current<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CurrentReading>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read the current sensor values.

fn read_device_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DeviceInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read device information (model, serial, firmware version, etc.).

fn read_rssi<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i16>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read the current RSSI (signal strength) in dBm.

fn read_battery<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u8>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read the battery level (0-100).

fn get_history_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HistoryInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get information about stored history.

fn download_history<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<HistoryRecord>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Download all historical readings.

fn download_history_with_options<'life0, 'async_trait>( &'life0 self, options: HistoryOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<HistoryRecord>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Download historical readings with custom options.

fn get_interval<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<MeasurementInterval>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the current measurement interval.

fn set_interval<'life0, 'async_trait>( &'life0 self, interval: MeasurementInterval, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the measurement interval.

fn get_calibration<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CalibrationData>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read calibration data from the device.