ManagerSystem

Access this instance at HomeyAPIV3Local.system.

Extends

Methods

connect

(async) connect(): Promise.<void>

Connect to the realtime namespace.

Returns

Promise.<void>

disconnect

(async) disconnect(): Promise.<void>

Disconnect from the realtime namespace.

Returns

Promise.<void>

getInfo

(async) getInfo(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/

Returns

Promise.<any>

getMemoryInfo

(async) getMemoryInfo(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/memory

Returns

Promise.<any>

getOptionForwardedPort

(async) getOptionForwardedPort(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/option/forwardedPort

Returns

Promise.<any>

getState

(async) getState(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/state

Returns

Promise.<any>

getStorageInfo

(async) getStorageInfo(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/storage

Returns

Promise.<any>

getSystemName

(async) getSystemName(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/system/name

Returns

Promise.<any>

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

ping

(async) ping(): Promise.<any>

Scopes

-

HTTP

GET /api/manager/system/ping

Returns

Promise.<any>

reboot

(async) reboot(): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/system/reboot

Returns

Promise.<any>

rebootOTA

(async) rebootOTA(): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/system/reboot-ota

Returns

Promise.<any>

sendLog

(async) sendLog(opts): Promise.<any>

Scopes

homey.system.readonly

HTTP

POST /api/manager/system/journalctl

Parameters

Name Type Description
opts
object
append
string <optional>
}

Returns

Promise.<any>

setOptionForwardedPort

(async) setOptionForwardedPort(opts): Promise.<any>

Scopes

homey.system

HTTP

PUT /api/manager/system/option/forwardedPort

Parameters

Name Type Description
opts
object
value
*
}

Returns

Promise.<any>

setSystemName

(async) setSystemName(opts): Promise.<any>

Scopes

homey.system

HTTP

PUT /api/manager/system/name

Parameters

Name Type Description
opts
object
name
string
}

Returns

Promise.<any>

startBluFi

(async) startBluFi(): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/system/blufi/start

Returns

Promise.<any>

stopBluFi

(async) stopBluFi(): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/system/blufi/stop

Returns

Promise.<any>

unsetOptionForwardedPort

(async) unsetOptionForwardedPort(): Promise.<any>

Scopes

homey.system

HTTP

DELETE /api/manager/system/option/forwardedPort

Returns

Promise.<any>