GattCharacteristic | @modum-io/modblue

Represents a GATT Characteristic.

Hierarchy

TypedEmitter<GattCharacteristicEvents>
- GattCharacteristic

Constructors

constructor

new GattCharacteristic(service: GattService, uuid: string, isRemote: boolean, propsOrFlag: number | GattCharacteristicProperty[], secureOrFlag: number | GattCharacteristicProperty[], readFuncOrValue?: ReadFunction | Buffer, writeFunc?: WriteFunction): GattCharacteristic

Overrides TypedEmitter<GattCharacteristicEvents>.constructor
- Defined in src/models/gatt/Characteristic.ts:77
Parameters
- service: GattService
- uuid: string
- isRemote: boolean
- propsOrFlag: number | GattCharacteristicProperty[]
- secureOrFlag: number | GattCharacteristicProperty[]
- Optional readFuncOrValue: ReadFunction | Buffer
- Optional writeFunc: WriteFunction
Returns GattCharacteristic

Properties

Readonly descriptors

descriptors: Map<string, GattDescriptor> = ...

The descriptors that belong to this characteristic, mapped by UUID. If this is a remote characteristic use discoverDescriptors to discover them.

Readonly isRemote

isRemote: boolean

True if this is a remote characteristic, false otherwise.

Readonly properties

properties: GattCharacteristicProperty[]

A list of all the properties that are enabled/supported for this characteristic.

Readonly propertyFlag

propertyFlag: number

The list of properties supported by this characteristic as a byte flag per the Bluetooth Core spec.

Readonly secure

secure: GattCharacteristicProperty[]

A list of all the properties on this characteristic that are secured.

Readonly secureFlag

secureFlag: number

The list of all secured properties of this characteristic as a byte flag per the Bluetooth Core spec.

Readonly service

service: GattService

The GATT service that this characteristic belongs to.

Readonly uuid

uuid: string

The UUID of this characteristic, no dashes (-).

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Abstract addDescriptor

addDescriptor(uuid: string, value: Buffer): Promise<GattDescriptor>

- Defined in src/models/gatt/Characteristic.ts:259
Local only: Adds a descriptor to this characteristic.

Parameters
- uuid: string
- value: Buffer
Returns Promise<GattDescriptor>

addListener

addListener(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

Abstract broadcast

broadcast(broadcast: boolean): Promise<void>

- Defined in src/models/gatt/Characteristic.ts:226
Remote only: Enable or disable broadcasts.

Parameters
- broadcast: boolean
 
 True to enable broadcasts, false otherwise.
Returns Promise<void>

Abstract discoverDescriptors

discoverDescriptors(): Promise<GattDescriptor[]>

- Defined in src/models/gatt/Characteristic.ts:208
Remote only: Discover all descriptors of this characteristic.

Returns Promise<GattDescriptor[]>

emit

emit(event: U, ...args: Parameters<GattCharacteristicEvents[U]>): boolean

Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19
Type parameters
- U: "notification"
Parameters
- event: U
- Rest ...args: Parameters<GattCharacteristicEvents[U]>
Returns boolean

eventNames

eventNames(): U[]

Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20
Type parameters
- U: "notification"
Returns U[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24
Returns number

handleRead

handleRead(offset: number): Promise<Buffer>

- Defined in src/models/gatt/Characteristic.ts:266
Local only: Handles an incoming read request for this characteristic.

Parameters
- offset: number
 
 The offset to start at
Returns Promise<Buffer>
The read data.

handleWrite

handleWrite(offset: number, data: Buffer, withoutResponse: boolean): Promise<number>

- Defined in src/models/gatt/Characteristic.ts:281
Local only: Handles an incoming write request for this characteristic.

Parameters
- offset: number
 
 The offset to start at.
- data: Buffer
 
 The data to write.
- withoutResponse: boolean
 
 True to not produce a response code, false otherwise.
Returns Promise<number>
The result code.

listenerCount

listenerCount(type: "notification"): number

Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21
Parameters
- type: "notification"
Returns number

listeners

listeners(type: U): GattCharacteristicEvents[U][]

Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22
Type parameters
- U: "notification"
Parameters
- type: U
Returns GattCharacteristicEvents[U][]

Abstract notify

notify(notify: boolean): Promise<void>

- Defined in src/models/gatt/Characteristic.ts:232
Remote only: Enable or disable notifications.

Parameters
- notify: boolean
 
 True to enable notifies, false otherwise.
Returns Promise<void>

off

off(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

on

on(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

once

once(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

prependListener

prependListener(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

prependOnceListener

prependOnceListener(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

rawListeners

rawListeners(type: U): GattCharacteristicEvents[U][]

Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23
Type parameters
- U: "notification"
Parameters
- type: U
Returns GattCharacteristicEvents[U][]

Abstract read

read(): Promise<Buffer>

- Defined in src/models/gatt/Characteristic.ts:213
Remote only: Read the current value of this characteristic.

Returns Promise<Buffer>

removeAllListeners

removeAllListeners(event?: "notification"): GattCharacteristic

Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15
Parameters
- Optional event: "notification"
Returns GattCharacteristic

removeListener

removeListener(event: U, listener: GattCharacteristicEvents[U]): GattCharacteristic

Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14
Type parameters
- U: "notification"
Parameters
- event: U
- listener: GattCharacteristicEvents[U]
Returns GattCharacteristic

setMaxListeners

setMaxListeners(n: number): GattCharacteristic

Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25
Parameters
- n: number
Returns GattCharacteristic

subscribe(): Promise<void>

- Defined in src/models/gatt/Characteristic.ts:237
Remote only: Enable notifications. Equivalent to calling notify with true.

Returns Promise<void>

toJSON

toJSON(): Record<string, unknown>

- Defined in src/models/gatt/Characteristic.ts:293
Returns Record<string, unknown>

toString

toString(): string

- Defined in src/models/gatt/Characteristic.ts:289
Returns string

unsubscribe

unsubscribe(): Promise<void>

- Defined in src/models/gatt/Characteristic.ts:248
Remote only: Disable nofitications. Equivalent to calling notify with false.

Returns Promise<void>

Abstract write

write(data: Buffer, withoutResponse: boolean): Promise<void>

- Defined in src/models/gatt/Characteristic.ts:220
Remote only: Write the specified data to this characteristic.

Parameters
- data: Buffer
 
 The data to write.
- withoutResponse: boolean
 
 Do not require a response from the remote GATT server for this write.
Returns Promise<void>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

service: GattService

uuid: string

isRemote: boolean

propsOrFlag: number | GattCharacteristicProperty[]

secureOrFlag: number | GattCharacteristicProperty[]

Optional readFuncOrValue: ReadFunction | Buffer

Optional writeFunc: WriteFunction

Returns GattCharacteristic

Properties

Readonly descriptors

Readonly isRemote

Readonly properties

Readonly propertyFlag

Readonly secure

Readonly secureFlag

Readonly service

Readonly uuid

Static defaultMaxListeners

Methods

Abstract addDescriptor

Parameters

uuid: string

value: Buffer

Returns Promise<GattDescriptor>

addListener

Type parameters

U: "notification"

Parameters

event: U

listener: GattCharacteristicEvents[U]

Returns GattCharacteristic

Abstract broadcast

Parameters

broadcast: boolean

Returns Promise<void>

Abstract discoverDescriptors

Returns Promise<GattDescriptor[]>

emit

Type parameters

U: "notification"

Parameters

event: U

Rest ...args: Parameters<GattCharacteristicEvents[U]>

Returns boolean

eventNames

Type parameters

U: "notification"

Returns U[]

getMaxListeners

Returns number

handleRead

Parameters

offset: number

Returns Promise<Buffer>

handleWrite

Parameters

offset: number

data: Buffer

withoutResponse: boolean

Returns Promise<number>

listenerCount

Parameters

type: "notification"

Returns number

listeners

Type parameters

U: "notification"

Parameters

type: U

Returns GattCharacteristicEvents[U][]

Abstract notify

Parameters