https://github.com/notcoffee418/european_smart_meter
Consumable API for the Belgian and Netherlands smart meter P1 port for Raspberry Pi
https://github.com/notcoffee418/european_smart_meter
Last synced: 12 months ago
JSON representation
Consumable API for the Belgian and Netherlands smart meter P1 port for Raspberry Pi
- Host: GitHub
- URL: https://github.com/notcoffee418/european_smart_meter
- Owner: NotCoffee418
- License: mit
- Created: 2025-05-30T10:29:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-05T09:24:55.000Z (about 1 year ago)
- Last Synced: 2025-06-17T01:44:23.993Z (about 1 year ago)
- Language: Go
- Size: 72.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Smart Meter API
Modular services to interact with the European smart meter designed to run on a Raspberry Pi.
- Interpreter API: Read the meter and provides the values as an API.
- Meter Collector: Get data from Interpreter API and store it in the database.
This was designed for Belgian meters but should work for other countries as well.
## Requirements
- Raspberry Pi 3+ (or other Linux machine)
- [P1 Smart Meter Cable](https://webshop.cedel.nl/nl/Slimme-meter-kabel-P1-naar-USB)
- [Activated P1 port on your smart meter](https://www.stroohm.be/en/help/using-and-accessing-the-p1-port-of-the-digital-meter-in-belgium/)
## Installation
1. [Set up Raspberry Pi](https://www.raspberrypi.com/documentation/computers/getting-started.html)
2. Connect the cable to the P1 port on the meter and a USB port on the Raspberry Pi
3. SSH into the Raspberry Pi or open a terminal on the Raspberry Pi
4. Disable Pi Desktop (optional, but recommended on older Pi's)
When running additional smart meter related software on the Pi, it may cause memory issues if we don't.
```bash
sudo raspi-config
# System Options → Boot / Auto Login → Console
# Exit and reboot
```
5. Install Interpreter API
```bash
# Install or update the Interpreter API
sudo curl -sSL https://raw.githubusercontent.com/NotCoffee418/european_smart_meter/main/installers/install_interpreter.sh | sudo bash /dev/stdin
```
6. Install Meter Collector
```bash
# Install or update the Meter Collector
sudo curl -sSL https://raw.githubusercontent.com/NotCoffee418/european_smart_meter/main/installers/install_meter_collector.sh | sudo bash /dev/stdin
```
7. Set up Auto-Upgrading and install Grafana
```bash
# Install or update the Auto-Updater
sudo curl -sSL https://raw.githubusercontent.com/NotCoffee418/european_smart_meter/refs/heads/main/installers/autoupdater.sh | sudo bash /dev/stdin
```
## Updating
Run the install scripts again to update the services. Configs remain intact.
## Interpreter API
The Interpreter API reads the meter and provides the values as an API with a websocket endpoint option.
This service is essential for all other services to work and can be optionally run as a standalone application to work with custom software.
### Endpoints
- **/latest**: Get the latest data from the smart meter
- **/ws**: Subscribe to the websocket endpoint to get real-time data from the smart meter
Both output the following JSON response structure:
```json
{
"timestamp": "2025-05-30T15:52:07", // Local Time
"current_consumption_kw": 0.150, // Combined Consumption (L1+L2+L3)
"current_production_kw": 0.0,
"l1_consumption_kw": 0.150,
"l2_consumption_kw": 0.0, // L2 and L3 is for 3 phase meters (industrial)
"l3_consumption_kw": 0.0, // L2 and L3 is for 3 phase meters (industrial)
"l1_production_kw": 0.0,
"l2_production_kw": 0.0,
"l3_production_kw": 0.0,
"total_consumption_day_kwh": 9999.999,
"total_consumption_night_kwh": 9999.99,
"total_production_day_kwh": 9999.99,
"total_production_night_kwh": 9999.99,
"current_tariff": 1, // 1=day, 2=night
"l1_voltage_v": 237.8,
"l2_voltage_v": 0.0,
"l3_voltage_v": 0.0,
"l1_current_a": 2.28,
"l2_current_a": 0.0,
"l3_current_a": 0.0,
"switch_electricity": 1, // 1=on, 0=off - Physical switch on the meter
"switch_gas": 1, // 1=on, 0=off - Physical switch on the meter
"meter_serial_electricity": "XXXXXXXXX",
"meter_serial_gas": "XXXXXXXXX",
"gas_consumption_m3": 9999.99 // Updated every 10 minutes
}
```
## Uninstallation
```bash
# Interpreter API (everything else depends on this)
curl -sSL https://raw.githubusercontent.com/NotCoffee418/european_smart_meter/main/installers/uninstall_interpreter.sh | sudo bash /dev/stdin
# Meter Collector
curl -sSL https://raw.githubusercontent.com/NotCoffee418/european_smart_meter/main/installers/uninstall_meter_collector.sh | sudo bash /dev/stdin
```
## Troubleshooting
### Device not found
If you have multiple USB ports, you need to check which one is the P1 port and adjust it in the docker-compose.yml file if it's not /dev/ttyUSB0.
```bash
# List all USB devices
ls /dev/ttyUSB*
```
### No data received
It may be that you have submitted the request to activate the P1 port but it's not activated yet.
You can check if you're receiving data by running the following command:
```bash
python3 -m serial.tools.miniterm /dev/ttyUSB0 115200 --xonxoff
```
## Unsorted info (todo)
### Paths
- /etc/european_smart_meter/interpreter_api.toml
- /etc/european_smart_meter/meter_collector.toml
- /var/lib/european_smart_meter/esm-meter.db
- /usr/bin/european_smart_meter/interpreter_api
- /usr/bin/european_smart_meter/meter_collector