Class SwitchBot

Main SwitchBot class - Hybrid BLE/API with automatic fallback

Hierarchy

EventEmitter
- SwitchBot

Index

Constructors

Accessors

Methods

cleanup discover getAPIClient getBLEScanner getConfig isAPIAvailable isBLEAvailable setLogLevel

Constructors

constructor

new SwitchBot(config?: SwitchBotConfig): SwitchBot
Parameters
- config: SwitchBotConfig = {}
Returns SwitchBot
Overrides EventEmitter.constructor
- Defined in switchbot.ts:167

Accessors

devices

get devices(): DeviceManager
Get device manager (for accessing devices)

Returns DeviceManager
- Defined in switchbot.ts:562

Methods

cleanup

cleanup(): Promise<void>
Cleanup and disconnect

Returns Promise<void>
- Defined in switchbot.ts:617

discover

discover(options?: DiscoveryOptions): Promise<SwitchBotDevice[]>
Discover devices (BLE + OpenAPI) BLE discovery runs first, then API discovery to enable proper device matching
Parameters
- options: DiscoveryOptions = {}
Returns Promise<SwitchBotDevice[]>
- Defined in switchbot.ts:258

getAPIClient

getAPIClient(): OpenAPIClient | undefined
Get API client (if available)

Returns OpenAPIClient | undefined
- Defined in switchbot.ts:576

getBLEScanner

getBLEScanner(): BLEScanner | undefined
Get BLE scanner (if available)

Returns BLEScanner | undefined
- Defined in switchbot.ts:569

getConfig

getConfig(): Required<SwitchBotConfig>
Get configuration

Returns Required<SwitchBotConfig>
- Defined in switchbot.ts:583

isAPIAvailable

isAPIAvailable(): boolean
Check if API is available

Returns boolean
- Defined in switchbot.ts:610

isBLEAvailable

isBLEAvailable(): boolean
Check if BLE is available

Returns boolean
- Defined in switchbot.ts:603

setLogLevel

setLogLevel(level: LogLevel): void
Set log level
Parameters
- level: LogLevel
Returns void
- Defined in switchbot.ts:590