Class BLEScanner

BLE Scanner for discovering SwitchBot devices

Hierarchy

EventEmitter
- BLEScanner

Index

Constructors

Methods

destroy getDevice getDiscoveredDevices isScanning startScan stopScan waitForDevice

Constructors

constructor

new BLEScanner(options?: { logLevel?: number; noble?: any }): BLEScanner
Parameters
- options: { logLevel?: number; noble?: any } = {}
Returns BLEScanner
Overrides EventEmitter.constructor
- Defined in ble.ts:35

Methods

destroy

destroy(): void
Cleanup all resources

Returns void
- Defined in ble.ts:401

getDevice

getDevice(mac: string, bleId?: string): BLEAdvertisement | undefined
Get discovered device by MAC or BLE ID
Parameters
- mac: string
- OptionalbleId: string
Returns BLEAdvertisement | undefined
- Defined in ble.ts:418

getDiscoveredDevices

getDiscoveredDevices(): BLEAdvertisement[]
Get all discovered devices

Returns BLEAdvertisement[]
- Defined in ble.ts:411

isScanning

isScanning(): boolean
Check if currently scanning

Returns boolean
- Defined in ble.ts:436

startScan

startScan(options?: BLEScanOptions): Promise<void>
Start scanning for devices
Parameters
- options: BLEScanOptions = {}
Returns Promise<void>
- Defined in ble.ts:349

stopScan

stopScan(): void
Stop scanning

Returns void
- Defined in ble.ts:392

waitForDevice

waitForDevice(
    mac: string,
    timeoutMs?: number,
    bleId?: string,
): Promise<BLEAdvertisement>
Wait for specific device
Parameters
- mac: string
- timeoutMs: number = BLE_SCAN_TIMEOUT
- OptionalbleId: string
Returns Promise<BLEAdvertisement>
- Defined in ble.ts:443