Skip to content

Commit

Permalink
Update readme and example config
Browse files Browse the repository at this point in the history
  • Loading branch information
GJSBRT committed Apr 12, 2024
1 parent 05d9123 commit 4af7861
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
7 changes: 7 additions & 0 deletions config.yaml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,15 @@ modbus:

# Power price configuration
power-prices:
# Enable or disable collecting completely
enable: false
sources:
all-in-power:
# Enable or disable All In Power power price collecting
enable: false
entsoe:
# Enable or disable entsoe power price collecting
enable: false
# Domains can be found here: https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_areas
domain: "10YNL----------L"
# You will need to contact Entsoe support to get access to their API.
Expand Down
12 changes: 10 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# Vonkje
Vonkje is a small service which manages communication, metrics, decision making and control of a solar plant. The goal of this application is to provide insight and to improve the efficiency of a solar plant.

## Features
- Metrics collection of devices
- Controlling state of devices
- Collecting power prices from suppliers

## Supported Devices
- Huawei Sun2000 and connected peripherals like Luna2000 battery and power meter.

## Runtime Dependencies
- Grafana for visualisation
- Victoria Metrics for metrics storage
- **Grafana** for visualisation
- **Victoria Metrics** for metrics storage

## Development Dependencies
- **Golang** 1.22 or higher
Expand Down

0 comments on commit 4af7861

Please sign in to comment.