The stress-server is a scriptable "chaos" BLE GATT peripheral designed for stress-testing the tauri-plugin-blec client. It runs on a Linux host using BlueZ and can simulate various network and device failures, such as dropping links, hiding advertisements, flooding notifications, delaying responses, failing requests, and simulating reboots (re-registering the GATT application).

It is built with the bluer crate and follows a specific wire protocol defined in ../stress-protocol.md.

The plugin provides a default set of permissions that allow access to various BLE (Bluetooth Low Energy) operations without a pre-configured scope. If you use the default permission set, the following capabilities are enabled:

• Scanning: allow-scan, allow-stop-scan, allow-scanning-state
• Connection: allow-connect, allow-disconnect, allow-connection-state
• Data Transfer: allow-send, allow-recv, allow-send-string, allow-recv-string
• Subscriptions: allow-subscribe, allow-subscribe-string, allow-unsubscribe
• Configuration & State: allow-get-adapter-state, allow-list-services, allow-mtu, allow-set-android-mtu, allow-set-timeouts, allow-set-write-behavior
• Permissions: allow-check-permissions

Integration scripts are fixed timelines followed independently by both the client and the server.

Execution Lifecycle

1. Baseline State: Before starting, the client must be connected and subscribed to ECHO and COUNTER.
2. Triggering: The client sends a CONTROL write with 0x10 and a script_id.
3. Timing: The client's t0 is the moment the 0x10 write returns; the server's t0 is the receipt of that write.
4. Completion: The server reaches done when its last step resolves. The client polls REPORT until the server state is done or aborted.
5. Cleanup: After a script, the client restores the baseline state before starting the next one.

Script Verdict

A script is considered a PASS only if every server step and every client step passed. If a step's time window elapses before its condition is met, the step fails.

Navigate to the examples/stress-server directory and use cargo run. You can provide commands via stdin or drive it via the CONTROL characteristic.

cd examples/stress-server
# Standard run with default name 'blec_stress'
cargo run -- --name blec_stress

# Run with debug logging for bluer
RUST_LOG=bluer=debug cargo run

To debug timing issues, merge the server and client logs. Both sides use Unix millisecond timestamps as the first column.

1. Copy the client log using the Copy log button.
2. Save both the server log and client log to files (e.g., server.log and client.log).
3. Merge and sort them by timestamp:

cat server.log client.log | sort -n > merged.log

Note: Ensure both devices have synchronized clocks (NTP) for accurate correlation.

You must initialize the plugin within your Tauri builder in src-tauri/src/lib.rs. You can use init() for a standard setup or try_init() if you want to handle potential initialization errors gracefully.

// Standard initialization
tauri::Builder::default()
    .plugin(tauri_plugin_blec::init())
    .run(tauri::generate_context!())
    .expect("error while running tauri application");

// Graceful initialization
let mut app = tauri::Builder::default();
app = match tauri_plugin_blec::try_init() {
    Ok(plugin) => app.plugin(plugin),
    Err(e) => {
        eprintln!("Failed to initialize blec plugin: {:?}", e);
        app
    }
};
app.run(tauri::generate_context())
    .expect("error while running tauri application");

By default, TypeScript treats .vue imports as generic Vue component types, which may prevent you from seeing actual prop types when importing components into TypeScript files (e.g., when using manual h(...) calls).

To get full type support, you must enable Volar's Take Over mode in VS Code:

1. Open the VS Code command palette and run Extensions: Show Built-in Extensions.
2. Locate the TypeScript and JavaScript Language Features extension.
3. Right-click it and select Disable (Workspace).
4. Open the command palette and run Developer: Reload Window to apply the changes.

This allows Volar to take over the TypeScript service, providing better type information for Vue files.

To use the plugin in your Tauri project, you must add the Rust crate to your src-tauri directory. You can do this using cargo add or by manually editing your Cargo.toml file.

cargo add tauri-plugin-blec

Or manually in src-tauri/Cargo.toml

[dependencies]
tauri-plugin-blec = "0.12"

To support Bluetooth on iOS, you must perform two steps:

1. Update Info.plist: Add the NSBluetoothAlwaysUsageDescription key with a description of why your app uses Bluetooth.
2. Add CoreBluetooth Framework:
   • Open your project using tauri ios dev --open.
   • In Xcode, select your project.
   • Under General -> Frameworks, Libraries, and Embedded Content, add the CoreBluetooth framework.

<key>NSBluetoothAlwaysUsageDescription</key>
<string>The App uses Bluetooth to communicate with BLE devices</string>