Class BluetoothDevice

Bluetooth Device class

Events

Name	Event	Description
`advertisementreceived`	BluetoothAdvertisingEvent	Advertisement received.
`characteristicvaluechanged`	Event	The value of a BLE Characteristic has changed.
`gattserverdisconnected`	Event	GATT server has been disconnected.
`serviceadded`	Event	A new service is available.
`servicechanged`	Event	An existing service has changed.
`serviceremoved`	Event	A service is unavailable.

Hierarchy

EventTarget
- BluetoothDevice

Implements

BluetoothDevice

Index

Constructors

Properties

gatt id name watchingAdvertisements

Accessors

onadvertisementreceived oncharacteristicvaluechanged ongattserverdisconnected onserviceadded onservicechanged onserviceremoved

Methods

forget unwatchAdvertisements watchAdvertisements

Constructors

constructor

new BluetoothDevice(
    init: BluetoothDeviceInit,
    bluetooth: Bluetooth,
    allowedServices: string[],
    forgetFn: () => void,
): BluetoothDevice
Device constructor
Parameters
- init: BluetoothDeviceInit
  A partial class to initialise values
- bluetooth: Bluetooth
- allowedServices: string[]
- forgetFn: () => void
Returns BluetoothDevice
Overrides EventTarget.constructor
- Defined in src/device.ts:167

Properties

`Readonly`gatt

gatt: BluetoothRemoteGATTServer

The gatt server of the device

`Readonly`id

id: string

The unique identifier of the device

`Readonly`name

name: string

The name of the device

`Readonly`watchingAdvertisements

watchingAdvertisements: boolean = false

Whether adverts are being watched (not implemented)

Accessors

onadvertisementreceived

set onadvertisementreceived(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onadvertisementreceived
- Defined in src/device.ts:152

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.oncharacteristicvaluechanged
- Defined in src/device.ts:92

ongattserverdisconnected

set ongattserverdisconnected(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.ongattserverdisconnected
- Defined in src/device.ts:140

onserviceadded

set onserviceadded(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onserviceadded
- Defined in src/device.ts:104

onservicechanged

set onservicechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onservicechanged
- Defined in src/device.ts:116

onserviceremoved

set onserviceremoved(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothDevice.onserviceremoved
- Defined in src/device.ts:128

Methods

forget

forget(): Promise<void>
Forget this device

Returns Promise<void>
Implementation of BluetoothDevice.forget
- Defined in src/device.ts:198

unwatchAdvertisements

unwatchAdvertisements(): Promise<void>
Stops watching adverts from this device (not implemented)

Returns Promise<void>
- Defined in src/device.ts:191

watchAdvertisements

watchAdvertisements(): Promise<void>
Starts watching adverts from this device (not implemented)

Returns Promise<void>
Implementation of BluetoothDevice.watchAdvertisements
- Defined in src/device.ts:184