jscruz / sensor.carbon_intensity_uk

Carbon Intensity UK Sensor for Home Assistant
MIT License
8 stars 11 forks source link
carbon custom-component custom-integration energy hacs home-assistant-custom sensor-platform

Carbon Intensity UK sensor

GitHub Release

GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

_Component to integrate with Carbon Intensity UK._

This component will set up the following platforms.

Platform Description
sensor Show info from Carbon Intensity UK API.

The sensor retrieves information using Carbon Intensity UK API library

alt Sensor attributes

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called carbon_intensity_uk.
  4. Download all the files from the custom_components/carbon_intensity_uk/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Carbon Intensity UK"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/carbon_intensity_uk/.translations/en.json
custom_components/carbon_intensity_uk/.translations/nb.json
custom_components/carbon_intensity_uk/.translations/sensor.nb.json
custom_components/carbon_intensity_uk/__init__.py
custom_components/carbon_intensity_uk/binary_sensor.py
custom_components/carbon_intensity_uk/config_flow.py
custom_components/carbon_intensity_uk/const.py
custom_components/carbon_intensity_uk/manifest.json
custom_components/carbon_intensity_uk/sensor.py
custom_components/carbon_intensity_uk/switch.py

Configuration is done in the UI

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines