Merge remote-tracking branch 'upstream/master'

data/config/apache/http-api-ssl.conf

@@ -0,0 +1,141 @@
+# openwb-version:1
+<IfModule mod_ssl.c>
+	Listen 8443
+
+	<VirtualHost _default_:8443>
+		ServerAdmin webmaster@localhost
+
+		DocumentRoot /var/www/html/openWB/runs/http-api
+
+		# Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
+		# error, crit, alert, emerg.
+		# It is also possible to configure the loglevel for particular
+		# modules, e.g.
+		#LogLevel info ssl:warn
+
+		ErrorLog ${APACHE_LOG_DIR}/api-ssl-error.log
+		CustomLog ${APACHE_LOG_DIR}/api-ssl-access.log combined
+
+		# For most configuration files from conf-available/, which are
+		# enabled or disabled at a global level, it is possible to
+		# include a line for only one particular virtual host. For example the
+		# following line enables the CGI configuration for this host only
+		# after it has been globally disabled with "a2disconf".
+		#Include conf-available/serve-cgi-bin.conf
+
+		#   SSL Engine Switch:
+		#   Enable/Disable SSL for this virtual host.
+		SSLEngine on
+
+		#   A self-signed (snakeoil) certificate can be created by installing
+		#   the ssl-cert package. See
+		#   /usr/share/doc/apache2/README.Debian.gz for more info.
+		#   If both key and certificate are stored in the same file, only the
+		#   SSLCertificateFile directive is needed.
+		SSLCertificateFile	/etc/ssl/certs/ssl-cert-snakeoil.pem
+		SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
+
+		#   Server Certificate Chain:
+		#   Point SSLCertificateChainFile at a file containing the
+		#   concatenation of PEM encoded CA certificates which form the
+		#   certificate chain for the server certificate. Alternatively
+		#   the referenced file can be the same as SSLCertificateFile
+		#   when the CA certificates are directly appended to the server
+		#   certificate for convinience.
+		#SSLCertificateChainFile /etc/apache2/ssl.crt/server-ca.crt
+
+		#   Certificate Authority (CA):
+		#   Set the CA certificate verification path where to find CA
+		#   certificates for client authentication or alternatively one
+		#   huge file containing all of them (file must be PEM encoded)
+		#   Note: Inside SSLCACertificatePath you need hash symlinks
+		#		 to point to the certificate files. Use the provided
+		#		 Makefile to update the hash symlinks after changes.
+		#SSLCACertificatePath /etc/ssl/certs/
+		#SSLCACertificateFile /etc/apache2/ssl.crt/ca-bundle.crt
+
+		#   Certificate Revocation Lists (CRL):
+		#   Set the CA revocation path where to find CA CRLs for client
+		#   authentication or alternatively one huge file containing all
+		#   of them (file must be PEM encoded)
+		#   Note: Inside SSLCARevocationPath you need hash symlinks
+		#		 to point to the certificate files. Use the provided
+		#		 Makefile to update the hash symlinks after changes.
+		#SSLCARevocationPath /etc/apache2/ssl.crl/
+		#SSLCARevocationFile /etc/apache2/ssl.crl/ca-bundle.crl
+
+		#   Client Authentication (Type):
+		#   Client certificate verification type and depth.  Types are
+		#   none, optional, require and optional_no_ca.  Depth is a
+		#   number which specifies how deeply to verify the certificate
+		#   issuer chain before deciding the certificate is not valid.
+		#SSLVerifyClient require
+		#SSLVerifyDepth  10
+
+		#   SSL Engine Options:
+		#   Set various options for the SSL engine.
+		#   o FakeBasicAuth:
+		#	 Translate the client X.509 into a Basic Authorisation.  This means that
+		#	 the standard Auth/DBMAuth methods can be used for access control.  The
+		#	 user name is the `one line' version of the client's X.509 certificate.
+		#	 Note that no password is obtained from the user. Every entry in the user
+		#	 file needs this password: `xxj31ZMTZzkVA'.
+		#   o ExportCertData:
+		#	 This exports two additional environment variables: SSL_CLIENT_CERT and
+		#	 SSL_SERVER_CERT. These contain the PEM-encoded certificates of the
+		#	 server (always existing) and the client (only existing when client
+		#	 authentication is used). This can be used to import the certificates
+		#	 into CGI scripts.
+		#   o StdEnvVars:
+		#	 This exports the standard SSL/TLS related `SSL_*' environment variables.
+		#	 Per default this exportation is switched off for performance reasons,
+		#	 because the extraction step is an expensive operation and is usually
+		#	 useless for serving static content. So one usually enables the
+		#	 exportation for CGI and SSI requests only.
+		#   o OptRenegotiate:
+		#	 This enables optimized SSL connection renegotiation handling when SSL
+		#	 directives are used in per-directory context.
+		#SSLOptions +FakeBasicAuth +ExportCertData +StrictRequire
+		<FilesMatch "\.(cgi|shtml|phtml|php)$">
+				SSLOptions +StdEnvVars
+		</FilesMatch>
+		<Directory /usr/lib/cgi-bin>
+				SSLOptions +StdEnvVars
+		</Directory>
+		<Directory /var/www/html/openWB/runs/http-api>
+			AllowOverride All
+			Require all granted
+			Options -Indexes
+		</Directory>
+		#   SSL Protocol Adjustments:
+		#   The safe and default but still SSL/TLS standard compliant shutdown
+		#   approach is that mod_ssl sends the close notify alert but doesn't wait for
+		#   the close notify alert from client. When you need a different shutdown
+		#   approach you can use one of the following variables:
+		#   o ssl-unclean-shutdown:
+		#	 This forces an unclean shutdown when the connection is closed, i.e. no
+		#	 SSL close notify alert is send or allowed to received.  This violates
+		#	 the SSL/TLS standard but is needed for some brain-dead browsers. Use
+		#	 this when you receive I/O errors because of the standard approach where
+		#	 mod_ssl sends the close notify alert.
+		#   o ssl-accurate-shutdown:
+		#	 This forces an accurate shutdown when the connection is closed, i.e. a
+		#	 SSL close notify alert is send and mod_ssl waits for the close notify
+		#	 alert of the client. This is 100% SSL/TLS standard compliant, but in
+		#	 practice often causes hanging connections with brain-dead browsers. Use
+		#	 this only for browsers where you know that their SSL implementation
+		#	 works correctly.
+		#   Notice: Most problems of broken clients are also related to the HTTP
+		#   keep-alive facility, so you usually additionally want to disable
+		#   keep-alive for those clients, too. Use variable "nokeepalive" for this.
+		#   Similarly, one has to force some clients to use HTTP/1.0 to workaround
+		#   their broken HTTP/1.1 implementation. Use variables "downgrade-1.0" and
+		#   "force-response-1.0" for this.
+		# BrowserMatch "MSIE [2-6]" \
+		#		nokeepalive ssl-unclean-shutdown \
+		#		downgrade-1.0 force-response-1.0
+
+	</VirtualHost>
+</IfModule>
+
+# vim: syntax=apache ts=4 sw=4 sts=4 sr noet

