Skip to main content

See the current co2 emissions per kWh of electricity in the Netherlands

Project description

CO2 monitor

This projects monitors the current CO₂ emissions per kWh of electricity being generated in the Netherlands. It obtains the data from ned.nl, and gets updated every 15 minutes. It has three modes:

$ co2monitor --help

Usage: co2monitor [OPTIONS] COMMAND [ARGS]...

  Shows the current CO2 emissions per kWh of electricity in the Netherlands.

Options:
  --debug / --no-debug
  --api-key TEXT        Override API_KEY environment variable.
  --api-url TEXT        [default: https://api.ned.nl/v1]
  --user-agent TEXT     Override USER_AGENT environment varaible.
  --polltime INTEGER    [default: 60]
  --version             Show the version and exit.
  -h, --help            Show this message and exit.

Commands:
  cli     Print emissions to the commandline.
  screen  Show emissions on an EPD screen connected via GPIO.
  tray    Add a system tray icon with emissions.

cli

This mode polls the API once per minute and outputs it in the current format:

2024-11-29 19:30: 310.45g CO2/kWh

tray

This creates a system tray icon showing the CO₂ emissions rounded to the nearest natural number, shown here below the tooltip:

img

On hover it shows more details, and on click it opens https://co2monitor.nl

screen

This mode shows the current emisions a small EPD screen connected to some GPIO pins of the Raspberry Pi. It assumes that we are running on a Raspberry Pi, and fails otherwise.

See here a photo of how it looks on my 2.9 inch screen:

img

It uses the current locale (specifically, LC_TIME) to determine how the date looks. See Pins for an overview of what pins need to be connected to the screen.

Installation

I show pip commands here. However, pip isn’t ideal for this: use pipx or, as I do, uv (uv tool install co2monitor[tray], for example).

$ pip install co2monitor

Is sufficient for the cli mode. The other modes require rather large libraries and are therefore excluded from the base package. Install the dependencies required for the tray mode (Qt) with

$ pip install co2monitor[tray]

And, shockingly,

$ pip install co2monitor[screen]

For the screen mode. This installs pillow, RPi.GPIO and spidev.

Development

See the Makefile for some handy dev commands. I use uv to manage my dependencies, but it does not really matter all that much.

pyproject.toml has an Entry Point, which means that it installs a binary called co2monitor in the virtual environment. If you have the virtual environment activated, you can run co2monitor. For uv, you can execute uv run co2monitor to run the project.

Pins

https://pinout.xyz/

Screen

Product

Name Function Color Pin number GPIO
VCC Power Grey 1 -
GND Ground Brown 6 -
DIN SPI MOSI Blue 19 10 (SPI0 MOSI)
CLK SPI Clock Yellow 23 11 (SPI0 SCLK)
CS SPI chip selection Orange 24 8 (SPI0 CE0)
DC Data/Command selection Green 22 25
RST Reset White 11 17
BUSY Busy status output Purple 18 24

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

co2monitor-2.2.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

co2monitor-2.2-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file co2monitor-2.2.tar.gz.

File metadata

  • Download URL: co2monitor-2.2.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for co2monitor-2.2.tar.gz
Algorithm Hash digest
SHA256 14ec2751ed9ca941d3ae33b46ea2d7d9a27c15ee12b644b6213702a23fb7d52c
MD5 dad5c746b980e5d637ba81377ef7f6c1
BLAKE2b-256 d8cbbcfb8fc842ee9948d4446a7786efd202af26e452086f64b00e17d17b4797

See more details on using hashes here.

File details

Details for the file co2monitor-2.2-py3-none-any.whl.

File metadata

  • Download URL: co2monitor-2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for co2monitor-2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e2c23d07ebf7fd861faef3c59bf582f3374b13a8b46990a3ab70dd5545360742
MD5 7ad40828d02580faf1a88b79acd492c4
BLAKE2b-256 de9d563771ff57f30c9d8e7b1cd2289c7551b22f0887b632e8341e7bb9198c11

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page