jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

CO2signal extra sensor doc (#18590)

Browse Source
This commit is contained in:
Paulus Schoutsen 2021-07-23 15:32:13 -07:00 committed by GitHub
parent 31269103f4
commit d8c9b79ddd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_integrations/co2signal.markdown
View File

@ -8,25 +8,17 @@ ha_iot_class: Cloud Polling
ha_domain: co2signal
ha_platforms:
- sensor
ha_config_flow: true
---
The `co2signal` sensor platform queries the [CO2Signal](https://www.co2signal.com/) API for the CO2 intensity of a specific region. Data can be collected via latitude/longitude or by country code. This API uses the same data as <https://www.electricitymap.org> Not all countries/regions in the world are supported so please consult this website to check local availability.
This platform requires a CO2Signal API key, which can be obtained [here](https://www.co2signal.com/). Note that this API key is for personal use only and other options exist when the data is used commercially.
At the moment, the free CO2Signal API only supports the average carbon intensity of a country and not the marginal carbon intensity.
<div class='note warning'>
The "free" API key is limited to a limited number of calls. Too many requests can result in data loss.
</div>
The `co2signal` sensor platform queries the [CO2Signal](https://www.co2signal.com/) API for the CO2 intensity of a specific region. Data can be collected for your home, a specific latitude/longitude or by country code. This API uses the same data as <https://www.electricitymap.org>. Not all countries/regions in the world are supported so please consult this website to check local availability.
## Prerequisites
To configure and use this integration, you need to obtain an [API key from CO2Signal](https://www.co2signal.com/).
To configure and use this integration, you need to obtain a [free API key from CO2Signal](https://www.co2signal.com/).
{% include integrations/config_flow.md %}
## Sensor Types
When configured, the platform will create one sensor for each configured location.
When configured, the platform will create two sensors for each configured location: the carbon intensity expressed in `gCO2eq/kWh` and a percentage how much the grid relies on fossil fuels for production.