Home Assistant Client library for Carbon Intensity API
Project description
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:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for carbonintensity-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a302d4c55bf381c6c93fc5952c067ae3a455956e2e29cabd084c47d55d1fe1d |
|
MD5 | dfec6c46dfe0e9a51ae52b8f7cad7f71 |
|
BLAKE2b-256 | c6aa359db26d9c6db188e87ad7295a9401c44e09d2be0770e0101f111ee00c68 |