Compare commits

..

No commits in common. "main" and "v0.2" have entirely different histories.
main ... v0.2

3 changed files with 12 additions and 21 deletions

3
.env
View File

@ -9,7 +9,7 @@ OPENDTU_ADDR=<ADDRESS OF OPENDTU> # address of opendtu (format: http(s)://<IP-
OPENDTU_USER=<OPENDTU USER> # username for opendtu auth
OPENDTU_PWD=<OPENDTU PWD> # password for opendtu auth
OPENDTU_INVERTER_SN=<SERIAL NR> # serial number of the inverter to control
LIMIT_CORRECTION_FACTOR=2 # correction factor for limit setting (e.g.: when only 2 strings of 4 are connected, you always need to set 2x the power), default: 1.0
LIMIT_CORRECTION_FACTOR=2 # correction factor for limit setting (e.g.: when only 2 strings of 4 are connected, you always need to set 2x the power), default: 2
LIMIT_UPDATE_INTERVAL=5 # interval in which the limit shall be updated, default: 5 [sec]
DRY_RUN=0 # if the limit shall be set or not; default: 1 (0: False, 1: True)
POWER_TARGET=15 # the target power consumption of the house, default: 50 [Watts]
@ -17,4 +17,5 @@ POWER_TARGET_MIN=0 # minimum percentage for the inverter output
POWER_TARGET_MAX=100 # maximum percentage for the inverter output limit, default: 100.0 [%]
POWER_DAMPING_FACTOR=0.7 # damping factor for changes of the inverter output limit (between 0-1), default: 0.3
POWER_LIMIT_CHANGE_TRESHOLD=0.3 # set a treshold for the api calls: they will not be executed if the new limit isn't that much higher, default: 0.5
POWER_LIMIT_TYPE=1 # the power limit type; DON'T CHANGE if you don't know what you're doing, default: 1 (see https://github.com/tbnobody/OpenDTU/discussions/742)
PYTHONUNBUFFERED=1 # for use in docker images (for fast logs, ...)

View File

