Access this instance at HomeyAPIV2.energy.
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>
getLiveReport
(async) getLiveReport(opts): Promise.<any>Scopes
homey.insights.readonly
HTTP
GET /api/manager/energy/live
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
zone
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getOptionCurrency
(async) getOptionCurrency(): Promise.<any>Scopes
SYSTEM_READONLY
HTTP
GET /api/manager/energy/option/currency
Returns
Promise.<any>
getOptionKWhCost
(async) getOptionKWhCost(): Promise.<any>Scopes
SYSTEM_READONLY
HTTP
GET /api/manager/energy/option/kWhCost
Returns
Promise.<any>
isConnected
isConnected(): BooleanIf this manager's namespace is connected to Socket.io.
Returns
Boolean
setOptionCurrency
(async) setOptionCurrency(opts): Promise.<any>Scopes
SYSTEM
HTTP
PUT /api/manager/energy/option/currency
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
string | |
|
|
Returns
Promise.<any>
setOptionKWhCost
(async) setOptionKWhCost(opts): Promise.<any>Scopes
SYSTEM
HTTP
PUT /api/manager/energy/option/kWhCost
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
number | |
|
|
Returns
Promise.<any>
unsetOptionCurrency
(async) unsetOptionCurrency(): Promise.<any>Scopes
SYSTEM
HTTP
DELETE /api/manager/energy/option/currency
Returns
Promise.<any>
unsetOptionKWhCost
(async) unsetOptionKWhCost(): Promise.<any>Scopes
SYSTEM
HTTP
DELETE /api/manager/energy/option/kWhCost
Returns
Promise.<any>