Runtime

BluetoothRuntimeCopy Anchor Link

class BluetoothRuntime

Scans for supported devices, connects, reads measurements and saves each one.

ConstructorsCopy Anchor Link

BluetoothRuntime.newCopy Anchor Link

BluetoothRuntime(BluetoothRuntimeOptions options)

Creates a runtime from platform ports and matching device drivers.

MethodsCopy Anchor Link

BluetoothRuntime.getSnapshotCopy Anchor Link

BluetoothSnapshot getSnapshot()

The current immutable runtime snapshot.

Returns BluetoothSnapshot.

BluetoothRuntime.subscribeCopy Anchor Link

Stream<BluetoothSnapshot> subscribe()

Emits the current snapshot followed by every state change.

Returns Stream<BluetoothSnapshot>.

BluetoothRuntime.checkPermissionCopy Anchor Link

Future<BluetoothPermission> checkPermission()

Reads Bluetooth permission without prompting.

Returns Future<BluetoothPermission>.

BluetoothRuntime.requestPermissionCopy Anchor Link

Future<BluetoothPermission> requestPermission()

Prompts for Bluetooth permission when the operating system permits it.

Returns Future<BluetoothPermission>.

BluetoothRuntime.openPermissionSettingsCopy Anchor Link

Future<void> openPermissionSettings()

Opens the app's system settings.

Returns Future<void>.

BluetoothRuntime.startScanCopy Anchor Link

Future<void> startScan()

Requests permission if needed, then scans whenever Bluetooth is on.

Returns Future<void>.

BluetoothRuntime.stopScanCopy Anchor Link

void stopScan()

Stops scanning while leaving connected devices active.

Returns void.

BluetoothRuntime.connectCopy Anchor Link

Future<void> connect(String deviceId)

Connects to a supported device found by a scan.

Returns Future<void>.

BluetoothRuntime.disconnectCopy Anchor Link

Future<void> disconnect(String deviceId)

Disconnects a device and suspends automatic reconnects for this session.

Returns Future<void>.

BluetoothRuntime.pairCopy Anchor Link

Future<void> pair(String deviceId)

Remembers and connects to a device, including after later scans.

Returns Future<void>.

BluetoothRuntime.forgetCopy Anchor Link

Future<void> forget(String deviceId)

Forgets a paired device and disconnects it.

Returns Future<void>.

BluetoothRuntime.retrySavesCopy Anchor Link

Future<void> retrySaves()

Retries failed saves and flushes the sink's offline queue.

Returns Future<void>.

BluetoothRuntime.disposeCopy Anchor Link

Future<void> dispose()

Stops scanning and waits for every device to disconnect.

Returns Future<void>.

BluetoothRuntimeOptionsCopy Anchor Link

class BluetoothRuntimeOptions

Dependencies for a BluetoothRuntime.

ConstructorsCopy Anchor Link

BluetoothRuntimeOptions.newCopy Anchor Link

BluetoothRuntimeOptions({
  required BluetoothScanner scanner,
  required BluetoothPermissions permissions,
  required BluetoothReadingSink sink,
  required Iterable<BluetoothDeviceSupport> devices,
  ResultPolicy? resultPolicy,
  OvokSecureStore? pairedStorage,
})

Creates a runtime configuration from platform ports and device support.

PropertiesCopy Anchor Link

BluetoothRuntimeOptions.scannerCopy Anchor Link

final BluetoothScanner scanner

The BLE adapter.

BluetoothRuntimeOptions.permissionsCopy Anchor Link

final BluetoothPermissions permissions

The operating system permission prompts.

BluetoothRuntimeOptions.sinkCopy Anchor Link

final BluetoothReadingSink sink

Where device readings are saved.

BluetoothRuntimeOptions.devicesCopy Anchor Link

final List<BluetoothDeviceSupport> devices

The device drivers considered by the runtime, in match priority order.

BluetoothRuntimeOptions.resultPolicyCopy Anchor Link

final ResultPolicy? resultPolicy

Selects readings to save; defaults to every reading.

BluetoothRuntimeOptions.pairedStorageCopy Anchor Link

final OvokSecureStore? pairedStorage

Secure storage for paired device IDs; pairing lasts for this session if omitted.