Class BleScanner

Implements

Scanner

Index

Constructors

Accessors

Methods

cancelCommissionableDeviceDiscovery close findCommissionableDevices findCommissionableDevicesContinuously findOperationalDevice getDiscoveredCommissionableDevices getDiscoveredDevice getDiscoveredOperationalDevice

Constructors

constructor

new BleScanner(nobleClient): BleScanner
Parameters
- nobleClient: NobleBleClient
Returns BleScanner
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:23

Accessors

type

get type(): ChannelType
Returns ChannelType
Implementation of Scanner.type
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:20

Methods

cancelCommissionableDeviceDiscovery

cancelCommissionableDeviceDiscovery(identifier): void
Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would be over.
Parameters
- identifier: CommissionableDeviceIdentifiers
Returns void
Implementation of Scanner.cancelCommissionableDeviceDiscovery
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:35

close

close(): void
Close the scanner server and free resources.

Returns void
Implementation of Scanner.close
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:49

findCommissionableDevices

findCommissionableDevices(identifier, timeoutSeconds?): Promise<CommissionableDevice[]>
Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, vendorId, etc.) and returns as soon as minimum one was found or the timeout is over.
Parameters
- identifier: CommissionableDeviceIdentifiers
- OptionaltimeoutSeconds: number
Returns Promise<CommissionableDevice[]>
Implementation of Scanner.findCommissionableDevices
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:46

findCommissionableDevicesContinuously

findCommissionableDevicesContinuously(identifier, callback, timeoutSeconds?, cancelSignal?): Promise<CommissionableDevice[]>
Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is called when it is discovered.
Parameters
- identifier: CommissionableDeviceIdentifiers
- callback: ((device: CommissionableDevice) => void)
  - - (device): void
    - Parameters
      device: CommissionableDevice
      Returns void
- OptionaltimeoutSeconds: number
- OptionalcancelSignal: Promise<void>
Returns Promise<CommissionableDevice[]>
Implementation of Scanner.findCommissionableDevicesContinuously
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:47

findOperationalDevice

findOperationalDevice(): Promise<undefined>
Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID and return them.

Returns Promise<undefined>
Implementation of Scanner.findOperationalDevice
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:44

getDiscoveredCommissionableDevices

getDiscoveredCommissionableDevices(identifier): CommissionableDevice[]
Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries.
Parameters
- identifier: CommissionableDeviceIdentifiers
Returns CommissionableDevice[]
Implementation of Scanner.getDiscoveredCommissionableDevices
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:48

getDiscoveredDevice

getDiscoveredDevice(address): DiscoveredBleDevice
Parameters
- address: string
Returns DiscoveredBleDevice
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:24

getDiscoveredOperationalDevice

getDiscoveredOperationalDevice(): undefined
Return already discovered addresses of an operational paired device and return them. Does not send out new DNS-SD queries.

Returns undefined
Implementation of Scanner.getDiscoveredOperationalDevice
- Defined in packages/nodejs-ble/dist/esm/BleScanner.d.ts:45