docs/Neues Modul programmieren.md

@@ -13,10 +13,10 @@ Exceptions dürfen daher nur abgefangen werden, wenn sie
 * behoben werden können.
 * weitere Aktionen vorgenommen werden sollen. Danach mit `raise e` die Exception erneut werfen, damit sie weiterverarbeitet werden kann.
 
-Bei Modulen, die einen http-Request ausführen, get/post-Requests immer mit `req.get_http_session().get/post()` stellen. [get_http_session](https://github.com/openWB/core/blob/02b34ff216b0dfc83fdc56a53b63d52d5d9a79d2/packages/modules/common/req.py#L8) prüft in einem Callback, ob ein Fehler aufgetreten ist und wirft eine Exception. Bei gängigen Fehlern wird diese in einen Text übersetzt, der auch für den Benutzer verständlich ist.  
+Bei Modulen, die einen http-Request ausführen, get/post-Requests immer mit `req.get_http_session().get/post()` aus dem Ordner modules/common stellen. [get_http_session](https://github.com/openWB/core/blob/02b34ff216b0dfc83fdc56a53b63d52d5d9a79d2/packages/modules/common/req.py#L8) loggt die Antwort und prüft in einem Callback, ob ein Fehler aufgetreten ist und wirft eine Exception. Bei gängigen Fehlern wird diese in einen Text übersetzt, der auch für den Benutzer verständlich ist.  
 
 Ein paar Hintergrund-Details, wie die Fehlerbehandlung umgesetzt ist:  
-Die update-Methode des Moduls wird immer mit dem [Kontextmanager](https://github.com/openWB/core/blob/02b34ff216b0dfc83fdc56a53b63d52d5d9a79d2/packages/modules/common/component_context.py#L11) aufgerufen. Dieser prüft nach dem Ende der Update-Methode, ob eine Exception aufgetreten ist und loggt diese und setzt die Topics `.../get/fault_state/ auf 2 und in `.../get/fault_str` den Text der Exception. fault_str wird dann im jeweiligen Modul auf der Status-Seite ausgegeben, um dem Benutzer eine Rückmeldung zu geben.
+Die update-Methode des Moduls wird immer mit dem [Kontextmanager](https://github.com/openWB/core/blob/02b34ff216b0dfc83fdc56a53b63d52d5d9a79d2/packages/modules/common/component_context.py#L11) aufgerufen. Dieser prüft nach dem Ende der Update-Methode, ob eine Exception aufgetreten ist und loggt diese und setzt die Topics `.../get/fault_state/` auf 2 und in `.../get/fault_str` den Text der Exception. fault_str wird dann im jeweiligen Modul auf der Status-Seite ausgegeben, um dem Benutzer eine Rückmeldung zu geben.
 
 ### Neues Gerät programmieren
 Für neue Geräte gibt es drei Muster:

docs/samples/sample_modbus/device.py

@@ -33,7 +33,7 @@ def update_components(components: Iterable[Union[SampleBat, SampleCounter, Sampl
                     component.update(c)
 
     try:
-        client = ModbusTcpClient_(device_config.configuration.ip_address, port)
+        client = ModbusTcpClient_(device_config.configuration.ip_address, device_config.configuration.port)
     except Exception:
         log.exception("Fehler in create_device")
     return ConfigurableDevice(

packages/control/bat.py

@@ -3,21 +3,23 @@
 from typing import List
 
 from dataclass_utils.factories import currents_list_factory
+from helpermodules.constants import NO_ERROR
 
 log = logging.getLogger(__name__)
 
 
 @dataclass
 class Get:
-    currents: List[float] = field(default_factory=currents_list_factory)
-    soc: float = 0
-    daily_exported: float = 0
-    daily_imported: float = 0
-    imported: float = 0
-    exported: float = 0
-    fault_state: int = 0
-    fault_str: str = ""
-    power: float = 0
+    currents: List[float] = field(default_factory=currents_list_factory, metadata={
+                                  "topic": "get/currents"})
+    soc: float = field(default=0, metadata={"topic": "get/soc"})
+    daily_exported: float = field(default=0, metadata={"topic": "get/daily_exported"})
+    daily_imported: float = field(default=0, metadata={"topic": "get/daily_imported"})
+    imported: float = field(default=0, metadata={"topic": "get/imported"})
+    exported: float = field(default=0, metadata={"topic": "get/exported"})
+    fault_state: int = field(default=0, metadata={"topic": "get/fault_state"})
+    fault_str: str = field(default=NO_ERROR, metadata={"topic": "get/fault_str"})
+    power: float = field(default=0, metadata={"topic": "get/power"})
 
 
 def get_factory() -> Get:

packages/control/chargelog/chargelog.py

@@ -450,8 +450,7 @@ def get_reference_time(cp, reference_position):
         return timecheck.create_timestamp() - 3540
     elif reference_position == ReferenceTime.END:
         # Wenn der Ladevorgang erst innerhalb der letzten Stunde gestartet wurde.
-        one_hour_back = timecheck.create_timestamp() - 3600
-        if (one_hour_back - cp.data.set.log.timestamp_start_charging) < 0:
+        if timecheck.create_unix_timestamp_current_full_hour() <= cp.data.set.log.timestamp_start_charging:
             return cp.data.set.log.timestamp_start_charging
         else:
             return timecheck.create_unix_timestamp_current_full_hour() + 60

packages/control/chargelog/chargelog_test.py

@@ -0,0 +1,154 @@
+
+import datetime
+from unittest.mock import Mock
+
+import pytest
+
+from control import data
+from control.chargelog import chargelog
+from control.chargelog.chargelog import calculate_charge_cost
+from control.chargepoint.chargepoint import Chargepoint
+from helpermodules import timecheck
+from test_utils.test_environment import running_on_github
+
+
+def mock_daily_log_with_charging(date: str, num_of_intervalls, monkeypatch):
+    """erzeugt ein daily_log, im ersten Eintrag gibt es keine Änderung, danach wird bis inklusive dem letzten Beitrag
+    geladen"""
+    bat_exported = pv_exported = cp_imported = counter_imported = 2000
+    date = datetime.datetime.strptime(date, "%m/%d/%Y, %H:%M")
+    daily_log = {"entries": []}
+    for i in range(0, num_of_intervalls):
+        if i != 0:
+            bat_exported += 1000
+            pv_exported += 500
+            cp_imported += 2000
+            counter_imported += 500
+        daily_log["entries"].append({'bat': {'all': {'exported': bat_exported, 'imported': 2000, 'soc': 100},
+                                             'bat2': {'exported': bat_exported, 'imported': 2000, 'soc': 100}},
+                                     'counter': {'counter0': {'exported': 2000,
+                                                              'grid': True,
+                                                              'imported': counter_imported}},
+                                     'cp': {'all': {'exported': 0, 'imported': cp_imported},
+                                            'cp4': {'exported': 0, 'imported': cp_imported}},
+                                     'date': date.strftime("%H:%M"),
+                                     'ev': {'ev0': {'soc': None}},
+                                     'hc': {'all': {'imported': 0}},
+                                     'pv': {'all': {'exported': pv_exported}, 'pv1': {'exported': pv_exported}},
+                                     'sh': {},
+                                     'timestamp': date.timestamp()})
+        date += datetime.timedelta(minutes=5)
+    mock_todays_daily_log = Mock(return_value=daily_log)
+    monkeypatch.setattr(chargelog, "get_todays_daily_log", mock_todays_daily_log)
+    return daily_log
+
+
+@pytest.fixture()
+def mock_data() -> None:
+    data.data_init(Mock())
+    data.data.optional_data.et_module = None
+
+
+def mock_create_entry_reference_end(clock, daily_log, monkeypatch):
+    current_log = daily_log["entries"][-1]
+    current_log["cp"]["all"]["imported"] += 500
+    current_log["cp"]["cp4"]["imported"] += 500
+    current_log["counter"]["counter0"]["imported"] += 500
+    current_log["date"] = clock
+    current_log["timestamp"] = datetime.datetime.strptime(f"05/16/2022, {clock}", "%m/%d/%Y, %H:%M").timestamp()
+    mock_create_entry = Mock(return_value=current_log)
+    monkeypatch.setattr(chargelog, "create_entry", mock_create_entry)
+
+
+def init_cp(charged_energy, costs, start_hour, start_minute=47):
+    cp = Chargepoint(4, None)
+    cp.data.set.log.imported_since_plugged = cp.data.set.log.imported_since_mode_switch = charged_energy
+    cp.data.set.log.timestamp_start_charging = datetime.datetime(2022, 5, 16, start_hour, start_minute).timestamp()
+    cp.data.get.imported = charged_energy + 2000
+    cp.data.set.log.costs = costs
+    return cp
+
+
+def test_calc_charge_cost_no_hour_change_reference_end(mock_data, monkeypatch):
+    cp = init_cp(6500, 0, 10, start_minute=27)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 10:25", 4, monkeypatch)
+    mock_create_entry_reference_end("10:42", daily_log, monkeypatch)
+
+    calculate_charge_cost(cp, True)
+
+    assert cp.data.set.log.costs == 1.425
+
+
+def test_calc_charge_cost_first_hour_change_reference_begin(mock_data, monkeypatch):
+    cp = init_cp(6000, 0, 7)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 07:45", 4, monkeypatch)
+    current_log = daily_log["entries"][-1]
+    current_log["date"] = "08:00"
+    current_log["timestamp"] = datetime.datetime.strptime("05/16/2022, 08:00", "%m/%d/%Y, %H:%M").timestamp()
+    mock_create_entry = Mock(return_value=current_log)
+    monkeypatch.setattr(chargelog, "create_entry", mock_create_entry)
+
+    calculate_charge_cost(cp, False)
+
+    assert cp.data.set.log.costs == 1.275
+
+
+def test_calc_charge_cost_first_hour_change_reference_begin_day_change(mock_data, monkeypatch):
+    cp = init_cp(6000, 0, 23)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 23:45", 4, monkeypatch)
+    current_log = daily_log["entries"][-1]
+    current_log["date"] = "00:00"
+    current_log["timestamp"] = datetime.datetime.strptime("05/17/2022, 00:00", "%m/%d/%Y, %H:%M").timestamp()
+    mock_create_entry = Mock(return_value=current_log)
+    monkeypatch.setattr(chargelog, "create_entry", mock_create_entry)
+    mock_today_timestamp = Mock(return_value=1652738421)
+    monkeypatch.setattr(timecheck, "create_timestamp", mock_today_timestamp)
+
+    calculate_charge_cost(cp, False)
+
+    assert cp.data.set.log.costs == 1.275
+
+
+def test_calc_charge_cost_one_hour_change_reference_end(mock_data, monkeypatch):
+    if running_on_github():
+        # ToDo Zeitzonen berücksichtigen, damit Tests auf Github laufen
+        return
+    cp = init_cp(22500, 1.275, 7)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 07:45", 12, monkeypatch)
+    mock_create_entry_reference_end("08:40", daily_log, monkeypatch)
+
+    calculate_charge_cost(cp, True)
+
+    assert cp.data.set.log.costs == 4.8248999999999995
+
+
+def test_calc_charge_cost_two_hour_change_reference_middle(mock_data, monkeypatch):
+    if running_on_github():
+        # ToDo Zeitzonen berücksichtigen, damit Tests auf Github laufen
+        return
+    cp = init_cp(22500, 1.275, 6)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 06:45", 16, monkeypatch)
+    current_log = daily_log["entries"][-1]
+    current_log["date"] = "08:00"
+    current_log["timestamp"] = datetime.datetime(2022, 5, 16, 8).timestamp()
+    mock_create_entry = Mock(return_value=current_log)
+    monkeypatch.setattr(chargelog, "create_entry", mock_create_entry)
+    mock_today_timestamp = Mock(return_value=1652680801)
+    monkeypatch.setattr(timecheck, "create_timestamp", mock_today_timestamp)
+
+    calculate_charge_cost(cp, False)
+
+    assert cp.data.set.log.costs == 6.375
+
+
+def test_calc_charge_cost_two_hour_change_reference_end(mock_data, monkeypatch):
+    if running_on_github():
+        # ToDo Zeitzonen berücksichtigen, damit Tests auf Github laufen
+        return
+    cp = init_cp(46500, 6.375, 6)
+    daily_log = mock_daily_log_with_charging("05/16/2022, 06:45", 24, monkeypatch)
+    mock_create_entry_reference_end("08:40", daily_log, monkeypatch)
+
+    calculate_charge_cost(cp, True)
+
+    assert cp.data.set.log.costs == 9.924900000000001

packages/control/chargepoint/chargepoint.py

@@ -101,8 +101,8 @@ def _is_grid_protection_inactive(self) -> Tuple[bool, Optional[str]]:
                             general_data.grid_protection_random_stop):
                         state = False
                         message = "Ladepunkt gesperrt, da der Netzschutz aktiv ist."
-                        Pub().pub("openWB/set/general/grid_protection_timestamp", None)
-                        Pub().pub("openWB/set/general/grid_protection_random_stop", 0)
+                        general_data.grid_protection_timestamp = None
+                        general_data.grid_protection_random_stop = 0
                 else:
                     state = False
                     message = "Ladepunkt gesperrt, da der Netzschutz aktiv ist."