Crate adafruit_ble_fs_client

Client-side implementation of the Adafruit BLE file transfer protocol

Provides a client-side interface to interact with a device which exposes files with the Adafruit BLE file transfer protocol. The protocol is documented here: https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer#protocol

This library is designed to enable you to bring your own bluetooth handler by implementing the adafruit_ble_fs_client::device::Device trait. Or you can use the implementations in the adafruit_ble_fs_client::providers module.

Example

use adafruit_ble_fs_client::AdafruitFileTransferClient;
use adafruit_ble_fs_client::providers::btleplug_provider::BtleplugDevice;

#[tokio::main]
async fn main() {
    let client = AdafruitFileTransferClient::<BtleplugDevice>::new_from_device_name("device-name")
        .await
        .unwrap();
    let version = client.get_version().await
        .unwrap();
    println!("Your client is running adafruit ble-fs version {version:?}");
    let files = client.list_directory("/").await.expect("Unable to list directory /");
    println!("Files in /: {files:?}");
}

Modules

providers

Contains implementations of the Device trait for different bluetooth handlers

Structs

AdafruitFileTransferClient

The main implementation of the file transfer protocol

Error

The main error type.

ResponseError

The error type for failures indicated by the responses coming from the device.

Traits

Device

Abstraction for communication with a BLE device Abstraction for communication with a BLE device