diff --git a/classes/bluetooth.BluetoothImpl.html b/classes/bluetooth.BluetoothImpl.html index 1e5e723b..3273a4f2 100644 --- a/classes/bluetooth.BluetoothImpl.html +++ b/classes/bluetooth.BluetoothImpl.html @@ -1,5 +1,5 @@ BluetoothImpl | Node Web Bluetooth

ClassBluetoothImpl

Bluetooth class

-

Hierarchy

  • EventDispatcher<BluetoothEvents>
    • BluetoothImpl

Implements

  • Bluetooth

Constructors

constructor +

Hierarchy

  • EventDispatcher<BluetoothEvents>
    • BluetoothImpl

Implements

  • Bluetooth

Constructors

constructor

Properties

emitter referringDevice?

Accessors

onadvertisementreceived @@ -18,12 +18,12 @@ requestDevice

Constructors

constructor

Properties

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Optional ReadonlyreferringDevice

referringDevice?: BluetoothDevice

Referring device for the bluetooth instance

-

Accessors

onadvertisementreceived

  • set onadvertisementreceived(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onavailabilitychanged

  • set onavailabilitychanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

ongattserverdisconnected

  • set ongattserverdisconnected(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceadded

  • set onserviceadded(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onservicechanged

  • set onservicechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceremoved

  • set onserviceremoved(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: ((this: this, ev: BluetoothEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: EventListener

    Returns void

cancelRequest

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

getAvailability

  • getAvailability(): Promise<boolean>

  • Gets the availability of a bluetooth adapter

    +

Returns BluetoothImpl

Properties

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Optional ReadonlyreferringDevice

referringDevice?: BluetoothDevice

Referring device for the bluetooth instance

+

Accessors

onadvertisementreceived

  • set onadvertisementreceived(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onavailabilitychanged

  • set onavailabilitychanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

ongattserverdisconnected

  • set ongattserverdisconnected(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceadded

  • set onserviceadded(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onservicechanged

  • set onservicechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceremoved

  • set onserviceremoved(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: ((this: this, ev: BluetoothEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • listener: EventListener

    Returns void

cancelRequest

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

getAvailability

  • getAvailability(): Promise<boolean>

  • Gets the availability of a bluetooth adapter

    Returns Promise<boolean>

    Promise containing a flag indicating bluetooth availability

    -

getDevices

  • getDevices(): Promise<BluetoothDevice[]>

  • Get all bluetooth devices

    -

    Returns Promise<BluetoothDevice[]>

removeEventListener

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: ((this: this, ev: BluetoothEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: EventListener

    Returns void

requestDevice

  • requestDevice(options?): Promise<BluetoothDevice>

  • Scans for a device matching optional filters

    +

getDevices

  • getDevices(): Promise<BluetoothDevice[]>

  • Get all bluetooth devices

    +

    Returns Promise<BluetoothDevice[]>

removeEventListener

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: ((this: this, ev: BluetoothEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothEvents[K]

          Returns void

    Returns void

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothEvents

    Parameters

    • type: K
    • callback: EventListener

    Returns void

requestDevice

  • requestDevice(options?): Promise<BluetoothDevice>

  • Scans for a device matching optional filters

    Parameters

    • options: RequestDeviceOptions = ...

      The options to use when scanning

    Returns Promise<BluetoothDevice>

    Promise containing a device which matches the options

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/characteristic.BluetoothRemoteGATTCharacteristicImpl.html b/classes/characteristic.BluetoothRemoteGATTCharacteristicImpl.html index 961d8d38..2a97ff83 100644 --- a/classes/characteristic.BluetoothRemoteGATTCharacteristicImpl.html +++ b/classes/characteristic.BluetoothRemoteGATTCharacteristicImpl.html @@ -1,5 +1,5 @@ BluetoothRemoteGATTCharacteristicImpl | Node Web Bluetooth

ClassBluetoothRemoteGATTCharacteristicImpl

Bluetooth Remote GATT Characteristic class

-

Hierarchy

  • EventDispatcher<CharacteristicEvents>
    • BluetoothRemoteGATTCharacteristicImpl

Implements

  • BluetoothRemoteGATTCharacteristic

Constructors

constructor +

Hierarchy

  • EventDispatcher<CharacteristicEvents>
    • BluetoothRemoteGATTCharacteristicImpl

Implements

  • BluetoothRemoteGATTCharacteristic

Constructors

constructor

Properties

emitter properties service @@ -19,26 +19,26 @@ writeValueWithResponse

Constructors

constructor

Properties

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Readonlyproperties

properties: BluetoothCharacteristicProperties

The properties of the characteristic

-

Readonlyservice

service: BluetoothRemoteGATTServiceImpl = undefined

The service the characteristic is related to

-

Readonlyuuid

uuid: string = undefined

The unique identifier of the characteristic

-

Accessors

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

value

  • get value(): DataView

  • The value of the characteristic

    -

    Returns DataView

Methods

addEventListener

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • listener: ((this: this, ev: CharacteristicEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: CharacteristicEvents[K]

          Returns void

    Returns void

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • listener: EventListener

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

getDescriptor

  • getDescriptor(descriptor): Promise<BluetoothRemoteGATTDescriptor>

  • Gets a single characteristic descriptor

    +

Returns BluetoothRemoteGATTCharacteristicImpl

Properties

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Readonlyproperties

properties: BluetoothCharacteristicProperties

The properties of the characteristic

+

Readonlyservice

service: BluetoothRemoteGATTServiceImpl = undefined

The service the characteristic is related to

+

Readonlyuuid

uuid: string = undefined

The unique identifier of the characteristic

+

Accessors

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

value

  • get value(): DataView

  • The value of the characteristic

    +

    Returns DataView

Methods

addEventListener

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • listener: ((this: this, ev: CharacteristicEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: CharacteristicEvents[K]

          Returns void

    Returns void

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • listener: EventListener

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

getDescriptor

  • getDescriptor(descriptor): Promise<BluetoothRemoteGATTDescriptor>

  • Gets a single characteristic descriptor

    Parameters

    • descriptor: string | number

      descriptor UUID

    Returns Promise<BluetoothRemoteGATTDescriptor>

    Promise containing the descriptor

    -

getDescriptors

  • getDescriptors(descriptor?): Promise<BluetoothRemoteGATTDescriptor[]>

  • Gets a list of the characteristic's descriptors

    +

getDescriptors

  • getDescriptors(descriptor?): Promise<BluetoothRemoteGATTDescriptor[]>

  • Gets a list of the characteristic's descriptors

    Parameters

    • Optionaldescriptor: string | number

      descriptor UUID

    Returns Promise<BluetoothRemoteGATTDescriptor[]>

    Promise containing an array of descriptors

    -

readValue

  • readValue(): Promise<DataView>

  • Gets the value of the characteristic

    +

readValue

  • readValue(): Promise<DataView>

  • Gets the value of the characteristic

    Returns Promise<DataView>

    Promise containing the value

    -

removeEventListener

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • callback: ((this: this, ev: CharacteristicEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: CharacteristicEvents[K]

          Returns void

    Returns void

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • callback: EventListener

    Returns void

startNotifications

  • startNotifications(): Promise<BluetoothRemoteGATTCharacteristic>

  • Start notifications of changes for the characteristic

    +

removeEventListener

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • callback: ((this: this, ev: CharacteristicEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: CharacteristicEvents[K]

          Returns void

    Returns void

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends "characteristicvaluechanged"

    Parameters

    • type: K
    • callback: EventListener

    Returns void

startNotifications

  • startNotifications(): Promise<BluetoothRemoteGATTCharacteristic>

  • Start notifications of changes for the characteristic

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    Promise containing the characteristic

    -

stopNotifications

  • stopNotifications(): Promise<BluetoothRemoteGATTCharacteristic>

  • Stop notifications of changes for the characteristic

    +

stopNotifications

  • stopNotifications(): Promise<BluetoothRemoteGATTCharacteristic>

  • Stop notifications of changes for the characteristic

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    Promise containing the characteristic

    -

writeValue

  • writeValue(value): Promise<void>

  • Updates the value of the characteristic

    +

writeValue

  • writeValue(value): Promise<void>

  • Updates the value of the characteristic

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

      -

    Returns Promise<void>

writeValueWithoutResponse

  • writeValueWithoutResponse(value): Promise<void>

  • Updates the value of the characteristic without waiting for a response

    +

Returns Promise<void>

writeValueWithoutResponse

writeValueWithResponse

Returns Promise<void>

writeValueWithResponse

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/descriptor.BluetoothRemoteGATTDescriptorImpl.html b/classes/descriptor.BluetoothRemoteGATTDescriptorImpl.html index d3d4f829..12ebe291 100644 --- a/classes/descriptor.BluetoothRemoteGATTDescriptorImpl.html +++ b/classes/descriptor.BluetoothRemoteGATTDescriptorImpl.html @@ -1,5 +1,5 @@ BluetoothRemoteGATTDescriptorImpl | Node Web Bluetooth

ClassBluetoothRemoteGATTDescriptorImpl

Bluetooth Remote GATT Descriptor class

-

Implements

  • BluetoothRemoteGATTDescriptor

Constructors

constructor +

Implements

  • BluetoothRemoteGATTDescriptor

Constructors

constructor

Properties

characteristic uuid

Accessors

value @@ -7,11 +7,11 @@ writeValue

Constructors

constructor

Properties

Readonlycharacteristic

characteristic: BluetoothRemoteGATTCharacteristic = undefined

The characteristic the descriptor is related to

-

Readonlyuuid

uuid: string = undefined

The unique identifier of the descriptor

-

Accessors

value

  • get value(): DataView

  • The value of the descriptor

    -

    Returns DataView

Methods

readValue

  • readValue(): Promise<DataView>

  • Gets the value of the descriptor

    +

Returns BluetoothRemoteGATTDescriptorImpl

Properties

Readonlycharacteristic

characteristic: BluetoothRemoteGATTCharacteristic = undefined

The characteristic the descriptor is related to

+

Readonlyuuid

uuid: string = undefined

The unique identifier of the descriptor

+

Accessors

value

  • get value(): DataView

  • The value of the descriptor

    +

    Returns DataView

Methods

readValue

  • readValue(): Promise<DataView>

  • Gets the value of the descriptor

    Returns Promise<DataView>

    Promise containing the value

    -

writeValue

  • writeValue(value): Promise<void>

  • Updates the value of the descriptor

    +

writeValue

  • writeValue(value): Promise<void>

  • Updates the value of the descriptor

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

      -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/device.BluetoothDeviceImpl.html b/classes/device.BluetoothDeviceImpl.html index 8eb7d284..7ddee2f4 100644 --- a/classes/device.BluetoothDeviceImpl.html +++ b/classes/device.BluetoothDeviceImpl.html @@ -1,5 +1,5 @@ BluetoothDeviceImpl | Node Web Bluetooth

ClassBluetoothDeviceImpl

Bluetooth Device class

-

Hierarchy

  • EventDispatcher<BluetoothDeviceEvents>
    • BluetoothDeviceImpl

Implements

  • BluetoothDevice

Constructors

constructor +

Hierarchy

  • EventDispatcher<BluetoothDeviceEvents>
    • BluetoothDeviceImpl

Implements

  • BluetoothDevice

Constructors

constructor

Properties

emitter gatt id @@ -19,11 +19,11 @@ watchAdvertisements

Constructors

constructor

Properties

Protectedemitter

emitter: EventEmitter<DefaultEventMap> = ...

Readonlygatt

gatt: BluetoothRemoteGATTServer = undefined

The gatt server of the device

-

Readonlyid

id: string = undefined

The unique identifier of the device

-

Readonlyname

name: string = undefined

The name of the device

-

ReadonlywatchingAdvertisements

watchingAdvertisements: boolean = false

Whether adverts are being watched (not implemented)

-

Accessors

onadvertisementreceived

  • set onadvertisementreceived(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

oncharacteristicvaluechanged

  • set oncharacteristicvaluechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

ongattserverdisconnected

  • set ongattserverdisconnected(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceadded

  • set onserviceadded(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onservicechanged

  • set onservicechanged(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

onserviceremoved

  • set onserviceremoved(fn): void

  • Parameters

    • fn: ((ev: Event) => void)
        • (ev): void

        • Parameters

          • ev: Event

          Returns void

    Returns void

Methods

addEventListener

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothDeviceEvents

    Parameters

    • type: K
    • listener: ((this: this, ev: BluetoothDeviceEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothDeviceEvents[K]

          Returns void

    Returns void

  • addEventListener<K>(type, listener): void

  • Type Parameters

    • K extends keyof BluetoothDeviceEvents

    Parameters

    • type: K
    • listener: EventListener

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

forget

  • forget(): Promise<void>

  • Forget this device

    -

    Returns Promise<void>

removeEventListener

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothDeviceEvents

    Parameters

    • type: K
    • callback: ((this: this, ev: BluetoothDeviceEvents[K]) => void)
        • (this, ev): void

        • Parameters

          • this: this
          • ev: BluetoothDeviceEvents[K]

          Returns void

    Returns void

  • removeEventListener<K>(type, callback): void

  • Type Parameters

    • K extends keyof BluetoothDeviceEvents

    Parameters

    • type: K
    • callback: EventListener

    Returns void

unwatchAdvertisements

  • unwatchAdvertisements(): Promise<void>

  • Stops watching adverts from this device (not implemented)

    -

    Returns Promise<void>

watchAdvertisements

  • watchAdvertisements(): Promise<void>

  • Starts watching adverts from this device (not implemented)

    -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+
  • forgetFn: (() => void)

    • Returns BluetoothDeviceImpl

    Properties

    Protectedemitter

    emitter: EventEmitter<DefaultEventMap> = ...

    Readonlygatt

    gatt: BluetoothRemoteGATTServer = undefined

    The gatt server of the device

    +

    Readonlyid

    id: string = undefined

    The unique identifier of the device

    +

    Readonlyname

    name: string = undefined

    The name of the device

    +

    ReadonlywatchingAdvertisements

    watchingAdvertisements: boolean = false

    Whether adverts are being watched (not implemented)

    +

    Accessors

    onadvertisementreceived

    • set onadvertisementreceived(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    oncharacteristicvaluechanged

    • set oncharacteristicvaluechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    ongattserverdisconnected

    • set ongattserverdisconnected(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceadded

    • set onserviceadded(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onservicechanged

    • set onservicechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceremoved

    • set onserviceremoved(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    Methods

    addEventListener

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof BluetoothDeviceEvents

      Parameters

      • type: K
      • listener: ((this: this, ev: BluetoothDeviceEvents[K]) => void)
          • (this, ev): void

          • Parameters

            • this: this
            • ev: BluetoothDeviceEvents[K]

            Returns void

      Returns void

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof BluetoothDeviceEvents

      Parameters

      • type: K
      • listener: EventListener

      Returns void

    dispatchEvent

    • dispatchEvent(event): boolean

    • Parameters

      • event: Event

      Returns boolean

    forget

    • forget(): Promise<void>

    • Forget this device

      +

      Returns Promise<void>

    removeEventListener

    • removeEventListener<K>(type, callback): void

    • Type Parameters

      • K extends keyof BluetoothDeviceEvents

      Parameters

      • type: K
      • callback: ((this: this, ev: BluetoothDeviceEvents[K]) => void)
          • (this, ev): void

          • Parameters

            • this: this
            • ev: BluetoothDeviceEvents[K]

            Returns void

      Returns void

    • removeEventListener<K>(type, callback): void

    • Type Parameters

      • K extends keyof BluetoothDeviceEvents

      Parameters

      • type: K
      • callback: EventListener

      Returns void

    unwatchAdvertisements

    • unwatchAdvertisements(): Promise<void>

    • Stops watching adverts from this device (not implemented)

      +

      Returns Promise<void>

    watchAdvertisements

    • watchAdvertisements(): Promise<void>

    • Starts watching adverts from this device (not implemented)

      +

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/server.BluetoothRemoteGATTServerImpl.html b/classes/server.BluetoothRemoteGATTServerImpl.html index c6b1899f..23d078e3 100644 --- a/classes/server.BluetoothRemoteGATTServerImpl.html +++ b/classes/server.BluetoothRemoteGATTServerImpl.html @@ -1,5 +1,5 @@ BluetoothRemoteGATTServerImpl | Node Web Bluetooth

    ClassBluetoothRemoteGATTServerImpl

    Bluetooth Remote GATT Server class

    -

    Implements

    • BluetoothRemoteGATTServer

    Constructors

    constructor +

    Implements

    • BluetoothRemoteGATTServer

    Constructors

    constructor

    Properties

    device

    Accessors

    connected

    Methods

    connect @@ -8,15 +8,15 @@ getPrimaryServices

    Constructors

    constructor

    Properties

    Readonlydevice

    device: BluetoothDeviceImpl = undefined

    The device the gatt server is related to

    -

    Accessors

    connected

    • get connected(): boolean

    • Whether the gatt server is connected

      -

      Returns boolean

    Methods

    connect

    • connect(): Promise<BluetoothRemoteGATTServer>

    • Connect the gatt server

      +

    Returns BluetoothRemoteGATTServerImpl

    Properties

    Readonlydevice

    device: BluetoothDeviceImpl = undefined

    The device the gatt server is related to

    +

    Accessors

    connected

    • get connected(): boolean

    • Whether the gatt server is connected

      +

      Returns boolean

    Methods

    connect

    • connect(): Promise<BluetoothRemoteGATTServer>

    • Connect the gatt server

      Returns Promise<BluetoothRemoteGATTServer>

      Promise containing the gatt server

      -

    disconnect

    • disconnect(): void

    • Disconnect the gatt server

      -

      Returns void

    getPrimaryService

    • getPrimaryService(service): Promise<BluetoothRemoteGATTService>

    • Gets a single primary service contained in the gatt server

      +

    disconnect

    • disconnect(): void

    • Disconnect the gatt server

      +

      Returns void

    getPrimaryService

    • getPrimaryService(service): Promise<BluetoothRemoteGATTService>

    • Gets a single primary service contained in the gatt server

      Parameters

      • service: BluetoothServiceUUID

        service UUID

      Returns Promise<BluetoothRemoteGATTService>

      Promise containing the service

      -

    getPrimaryServices

    • getPrimaryServices(service?): Promise<BluetoothRemoteGATTService[]>

    • Gets a list of primary services contained in the gatt server

      +

    getPrimaryServices

    • getPrimaryServices(service?): Promise<BluetoothRemoteGATTService[]>

    • Gets a list of primary services contained in the gatt server

      Parameters

      • Optionalservice: BluetoothServiceUUID

        service UUID

      Returns Promise<BluetoothRemoteGATTService[]>

      Promise containing an array of services

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/service.BluetoothRemoteGATTServiceImpl.html b/classes/service.BluetoothRemoteGATTServiceImpl.html index 386a19c9..b0a15f3d 100644 --- a/classes/service.BluetoothRemoteGATTServiceImpl.html +++ b/classes/service.BluetoothRemoteGATTServiceImpl.html @@ -1,5 +1,5 @@ BluetoothRemoteGATTServiceImpl | Node Web Bluetooth

    ClassBluetoothRemoteGATTServiceImpl

    Bluetooth Remote GATT Service class

    -

    Hierarchy

    • EventDispatcher<ServiceEvents>
      • BluetoothRemoteGATTServiceImpl

    Implements

    • BluetoothRemoteGATTService

    Constructors

    constructor +

    Hierarchy

    • EventDispatcher<ServiceEvents>
      • BluetoothRemoteGATTServiceImpl

    Implements

    • BluetoothRemoteGATTService

    Constructors

    constructor

    Properties

    device emitter isPrimary @@ -17,19 +17,19 @@ removeEventListener

    Constructors

    constructor

    Properties

    Readonlydevice

    device: BluetoothDeviceImpl = undefined

    The device the service is related to

    -

    Protectedemitter

    emitter: EventEmitter<DefaultEventMap> = ...

    ReadonlyisPrimary

    isPrimary: boolean = false

    Whether the service is a primary one

    -

    Readonlyuuid

    uuid: string = undefined

    The unique identifier of the service

    -

    Accessors

    oncharacteristicvaluechanged

    • set oncharacteristicvaluechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceadded

    • set onserviceadded(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onservicechanged

    • set onservicechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceremoved

    • set onserviceremoved(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    Methods

    addEventListener

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • listener: ((this: this, ev: ServiceEvents[K]) => void)
          • (this, ev): void

          • Parameters

            • this: this
            • ev: ServiceEvents[K]

            Returns void

      Returns void

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • listener: EventListener

      Returns void

    dispatchEvent

    • dispatchEvent(event): boolean

    • Parameters

      • event: Event

      Returns boolean

    getCharacteristic

    • getCharacteristic(characteristic): Promise<BluetoothRemoteGATTCharacteristic>

    • Gets a single characteristic contained in the service

      +

    Returns BluetoothRemoteGATTServiceImpl

    Properties

    Readonlydevice

    device: BluetoothDeviceImpl = undefined

    The device the service is related to

    +

    Protectedemitter

    emitter: EventEmitter<DefaultEventMap> = ...

    ReadonlyisPrimary

    isPrimary: boolean = false

    Whether the service is a primary one

    +

    Readonlyuuid

    uuid: string = undefined

    The unique identifier of the service

    +

    Accessors

    oncharacteristicvaluechanged

    • set oncharacteristicvaluechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceadded

    • set onserviceadded(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onservicechanged

    • set onservicechanged(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    onserviceremoved

    • set onserviceremoved(fn): void

    • Parameters

      • fn: ((ev: Event) => void)
          • (ev): void

          • Parameters

            • ev: Event

            Returns void

      Returns void

    Methods

    addEventListener

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • listener: ((this: this, ev: ServiceEvents[K]) => void)
          • (this, ev): void

          • Parameters

            • this: this
            • ev: ServiceEvents[K]

            Returns void

      Returns void

    • addEventListener<K>(type, listener): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • listener: EventListener

      Returns void

    dispatchEvent

    • dispatchEvent(event): boolean

    • Parameters

      • event: Event

      Returns boolean

    getCharacteristic

    • getCharacteristic(characteristic): Promise<BluetoothRemoteGATTCharacteristic>

    • Gets a single characteristic contained in the service

      Parameters

      • characteristic: BluetoothCharacteristicUUID

        characteristic UUID

      Returns Promise<BluetoothRemoteGATTCharacteristic>

      Promise containing the characteristic

      -

    getCharacteristics

    • getCharacteristics(characteristic?): Promise<BluetoothRemoteGATTCharacteristic[]>

    • Gets a list of characteristics contained in the service

      +

    getCharacteristics

    • getCharacteristics(characteristic?): Promise<BluetoothRemoteGATTCharacteristic[]>

    • Gets a list of characteristics contained in the service

      Parameters

      • Optionalcharacteristic: BluetoothCharacteristicUUID

        characteristic UUID

      Returns Promise<BluetoothRemoteGATTCharacteristic[]>

      Promise containing an array of characteristics

      -

    getIncludedService

    • getIncludedService(service): Promise<BluetoothRemoteGATTService>

    • Gets a single service included in the service

      +

    getIncludedService

    • getIncludedService(service): Promise<BluetoothRemoteGATTService>

    • Gets a single service included in the service

      Parameters

      • service: BluetoothServiceUUID

        service UUID

      Returns Promise<BluetoothRemoteGATTService>

      Promise containing the service

      -

    getIncludedServices

    • getIncludedServices(service?): Promise<BluetoothRemoteGATTService[]>

    • Gets a list of services included in the service

      +

    getIncludedServices

    • getIncludedServices(service?): Promise<BluetoothRemoteGATTService[]>

    • Gets a list of services included in the service

      Parameters

      • Optionalservice: BluetoothServiceUUID

        service UUID

      Returns Promise<BluetoothRemoteGATTService[]>

      Promise containing an array of services

      -

    removeEventListener

    • removeEventListener<K>(type, callback): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • callback: ((this: this, ev: ServiceEvents[K]) => void)
          • (this, ev): void

          • Parameters

            • this: this
            • ev: ServiceEvents[K]

            Returns void

      Returns void

    • removeEventListener<K>(type, callback): void

    • Type Parameters

      • K extends keyof ServiceEvents

      Parameters

      • type: K
      • callback: EventListener

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/enums/adapters_simpleble.AddressType.html b/enums/adapters_simpleble.AddressType.html index a2fc5ba3..116fa99a 100644 --- a/enums/adapters_simpleble.AddressType.html +++ b/enums/adapters_simpleble.AddressType.html @@ -1,5 +1,5 @@ AddressType | Node Web Bluetooth

    EnumerationAddressType

    SimpleBLE address type.

    -

    Enumeration Members

    PUBLIC +

    Enumeration Members

    PUBLIC RANDOM UNSPECIFIED -

    Enumeration Members

    PUBLIC

    PUBLIC

    RANDOM

    RANDOM

    UNSPECIFIED

    UNSPECIFIED

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    PUBLIC

    PUBLIC

    RANDOM

    RANDOM

    UNSPECIFIED

    UNSPECIFIED

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/adapters_simpleble.getAdapters.html b/functions/adapters_simpleble.getAdapters.html index a81e860e..efd1d88b 100644 --- a/functions/adapters_simpleble.getAdapters.html +++ b/functions/adapters_simpleble.getAdapters.html @@ -1 +1 @@ -getAdapters | Node Web Bluetooth

    FunctiongetAdapters

    Settings

    Member Visibility
    +getAdapters | Node Web Bluetooth

    FunctiongetAdapters

    Settings

    Member Visibility
    diff --git a/functions/adapters_simpleble.isEnabled.html b/functions/adapters_simpleble.isEnabled.html index 84c54bb1..a00f8fd3 100644 --- a/functions/adapters_simpleble.isEnabled.html +++ b/functions/adapters_simpleble.isEnabled.html @@ -1 +1 @@ -isEnabled | Node Web Bluetooth

    FunctionisEnabled

    Settings

    Member Visibility
    +isEnabled | Node Web Bluetooth

    FunctionisEnabled

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index 21a9cf0f..482168f7 100644 --- a/index.html +++ b/index.html @@ -8,6 +8,12 @@

    Getting Started

    See the examples or view the API documentation at:

    https://thegecko.github.io/webbluetooth/

    +

    Supported Platforms

    Binaries are built to support the following platforms:

    +

    Usage

    The module exports a default navigator.bluetooth instance, the Bluetooth class to allow you to instantiate your own bluetooth instances and the Bluetooth helper methods:

  • getService: ((name: string | number) => string)

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility