ManagerEnergy - Homey Web API

Access this instance at HomeyAPIV3Local.energy.

Extends

HomeyAPIV3.ManagerEnergy

Classes

Instance Methods

deleteReports

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

Scopes

homey.energy

HTTP

DELETE /api/manager/energy/reports

Returns

Promise.<any>

fetchDynamicElectricityPrices

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/price/electricity/dynamic

Parameters

Name	Type	Description
`opts`	object
`date`	string	In `query`
}

Returns

Promise.<any>

getCurrency

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/currency

Returns

Promise.<any>

getDynamicElectricityPriceUserCosts

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/price/electricity/dynamic/user-costs

Returns

Promise.<any>

getDynamicPricesElectricityZone

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/price/electricity/dynamic/zone

Returns

Promise.<any>

getDynamicPricesElectricityZones

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/price/electricity/dynamic/zones

Returns

Promise.<any>

getElectricityPriceType

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/price/electricity/type

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>	In `query`
}

Returns

Promise.<any>

getOptionElectricityPriceDynamicPreferredInterval

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

Scopes

homey.energy.readonly

HTTP

GET /api/manager/energy/option/electricityPriceDynamicPreferredInterval

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	In `query`
`cache`	string <optional>	In `query`
}

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	In `query`
`cache`	string <optional>	In `query`
}

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	In `query`
`cache`	string <optional>	In `query`
}

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	In `query`
`cache`	string <optional>	In `query`
}

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	In `body`
`date`	string <optional>
`categories`	array <optional>
`deviceIds`	array <optional>
}
}

Returns

Promise.<any>

setDynamicElectricityPriceUserCosts

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

Scopes

homey.energy

HTTP

PUT /api/manager/energy/price/electricity/dynamic/user-costs

Parameters

Name	Type	Description
`opts`	object
`mathExpression`	string	In `body`
`type`	string <optional>	In `body`
}

Returns

Promise.<any>

setDynamicPricesElectricityZone

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

Scopes

homey.energy

HTTP

PUT /api/manager/energy/price/electricity/dynamic/zone

Parameters

Name	Type	Description
`opts`	object
`options`	object	In `body`
`zoneId`	string <optional>
`zoneVersion`	string <optional>
`zoneName`	string <optional>
`zoneCountryKey`	string <optional>
}
}

Returns

Promise.<any>

setElectricityPriceType

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

Scopes

homey.energy

HTTP

PUT /api/manager/energy/price/electricity/:type

Parameters

Name	Type	Description
`opts`	object
`type`	string	In `path`
}

Returns

Promise.<any>

setOptionElectricityPriceDynamicPreferredInterval

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

Scopes

homey.energy

HTTP

PUT /api/manager/energy/option/electricityPriceDynamicPreferredInterval

Parameters

Name	Type	Description
`opts`	object
`value`	*	In `body`
}

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`	*	In `body`
}

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`	*	In `body`
}

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`	*	In `body`
}

Returns

Promise.<any>

unsetDynamicElectricityPriceUserCosts

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

Scopes

homey.energy

HTTP

DELETE /api/manager/energy/price/electricity/dynamic/user-costs

Returns

Promise.<any>

unsetOptionElectricityPriceDynamicPreferredInterval

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

Scopes

homey.energy

HTTP

DELETE /api/manager/energy/option/electricityPriceDynamicPreferredInterval

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`	HomeyAPIV3Local.ManagerEnergy.EnergyReportDay

energyreportday.delete

.on('energyreportday.delete')

Parameters

Name	Type	Description
`energyreportday`	HomeyAPIV3Local.ManagerEnergy.EnergyReportDay

energyreportday.update

.on('energyreportday.update')

Parameters

Name	Type	Description
`energyreportday`	HomeyAPIV3Local.ManagerEnergy.EnergyReportDay

energyreporthour.create

.on('energyreporthour.create')

Parameters

Name	Type	Description
`energyreporthour`	HomeyAPIV3Local.ManagerEnergy.EnergyReportHour

energyreporthour.delete

.on('energyreporthour.delete')

Parameters

Name	Type	Description
`energyreporthour`	HomeyAPIV3Local.ManagerEnergy.EnergyReportHour

energyreporthour.update

.on('energyreporthour.update')

Parameters

Name	Type	Description
`energyreporthour`	HomeyAPIV3Local.ManagerEnergy.EnergyReportHour

energyreportmonth.create

.on('energyreportmonth.create')

Parameters

Name	Type	Description
`energyreportmonth`	HomeyAPIV3Local.ManagerEnergy.EnergyReportMonth

energyreportmonth.delete

.on('energyreportmonth.delete')

Parameters

Name	Type	Description
`energyreportmonth`	HomeyAPIV3Local.ManagerEnergy.EnergyReportMonth

energyreportmonth.update

.on('energyreportmonth.update')

Parameters

Name	Type	Description
`energyreportmonth`	HomeyAPIV3Local.ManagerEnergy.EnergyReportMonth

energyreportweek.create

.on('energyreportweek.create')

Parameters

Name	Type	Description
`energyreportweek`	HomeyAPIV3Local.ManagerEnergy.EnergyReportWeek

energyreportweek.delete

.on('energyreportweek.delete')

Parameters

Name	Type	Description
`energyreportweek`	HomeyAPIV3Local.ManagerEnergy.EnergyReportWeek

energyreportweek.update

.on('energyreportweek.update')

Parameters

Name	Type	Description
`energyreportweek`	HomeyAPIV3Local.ManagerEnergy.EnergyReportWeek

energyreportyear.create

.on('energyreportyear.create')

Parameters

Name	Type	Description
`energyreportyear`	HomeyAPIV3Local.ManagerEnergy.EnergyReportYear

energyreportyear.delete

.on('energyreportyear.delete')

Parameters

Name	Type	Description
`energyreportyear`	HomeyAPIV3Local.ManagerEnergy.EnergyReportYear

energyreportyear.update

.on('energyreportyear.update')

Parameters

Name	Type	Description
`energyreportyear`	HomeyAPIV3Local.ManagerEnergy.EnergyReportYear