home-assistant.io/source/_integrations/amberelectric.markdown
c0ffeeca7 9af249a1fc
A integrations: minor style fix (#29893)
* A integrations: minot style fix

- apply sentence style capitalization
- add refs to glossary terms

* Fix glossary

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2023-11-20 09:02:21 +01:00

2.2 KiB

title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_platforms ha_integration_type
Amber Electric Instructions on how to integrate Amber Electric live prices within Home Assistant.
Energy
Sensor
2021.10 Cloud Polling true
@madpilot
amberelectric
binary_sensor
sensor
integration

Amber is an Australian electricity retailer that provides access to wholesale electricity prices. Customers monitor the wholesale price and shift their energy usage to cheaper, greener times. This saves them money and supports the shift to a more renewably-powered Australia.

Using the Amber Electric {% term integration %}, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts

Getting an API Key

To use this {% term integration %}, you will need to generate an API key.

  1. Login to your Amber account at: https://app.amber.com.au
  2. Click Settings
  3. Enable Developer Mode
  4. Click Generate API Key
  5. Give your API Key a memorable name (say, Home Assistant)
  6. Copy the code that is generated. Note: It will disappear after you reload the page, so make sure you make note of it!

{% include integrations/config_flow.md %}

How the integration works

Prices are split up into three channel types:

  • General - This is the channel that records all your power usage from your lights and appliances
  • Controlled Load - A special channel that is only activated during off-peak times. Often electric hot water systems are connected to the controlled load channel.
  • Feed In - A channel that records exported power from solar panels and batteries.

It exposes the following {% term sensors %} for each channel type:

  • Price - Your current electricity price in $/kWh
  • Forecast - The forecasted prices for the next 12 hours
  • Descriptor - A description of the price. Useful if you want to create a Amber light that matches the app.

There are two additional sensors:

  • Price Spike - A binary sensor that indicates when the current price is over $3/kWh.
  • Renewables - The percentage of renewable energy currently in the grid.