Skip to content

Amber Electric Binding ​

A binding that supports the Australian energy retailer Amber's API (https://www.amber.com.au/) and provides data on the current pricing for buying and selling power, as well as the current level of renewables in the Australian National Electricity Market (NEM).

Supported Things ​

  • service Amber Electric API

Discovery ​

The binding does not support auto discovery.

Thing Configuration ​

As a minimum, the apiKey is needed:

Thing ParameterDefault ValueRequiredAdvancedDescription
apiKeyN/AYesNoThe API key from the 'Developer' section of https://apps.amber.com.au
nmiN/ANoNoThe NMI (NMI (National Metering Identifier) for your property. Required if you have multiple accounts

Channels ​

channel idtypedescription
electricity-priceNumber:EnergyPriceCurrent price to import power from the grid
controlled-load-priceNumber:EnergyPriceCurrent price to import power for Controlled Load
feed-in-priceNumber:EnergyPriceCurrent price to export power to the grid
electricity-statusStringCurrent price status of grid import
controlled-load-statusStringCurrent price status of controlled load import
feed-in-statusStringCurrent price status of Feed-In
nem-timeStringNEM time of last pricing update
renewablesNumber:DimensionlessCurrent level of renewables in the NEM
spikeSwitchReport if the grid has a current price spike
estimateSwitchReport if the current pricing is an estimate or not

Full Example ​

amberelectric.things ​

java
amberelectric:service:AmberElectric [ apiKey="psk_xxxxxxxxxxxxxxxxxxxx" ]

amberelectric.items ​

dsl
Number:EnergyPrice AmberElectric_ElectricityPrice { channel="amberelectric:service:AmberElectric:electricity-price" }
Number:EnergyPrice AmberElectric_ControlledLoadPrice { channel="amberelectric:service:AmberElectric:controlled-load-price" }
Number:EnergyPrice AmberElectric_FeedInPrice { channel="amberelectric:service:AmberElectric:feed-in-price" }
String AmberElectric_ElectricityStatus { channel="amberelectric:service:AmberElectric:electricity-status" }
String AmberElectric_ControlledLoadStatus { channel="amberelectric:service:AmberElectric:controlled-load-status" }
String AmberElectric_FeedInStatus { channel="amberelectric:service:AmberElectric:feed-in-status" }
String AmberElectric_nemtime { channel="amberelectric:service:AmberElectric:nem-time" }
Number AmberElectric_Renewables { channel="amberelectric:service:AmberElectric:renewables" }
Switch AmberElectric_Spike { channel="amberelectric:service:AmberElectric:spike" }
Switch AmberElectric_Estimate { channel="amberelectric:service:AmberElectric:estimate" }

amberelectric.sitemap ​

dsl
Text item=AmberElectric_ElectricityPrice label="Electricity Price"
Text item=AmberElectric_ControlledLoadPrice label="Controlled Load Price"
Text item=AmberElectric_FeedInPrice label="Feed-In Price"
Text item=AmberElectric_ElectricityStatus label="Electricity Price Status"
Text item=AmberElectric_ControlledLoadStatus label="Controlled Load Price Status"
Text item=AmberElectric_FeedInStatus label="Feed-In Price Status"
Text item=AmberElectric_nemtime label="Current time of NEM pricing"
Text item=AmberElectric_Renewables label="Renewables Level"
Switch item=AmberElectric_Spike  label="Spike Status"
Switch item=AmberElectric_Estimate  label="Estimated Pricing (On = Estimate, Off = final pricing"