SwitchBotHandler

SwitchBot clientクラス SwitchBotのWebAPIを利用して状態取得や状態変更を実施する。ユーザのTokenとSecretKeyが必要で、取得方法は公式に書いてあります。公式のドキュメントはこのモジュールのReadmeに参照先がかいてあります。

Constructor

new SwitchBotHandler(token, secret)

コンストラクタ

Source:

index.js, line 18

Parameters:

Name	Type	Description
`token`	`string`	switch bot token
`secret`	`string`	switch bot secret

Methods

getDevices(callback)

デバイスリストを取得する。デバイスリストを取得したらcallback関数を呼ぶ。

Source:

index.js, line 50

Parameters:

Name	Type	Description
`callback`	`function`	user function

getDevices(callback)

デバイスリストを取得する。デバイスリストを取得したらcallback関数を呼ぶ。

Source:

index.js, line 50

Parameters:

Name	Type	Description
`callback`	`function`	user function

(async) getDevicesSync() → {string}

デバイスリストを同期的に取得する。デバイスリストを取得したらreturnする。getDevicesのほうがパフォーマンスに優れる。

Source:

index.js, line 60

Returns:

Type:: string

(async) getDevicesSync() → {string}

デバイスリストを同期的に取得する。デバイスリストを取得したらreturnする。getDevicesのほうがパフォーマンスに優れる。

Source:

index.js, line 60

Returns:

Type:: string

getDeviceStatus(callback)

デバイスの状態取得

Source:

index.js, line 70

Parameters:

Name	Type	Description
`callback`	`function`	user function

getDeviceStatus(callback)

デバイスの状態取得

Source:

index.js, line 70

Parameters:

Name	Type	Description
`callback`	`function`	user function

(async) getDeviceStatusSync(deviceId) → {string}

デバイスの状態取得

Source:

index.js, line 80

Parameters:

Name	Type	Description
`deviceId`	`string`	deviceId

Returns:

Type:: string

(async) getDeviceStatusSync(deviceId) → {string}

デバイスの状態取得

Source:

index.js, line 80

Parameters:

Name	Type	Description
`deviceId`	`string`	deviceId

Returns:

Type:: string

getRequest(path, callback)

内部関数：情報取得

Source:

index.js, line 130

Parameters:

Name	Type	Description
`path`	`string`
`callback`	`function`

Throws:

error

getRequest(path, callback)

内部関数：情報取得

Source:

index.js, line 130

Parameters:

Name	Type	Description
`path`	`string`
`callback`	`function`

Throws:

error

getRequestHeaders() → {Headers}

内部関数：通信用HTTPヘッダ生成

Source:

index.js, line 202

Returns:

Type:: Headers

request headers for switch bot

getRequestHeaders() → {Headers}

内部関数：通信用HTTPヘッダ生成

Source:

index.js, line 202

Returns:

Type:: Headers

request headers for switch bot

(async) getRequestSync(path) → {string}

内部関数：情報取得

Source:

index.js, line 146

Parameters:

Name	Type	Description
`path`	`string`

Returns:

Type:: string

(async) getRequestSync(path) → {string}

内部関数：情報取得

Source:

index.js, line 146

Parameters:

Name	Type	Description
`path`	`string`

Returns:

Type:: string

postRequest(path, body, callback)

内部関数：情報書き込み

Source:

index.js, line 160

Parameters:

Name	Type	Description
`path`	`string`
`body`	`string`
`callback`	`function`

Throws:

error

postRequest(path, body, callback)

内部関数：情報書き込み

Source:

index.js, line 160

Parameters:

Name	Type	Description
`path`	`string`
`body`	`string`
`callback`	`function`

Throws:

error

(async) postRequestSync(path, body) → {string}

内部関数：情報書き込み

Source:

index.js, line 177

Parameters:

Name	Type	Description
`path`	`string`
`body`	`string`

Returns:

Type:: string

(async) postRequestSync(path, body) → {string}

内部関数：情報書き込み

Source:

index.js, line 177

Parameters:

Name	Type	Description
`path`	`string`
`body`	`string`

Returns:

Type:: string

setDeviceStatus(deviceId, _command, _params, callback)

デバイスの状態変更

Source:

index.js, line 93

Parameters:

Name	Type	Description
`deviceId`	`string`
`_command`	`string`
`_params`	`string`
`callback`	`function`

setDeviceStatus(deviceId, _command, _params, callback)

デバイスの状態変更

Source:

index.js, line 93

Parameters:

Name	Type	Description
`deviceId`	`string`
`_command`	`string`
`_params`	`string`
`callback`	`function`

(async) setDeviceStatusSync(deviceId, _command, _params) → {string}

デバイスの状態変更

Source:

index.js, line 110

Parameters:

Name	Type	Description
`deviceId`	`string`
`_command`	`string`
`_params`	`string`

Returns:

Type:: string

(async) setDeviceStatusSync(deviceId, _command, _params) → {string}

デバイスの状態変更

Source:

index.js, line 110

Parameters:

Name	Type	Description
`deviceId`	`string`
`_command`	`string`
`_params`	`string`

Returns:

Type:: string