sensor.opennem
Home Assistant sensor for OpenNEM Data
This component will set up a sensor platform to retrieve data from OpenNEM, an open platform to access National Electricity Market Data (Australia)
This component will set up the following platforms.
| Platform | Description |
|---|---|
sensor |
Show info from OpenNEM API. |
IMPORTANT: This integration breaks with Home Assistant 2023.08 - I'm unsure when I will be able to fix the issues that break the integration. Happy to accept any and all PRs that resolve this (and any other issues with the integration)
Installation
Manual Installation
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml). - If you do not have a
custom_componentsdirectory (folder) there, you need to create it. - In the
custom_componentsdirectory (folder) create a new folder calledopennem. - Download all the files from the
custom_components/opennem/directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Create Configuration (see below)
- Restart Home Assistant
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "OpenNEM"
Installation via Home Assistant Community Store (HACS)
- Ensure HACS is installed.
- Search for and install the "OpenNEM (AU) Data" integration
- Configure the sensor
- Restart Home Assistant
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "OpenNEM"
Configuration is done in the UI
Regions
OpenNEM data is published for the following regions (states):
| State | Region for Config |
|---|---|
| Queensland | qld |
| New South Wales | nsw |
| Victoria | vic |
| South Australia | sa |
| Tasmania | tas |
| Western Australia | wa |
| National Energy Market | nem |
Attributes
Not all energy sources are applicable in each region, the sensor will only report the sources that are applicable to each region
| Name | Type | Attribute | Description | |
|---|---|---|---|---|
| Battery - Charging | Load | battery_charging |
||
| Battery - Discharging | Energy Source | battery_discharging |
||
| BioEnergy (Biomass) | Energy Source | bioenergy_biomass |
||
| BioEnergy (Biogas) | Energy Source | bioenergy_biogas |
||
| Black Coal | Energy Source | coal_black |
||
| Brown Coal | Energy Source | coal_brown |
||
| Exported Electricity | Outward Energy | exports |
Electricity exported to other Regions | |
| Demand | Demand | demand |
Not Available in WA | |
| Distillate | Energy Source | distillate |
||
| Emissions Factor | Emissions | emissions_factor |
Tonnes of CO2 Equivalent per MW | |
| Flow (between Regions) | Energy Transfer | flow_{region} |
Energy Flow between interconnected regions | |
| Generation by Fossil Fuels | Calculated | fossilfuel |
Electricity generated (in region) from Fossil Fuel sources | |
| Generation by Renewables | Calculated | renewables |
Electricity generated (in region) from Renewable sources | |
| Generation vs Demand | Calculated | genvsdemand |
See Below (Not available in WA) | |
| Gas (Combined Cycle Power Plant) | Energy Source | gas_ccgt |
||
| Gas (Open Cycle Gas Turbines) | Energy Source | gas_ocgt |
||
| Gas (Reciprocating Engine) | Energy Source | gas_recip |
||
| Gas (Steam) | Energy Source | gas_steam |
||
| Gas (Waste Coal Mine) | Energy Source | gas_wcmg |
||
| Electricity Generated | Calculated | generation |
Electricity generated in Region | |
| Hydro | Energy Source | hydro |
||
| Imported Electricity | Incoming Energy | imports |
Electricity imported from other Regions | |
| Spot Price | Price | price |
Current Spot Price | |
| Pumps | Load | pumps |
||
| Solar (Rooftop) | Energy Source | solar_rooftop |
||
| Solar (Utility) | Energy Source | solar_utility |
||
| Temperature | Temperature | temperature |
Current Average Temperature in Region | |
| Wind | Energy Source | wind |
Generation vs Demand
The genvsdemand attribute is a calculation of the generation in a region (excluding any imports) minus the the region's energy demands. Where the attribute is a negative number, the region is not generating sufficient energy to meet demand.
Contributions are welcome!
If you want to contribute to this please read the Contribution guidelines