Ports

BluetoothCancellationCopy Anchor Link

class BluetoothCancellation

Cancels a pending peripheral connection or device driver.

ConstructorsCopy Anchor Link

BluetoothCancellation.newCopy Anchor Link

BluetoothCancellation()

PropertiesCopy Anchor Link

BluetoothCancellation.isCancelledCopy Anchor Link

bool get isCancelled

Whether cancellation has been requested.

BluetoothCancellation.whenCancelledCopy Anchor Link

Future<void> get whenCancelled

Completes when cancellation is requested.

MethodsCopy Anchor Link

BluetoothCancellation.cancelCopy Anchor Link

void cancel()

Requests cancellation once.

Returns void.

BluetoothLinkCopy Anchor Link

abstract interface class BluetoothLink

An open GATT connection that can read and write characteristics.

MethodsCopy Anchor Link

BluetoothLink.subscribeCopy Anchor Link

Stream<List<int>> subscribe(String service, String characteristic)

Listens to notifications or indications for one characteristic.

Returns Stream<List<int>>.

BluetoothLink.writeCopy Anchor Link

Future<void> write(
  String service,
  String characteristic,
  List<int> bytes,
)

Writes bytes to a characteristic with response.

Returns Future<void>.

BluetoothLink.closeCopy Anchor Link

Future<void> close()

Cancels subscriptions and disconnects.

Returns Future<void>.

BluetoothPeripheralCopy Anchor Link

abstract interface class BluetoothPeripheral

A Bluetooth peripheral discovered by a BluetoothScanner.

PropertiesCopy Anchor Link

BluetoothPeripheral.idCopy Anchor Link

String get id

The platform identifier for this peripheral.

BluetoothPeripheral.advertisementCopy Anchor Link

BluetoothAdvertisement get advertisement

What this peripheral advertises.

MethodsCopy Anchor Link

BluetoothPeripheral.openLinkCopy Anchor Link

Future<BluetoothLink> openLink(BluetoothCancellation cancellation)

Connects and discovers services, stopping if cancellation is requested.

Returns Future<BluetoothLink>.

BluetoothPermissionsCopy Anchor Link

abstract interface class BluetoothPermissions

Bluetooth permission checks and system prompts.

MethodsCopy Anchor Link

BluetoothPermissions.checkCopy Anchor Link

Future<BluetoothPermission> check()

Reads the current permission without prompting.

Returns Future<BluetoothPermission>.

BluetoothPermissions.requestCopy Anchor Link

Future<BluetoothPermission> request()

Prompts for Bluetooth permission when the operating system permits it.

Returns Future<BluetoothPermission>.

BluetoothPermissions.openSettingsCopy Anchor Link

Future<void> openSettings()

Opens the app's system settings.

Returns Future<void>.

BluetoothReadingSinkCopy Anchor Link

abstract interface class BluetoothReadingSink

Stores measurements reported by Bluetooth devices.

MethodsCopy Anchor Link

BluetoothReadingSink.saveCopy Anchor Link

Future<BluetoothSaveResult> save(BluetoothDeviceReading reading)

Saves a reading or queues it for an offline retry.

Returns Future<BluetoothSaveResult>.

BluetoothReadingSink.flushQueuedCopy Anchor Link

Future<List<String>> flushQueued()

Retries queued readings and returns the IDs that were saved.

Returns Future<List<String>>.

BluetoothSaveResultCopy Anchor Link

class BluetoothSaveResult

A completed measurement save.

ConstructorsCopy Anchor Link

BluetoothSaveResult.savedCopy Anchor Link

BluetoothSaveResult.saved()

Creates a saved result.

BluetoothSaveResult.queuedCopy Anchor Link

BluetoothSaveResult.queued(String queueId)

Creates an offline queued result.

PropertiesCopy Anchor Link

BluetoothSaveResult.statusCopy Anchor Link

final BluetoothSaveStatus status

The save outcome.

BluetoothSaveResult.queueIdCopy Anchor Link

final String? queueId

The offline queue ID when queued.

BluetoothScannerCopy Anchor Link

abstract interface class BluetoothScanner

The platform adapter's state and scan stream.

PropertiesCopy Anchor Link

BluetoothScanner.stateCopy Anchor Link

BluetoothAdapterState get state

The adapter's current state.

BluetoothScanner.stateChangesCopy Anchor Link

Stream<BluetoothAdapterState> get stateChanges

Adapter state changes, including the first state when the stream is listened to.

MethodsCopy Anchor Link

BluetoothScanner.scanCopy Anchor Link

Stream<BluetoothPeripheral> scan()

Scans until the listener cancels or an error occurs.

Returns Stream<BluetoothPeripheral>.