Class GattService

Represents a GATT service.

Hierarchy

GattService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GattService(gatt: Gatt, uuid: string, isRemote: boolean): GattService

- Defined in src/models/gatt/Service.ts:33
Parameters
- gatt: Gatt
- uuid: string
- isRemote: boolean
Returns GattService

Properties

Readonly characteristics

characteristics: Map<string, GattCharacteristic> = ...

The characteristics that belong to this service, mapped by UUID. If this is a remote service use discoverCharacteristics to discover them.

Readonly gatt

gatt: Gatt

The GATT server this service belongs to.

Readonly isRemote

isRemote: boolean

True if this is a remote service, false otherwise.

Readonly uuid

uuid: string

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

Methods

Abstract addCharacteristic

addCharacteristic(uuid: string, props: GattCharacteristicProperty[], secure: GattCharacteristicProperty[], value?: Buffer): Promise<GattCharacteristic>
addCharacteristic(uuid: string, props: GattCharacteristicProperty[], secure: GattCharacteristicProperty[], readFunc?: ReadFunction, writeFunc?: WriteFunction): Promise<GattCharacteristic>

- Defined in src/models/gatt/Service.ts:42
Local only: Add a new characteristic to this service

Parameters
- uuid: string
- props: GattCharacteristicProperty[]
- secure: GattCharacteristicProperty[]
- Optional value: Buffer
Returns Promise<GattCharacteristic>
- Defined in src/models/gatt/Service.ts:52
Local only: Add a new characteristic to this service

Parameters
- uuid: string
- props: GattCharacteristicProperty[]
- secure: GattCharacteristicProperty[]
- Optional readFunc: ReadFunction
- Optional writeFunc: WriteFunction
Returns Promise<GattCharacteristic>

Abstract discoverCharacteristics

discoverCharacteristics(): Promise<GattCharacteristic[]>

- Defined in src/models/gatt/Service.ts:63
Remote only: Discover all charactersitics of this service.

Returns Promise<GattCharacteristic[]>

toJSON

toJSON(): Record<string, unknown>

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

toString

toString(): string

- Defined in src/models/gatt/Service.ts:65
Returns string

Generated using TypeDoc