badguy99 / carbonintensity

Carbon Intensity Simple Client Library

carbonintensity

Simple Carbon Intensity UK API Library

The purpose of this library is to retrieve information from Carbon Intensity UK

The client connects asynchrnously to the API for retrieving information about the current level of CO2 generating energy in the current period.

It uses aiohttp to communicate with the API asynchrnously. This decision has been based mainly on the premise that the library will be used in the context of Home Assistant integration.

In addition it calculates when is the next 24 hours lowest level comparing values of the CO2 forecast levels.

Example

Retrieve regional information based on postcode SW1 for the next 24 hours starting now:

   client = Client("SW1")
   response = await client.async_get_data()
   data = response["data"]

Note: Time in UTC

Data format

An example of the function output can be found below:

   {
       "data":
        {
              "current_period_from": "2020-05-20T10:00Z",
              "current_period_to": "2020-05-20T10:30Z",
              "current_period_forecast":300,
              "current_period_index": "high",
              "lowest_period_from":"2020-05-21T14:00Z",
              "lowest_period_to":"2020-05-21T14:30Z",
              "lowest_period_forecast": 168,
              "lowest_period_index": "moderate",
              "postcode": "SW1"
        }
    }

Install carbonintensity

python3 -m pip install -U carbonintensity

Licenses

This work is based on the following:

• sampleclient: See Original license
• Carbon Intensity API: See Terms and conditions