Bluetooth for `@ovok/native/next` in browsers, over Web Bluetooth: the same `BluetoothRuntime`, devices, result

Bluetooth for @ovok/native/next in browsers, over Web Bluetooth: the same BluetoothRuntime, devices, result policies and hooks as @ovok/native/next/bluetooth, with a Web Bluetooth scanner instead of react-native-ble-plx. Nothing here loads react-native-ble-plx or react-native-permissions, so a web bundle can import it.

Import from @ovok/native/next/bluetooth/web.

Functions

createWebBluetoothRuntime()

function createWebBluetoothRuntime(__namedParameters): BluetoothRuntime;

A BluetoothRuntime wired for browsers: Web Bluetooth through scanner, saving through client.

Parameters

Parameter	Type
`__namedParameters`	`CreateWebBluetoothRuntimeOptions`

Returns

BluetoothRuntime

isWebBluetoothAvailable()

function isWebBluetoothAvailable(): boolean;

Whether this browser has Web Bluetooth, such as Chrome and Edge on desktop and Android, or Bluefy on iOS.

Returns

boolean

webBluetoothPermissions()

function webBluetoothPermissions(): BluetoothPermissions;

Browser permissions: the browser asks per device in its chooser, so there is no prompt to show first. Granted where the browser has Web Bluetooth, denied where it has none; no settings page can change that.

Returns

BluetoothPermissions

webBluetoothScanner()

function webBluetoothScanner(__namedParameters?): WebBluetoothScanner;

Finds devices through Web Bluetooth. A scan reports the devices this site may already use (getDevices, where the browser has it) and every device picked with chooseDevice; browsers can't scan in the background or without the user picking.

Parameters

Parameter	Type
`__namedParameters?`	`WebBluetoothScannerOptions`

Returns

WebBluetoothScanner

webBluetoothServicesFor()

function webBluetoothServicesFor(acceptedDevices?): string[];

WEB_BLUETOOTH_SERVICES and the services of the defineCustomDevice declarations among acceptedDevices.

Parameters

Parameter	Type	Default value
`acceptedDevices?`	readonly `AcceptedDevice`[]	`[]`

Returns

string[]

Interfaces

WebBluetoothScanner

A BluetoothScanner for browsers, where a page only reaches the devices the user picks in the browser's chooser.

Extends

BluetoothScanner

Methods

chooseDevice()

chooseDevice(): Promise<Peripheral | undefined>;

Opens the browser's device chooser, so it must run from a user gesture such as a tap. Resolves to the picked device, which a running scan also reports, or to undefined when the user closes the chooser.

Returns

Promise<Peripheral | undefined>

scan()

scan(onFound, onError): () => void;

Reports peripherals until the returned stop is called; onError may be called before scan returns.

Parameters

Parameter	Type
`onFound`	(`peripheral`) => `void`
`onError`	(`error`) => `void`

Returns

() => void

Inherited from

BluetoothScanner.scan

watchState()

watchState(listener): () => void;

Reports the adapter state now and on every change; returns the unsubscribe.

Parameters

Parameter	Type
`listener`	(`state`) => `void`

Returns

() => void

Inherited from

BluetoothScanner.watchState

Type Aliases

CreateWebBluetoothRuntimeOptions

type CreateWebBluetoothRuntimeOptions = object;

What createWebBluetoothRuntime needs.

Properties

client

client: Pick<Ovok, "measurements">;

Saves the readings.

devices

devices: readonly DeviceSupport[];

The devices to look for.

pairedStorage?

pairedStorage?: OvokStorage;

Where the paired device IDs persist; without it pairing lasts until the runtime is disposed.

resultPolicy?

resultPolicy?: ResultPolicy;

Which readings of a connection to keep; defaults to every reading.

scanner

scanner: WebBluetoothScanner;

The browser's devices, from webBluetoothScanner; the app calls its chooseDevice from a tap.

WebBluetoothScannerOptions

type WebBluetoothScannerOptions = object;

What webBluetoothScanner needs.

Properties

acceptedDevices?

acceptedDevices?: readonly AcceptedDevice[];

The accepted devices; the chooser also allows the services of their defineCustomDevice declarations.

bluetooth?

bluetooth?: WebBluetooth;

The Web Bluetooth API; defaults to navigator.bluetooth.

Variables

WEB_BLUETOOTH_SERVICES

const WEB_BLUETOOTH_SERVICES: readonly string[];

Every GATT service an integrated device uses, as a browser must be told when the user picks a device: a page can only reach the services it named in navigator.bluetooth.requestDevice's optionalServices.