Class Adapter

Hierarchy

TypedEmitter<AdapterEvents>
- Adapter

Constructors

constructor

new Adapter(modblue: MODblue, id: string, name: string, address?: string): Adapter

Overrides TypedEmitter<AdapterEvents>.constructor
- Defined in src/models/Adapter.ts:52
Parameters
- modblue: MODblue
- id: string
- name: string
- Optional address: string
Returns Adapter

Properties

Readonly id

id: string

The unique identifier of this adapter.

Readonly modblue

modblue: MODblue

The instance of MODblue that this adapter was found by.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

address

get address(): string

- Defined in src/models/Adapter.ts:48
The MAC address of this adapter. All lowercase, with colon separator between bytes, e.g. 11:22:33:aa:bb:cc

Returns string

addressType

get addressType(): string

- Defined in src/models/Adapter.ts:40
The MAC address type of this adapter.

Returns string

name

get name(): string

- Defined in src/models/Adapter.ts:32
The public name of this adapter.

Returns string

Methods

addListener

addListener<U>(event: U, listener: AdapterEvents[U]): Adapter

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

emit

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

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

eventNames

eventNames<U>(): U[]

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

getMaxListeners

getMaxListeners(): number

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

Abstract getScannedPeripherals

getScannedPeripherals(): Promise<Peripheral[]>

- Defined in src/models/Adapter.ts:140
Get all peripherals that were found since the last scan start.

Returns Promise<Peripheral[]>

Abstract isAdvertising

isAdvertising(): boolean

- Defined in src/models/Adapter.ts:145
Returns true if this adapter is currently advertising, false otherwise.

Returns boolean

Abstract isScanning

isScanning(): boolean

- Defined in src/models/Adapter.ts:123
Returns true if this adapter is currently scanning, false otherwise.

Returns boolean

listenerCount

listenerCount(type: keyof AdapterEvents): number

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

listeners

listeners<U>(type: U): AdapterEvents[U][]

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

off

off<U>(event: U, listener: AdapterEvents[U]): Adapter

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

on

on<U>(event: U, listener: AdapterEvents[U]): Adapter

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

once

once<U>(event: U, listener: AdapterEvents[U]): Adapter

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

prependListener

prependListener<U>(event: U, listener: AdapterEvents[U]): Adapter

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

prependOnceListener

prependOnceListener<U>(event: U, listener: AdapterEvents[U]): Adapter

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

rawListeners

rawListeners<U>(type: U): AdapterEvents[U][]

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

removeAllListeners

removeAllListeners(event?: keyof AdapterEvents): Adapter

Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15
Parameters
- Optional event: keyof AdapterEvents
Returns Adapter

removeListener

removeListener<U>(event: U, listener: AdapterEvents[U]): Adapter

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

scanFor

scanFor(filter: string | ((peripheral: Peripheral) => boolean), timeoutInSeconds?: number, serviceUUIDs?: string[]): Promise<Peripheral>

- Defined in src/models/Adapter.ts:68
Scans for a specific Peripheral using the specified matching function and returns the peripheral once found. If the timeout is reached before finding a peripheral the returned promise will be rejected.

Parameters
- filter: string | ((peripheral: Peripheral) => boolean)
  
  Either a string that is used as name prefix, or a function that returns true if the specified peripheral is the peripheral we're looking for.
- timeoutInSeconds: number = 10
  
  The timeout in seconds. The returned promise will reject once the timeout is reached.
- Optional serviceUUIDs: string[]
  
  The UUIDs of the GattServices that must be contained in the advertisement data.
Returns Promise<Peripheral>

setMaxListeners

setMaxListeners(n: number): Adapter

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

Abstract setupGatt

setupGatt(maxMtu?: number): Promise<GattLocal>

- Defined in src/models/Adapter.ts:162
Setup the GATT server for this adapter to communicate with connecting remote peripherals.

Parameters
- Optional maxMtu: number
  
  The maximum MTU that will be negotiated in case the remote peripheral starts an MTU negotation.
Returns Promise<GattLocal>

Abstract startAdvertising

startAdvertising(deviceName: string, serviceUUIDs?: string[]): Promise<void>

- Defined in src/models/Adapter.ts:152
Start advertising on this adapter.

Parameters
- deviceName: string
  
  The device name that is included in the advertisement.
- Optional serviceUUIDs: string[]
  
  The UUIDs of the GattServices that are included in the advertisement.
Returns Promise<void>

Abstract startScanning

startScanning(serviceUUIDs?: string[], allowDuplicates?: boolean): Promise<void>

- Defined in src/models/Adapter.ts:131
Start scanning for nearby Peripherals.

Parameters
- Optional serviceUUIDs: string[]
  
  The UUIDs of the GattService that an advertising packet must advertise to emit a discover event.
- Optional allowDuplicates: boolean
  
  True if advertisements for the same peripheral should emit multiple discover events.
Returns Promise<void>

Abstract stopAdvertising

stopAdvertising(): Promise<void>

- Defined in src/models/Adapter.ts:156
Stop any ongoing advertisements.

Returns Promise<void>

Abstract stopScanning

stopScanning(): Promise<void>

- Defined in src/models/Adapter.ts:135
Stop scanning for peripherals.

Returns Promise<void>

toJSON

toJSON(): Record<string, unknown>

- Defined in src/models/Adapter.ts:168
Returns Record<string, unknown>

toString

toString(): string

- Defined in src/models/Adapter.ts:164
Returns string

Generated using TypeDoc