mainSwitchBot - Documentation

Source:

mainSwitchBot.js, line 10

Members

(inner) callback

Description:

SwitchBotの状態を取得したら呼ばれる関数を保持

Source:

mainSwitchBot.js, line 55

Default Value:

null

SwitchBotの状態を取得したら呼ばれる関数を保持

(inner) client

Description:

SwitchBotとの接続を保持

Source:

mainSwitchBot.js, line 45

Default Value:

null

SwitchBotとの接続を保持

(inner) config

Description:

mainSwitchBotのconfig

Source:

mainSwitchBot.js, line 27

mainSwitchBotのconfig

(inner) isRun

Description:

初期化して起動済みのフラグ

Source:

mainSwitchBot.js, line 60

Default Value:

null

初期化して起動済みのフラグ

(inner) mainSwitchBot

Description:

SwitchBotとの通信を管理

Source:

mainSwitchBot.js, line 44

SwitchBotとの通信を管理

(inner) observationJob

Description:

定期的にSwitchBotの状態を取得するタイマー

Source:

mainSwitchBot.js, line 50

Default Value:

null

定期的にSwitchBotの状態を取得するタイマー

(inner) persist

Description:

mainSwitchBotのpersist

Source:

mainSwitchBot.js, line 35

mainSwitchBotのpersist

(inner) sendIPCMessage

Description:

mainSwitchBotからIPCMessageを呼ぶためのcallback

Source:

mainSwitchBot.js, line 38

mainSwitchBotからIPCMessageを呼ぶためのcallback

Methods

(inner) control(idopt, commandopt) → {void}

Source:

mainSwitchBot.js, line 196

Parameters:

Name	Type	Attributes	Description
`id`	id	<optional>
`command`	command	<optional>

Returns:

Type: void

(async, inner) getCases(dateopt) → {ret}

Source:

mainSwitchBot.js, line 555

Parameters:

Name	Type	Attributes	Description
`date`	date	<optional>

Returns:

Type: ret

(async, inner) getConfig() → {config}

Source:

mainSwitchBot.js, line 174

Parameters:

Type	Description
void

Returns:

Type: config

(async, inner) getCurrentRows(theDayBeginopt, theDayEndopt, plugopt, subQueryopt) → {rows}

Source:

mainSwitchBot.js, line 787

Parameters:

Name	Type	Attributes
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>
`plug`	plug	<optional>
`subQuery`	subQuery	<optional>

Returns:

Type: rows

(async, inner) getHumidityRows(_sendIPCMessageopt) → {rows}

Source:

mainSwitchBot.js, line 683

Parameters:

Name	Type	Attributes	Description
`_sendIPCMessage`	sendIPCMessage	<optional>

Returns:

Type: rows

(async, inner) getMeterList(theDayBeginopt, theDayEndopt) → {rows}

Source:

mainSwitchBot.js, line 588

Parameters:

Name	Type	Attributes	Description
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>

Returns:

Type: rows

(async, inner) getPersist() → {persist}

Source:

mainSwitchBot.js, line 185

Parameters:

Type	Description
void

Returns:

Type: persist

(async, inner) getTempratureRows(theDayBeginopt, theDayEndopt, meteropt, subQueryopt) → {rows}

Source:

mainSwitchBot.js, line 649

Parameters:

Name	Type	Attributes
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>
`meter`	meter	<optional>
`subQuery`	subQuery	<optional>

Returns:

Type: rows

(async, inner) getTodayRoomEnvSwitchBot() → {object}

Source:

mainSwitchBot.js, line 824

Parameters:

Type	Description
void

Returns:

Type: object

(async, inner) getVoltageRows(theDayBeginopt, theDayEndopt, plugopt, subQueryopt) → {rows}

Source:

mainSwitchBot.js, line 718

Parameters:

Name	Type	Attributes
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>
`plug`	plug	<optional>
`subQuery`	subQuery	<optional>

Returns:

Type: rows

(async, inner) getWeightRows(theDayBeginopt, theDayEndopt, plugopt, subQueryopt) → {rows}

Source:

mainSwitchBot.js, line 752

Parameters:

Name	Type	Attributes
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>
`plug`	plug	<optional>
`subQuery`	subQuery	<optional>

Returns:

Type: rows

(async, inner) plugMiniList(theDayBeginopt, theDayEndopt) → {rows}

Source:

mainSwitchBot.js, line 618

Parameters:

Name	Type	Attributes	Description
`theDayBegin`	theDayBegin	<optional>
`theDayEnd`	theDayEnd	<optional>

Returns:

Type: rows

(inner) renewFacilities(_clientopt, callback(devStatusList)opt)

Source:

mainSwitchBot.js, line 214

Parameters:

Name	Type	Attributes	Description
`_client`	Object	<optional>
`callback(devStatusList)`	function	<optional>

(async, inner) sendTodayRoomEnv() → {void}

Source:

mainSwitchBot.js, line 961

Parameters:

Type	Description
void

Returns:

Type: void

(async, inner) setConfig(_configopt) → {void}

Source:

mainSwitchBot.js, line 157

Parameters:

Name	Type	Attributes	Description
`_config`	_config	<optional>

Returns:

Type: void

(async, inner) start(_sendIPCMessageopt) → {void}

Source:

mainSwitchBot.js, line 68

Parameters:

Name	Type	Attributes	Description
`_sendIPCMessage`	sendIPCMessage	<optional>

Returns:

Type: void

(async, inner) stop(voidopt) → {void}

Source:

mainSwitchBot.js, line 128

Parameters:

Name	Type	Attributes	Description
`void`	void	<optional>

Returns:

Type: void

(async, inner) stopObservation(voidopt)

Source:

mainSwitchBot.js, line 293

Parameters:

Name	Type	Attributes	Description
`void`	void	<optional>

(async, inner) stopWithoutSave(voidopt) → {void}

Source:

mainSwitchBot.js, line 143

Parameters:

Name	Type	Attributes	Description
`void`	void	<optional>

Returns:

Type: void

(async, inner) storeData(facilitiesopt)

Source:

mainSwitchBot.js, line 314

Parameters:

Name	Type	Attributes	Description
`facilities`	facilities	<optional>

Type Definitions

_callback() → {void}

Source:

mainSwitchBot.js, line 254

Returns:

Type: void