Class GattLocal

A local GATT server.

Hierarchy

Gatt
- GattLocal

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GattLocal(adapter: Adapter, mtu?: number, services?: GattService[]): GattLocal

Overrides Gatt.constructor
- Defined in src/models/gatt/GattLocal.ts:22
Parameters
- adapter: Adapter
- Optional mtu: number
- Optional services: GattService[]
Returns GattLocal

Properties

Readonly adapter

adapter: Adapter

The adapter that this GATT server belongs to.

Readonly services

services: Map<string, GattService> = ...

The services that belong to this GATT server, mapped by UUID. If this is a remote GATT use discoverServices to discover them.

Accessors

isRemote

get isRemote(): boolean

- Defined in src/models/gatt/GattLocal.ts:18
Returns boolean

mtu

get mtu(): number

- Defined in src/models/gatt/Gatt.ts:27
Local: The maximum MTU that will be agreed upon during negotiation. Remote: The MTU that was agreed upon during negotiation.

Returns number

Methods

Abstract addService

addService(uuid: string): Promise<GattService>

- Defined in src/models/gatt/GattLocal.ts:37
Adds a new service to this GATT server.

Parameters
- uuid: string
Returns Promise<GattService>

Abstract prepare

prepare(deviceName: string): Promise<void>

- Defined in src/models/gatt/GattLocal.ts:43
Prepares this GATT server for advertisement.

Parameters
- deviceName: string
  
  The name of this device as specified in the general service / characteristic.
Returns Promise<void>

toJSON

toJSON(): Record<string, unknown>

Overrides Gatt.toJSON
- Defined in src/models/gatt/GattLocal.ts:49
Returns Record<string, unknown>

toString

toString(): string

Overrides Gatt.toString
- Defined in src/models/gatt/GattLocal.ts:45
Returns string

Generated using TypeDoc