Class OpenAPIClient

OpenAPI Client for SwitchBot API v1.1

Constructors

constructor

new OpenAPIClient(
    token: string,
    secret: string,
    baseURL?: string,
    logLevel?: number,
): OpenAPIClient
Parameters
- token: string
- secret: string
- baseURL: string = urls.base
- OptionallogLevel: number
Returns OpenAPIClient
- Defined in api.ts:19

Methods

airPurifierSetFanSpeed

airPurifierSetFanSpeed(
deviceId: string,
speed: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- speed: number
Returns Promise<APICommandResponse>
- Defined in api.ts:318

airPurifierSetMode

airPurifierSetMode(
deviceId: string,
mode: "auto" | "manual" | "sleep",
): Promise<APICommandResponse>
Parameters
- deviceId: string
- mode: "auto" | "manual" | "sleep"
Returns Promise<APICommandResponse>
- Defined in api.ts:314

airPurifierTurnOff

airPurifierTurnOff(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:310

airPurifierTurnOn

airPurifierTurnOn(deviceId: string): Promise<APICommandResponse>
Air Purifier-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:306

blindTiltClose

blindTiltClose(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:329

blindTiltOpen

blindTiltOpen(deviceId: string): Promise<APICommandResponse>
Blind Tilt-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:325

blindTiltSetPosition

blindTiltSetPosition(
deviceId: string,
position: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- position: number
Returns Promise<APICommandResponse>
- Defined in api.ts:333

botPress

botPress(deviceId: string): Promise<APICommandResponse>
Bot-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:205

botTurnOff

botTurnOff(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:213

botTurnOn

botTurnOn(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:209

curtainClose

curtainClose(deviceId: string, speed?: number): Promise<APICommandResponse>
Parameters
- deviceId: string
- speed: number = 255
Returns Promise<APICommandResponse>
- Defined in api.ts:225

curtainOpen

curtainOpen(deviceId: string, speed?: number): Promise<APICommandResponse>
Curtain-specific commands
Parameters
- deviceId: string
- speed: number = 255
Returns Promise<APICommandResponse>
- Defined in api.ts:220

curtainPause

curtainPause(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:230

curtainSetPosition

curtainSetPosition(
    deviceId: string,
    position: number,
    speed?: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- position: number
- speed: number = 255
Returns Promise<APICommandResponse>
- Defined in api.ts:234

deleteWebhook

deleteWebhook(url: string): Promise<void>
Delete webhook
Parameters
- url: string
Returns Promise<void>
- Defined in api.ts:174

executeScene

executeScene(sceneId: string): Promise<void>
Execute a scene
Parameters
- sceneId: string
Returns Promise<void>
- Defined in api.ts:133

getConfig

getConfig(): { baseURL: string; token: string }
Get client configuration

Returns { baseURL: string; token: string }
- Defined in api.ts:340

getDevice

getDevice(deviceId: string): Promise<APIDevice | undefined>
Get specific device information
Parameters
- deviceId: string
Returns Promise<APIDevice | undefined>
- Defined in api.ts:181

getDevices

getDevices(): Promise<DeviceListResponse>
Get all devices

Returns Promise<DeviceListResponse>
- Defined in api.ts:87

getDevicesByType

getDevicesByType(deviceType: string): Promise<APIDevice[]>
Get devices by type
Parameters
- deviceType: string
Returns Promise<APIDevice[]>
- Defined in api.ts:189

getScenes

getScenes(): Promise<SceneListResponse>
Get all scenes

Returns Promise<SceneListResponse>
- Defined in api.ts:125

getStatus

getStatus(deviceId: string): Promise<APIDeviceStatus>
Get device status
Parameters
- deviceId: string
Returns Promise<APIDeviceStatus>
- Defined in api.ts:95

humidifierSetMode

humidifierSetMode(
deviceId: string,
mode: "auto" | "manual",
): Promise<APICommandResponse>
Parameters
- deviceId: string
- mode: "auto" | "manual"
Returns Promise<APICommandResponse>
- Defined in api.ts:299

humidifierTurnOff

humidifierTurnOff(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:295

humidifierTurnOn

humidifierTurnOn(deviceId: string): Promise<APICommandResponse>
Humidifier-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:291

isCloudServiceEnabled

isCloudServiceEnabled(deviceId: string): Promise<boolean>
Check if device has cloud service enabled
Parameters
- deviceId: string
Returns Promise<boolean>
- Defined in api.ts:197

lightSetBrightness

lightSetBrightness(
deviceId: string,
brightness: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- brightness: number
Returns Promise<APICommandResponse>
- Defined in api.ts:276

lightSetColor

lightSetColor(
    deviceId: string,
    red: number,
    green: number,
    blue: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- red: number
- green: number
- blue: number
Returns Promise<APICommandResponse>
- Defined in api.ts:280

lightSetColorTemperature

lightSetColorTemperature(
deviceId: string,
temperature: number,
): Promise<APICommandResponse>
Parameters
- deviceId: string
- temperature: number
Returns Promise<APICommandResponse>
- Defined in api.ts:284

lightTurnOff

lightTurnOff(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:272

lightTurnOn

lightTurnOn(deviceId: string): Promise<APICommandResponse>
Bulb/Light-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:268

lockLock

lockLock(deviceId: string): Promise<APICommandResponse>
Lock-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:242

lockUnlock

lockUnlock(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:246

plugToggle

plugToggle(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:261

plugTurnOff

plugTurnOff(deviceId: string): Promise<APICommandResponse>
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:257

plugTurnOn

plugTurnOn(deviceId: string): Promise<APICommandResponse>
Plug-specific commands
Parameters
- deviceId: string
Returns Promise<APICommandResponse>
- Defined in api.ts:253

queryWebhook

queryWebhook(urls?: string[]): Promise<WebhookQueryResponse>
Query webhook configuration
Parameters
- Optionalurls: string[]
Returns Promise<WebhookQueryResponse>
- Defined in api.ts:153

sendCommand

sendCommand(
    deviceId: string,
    command: string,
    parameter?: any,
): Promise<APICommandResponse>
Send command to device
Parameters
- deviceId: string
- command: string
- Optionalparameter: any
Returns Promise<APICommandResponse>
- Defined in api.ts:103

setBaseURL

setBaseURL(newBaseURL: string): void
Update base URL
Parameters
- newBaseURL: string
Returns void
- Defined in api.ts:350

setupWebhook

setupWebhook(config: WebhookConfig): Promise<WebhookSetupResponse>
Setup webhook
Parameters
- config: WebhookConfig
Returns Promise<WebhookSetupResponse>
- Defined in api.ts:140

updateWebhook

updateWebhook(config: WebhookConfig): Promise<void>
Update webhook
Parameters
- config: WebhookConfig
Returns Promise<void>
- Defined in api.ts:167