@ -1,15 +1,12 @@
# SolarControl
![Version badge](https://shields.privacynerd.de/badge/Latest-v1.1-green?style=flat-square)
![DockerHub pulls badge](https://shields.privacynerd.de/docker/pulls/bluefox42/solarcontrol?style=flat-square)
Enforce a zero export (or whatever consumption you like) policy with an OpenDTU-controlled inverter and energy data from MQTT.
Enforce a zero export (or whatever consumption you like) policy with an OpenDTU-controlled inverter and energy data from MQTT
## Configuring and usage
### docker-compose
### Docker
To run it using docker, try the `docker-compose.yaml` file present in this repository. You will need the .env file too for that reasons, so the easiest thing is to just run the following commands:
@ -20,7 +17,7 @@ docker-compose up -d && docker-compose logs -f
```
### barebone
### Bare-bone
The script can be configured using the .env file where you can adjust it (hopefully perfect) to your needs. After that, just run the script:
@ -36,7 +33,7 @@ Please note: the .env file needs to be in the same folder or any other folder hi
To update, simply use `git pull` to pull the latest changes. Afterwards, you need to restart your script (with docker, just use `docker-compose up -d --force-recreate`).
## Building the docker image
## Building docker
To build the image for docker, simply use the following commands:
@ -45,7 +42,6 @@ docker login # login to docker hub
docker buildx create --name buildx-multi-arch
docker buildx use buildx-multi-arch
docker buildx build --no-cache --platform linux/amd64,linux/386,linux/arm/v5,linux/arm/v7,linux/arm64/v8,linux/ppc64le,linux/s390x -t bluefox42/solarcontrol:<VERSION> -t bluefox42/solarcontrol:latest . --push
docker logout # so that credentials are no longer stored in clear but are deleted
```

View File

@ -8,6 +8,7 @@ from time import time, sleep
import json
from threading import Thread
import requests
import urllib3 # only for exception handling
import math
@ -44,12 +45,9 @@ power_target_min = float(os.getenv('POWER_TARGET_MIN', 0))
power_target_max = float(os.getenv('POWER_TARGET_MAX', 100))
power_damping_factor = float(os.getenv('POWER_DAMPING_FACTOR', 0.3))
power_limit_change_treshold = float(os.getenv('POWER_LIMIT_CHANGE_TRESHOLD', 0.5))
power_limit_type = int(os.getenv('POWER_LIMIT_TYPE', 1))
dry_run = bool(int(os.getenv('DRY_RUN', 1)))
# set other important variables
power_limit_type = 1 # only set the limit temporary to avoid memory damage; see also: https://github.com/tbnobody/OpenDTU/discussions/742
version = "v1.1" # the version number
# some checks for the correctness of supplied data
if power_target_min < 0: power_target_min = 0
if power_target_max > 100: power_target_max = 100
@ -57,16 +55,13 @@ if power_damping_factor < 0: power_damping_factor = 0.0
if power_damping_factor > 1: power_damping_factor = 1.0
print(f"{bcolors.OKCYAN}Welcome to {bcolors.ENDC}{bcolors.OKBLUE}{bcolors.BOLD}SolarControl{bcolors.ENDC}{bcolors.OKCYAN} ({version})!{bcolors.ENDC}")
# create the powers dict (containing the current use) and data variables (for thread sharing)
powers_raw = {"solar": 0, "solar_ts": 0, "house": 0, "house_ts": 0}
powers = {"total": None, "total_house": None, "total_solar": None, "timestamp": 0}
# define mqtt callbacks
def on_connect(client, userdata, flags, reason_code, properties):
print(f"{bcolors.OKGREEN}Connected to the MQTT broker ({mq_broker}:{mq_port}) with result code {bcolors.ENDC}{reason_code}{bcolors.OKGREEN}.{bcolors.ENDC}")
print(f"{bcolors.OKGREEN}Connected with result code {bcolors.ENDC}{reason_code}")
client.subscribe("lge320/#")
client.subscribe("solar/ac/#")
def on_message(client, userdata, msg):
@ -88,7 +83,6 @@ mqttc.connect(mq_broker, mq_port, 60)
mqttc.loop_start()
def threaded_current_power_calculation():
while True:
last_powers = powers_raw.copy()
@ -111,8 +105,8 @@ def threaded_solar_power_limit_setting():
# Get current openDTU current limit status
try:
status = requests.get(opendtu_address.strip("/") + "/api/limit/status", auth=(opendtu_user, opendtu_pwd)).json().copy()
except BaseException as e:
print(f"{bcolors.FAIL}Some error occured while trying to reach out to OpenDTU to get latest data about the inverter limit status. Skipping for now.{bcolors.ENDC}\n==== START OF EXCEPTION ====\n{e}\n==== END OF EXCEPTION ====")
except (requests.exceptions.RequestException, urllib3.exceptions.HTTPError) as e:
print(f"{bcolors.ERROR}Some error occured while trying to reach out to OpenDTU to get latest data about the inverter limit status. Skipping for now.{bcolors.ENDC}\n==== START OF EXCEPTION ====\n{e}\n==== END OF EXCEPTION ====")
sleep(0.2) # wait some time (to avaid cpu overload on continuous unavailability of the service)
continue # skip this loop pass
@ -161,7 +155,7 @@ def threaded_solar_power_limit_setting():
else:
print(f"{bcolors.WARNING}Now the new limit would be set via the API (but DRY_RUN is either not specified or True): {str(new_limit)}%")
elif status[opendtu_inverter_sn]["max_power"] == 0:
print(f"{bcolors.FAIL}OpenDTU is reporting strange values for the inverter's maximum power output. Skipping it for now.{bcolors.ENDC}")
print(f"{bcolors.ERROR}OpenDTU is reporting strange values for the inverter's maximum power output. Skipping it for now.{bcolors.ENDC}")
while (time() - last_time) < limit_update_interval: