Access this instance at HomeyAPIV3Cloud.energy.
Extends
- HomeyAPIV3.ManagerEnergy
Classes
Instance Methods
deleteReports
(async) deleteReports(): Promise.<any>Scopes
homey.energy
HTTP
DELETE /api/manager/energy/reports
Returns
Promise.<any>
getCurrency
(async) getCurrency(): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/currency
Returns
Promise.<any>
getLiveReport
(async) getLiveReport(opts): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/live
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
zone
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getOptionElectricityPriceFixed
(async) getOptionElectricityPriceFixed(): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/option/electricityPriceFixed
Returns
Promise.<any>
getOptionGasPriceFixed
(async) getOptionGasPriceFixed(): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/option/gasPriceFixed
Returns
Promise.<any>
getOptionWaterPriceFixed
(async) getOptionWaterPriceFixed(): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/option/waterPriceFixed
Returns
Promise.<any>
getReportDay
(async) getReportDay(opts): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/report/day
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
date
|
string | |
cache
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getReportMonth
(async) getReportMonth(opts): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/report/month
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
yearMonth
|
string | |
cache
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getReportWeek
(async) getReportWeek(opts): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/report/week
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
isoWeek
|
string | |
cache
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getReportYear
(async) getReportYear(opts): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/report/year
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
year
|
string | |
cache
|
string
<optional> |
|
|
|
Returns
Promise.<any>
getReportsAvailable
(async) getReportsAvailable(): Promise.<any>Scopes
homey.energy.readonly
HTTP
GET /api/manager/energy/reports/available
Returns
Promise.<any>
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/energy/state
Returns
Promise.<any>
resetReportDayCategories
(async) resetReportDayCategories(opts): Promise.<any>Scopes
homey.energy
HTTP
PUT /api/manager/energy/report/day/reset/categories
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
options
|
object | |
date
|
string
<optional> |
|
categories
|
array
<optional> |
|
deviceIds
|
array
<optional> |
|
|
|
||
|
|
Returns
Promise.<any>
setOptionElectricityPriceFixed
(async) setOptionElectricityPriceFixed(opts): Promise.<any>Scopes
homey.energy
HTTP
PUT /api/manager/energy/option/electricityPriceFixed
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
* | |
|
|
Returns
Promise.<any>
setOptionGasPriceFixed
(async) setOptionGasPriceFixed(opts): Promise.<any>Scopes
homey.energy
HTTP
PUT /api/manager/energy/option/gasPriceFixed
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
* | |
|
|
Returns
Promise.<any>
setOptionWaterPriceFixed
(async) setOptionWaterPriceFixed(opts): Promise.<any>Scopes
homey.energy
HTTP
PUT /api/manager/energy/option/waterPriceFixed
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
value
|
* | |
|
|
Returns
Promise.<any>
unsetOptionElectricityPriceFixed
(async) unsetOptionElectricityPriceFixed(): Promise.<any>Scopes
homey.energy
HTTP
DELETE /api/manager/energy/option/electricityPriceFixed
Returns
Promise.<any>
unsetOptionGasPriceFixed
(async) unsetOptionGasPriceFixed(): Promise.<any>Scopes
homey.energy
HTTP
DELETE /api/manager/energy/option/gasPriceFixed
Returns
Promise.<any>
unsetOptionWaterPriceFixed
(async) unsetOptionWaterPriceFixed(): Promise.<any>Scopes
homey.energy
HTTP
DELETE /api/manager/energy/option/waterPriceFixed
Returns
Promise.<any>
Events
energyreportday.create
.on('energyreportday.create')Parameters
| Name | Type | Description |
|---|---|---|
energyreportday
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportDay |
energyreportday.delete
.on('energyreportday.delete')Parameters
| Name | Type | Description |
|---|---|---|
energyreportday
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportDay |
energyreportday.update
.on('energyreportday.update')Parameters
| Name | Type | Description |
|---|---|---|
energyreportday
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportDay |
energyreporthour.create
.on('energyreporthour.create')Parameters
| Name | Type | Description |
|---|---|---|
energyreporthour
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportHour |
energyreporthour.delete
.on('energyreporthour.delete')Parameters
| Name | Type | Description |
|---|---|---|
energyreporthour
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportHour |
energyreporthour.update
.on('energyreporthour.update')Parameters
| Name | Type | Description |
|---|---|---|
energyreporthour
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportHour |
energyreportmonth.create
.on('energyreportmonth.create')Parameters
| Name | Type | Description |
|---|---|---|
energyreportmonth
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportMonth |
energyreportmonth.delete
.on('energyreportmonth.delete')Parameters
| Name | Type | Description |
|---|---|---|
energyreportmonth
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportMonth |
energyreportmonth.update
.on('energyreportmonth.update')Parameters
| Name | Type | Description |
|---|---|---|
energyreportmonth
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportMonth |
energyreportweek.create
.on('energyreportweek.create')Parameters
| Name | Type | Description |
|---|---|---|
energyreportweek
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportWeek |
energyreportweek.delete
.on('energyreportweek.delete')Parameters
| Name | Type | Description |
|---|---|---|
energyreportweek
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportWeek |
energyreportweek.update
.on('energyreportweek.update')Parameters
| Name | Type | Description |
|---|---|---|
energyreportweek
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportWeek |
energyreportyear.create
.on('energyreportyear.create')Parameters
| Name | Type | Description |
|---|---|---|
energyreportyear
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportYear |
energyreportyear.delete
.on('energyreportyear.delete')Parameters
| Name | Type | Description |
|---|---|---|
energyreportyear
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportYear |
energyreportyear.update
.on('energyreportyear.update')Parameters
| Name | Type | Description |
|---|---|---|
energyreportyear
|
HomeyAPIV3Cloud.ManagerEnergy.EnergyReportYear |