Compare commits

...

64 commits
v0.0.5 ... main

Author SHA1 Message Date
50d89748f7
go mod tidy
All checks were successful
Build Docker image / build (push) Successful in 3m8s
Build Golang packages / release (push) Has been skipped
2024-09-14 18:16:13 +02:00
dc6f41eeb0
Update go dependencies. 2024-09-14 18:15:52 +02:00
0052a9848b
go mod tidy
All checks were successful
Build Docker image / build (push) Successful in 2m16s
Build Golang packages / release (push) Has been skipped
2024-08-14 23:18:54 +02:00
626b7f9993
Update Go 1.22 -> 1.23
All checks were successful
Build Docker image / build (push) Successful in 2m17s
Build Golang packages / release (push) Has been skipped
2024-08-14 19:34:59 +02:00
ed1b6d69ec
Go dependency upgrades
All checks were successful
Build Docker image / build (push) Successful in 3m44s
Build Golang packages / release (push) Has been skipped
2024-08-10 23:42:38 +02:00
c8b8211e3a
Add documentation for ARG TARGET* 2024-08-10 09:54:57 +02:00
ce336b4f85
Make go build TARGETOS configurable.
All checks were successful
Build Docker image / build (push) Successful in 2m16s
Build Golang packages / release (push) Successful in 2m1s
2024-08-08 11:19:01 +02:00
b8ea94bb61
Add TARGETOS and TARGETARCH to fix multi-platform compilation issue.
Some checks failed
Build Golang packages / release (push) Waiting to run
Build Docker image / build (push) Has been cancelled
2024-08-08 11:18:26 +02:00
014a5e85a2
Fix to take into account user-defined timezone for insertEvents. Add multi OpenDTU TODO. 2024-08-07 18:55:26 +02:00
32bebfdca2
Add default admin user to OPENDTU_USERNAME
All checks were successful
Build Docker image / build (push) Successful in 1m12s
Build Golang packages / release (push) Successful in 2m16s
2024-07-27 00:43:29 +02:00
3556e401bc
Add configurable LOG_LEVEL env vars.
Some checks failed
Build Golang packages / release (push) Waiting to run
Build Docker image / build (push) Has been cancelled
2024-07-27 00:42:51 +02:00
b63c1e85d3
Add DEBUG log_level.
All checks were successful
Build Docker image / build (push) Successful in 1m35s
Build Golang packages / release (push) Successful in 2m4s
2024-07-27 00:08:40 +02:00
48d0382b0e
BREAKING: Migrate REMOTE_URL to OPENDTU_ADDRESS.
All checks were successful
Build Docker image / build (push) Successful in 1m12s
Build Golang packages / release (push) Successful in 2m4s
BREAKING: Migrate opendtu to opendtu_address
Add authentication capability for locked-down opendtu's.
Updated setup examples with new variables.
2024-07-26 23:46:19 +02:00
bf885fb84c
Change default version in compose examples from main to latest.
All checks were successful
Build Docker image / build (push) Successful in 1m5s
Build Golang packages / release (push) Successful in 2m6s
2024-07-26 22:42:31 +02:00
a7576cd0c0
Add health check TODO.
All checks were successful
Build Docker image / build (push) Successful in 1m4s
Build Golang packages / release (push) Has been skipped
2024-07-26 22:37:29 +02:00
9a0fb6ad1c
Remove completed DB migration TODO. 2024-07-26 22:36:50 +02:00
444e5065a4
Implement proper DB migrations using Goose. Upgrade go packages.
All checks were successful
Build Docker image / build (push) Successful in 1m8s
Build Golang packages / release (push) Has been skipped
2024-07-26 22:35:30 +02:00
6902facab6
Bugfix: Migrate insertLiveData and queryEventsEndpoint to new config struct.
All checks were successful
Build Docker image / build (push) Successful in 1m14s
Build Golang packages / release (push) Successful in 1m56s
2024-07-26 11:00:41 +02:00
d7262164f6
loadConfig should not be exported.
All checks were successful
Build Docker image / build (push) Successful in 1m10s
Build Golang packages / release (push) Has been skipped
2024-07-25 22:46:34 +02:00
79ea7706e1
Merge branch 'main' of git.hollander.online:energy/opendtu-logger
All checks were successful
Build Docker image / build (push) Successful in 1m13s
Build Golang packages / release (push) Successful in 2m2s
2024-07-25 21:04:50 +02:00
c73983d6cd
Add startup message. 2024-07-25 21:04:22 +02:00
bbc4ea0766 Add Home Assistant installation pointers
All checks were successful
Build Docker image / build (push) Successful in 1m11s
Build Golang packages / release (push) Has been skipped
2024-07-25 20:00:38 +02:00
2d843ceb3f
Handle TimescaleDBEnabled as bool.
All checks were successful
Build Docker image / build (push) Successful in 1m6s
Build Golang packages / release (push) Successful in 1m58s
2024-07-25 19:26:36 +02:00
5282a22879
Fix: change Config.TimescaleDBEnabled to bool.
Some checks failed
Build Docker image / build (push) Failing after 1m0s
Build Golang packages / release (push) Has been skipped
2024-07-25 19:21:04 +02:00
6230869120
Add capability to read from options.json to provide Home Assistant support.
All checks were successful
Build Docker image / build (push) Successful in 1m23s
Build Golang packages / release (push) Has been skipped
2024-07-25 19:15:11 +02:00
2f3e8ad1d6
Document Event logging limitations for inverters with battery systems on PV input side.
All checks were successful
Build Docker image / build (push) Successful in 1m19s
Build Golang packages / release (push) Successful in 2m6s
2024-07-25 11:13:49 +02:00
77a59f814b
Comment out debugging code. 2024-07-25 11:07:10 +02:00
1dbea69f52
Preparations for adding event timestamps.
All checks were successful
Build Docker image / build (push) Successful in 1m13s
Build Golang packages / release (push) Has been skipped
2024-07-01 14:39:19 +02:00
6c810b4e2b
Don't include compiled binaries. 2024-07-01 14:38:30 +02:00
0e491612dd
Add data_age=0 as events requirement.
All checks were successful
Build Docker image / build (push) Successful in 1m36s
Build Golang packages / release (push) Has been skipped
2024-07-01 14:12:40 +02:00
40c81c0bb3
Add better message about purpose and features of OpenDTU logger.
All checks were successful
Build Docker image / build (push) Successful in 2m32s
Build Golang packages / release (push) Has been skipped
2024-06-12 11:13:06 +02:00
8a30678c1d
Add OpenDTU discussion topic link.
All checks were successful
Build Docker image / build (push) Successful in 1m6s
Build Golang packages / release (push) Has been skipped
2024-04-09 13:28:10 +02:00
ffa8ef0746
Add light mode hint.
All checks were successful
Build Docker image / build (push) Successful in 59s
Build Golang packages / release (push) Has been skipped
2024-04-08 22:57:03 +02:00
673d32efd7
Add tooltip hint.
Some checks failed
Build Golang packages / release (push) Waiting to run
Build Docker image / build (push) Has been cancelled
2024-04-08 22:56:37 +02:00
9293e00652
Typo fix.
All checks were successful
Build Docker image / build (push) Successful in 54s
Build Golang packages / release (push) Has been skipped
2024-04-08 22:33:53 +02:00
8e94211cd6
Add PV dashboard screenshot note.
All checks were successful
Build Docker image / build (push) Successful in 55s
Build Golang packages / release (push) Has been skipped
2024-04-08 22:32:00 +02:00
4b895b97a8
Fix README screenshot.
All checks were successful
Build Docker image / build (push) Successful in 58s
Build Golang packages / release (push) Has been skipped
2024-04-08 22:30:34 +02:00
87382e2486
Add screenshot to README.md.
All checks were successful
Build Docker image / build (push) Successful in 1m2s
Build Golang packages / release (push) Has been skipped
2024-04-08 22:28:53 +02:00
a3debb7866
Add PV screenshot dark mode.
Some checks failed
Build Golang packages / release (push) Waiting to run
Build Docker image / build (push) Has been cancelled
2024-04-08 22:25:52 +02:00
7fc988501b
Improve feedback paragraph.
All checks were successful
Build Docker image / build (push) Successful in 1m21s
Build Golang packages / release (push) Has been skipped
2024-04-03 22:48:54 +02:00
0cf4661f46
Add feedback note.
All checks were successful
Build Docker image / build (push) Successful in 1m27s
Build Golang packages / release (push) Has been skipped
2024-04-03 22:44:35 +02:00
69b488acc8
Small clarification of events versus inverter data.
All checks were successful
Build Docker image / build (push) Successful in 1m14s
Build Golang packages / release (push) Successful in 2m8s
2024-03-28 14:33:33 +01:00
fb756e943d
Add Grafana comment to intro. 2024-03-28 14:33:11 +01:00
083a2f2667
more documentation work.
All checks were successful
Build Docker image / build (push) Successful in 1m16s
Build Golang packages / release (push) Has been skipped
2024-03-27 23:13:28 +01:00
04b60a3b2c
.env clarification
All checks were successful
Build Docker image / build (push) Successful in 1m33s
Build Golang packages / release (push) Has been skipped
2024-03-27 23:10:35 +01:00
49f3396c10
Add elaborate Docker Compose instructions.
All checks were successful
Build Docker image / build (push) Successful in 1m28s
Build Golang packages / release (push) Has been skipped
2024-03-27 18:37:10 +01:00
7b9f964950
change DB name 2024-03-27 18:23:48 +01:00
9241a1ed9d
Improve example.env 2024-03-27 18:17:11 +01:00
3a421b1344
Change timescaleDB bind mount to docker volume for easier deployment.
All checks were successful
Build Docker image / build (push) Successful in 1m36s
Build Golang packages / release (push) Has been skipped
2024-03-27 18:13:23 +01:00
17e1f54ab2
Improve auto restart limitation explanation. 2024-03-27 10:22:51 +01:00
a3079d1ac4
Change wording of restart limitations for websocket disconnections.
All checks were successful
Build Docker image / build (push) Successful in 1m11s
Build Golang packages / release (push) Has been skipped
2024-03-27 10:21:08 +01:00
1c399f373a
Add 'restart: always' to Compose examples. 2024-03-27 10:19:09 +01:00
b1f8319824
Add riscv64 support.
All checks were successful
Build Docker image / build (push) Successful in 1m16s
Build Golang packages / release (push) Has been skipped
2024-03-27 10:12:10 +01:00
40a904f458
Add 32-bit ARM support. 2024-03-27 10:10:54 +01:00
e7ea317425
Add support for 32-bit Linux i386. 2024-03-27 10:05:25 +01:00
357f48b4ae
Add support for mips64 (e.g. some routers with OpenWRT). 2024-03-27 10:03:01 +01:00
b0f537feb9
Add support for 32-bit x86. 2024-03-27 10:02:15 +01:00
6dc084504d
Add support for Raspberry Pi 1 / Raspberry Pi Zero. 2024-03-27 10:01:49 +01:00
a6ea7705ae
Add support for Raspberry Pi 2 and up 2024-03-27 10:01:24 +01:00
464e19727a
Add support for linux/riscv64 2024-03-27 09:56:18 +01:00
dfb5721e25
Improve install instructions.
All checks were successful
Build Docker image / build (push) Successful in 1m17s
Build Golang packages / release (push) Has been skipped
2024-03-27 09:50:37 +01:00
d88d3fdef6
Add Grafana Docker Compose example. 2024-03-27 09:50:18 +01:00
2ff5a0e04a
typo fix
All checks were successful
Build Docker image / build (push) Successful in 1m10s
Build Golang packages / release (push) Has been skipped
2024-03-25 20:04:49 +01:00
f32072e997
Add systemd configuration. 2024-03-25 10:59:36 +01:00
24 changed files with 753 additions and 154 deletions

View file

@ -51,6 +51,6 @@ jobs:
push: ${{ gitea.event_name != 'pull_request' }} push: ${{ gitea.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}
platforms: linux/arm64,linux/amd64 platforms: linux/arm64, linux/amd64, linux/riscv64, linux/arm/v7, linux/arm/v6, linux/386, linux/mips64
- name: Cleanup old images - name: Cleanup old images
run: docker system prune -f run: docker system prune -f

View file

@ -23,12 +23,20 @@ jobs:
cache: false cache: false
- name: release-build-linux-amd64 - name: release-build-linux-amd64
run: GOOS=linux GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-amd64 run: GOOS=linux GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-amd64
- name: release-build-linux-386
run: GOOS=linux GOARCH=386 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-386
- name: release-build-linux-arm64 - name: release-build-linux-arm64
run: GOOS=linux GOARCH=arm64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-arm64 run: GOOS=linux GOARCH=arm64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-arm64
- name: release-build-linux-arm
run: GOOS=linux GOARCH=arm go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-arm
- name: release-build-linux-riscv64
run: GOOS=linux GOARCH=riscv64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-linux-riscv64
- name: release-build-windows-amd64 - name: release-build-windows-amd64
run: GOOS=windows GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-windows-amd64.exe run: GOOS=windows GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-windows-amd64.exe
- name: release-build-windows-arm64 - name: release-build-windows-arm64
run: GOOS=windows GOARCH=arm64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-windows-arm64.exe run: GOOS=windows GOARCH=arm64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-windows-arm64.exe
- name: release-build-darwin-amd64 - name: release-build-darwin-amd64
run: GOOS=darwin GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-darwin-amd64 run: GOOS=darwin GOARCH=amd64 go build -v -ldflags="-s -w -X 'main.Version=${{ github.ref_name }}'" -o bin/opendtu-logger-${{ github.ref_name }}-darwin-amd64
- name: release-build-darwin-arm64 - name: release-build-darwin-arm64

3
.gitignore vendored
View file

@ -71,4 +71,5 @@ go.work
docs docs
# Don't include compiled binary # Don't include compiled binary
main main
opendtu-logger

View file

@ -1,5 +1,5 @@
# Use buildx for multi-architecture support # Use buildx for multi-architecture support
FROM --platform=${BUILDPLATFORM} golang:1.22 AS builder FROM --platform=${BUILDPLATFORM} golang:1.23 AS builder
WORKDIR /app WORKDIR /app
@ -11,7 +11,10 @@ RUN go mod download
COPY . . COPY . .
# Build the application for the specified target architecture # Build the application for the specified target architecture
RUN CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build -o opendtu-logger . # https://www.docker.com/blog/faster-multi-platform-builds-dockerfile-cross-compilation-guide/
# Declare TARGETOS and TARGETARCH in the local scope so they can be used in the build stage.
ARG TARGETOS TARGETARCH
RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -o opendtu-logger .
# Create a minimal runtime image # Create a minimal runtime image
FROM --platform=${TARGETPLATFORM} scratch FROM --platform=${TARGETPLATFORM} scratch

151
README.md
View file

@ -1,31 +1,145 @@
# OpenDTU logger # OpenDTU logger
OpenDTU logger connects to the OpenDTU livedata websocket and captures metrics. OpenDTU logger adds detailed, long-term storage and visualisation of Hoymiles solar inverter metrics monitored with OpenDTU:
These metrics are inserted into a PostgreSQL database.
Optionally, TimescaleDB can be used.
## Install instructions - It connects to the OpenDTU livedata websocket and captures metrics.
- These metrics are inserted into a PostgreSQL database. Optionally, TimescaleDB can be used.
- Included in OpenDTU Logger are a number of Grafana dashboards, which can be used to provide useful visualisations and insights.
- The image below shows the PV dashboard of a given day in dark mode. Light mode is also supported. Hovering over the graphs will result in a tooltip, providing the exact values recorded at a given time.
### Docker ![PV dashboard in dark mode](https://git.hollander.online/energy/opendtu-logger/raw/commit/a3debb78665641fe7101555d85df89eb0f0d2a79/screenshots/PV-overview-dark-mode.png)
## OpenDTU logger installation instructions
OpenDTU logger can be installed in different ways:
1. Using the [Home Assistant add-on repository](https://git.hollander.online/energy/home-assistant-addons).
2. Using [Docker Compose](#docker-compose)
3. Using the binary available on the [releases page](https://git.hollander.online/energy/opendtu-logger/releases)
4. Compiling the code yourself.
Using the Home Assistant add-on or Docker Compose is the preferred way to install OpenDTU Logger.
Installation on Home Assistant can be done by adding the [Home Assistant add-on repository](https://git.hollander.online/energy/home-assistant-addons) to the Home Assistant add-on store and following the instructions provided. Other installation methods are described below.
### Configuring OpenDTU
In order for OpenDTU Logger to work properly, it is required to ensure the following OpenDTU settings are used.
- Within OpenDTU, go to `Settings` -> `Inverter settings` (<http://YOUR_OPENDTU_IP_ADDRESS/settings/inverter>).
- For each inverter in the inverter list, click on the pencil (Edit inverter) and go to `Advanced`.
- Enable `Zero daily yield at midnight` and `Clear Eventlog at midnight`.
- Click `Save`
- Repeat this procedure for every inverter.
### Docker Compose
The `docker` folder in this [repository](https://git.hollander.online/energy/opendtu-logger) contains example Docker compose files. The `compose.with-database-grafana.yml` file contains a full setup suitable for a standalone deployment. The other compose files are aimed at integration into existing environments.
To use the standalone deployment, take the following steps
Enter the `docker` folder
```sh ```sh
docker pull git.hollander.online/energy/opendtu-logger:0.0 cd docker
``` ```
Preferably, run the Docker image using the Docker compose examples provided in the `./docker` folder. Copy `example.with-database.env` to `.env`. E.g.:
```sh
cp example.with-database.env .env
```
In the `.env` file:
- Edit the `REMOTE_URL` to point to your OpenDTU.
- In `DB_URL` alter the `password` field. Set the same value in. `PG_PASSWORD`
Deploy the Docker containers by running the following command from the `docker` folder.
```sh
docker compose -f compose.with-database-grafana.yml up
```
Docker should now start downloading the required containers and bring up OpenDTU Logger, TimescaleDB and Grafana. If everything seems ok, press `CTRL + C` to stop the containers. Next, execute
```sh
docker compose -f compose.with-database-grafana.yml up -d
```
The `-d` flag ensures that the containers are started in the background, so you can safely close your terminal window. If desired, containers running in the background can be stopped by running compose again with the `down` command.
```sh
docker compose -f compose.with-database-grafana.yml down
```
#### Setting up Grafana
After deploying OpenDTU Logger with Docker Compose, Grafana should be available at <http://localhost:3000>.
The initial login username and password are `admin:admin`. After the initial login, Grafana will request you to change the password to something more secure.
##### Configuring the OpenDTU Logger data source
After logging in, go to `Connections` -> `Data sources` -> `Add new data source`.
- Under `SQL` select `PostgreSQL`.
- Change the following fields
- `Host URL`: `timescaledb:5432`
- `Database name`: `opendtu_logger`
- `Username`: `postgres`
- `Password`: The password you set in the `.env.` file in the previous step.
- `TLS/SSL Mode`: `disable`
- `TimescaleDB`: set the slider to `enable`
- Click `Save and test`
- You should get a green box with a `Database Connection OK` message.
##### Adding the OpenDTU Logger dashboards
Now that the data source has been configured, we can add our dashboards.
- Go to `Dashboards` -> `New` -> `Import`.
- Upload `PV.json` from the `grafana` folder in this [repository](https://git.hollander.online/energy/opendtu-logger)
- After uploading, Grafana requests you to configure a data source. Select the data source configured in the previous step. Click `Import`. The dashboard should now be ready.
- If you want more dashboards, import the other dashboards from the `grafana` folder as well, or create your own.
### Binary ### Binary
Go to the [releases page](https://git.hollander.online/energy/opendtu-logger/releases) and download the most recent stable release. Go to the [releases page](https://git.hollander.online/energy/opendtu-logger/releases) and download the most recent stable release.
#### Running example #### Running the binary as local user
```sh ```sh
REMOTE_URL="opendtu:80" DB_URL="host=localhost port=5432 user=postgres password=secret dbname=dtu sslmode=disable" TIMESCALEDB_ENABLED="true" TZ="Europe/Amsterdam" ./opendtu-logger REMOTE_URL="opendtu:80" DB_URL="host=localhost port=5432 user=postgres password=secret dbname=dtu sslmode=disable" TIMESCALEDB_ENABLED="true" TZ="Europe/Amsterdam" ./opendtu-logger
``` ```
#### Creating a more permanent setup on Linux using systemd
```sh
sudo adduser --system --group --disabled-login --home /opt/opendtu-logger opendtu-logger
sudo mkdir /opt/opendtu-logger
sudo mkdir /opt/opendtu-logger/data
sudo mv ./opendtu-logger /opt/opendtu-logger/
sudo chown -R opendtu-logger:opendtu-logger /opt/opendtu-logger
```
```sh
sudo nano /etc/systemd/system/opendtu-logger.service
```
Add the contents of `systemd/opendtu-logger.service` and alter the `REMOTE_URL` and `DB_URL` environment variables to match your setup.
### PostgreSQL setup ### PostgreSQL setup
To install PostgreSQL on Debian / Ubuntu run
```sh
sudo apt install postgresql
```
The OpenDTU logger logs to a PostgreSQL database and optionally supports TimescaleDB. Create a separate database and user using the following commands. The OpenDTU logger logs to a PostgreSQL database and optionally supports TimescaleDB. Create a separate database and user using the following commands.
```sql ```sql
@ -35,7 +149,7 @@ GRANT ALL privileges ON DATABASE opendtu_logger TO opendtu_logger;
GRANT ALL ON SCHEMA public TO opendtu_logger; GRANT ALL ON SCHEMA public TO opendtu_logger;
``` ```
Optional: enable TimescaleDB extension Optional: enable the TimescaleDB extension. To make use of TimescaleDB, follow the steps outlined in [their documentation](https://docs.timescale.com/self-hosted/latest/install/installation-linux/). Then, enable TimescaleDB support for the `opendtu_logger` database by executing the following commands
```sql ```sql
\c opendtu_logger \c opendtu_logger
@ -53,15 +167,24 @@ TIMESCALEDB_ENABLED="true"
TZ="Europe/Amsterdam" TZ="Europe/Amsterdam"
``` ```
## Grafana - `REMOTE_URL`is used to specify the IP address or hostname OpenDTU is running on. E.g.: `192.168.1.6` or `opendtu.internal`
- `DB_URL` specifies the credentials required to connect to the PostgreSQL database. All [connection parameters documented by golang's `lib/pq` package](https://pkg.go.dev/github.com/lib/pq#hdr-Connection_String_Parameters) can be used.
- `TIMESCALEDB_ENABLED` should be set to `true` or `false`.
- `TZ` is used to ensure data is recorded with the right timestamp. Choose the timezone valid for your location from [this Wikipedia page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
The `grafana` folder contains example dashboards. ## Grafana dashboards
The `grafana` folder contains example dashboards which can be imported into existing Grafana installs, or into the provided Docker Compose with Grafana setup.
- The `opendtu_` dashboards contain visualisations for each table the OpenDTU logger records to. - The `opendtu_` dashboards contain visualisations for each table the OpenDTU logger records to.
- `PV.json` is a dashboard which combines the visualisations of each table that I found to be most useful. - `PV.json` is a dashboard which combines the visualisations of each table that I found to be most useful.
- `Zonnepanelen.json` is the same as `PV.json`, but in Dutch language. - `Zonnepanelen.json` is the same as `PV.json`, but in Dutch language.
## Known issues ## Known limitations
- The logger will currently log every event posted by OpenDTU to the websocket. Checks still need to be added to determine the uniqueness of an event. For more information, see also [this OpenDTU Github issue](https://github.com/tbnobody/OpenDTU/issues/1800). - The logger currently assumes that events reported by OpenDTU occurred on the current day. This works for the majority of users, as the inverters reset every night when the sun goes down and OpenDTU is configured to forget old events data at midnight. For micro inverters with battery storage added to the PV input side, such as Zendure or Anker Solix, checks still need to be added to account for the fact that these inverters don't necessarily reset every night. Event recording will work, but entries might be recorded multiple times. For more information, see also [this OpenDTU Github issue](https://github.com/tbnobody/OpenDTU/issues/1800).
- Upon restart of the OpenDTU, OpenDTU Logger will need to be restarted manually as well. Automatic reconnection logic is a work in progress. - Upon restart of the OpenDTU, the OpenDTU Logger binary needs to be restarted as well. When using the provided `compose.yml` files with Docker, or using the `systemd` service file when using the binary, this happens automatically.
## Feedback
If you'd like to provide feedback about this project, or in case you'd like to ask questions, please refer to [this page](https://pieterhollander.nl/author/pieter-hollander/) for contact information (e-mail, Github or LinkedIn), or use the [contact form](https://pieterhollander.nl/#contact) on my website. You can also respond by placing your remarks in [this discussion on Github](https://github.com/tbnobody/OpenDTU/discussions/1842).

View file

@ -0,0 +1,69 @@
version: '3.8'
services:
timescaledb:
image: timescale/timescaledb:latest-pg16
restart: always
environment:
POSTGRES_USER: ${PG_USER}
POSTGRES_PASSWORD: ${PG_PASSWORD}
POSTGRES_DB: ${PG_DB}
ports:
- "5432:5432"
networks:
- internal
volumes:
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
- opendtu_db:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${PG_USER}"]
interval: 5s
timeout: 5s
retries: 20
opendtu-logger:
image: git.hollander.online/energy/opendtu-logger:latest
restart: always
environment:
DB_URL: ${DB_URL}
OPENDTU_ADDRESS: ${OPENDTU_ADDRESS}
OPENDTU_AUTH: ${OPENDTU_AUTH}
OPENDTU_USERNAME: ${OPENDTU_USERNAME}
OPENDTU_PASSWORD: ${OPENDTU_PASSWORD}
TIMESCALEDB_ENABLED: ${TIMESCALEDB_ENABLED}
TZ: ${TZ}
LOG_LEVEL: ${LOG_LEVEL}
depends_on:
timescaledb:
condition: service_healthy
networks:
- internal
volumes:
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
grafana:
image: grafana/grafana:latest
container_name: grafana
restart: always
user: "1000:1000"
ports:
- "3000:3000"
networks:
- internal
volumes:
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
- opendtu_logger_grafana:/var/lib/grafana:rw
environment:
GF_DATAPROXY_ROW_LIMIT: 5000000
# GF_LOG_FILTERS: rendering:debug
healthcheck:
test: ["CMD-SHELL", "curl -f localhost:3000/api/health && echo 'ready'"]
interval: 10s
retries: 30
networks:
internal:
attachable: true
volumes:
opendtu_logger_grafana:
opendtu_db:

View file

@ -1,6 +1,7 @@
version: '3.8' version: '3.8'
services: services:
timescaledb: timescaledb:
restart: always
image: timescale/timescaledb:latest-pg16 image: timescale/timescaledb:latest-pg16
environment: environment:
POSTGRES_USER: ${PG_USER} POSTGRES_USER: ${PG_USER}
@ -21,12 +22,18 @@ services:
retries: 20 retries: 20
opendtu-logger: opendtu-logger:
image: git.hollander.online/energy/opendtu-logger:main restart: always
image: git.hollander.online/energy/opendtu-logger:latest
environment: environment:
DB_URL: ${DB_URL} DB_URL: ${DB_URL}
REMOTE_URL: ${REMOTE_URL} OPENDTU_ADDRESS: ${OPENDTU_ADDRESS}
OPENDTU_AUTH: ${OPENDTU_AUTH}
OPENDTU_USERNAME: ${OPENDTU_USERNAME}
OPENDTU_PASSWORD: ${OPENDTU_PASSWORD}
TIMESCALEDB_ENABLED: ${TIMESCALEDB_ENABLED} TIMESCALEDB_ENABLED: ${TIMESCALEDB_ENABLED}
TZ: ${TZ} TZ: ${TZ}
LOG_LEVEL: ${LOG_LEVEL}
depends_on: depends_on:
timescaledb: timescaledb:
condition: service_healthy condition: service_healthy

View file

@ -1,12 +1,17 @@
version: '3.8' version: '3.8'
services: services:
opendtu-logger: opendtu-logger:
image: git.hollander.online/energy/opendtu-logger:main restart: always
image: git.hollander.online/energy/opendtu-logger:latest
environment: environment:
DB_URL: ${DB_URL} DB_URL: ${DB_URL}
REMOTE_URL: ${REMOTE_URL} OPENDTU_ADDRESS: ${OPENDTU_ADDRESS}
OPENDTU_AUTH: ${OPENDTU_AUTH}
OPENDTU_USERNAME: ${OPENDTU_USERNAME}
OPENDTU_PASSWORD: ${OPENDTU_PASSWORD}
TIMESCALEDB_ENABLED: ${TIMESCALEDB_ENABLED} TIMESCALEDB_ENABLED: ${TIMESCALEDB_ENABLED}
TZ: ${TZ} TZ: ${TZ}
LOG_LEVEL: ${LOG_LEVEL}
depends_on: depends_on:
timescaledb: timescaledb:
condition: service_healthy condition: service_healthy

11
docker/example.env Normal file
View file

@ -0,0 +1,11 @@
# OpenDTU
OPENDTU_ADDRESS="192.168.1.89:80"
OPENDTU_AUTH=false
OPENDTU_USERNAME=admin
OPENDTU_PASSWORD=
# OpenDTU Logger
DB_URL="host=timescaledb port=5432 user=postgres password=secret dbname=opendtu_logger sslmode=disable"
TIMESCALEDB_ENABLED=true
TZ="Europe/Amsterdam"
LOG_LEVEL=INFO"

View file

@ -1,7 +1,16 @@
REMOTE_URL="opendtu:80" # OpenDTU
DB_URL="host=timescaledb port=5432 user=postgres password=secret dbname=dtu sslmode=disable" OPENDTU_ADDRESS="192.168.1.89:80"
OPENDTU_AUTH=false
OPENDTU_USERNAME=admin
OPENDTU_PASSWORD=
# OpenDTU Logger
DB_URL="host=timescaledb port=5432 user=postgres password=secret dbname=opendtu_logger sslmode=disable"
TIMESCALEDB_ENABLED=true TIMESCALEDB_ENABLED=true
TZ="Europe/Amsterdam" TZ="Europe/Amsterdam"
PG_USER= LOG_LEVEL=INFO"
# Database configuration
PG_USER=postgres
PG_PASSWORD= PG_PASSWORD=
PG_DB= PG_DB=opendtu_logger

12
go.mod
View file

@ -1,10 +1,16 @@
module git.hollander.online/energy/opendtu-logger module git.hollander.online/energy/opendtu-logger
go 1.22 go 1.23
require ( require (
github.com/gorilla/websocket v1.5.1 github.com/gorilla/websocket v1.5.3
github.com/lib/pq v1.10.9 github.com/lib/pq v1.10.9
github.com/pressly/goose/v3 v3.22.0
) )
require golang.org/x/net v0.17.0 // indirect require (
github.com/mfridman/interpolate v0.0.2 // indirect
github.com/sethvargo/go-retry v0.3.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/sync v0.8.0 // indirect
)

52
go.sum
View file

@ -1,6 +1,50 @@
github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw= github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mfridman/interpolate v0.0.2 h1:pnuTK7MQIxxFz1Gr+rjSIx9u7qVjf5VOoM/u6BbAxPY=
github.com/mfridman/interpolate v0.0.2/go.mod h1:p+7uk6oE07mpE/Ik1b8EckO0O4ZXiGAfshKBWLUM9Xg=
github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/pressly/goose/v3 v3.22.0 h1:wd/7kNiPTuNAztWun7iaB98DrhulbWPrzMAaw2DEZNw=
github.com/pressly/goose/v3 v3.22.0/go.mod h1:yJM3qwSj2pp7aAaCvso096sguezamNb2OBgxCnh/EYg=
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
github.com/sethvargo/go-retry v0.3.0 h1:EEt31A35QhrcRZtrYFDTBg91cqZVnFL2navjDrah2SE=
github.com/sethvargo/go-retry v0.3.0/go.mod h1:mNX17F0C/HguQMyMyJxcnU471gOZGxCLyYaFyAZraas=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
modernc.org/gc/v3 v3.0.0-20240107210532-573471604cb6 h1:5D53IMaUuA5InSeMu9eJtlQXS2NxAhyWQvkKEgXZhHI=
modernc.org/gc/v3 v3.0.0-20240107210532-573471604cb6/go.mod h1:Qz0X07sNOR1jWYCrJMEnbW/X55x206Q7Vt4mz6/wHp4=
modernc.org/libc v1.55.3 h1:AzcW1mhlPNrRtjS5sS+eW2ISCgSOLLNyFzRh/V3Qj/U=
modernc.org/libc v1.55.3/go.mod h1:qFXepLhz+JjFThQ4kzwzOjA/y/artDeg+pcYnY+Q83w=
modernc.org/mathutil v1.6.0 h1:fRe9+AmYlaej+64JsEEhoWuAYBkOtQiMEU7n/XgfYi4=
modernc.org/mathutil v1.6.0/go.mod h1:Ui5Q9q1TR2gFm0AQRqQUaBWFLAhQpCwNcuhBOSedWPo=
modernc.org/memory v1.8.0 h1:IqGTL6eFMaDZZhEWwcREgeMXYwmW83LYW8cROZYkg+E=
modernc.org/memory v1.8.0/go.mod h1:XPZ936zp5OMKGWPqbD3JShgd/ZoQ7899TUuQqxY+peU=
modernc.org/sqlite v1.32.0 h1:6BM4uGza7bWypsw4fdLRsLxut6bHe4c58VeqjRgST8s=
modernc.org/sqlite v1.32.0/go.mod h1:UqoylwmTb9F+IqXERT8bW9zzOWN8qwAIcLdzeBZs4hA=
modernc.org/strutil v1.2.0 h1:agBi9dp1I+eOnxXeiZawM8F4LawKv4NzGWSaLfyeNZA=
modernc.org/strutil v1.2.0/go.mod h1:/mdcBmfOibveCTBxUl5B5l6W+TTH1FXPLHZE6bTosX0=
modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
modernc.org/token v1.1.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM=

352
main.go
View file

@ -1,25 +1,30 @@
// TODO: Storage optimisation: Map inverter serial to shorter serial. Use that for referring. // TODO: Storage optimisation: Map inverter serial to shorter serial. Use that for referring.
// TODO: Use username and password provided using Basic Authentication.
// TODO: Record Inverter struct data only on-change. // TODO: Record Inverter struct data only on-change.
// Idea: Make a full admin / config GUI and only configure through this utility. // Idea: Make a full admin / config GUI and only configure through this utility.
// Idea: Gather settings only on start-up. // Idea: Gather settings only on start-up.
// TODO: Only update meter readings such as yieldday, yieldtotal on-change. // TODO: Only update meter readings such as yieldday, yieldtotal on-change.
// TODO: Implement proper DB migrations. // TODO: Add a health check endpoint, potentially log to it.
// TODO: Add support for monitoring multiple OpenDTU's at once.
package main package main
import ( import (
"database/sql" "database/sql"
"encoding/base64"
"encoding/json" "encoding/json"
"fmt" "fmt"
"io/fs"
"log" "log"
"log/slog" "log/slog"
"net/http" "net/http"
"os" "os"
"strconv"
"time" "time"
_ "time/tzdata" _ "time/tzdata"
"git.hollander.online/energy/opendtu-logger/migrations"
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
_ "github.com/lib/pq" _ "github.com/lib/pq"
"github.com/pressly/goose/v3"
) )
// VUD contains three variables used for most metrics sent by OpenDTU: // VUD contains three variables used for most metrics sent by OpenDTU:
@ -103,10 +108,12 @@ type LiveData struct {
// Events struct // Events struct
type Event struct { type Event struct {
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
Message string `json:"message"` Message string `json:"message"`
StartTime int `json:"start_time"` StartTime int `json:"start_time"`
EndTime int `json:"end_time"` EndTime int `json:"end_time"`
StartTimestamp time.Time
EndTimestamp time.Time
} }
type EventsResponse struct { type EventsResponse struct {
@ -141,14 +148,138 @@ type InverterSettingsData struct {
Inverters []InverterSettings `json:"inverter"` Inverters []InverterSettings `json:"inverter"`
} }
// Config settings struct
type Config struct {
DB string `json:"db"`
OpenDTUAddress string `json:"opendtu_address"`
OpenDTUAuth bool `json:"opendtu_auth"`
OpenDTUUser string `json:"opendtu_username"`
OpenDTUPassword string `json:"opendtu_password"`
TimescaleDB bool `json:"timescaledb"`
TZ string `json:"tz"`
LogLevel string `json:"log_level"`
}
var logger = slog.New(slog.NewJSONHandler(os.Stdout, nil)) var logger = slog.New(slog.NewJSONHandler(os.Stdout, nil))
var config Config
// LoadConfig attempts to read the configuration from options.json
// If it fails, it falls back to using environment variables
func loadConfig() Config {
configFilePath := os.Getenv("CONFIG_FILE")
if configFilePath == "" {
configFilePath = "/data/options.json"
}
data, err := os.ReadFile(configFilePath)
if err == nil {
// Successfully read the file, parse the JSON
err = json.Unmarshal(data, &config)
if err != nil {
log.Fatalf("Error parsing config file: %v", err)
}
if config.DB == "" {
log.Fatal("db connection settings are not set")
}
if config.OpenDTUAddress == "" {
log.Fatal("opendtu_address is not set")
}
if config.OpenDTUAuth {
if config.OpenDTUUser == "" {
log.Fatal("opendtu_username is not set, while opendtu_auth is set to enabled. Set opendtu_auth to false or set username")
}
if config.OpenDTUPassword == "" {
log.Fatal("opendtu_password is not set, while opendtu_auth is set to enabled. Set opendtu_auth to false or set password")
}
}
} else {
logger.Info("JSON config file not found. Falling back to environment variables.")
// Fallback to environment variables
config.DB = os.Getenv("DB_URL")
if config.DB == "" {
log.Fatal("DB_URL environment variable is not set.")
}
config.OpenDTUAddress = os.Getenv("OPENDTU_ADDRESS")
if config.OpenDTUAddress == "" {
log.Fatal("OPENDTU_ADDRESS environment variable is not set.")
}
openDTUAuthStr := os.Getenv("OPENDTU_AUTH")
if openDTUAuthStr != "" {
openDTUAuth, err := strconv.ParseBool(openDTUAuthStr)
if err != nil {
log.Fatalf("Error parsing OPENDTU_AUTH: %v", err)
}
config.OpenDTUAuth = openDTUAuth
}
if config.OpenDTUAuth {
config.OpenDTUUser = os.Getenv("OPENDTU_USERNAME")
if config.OpenDTUUser == "" {
log.Fatal("OPENDTU_USERNAME environment variable is not set.")
}
config.OpenDTUPassword = os.Getenv("OPENDTU_PASSWORD")
if config.OpenDTUPassword == "" {
log.Fatal("OPENDTU_PASSWORD environment variable is not set.")
}
}
timescaleDBStr := os.Getenv("TIMESCALEDB_ENABLED")
if timescaleDBStr != "" {
timescaleDB, err := strconv.ParseBool(timescaleDBStr)
if err != nil {
log.Fatalf("Error parsing TIMESCALEDB_ENABLED: %v", err)
}
config.TimescaleDB = timescaleDB
}
config.TZ = os.Getenv("TZ")
config.LogLevel = os.Getenv("LOG_LEVEL")
}
_, err = time.LoadLocation(config.TZ)
if err != nil {
logger.Warn("invalid timezone")
}
return config
}
// Helper function to map environment variable to slog.Level
func getLogLevel(defaultLevel slog.Level) slog.Level {
logLevelStr := config.LogLevel
switch logLevelStr {
case "DEBUG":
return slog.LevelDebug
case "INFO":
return slog.LevelInfo
case "WARN":
return slog.LevelWarn
case "ERROR":
return slog.LevelError
default:
return defaultLevel
}
}
// Function to create a new logger with a specified log level
func createLoggerWithLevel(level slog.Level) *slog.Logger {
return slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
Level: level,
}))
}
// Main program // Main program
func main() { func main() {
// Initial logger setup // Initial logger setup
slog.SetDefault(logger) slog.SetDefault(logger)
dbConnStr := (os.Getenv("DB_URL")) // Load the configuration
config := loadConfig()
// Set the logLevel
logLevel := getLogLevel(slog.LevelInfo) // Default to info level
logger = createLoggerWithLevel(logLevel)
dbConnStr := config.DB
// Connect to PostgreSQL // Connect to PostgreSQL
db, err := sql.Open("postgres", dbConnStr) db, err := sql.Open("postgres", dbConnStr)
if err != nil { if err != nil {
@ -157,17 +288,21 @@ func main() {
defer db.Close() defer db.Close()
// Create tables if they don't exist // Create tables if they don't exist
createTables(db) migrateDB(db)
// Get WebSocket URL from environment variable // Create WebSocket URL from config variable
RemoteURL := os.Getenv("REMOTE_URL") wsURL := "ws://" + config.OpenDTUAddress + "/livedata"
wsURL := "ws://" + RemoteURL + "/livedata"
if wsURL == "" { logger.Debug(wsURL)
log.Fatal("WEBSOCKET_URL environment variable is not set.")
// Create headers with optional Basic Auth
headers := http.Header{}
if config.OpenDTUAuth {
headers.Set("Authorization", basicAuth(config.OpenDTUUser, config.OpenDTUPassword))
} }
// Establish WebSocket connection // Establish WebSocket connection
c, _, err := websocket.DefaultDialer.Dial(wsURL, nil) c, _, err := websocket.DefaultDialer.Dial(wsURL, headers)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)
} }
@ -178,6 +313,8 @@ func main() {
log.Fatal(err) log.Fatal(err)
} }
logger.Info("OpenDTU Logger has been successfully initialised. Starting data recording...")
// Start listening for WebSocket messages // Start listening for WebSocket messages
go func() { go func() {
for { for {
@ -211,7 +348,10 @@ func handleMessage(message []byte, db *sql.DB) {
// Check conditions for recording data // Check conditions for recording data
for _, inverter := range liveData.Inverters { for _, inverter := range liveData.Inverters {
if inverter.Events > 0 && inverter.Events > getPreviousEventsCount(db, inverter.Serial) { // Record events data
// Optional debugging code:
// log.Println("Events data:", "age", inverter.DataAge, "event number", inverter.Events, "previous event count", getPreviousEventsCount(db, inverter.Serial))
if inverter.DataAge == 0 && inverter.Events > 0 && inverter.Events > getPreviousEventsCount(db, inverter.Serial) {
// Query the endpoint for events // Query the endpoint for events
events, err := queryEventsEndpoint(inverter.Serial) events, err := queryEventsEndpoint(inverter.Serial)
if err != nil { if err != nil {
@ -222,7 +362,7 @@ func handleMessage(message []byte, db *sql.DB) {
// Insert events data into the opendtu_events table // Insert events data into the opendtu_events table
insertEvents(db, inverter.Serial, events) insertEvents(db, inverter.Serial, events)
} }
// Record inverter data
if inverter.DataAge == 0 && inverter.Reachable { if inverter.DataAge == 0 && inverter.Reachable {
// Insert data into PostgreSQL tables // Insert data into PostgreSQL tables
insertLiveData(db, inverter, liveData.Total, liveData.Hints) insertLiveData(db, inverter, liveData.Total, liveData.Hints)
@ -231,103 +371,16 @@ func handleMessage(message []byte, db *sql.DB) {
} }
} }
func createTables(db *sql.DB) { func migrateDB(db *sql.DB) {
// Execute SQL statements to create tables if they don't exist
// inverter_serial is TEXT as some non-Hoymiles inverters use non-numeric serial numbers.
// An additional advantage is that it makes plotting in Grafana easier.
// TODO: Foreign keys commented out as TimescaleDB hypertables don't support them. // TODO: Foreign keys commented out as TimescaleDB hypertables don't support them.
createTableSQL := `
CREATE TABLE IF NOT EXISTS opendtu_log (
timestamp TIMESTAMPTZ UNIQUE DEFAULT CURRENT_TIMESTAMP,
power NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC
);
CREATE TABLE IF NOT EXISTS opendtu_inverters (
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
name TEXT,
producing BOOL,
limit_relative NUMERIC,
limit_absolute NUMERIC
);
CREATE TABLE IF NOT EXISTS opendtu_inverters_ac (
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
ac_number INT,
power NUMERIC,
voltage NUMERIC,
current NUMERIC,
frequency NUMERIC,
powerfactor NUMERIC,
reactivepower NUMERIC
);
CREATE TABLE IF NOT EXISTS opendtu_inverters_dc (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
dc_number INT,
name TEXT,
power NUMERIC,
voltage NUMERIC,
current NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC,
irradiation NUMERIC
);
CREATE TABLE IF NOT EXISTS opendtu_inverters_inv (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
temperature NUMERIC,
power_dc NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC,
efficiency NUMERIC
);
CREATE TABLE IF NOT EXISTS opendtu_events ( // Perform DB migrations
-- id SERIAL PRIMARY KEY, err := migrateFS(db, migrations.FS, ".")
timestamp TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
inverter_serial TEXT,
message_id INT,
message TEXT,
start_time INT,
end_time INT
);
CREATE TABLE IF NOT EXISTS opendtu_hints (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
time_sync BOOL,
radio_problem BOOL,
default_password BOOL
);
CREATE INDEX IF NOT EXISTS opendtu_log_timestamp_idx ON opendtu_log (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_inverters_timestamp_idx ON opendtu_inverters (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_inverters_ac_timestamp_idx ON opendtu_inverters_ac (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_inverters_dc_timestamp_idx ON opendtu_inverters_dc (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_inverters_inv_timestamp_idx ON opendtu_inverters_inv (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_events_timestamp_idx ON opendtu_events (timestamp);
CREATE INDEX IF NOT EXISTS opendtu_hints_timestamp_idx ON opendtu_hints (timestamp);
`
_, err := db.Exec(createTableSQL)
if err != nil { if err != nil {
log.Fatal("Error creating tables: ", err) log.Fatal("Error performing database migrations: ", err)
} }
timescaleEnabled := os.Getenv("TIMESCALEDB_ENABLED") timescaleEnabled := config.TimescaleDB
enableTimescaleDB := ` enableTimescaleDB := `
-- CREATE EXTENSION IF NOT EXISTS timescaledb; -- CREATE EXTENSION IF NOT EXISTS timescaledb;
@ -339,7 +392,7 @@ func createTables(db *sql.DB) {
SELECT create_hypertable('opendtu_events', 'timestamp', if_not_exists => TRUE, migrate_data => TRUE); SELECT create_hypertable('opendtu_events', 'timestamp', if_not_exists => TRUE, migrate_data => TRUE);
SELECT create_hypertable('opendtu_hints', 'timestamp', if_not_exists => TRUE, migrate_data => TRUE); SELECT create_hypertable('opendtu_hints', 'timestamp', if_not_exists => TRUE, migrate_data => TRUE);
` `
if timescaleEnabled == "true" { if timescaleEnabled {
_, err := db.Exec(enableTimescaleDB) _, err := db.Exec(enableTimescaleDB)
if err != nil { if err != nil {
log.Fatal("Error enabling TimescaleDB: ", err) log.Fatal("Error enabling TimescaleDB: ", err)
@ -348,7 +401,7 @@ func createTables(db *sql.DB) {
} }
func insertLiveData(db *sql.DB, inverter Inverter, total Total, hints Hints) { func insertLiveData(db *sql.DB, inverter Inverter, total Total, hints Hints) {
timeZone := os.Getenv("TZ") timeZone := config.TZ
loc, _ := time.LoadLocation(timeZone) loc, _ := time.LoadLocation(timeZone)
timestamp := time.Now().In(loc) timestamp := time.Now().In(loc)
@ -425,16 +478,60 @@ func insertLiveData(db *sql.DB, inverter Inverter, total Total, hints Hints) {
} }
func queryEventsEndpoint(inverterSerial string) (*EventsResponse, error) { func migrate(db *sql.DB, dir string) error {
remoteURL := os.Getenv("REMOTE_URL") err := goose.SetDialect("postgres")
endpoint := fmt.Sprintf("http://"+remoteURL+"/api/eventlog/status?inv=%s", inverterSerial) if err != nil {
return fmt.Errorf("migrate: %w", err)
}
err = goose.Up(db, dir)
if err != nil {
return fmt.Errorf("migrate: %w", err)
}
return nil
resp, err := http.Get(endpoint) }
func migrateFS(db *sql.DB, migrationFS fs.FS, dir string) error {
// In case the dir is an empty string, they probably meant the current directory and goose wants a period for that.
if dir == "" {
dir = "."
}
goose.SetBaseFS(migrationFS)
defer func() {
// Ensure that we remove the FS on the off chance some other part of our app uses goose for migrations and doesn't want to use our FS.
goose.SetBaseFS(nil)
}()
return migrate(db, dir)
}
func queryEventsEndpoint(inverterSerial string) (*EventsResponse, error) {
endpoint := fmt.Sprintf("http://"+config.OpenDTUAddress+"/api/eventlog/status?inv=%s", inverterSerial)
// Create a new HTTP request
req, err := http.NewRequest("GET", endpoint, nil)
if err != nil {
return nil, err
}
if config.OpenDTUAuth {
// Add Basic Auth header
req.Header.Add("Authorization", basicAuth(config.OpenDTUUser, config.OpenDTUPassword))
}
// Send the request
client := &http.Client{}
resp, err := client.Do(req)
if err != nil { if err != nil {
return nil, err return nil, err
} }
defer resp.Body.Close() defer resp.Body.Close()
// Check for HTTP errors
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("HTTP request failed with status: %s", resp.Status)
}
// Decode the response
var eventsResponse EventsResponse var eventsResponse EventsResponse
if err := json.NewDecoder(resp.Body).Decode(&eventsResponse); err != nil { if err := json.NewDecoder(resp.Body).Decode(&eventsResponse); err != nil {
return nil, err return nil, err
@ -444,6 +541,11 @@ func queryEventsEndpoint(inverterSerial string) (*EventsResponse, error) {
} }
// The events counter reported by OpenDTU resets every day. // The events counter reported by OpenDTU resets every day.
// However, this assumes that the inverters from which the events are pulled are reset every day, during the night.
// Additionally, this function requires OpenDTU to be set to "Clear Eventlog at midnight" for each inverter.
// "Clear Eventlog at midnight" should be set to ON in "Inverter settings" -> "pencil" -> "Advanced".
// To account for possible time drifts, the first and last 10 minutes of the day are excluded.
//
// Longest day NL: sun up 4:16, sun down 22:50 // Longest day NL: sun up 4:16, sun down 22:50
// Shortest day NL: sun up 8:44, sun down 16:25 // Shortest day NL: sun up 8:44, sun down 16:25
func getPreviousEventsCount(db *sql.DB, inverterSerial string) int { func getPreviousEventsCount(db *sql.DB, inverterSerial string) int {
@ -452,8 +554,8 @@ func getPreviousEventsCount(db *sql.DB, inverterSerial string) int {
SELECT COUNT(*) SELECT COUNT(*)
FROM opendtu_events FROM opendtu_events
WHERE inverter_serial = $1 WHERE inverter_serial = $1
AND timestamp >= CURRENT_DATE + INTERVAL '9 hours' AND timestamp >= CURRENT_DATE + INTERVAL '10 minutes'
AND timestamp < CURRENT_DATE + INTERVAL '23 hours' AND timestamp < CURRENT_DATE + INTERVAL '23 hours 50 minutes'
`, inverterSerial).Scan(&count) `, inverterSerial).Scan(&count)
if err != nil && err != sql.ErrNoRows { if err != nil && err != sql.ErrNoRows {
logger.Error("Error querying previous events count", "error", err) logger.Error("Error querying previous events count", "error", err)
@ -462,7 +564,9 @@ func getPreviousEventsCount(db *sql.DB, inverterSerial string) int {
} }
func insertEvents(db *sql.DB, inverterSerial string, events *EventsResponse) { func insertEvents(db *sql.DB, inverterSerial string, events *EventsResponse) {
timestamp := time.Now() timeZone := config.TZ
loc, _ := time.LoadLocation(timeZone)
timestamp := time.Now().In(loc)
for _, event := range events.Events { for _, event := range events.Events {
// Insert events data into the events table // Insert events data into the events table
@ -476,10 +580,10 @@ func insertEvents(db *sql.DB, inverterSerial string, events *EventsResponse) {
} }
if len(events.Events) > 0 && events.Events[0].EndTime == 0 { if len(events.Events) > 0 && events.Events[0].EndTime == 0 {
// If end_time is 0, schedule a job to update the corresponding message row every 30 minutes // If end_time is 0, schedule a job to update the corresponding message row every 10 minutes
go func() { go func() {
for { for {
time.Sleep(30 * time.Minute) time.Sleep(10 * time.Minute)
updatedEvents, err := queryEventsEndpoint(inverterSerial) updatedEvents, err := queryEventsEndpoint(inverterSerial)
if err != nil { if err != nil {
logger.Error("Error querying events endpoint for updates", "error", err) logger.Error("Error querying events endpoint for updates", "error", err)
@ -505,6 +609,12 @@ func updateEvents(db *sql.DB, inverterSerial string, events *EventsResponse) {
} }
} }
// basicAuth generates the Basic Auth header value
func basicAuth(username, password string) string {
credentials := username + ":" + password
return "Basic " + base64.StdEncoding.EncodeToString([]byte(credentials))
}
// TODO: finish this function. // TODO: finish this function.
// func updateInverterConfig(db *sql.DB) { // func updateInverterConfig(db *sql.DB) {
// // Periodically query the /api/inverter/list // // Periodically query the /api/inverter/list
@ -523,8 +633,8 @@ func updateEvents(db *sql.DB, inverterSerial string, events *EventsResponse) {
// } // }
// func queryConfigEndpoint() (*InverterSettingsData, error) { // func queryConfigEndpoint() (*InverterSettingsData, error) {
// remoteURL := os.Getenv("REMOTE_URL") // openDTUAddress := os.Getenv("OPENDTU_ADDRESS")
// endpoint := fmt.Sprintf("http://" + remoteURL + "/api/inverter/list") // endpoint := fmt.Sprintf("http://" + openDTUAddress + "/api/inverter/list")
// resp, err := http.Get(endpoint) // resp, err := http.Get(endpoint)
// if err != nil { // if err != nil {

14
migrations/00001_log.sql Normal file
View file

@ -0,0 +1,14 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_log (
timestamp TIMESTAMPTZ UNIQUE DEFAULT CURRENT_TIMESTAMP,
power NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC
);
CREATE INDEX IF NOT EXISTS opendtu_log_timestamp_idx ON opendtu_log (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,19 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_inverters (
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
-- inverter_serial is TEXT as some non-Hoymiles inverters use non-numeric serial numbers.
-- An additional advantage is that it makes plotting in Grafana easier.
inverter_serial TEXT,
name TEXT,
producing BOOL,
limit_relative NUMERIC,
limit_absolute NUMERIC
);
CREATE INDEX IF NOT EXISTS opendtu_inverters_timestamp_idx ON opendtu_inverters (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,20 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_inverters_ac (
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
ac_number INT,
power NUMERIC,
voltage NUMERIC,
current NUMERIC,
frequency NUMERIC,
powerfactor NUMERIC,
reactivepower NUMERIC
);
CREATE INDEX IF NOT EXISTS opendtu_inverters_ac_timestamp_idx ON opendtu_inverters_ac (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,22 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_inverters_dc (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
dc_number INT,
name TEXT,
power NUMERIC,
voltage NUMERIC,
current NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC,
irradiation NUMERIC
);
CREATE INDEX IF NOT EXISTS opendtu_inverters_dc_timestamp_idx ON opendtu_inverters_dc (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,19 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_inverters_inv (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
inverter_serial TEXT,
temperature NUMERIC,
power_dc NUMERIC,
yieldday NUMERIC,
yieldtotal NUMERIC,
efficiency NUMERIC
);
CREATE INDEX IF NOT EXISTS opendtu_inverters_inv_timestamp_idx ON opendtu_inverters_inv (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,17 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_events (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
inverter_serial TEXT,
message_id INT,
message TEXT,
start_time INT,
end_time INT
);
CREATE INDEX IF NOT EXISTS opendtu_events_timestamp_idx ON opendtu_events (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,26 @@
-- +goose Up
-- +goose StatementBegin
DO $$
BEGIN
-- Check if start_timestamp column exists
IF NOT EXISTS (SELECT 1 FROM information_schema.columns
WHERE table_name='opendtu_events'
AND column_name='start_timestamp') THEN
-- Add start_timestamp column
ALTER TABLE opendtu_events
ADD COLUMN start_timestamp TIMESTAMPTZ;
END IF;
-- Check if end_timestamp column exists
IF NOT EXISTS (SELECT 1 FROM information_schema.columns
WHERE table_name='opendtu_events'
AND column_name='end_timestamp') THEN
-- Add end_timestamp column
ALTER TABLE opendtu_events
ADD COLUMN end_timestamp TIMESTAMPTZ;
END IF;
END $$;
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

View file

@ -0,0 +1,16 @@
-- +goose Up
-- +goose StatementBegin
CREATE TABLE IF NOT EXISTS opendtu_hints (
-- id SERIAL PRIMARY KEY,
timestamp TIMESTAMPTZ,
-- FOREIGN KEY (timestamp) REFERENCES opendtu_log(timestamp),
time_sync BOOL,
radio_problem BOOL,
default_password BOOL
);
CREATE INDEX IF NOT EXISTS opendtu_hints_timestamp_idx ON opendtu_hints (timestamp);
-- +goose StatementEnd
-- +goose Down
-- +goose StatementBegin
-- +goose StatementEnd

6
migrations/fs.go Normal file
View file

@ -0,0 +1,6 @@
package migrations
import "embed"
//go:embed *.sql
var FS embed.FS

Binary file not shown.

After

Width:  |  Height:  |  Size: 741 KiB

View file

@ -0,0 +1,44 @@
GNU nano 7.2 /etc/systemd/system/opendtu-logger.service
[Unit]
Description=OpenDTU Logger
Documentation=https://git.hollander.online/energy/opendtu-logger
After=network.target auditd.service
# If using a PostgreSQL DB on the local machine, uncomment the following additional "After" and "Require" sections.
## PostgreSQL
# After=postgresql.service
# Requires=postgresql.service
[Service]
RestartSec=10s
Type=simple
User=opendtu-logger
Group=opendtu-logger
Environment="OPENDTU_ADDRESS=opendtu.local:80"
Environment="OPENDTU_AUTH=false"
Environment="OPENDTU_USERNAME=admin"
Environment="OPENDTU_PASSWORD=your_super_secret_password"
Environment="DB_URL=host=localhost port=5432 user=postgres password=secret dbname=dtu sslmode=disable"
Environment="TIMESCALEDB_ENABLED=true"
Environment="TZ=Europe/Amsterdam"
Environment="LOG_LEVEL=INFO"
WorkingDirectory=/opt/opendtu-logger/
ExecStart=/opt/opendtu-logger/opendtu-logger
Restart=always
# Isolate OpenDTU Logger from the rest of the system
PrivateTmp=true
PrivateDevices=true
ProtectHome=true
NoNewPrivileges=true
ProtectSystem=strict
# Only allow writes to the following directories
ReadWritePaths=/opt/opendtu-logger/data/
[Install]
WantedBy=multi-user.target