Class BluetoothRemoteGATTCharacteristicImpl

Bluetooth Remote GATT Characteristic class

Hierarchy

  • EventDispatcher<CharacteristicEvents>
    • BluetoothRemoteGATTCharacteristicImpl

Implements

  • BluetoothRemoteGATTCharacteristic

Constructors

constructor

Properties

emitter properties service uuid

Accessors

oncharacteristicvaluechanged value

Methods

addEventListener dispatchEvent getDescriptor getDescriptors readValue removeEventListener startNotifications stopNotifications writeValue writeValueWithoutResponse 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

    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

    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

    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

    Returns Promise<BluetoothRemoteGATTCharacteristic>

    Promise containing 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

    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

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

    Returns Promise<void>

writeValueWithResponse

  • writeValueWithResponse(value): Promise<void>

  • Updates the value of the characteristic and waits for a response

    Parameters

    • value: ArrayBuffer | ArrayBufferView

      The value to write

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods