Erste Version, welche an Uniper gesendet worden ist.

source/conf.py

@@ -24,12 +24,12 @@ language = 'de'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 #html_theme = 'alabaster'
-#html_theme = "sphinx_rtd_theme"
-html_theme = "pydata_sphinx_theme"
+html_theme = "sphinx_rtd_theme"
+#html_theme = "pydata_sphinx_theme"
 html_static_path = ['_static']
-html_css_files = [
-    'theme_overrides.css',
-]
+#html_css_files = [
+#    'theme_overrides.css',
+#]
 
 html_theme_options = {
    # ...

source/general_overview/changelog.rst

@@ -10,4 +10,88 @@ Changelog
 Alle Versionsänderung bei den Schnittstellen und am BMS werden hier dokumentiert und aufgelistet.
 
 Die Version wird nach dem folgendem Muster aufgebaut. ``MAJOR.MINOR.PATCH``, wobei ``MAJOR``,
-``MINOR`` und ``PATCH`` aus Zahlen bestehen.
+``MINOR`` und ``PATCH`` aus Zahlen bestehen.
+
+Die Versionierung folgt den folgenen Regel:
+
+- Eine Änderung der ``MAJOR`` Version kann Änderungen an der Schnittstelle haben,
+  welche nicht mit der vorherigen Version kompatibel sein müssen.
+- ``MINOR`` Änderungen enthalten Verbesserungen oder fügen neue Features hinzu.
+  Diese Änderungen sind jedoch zu vorherigen Versionen kompatibel.
+- Eine Änderung an ``PATCH`` beschreibt behebungen von fehlern oder kleine Verbesserungen der aktuellen Version.
+
+*****
+1.0.0
+*****
+In dieser Version wurde das Interface bezüglich der Fehlermeldungen angepasst.
+Die bisherigen Register (11.040 und 11.044) sind nun obsolet und werden durch die Register 13.000 - 15.000 ersetzt.
+Dadurch können nun Fehler und Warnung bis zu den einzelnen Sensoren einer Unit hinunter vom EMS angezeigt werden.
+
+Weiterhin wurden einige Register als nicht implementiert markiert, da die Entwicklung der entsprechenden Algorithmen,
+welche für die Berechnung der Werte zuständig wären, pausiert worden ist.
+Auch die Register 12.002 und 12.004 wurde als obsolet markiert, da die Batterie in diesem Projekt nicht mit Blindleistung
+betrieben werden soll.
+
+
+Hinzugekommen
+=============
+- Register 13.000 - 13.004
+- Register 14.000 - 14.046
+- Register 15.000 - 15.046
+
+
+Geändert
+========
+- Register 12.002 - Setpoint CosPhi - Keine Funktion mehr
+- Register 12.004 - Reactive Power Type - Keine Funktion mehr
+- Register 11.002 bis 11.010 - Werden nicht bedient
+- Register 11.022 - Wird nicht bedient
+
+
+Obsolet
+=======
+- Register 11.040 - Warning Bitmap
+- Register 11.044 - Error Bitmap
+- Register 12.002 - Setpoint CosPhi
+- Register 12.004 - Reactive Power Type
+
+
+Entfernt
+========
+-
+
+
+Fixed
+=====
+-
+
+
+
+*****
+0.9.0
+*****
+- Erste Version des Interfaces.
+
+
+Hinzugekommen
+=============
+- Erste Version des Interfaces.
+
+
+Geändert
+========
+-
+
+Obsolet
+=======
+-
+
+
+Entfernt
+========
+-
+
+
+Fixed
+=====
+-

source/index.rst

@@ -22,10 +22,10 @@ Willkommen zur Dokumentation des Uniperprojektes.
 
 Die Dokumentation gliedert sich in folgende Teile:
 
-#. Generelle Übersicht
+#. :ref:`Generelle_Übersicht`
 #. Betriebsmodi
-#. OPC-UA Schnittstellenbeschreibung
-#. Modbus-TCP/IP Schnittstellenbeschreibung
+#. :ref:`OPC-UA_Schnittstellenbeschreibung`
+#. :ref:`Modbus`
 #. Fehlermeldungen
 #. Entwickler Handbuch
 
@@ -65,9 +65,26 @@ Dokumentations-Regeln
 
 Alle genannten Abschnitte sind hier zu finden:
 
+.. _Generelle_Übersicht:
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Generelle Übersicht:
 
    ./general_overview/changelog
+
+.. _OPC-UA_Schnittstellenbeschreibung:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: OPC-UA
+
+   ./opcua/opcua_schnittstelle
+
+.. _Modbus:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Modbus-TCP/IP
+
    ./modbus/EMS_Schnittstelle

source/modbus/EMS_Schnittstelle.rst

@@ -14,6 +14,16 @@ Allgemeine Informationen zu der Schnittstelle zwischen BMS und EMS:
 * Der Adressbereicht ist: 10.000...16.000
 
 
+************************
+Verbindungseinstellungen
+************************
+IP-Adresse
+    192.168.42.1
+
+Port
+    502
+
+
 **********
 Datentypen
 **********

source/opcua/opcua_schnittstelle.rst

@@ -0,0 +1,52 @@
+####################
+OPC-UA-Schnittstelle
+####################
+
+Im folgenden wird die OPC-UA Schnittstelled es BMS beschrieben. Diese Schnittstelle
+dient zum aktuellen Zeitpunkt nur zum Auslesen von Prozessdaten. Die Steuerung der Batterie erfolgt ausschließlich
+über die Modbus-Schnittstelle.
+
+
+************************
+Verbindungseinstellungen
+************************
+
+IP-Adresse
+    10.103.32.50
+
+Port
+    4840
+
+Security Policies
+    * Basic256Sha256
+    * Aes256_Sha256_RsaPss
+    * Aes128_Sha256_RsaOaep
+
+
+***************************
+Aufbau des SCADA-Interfaces
+***************************
+Im folgenden wird ein Überblick über das SCADA-Interface des BMS gegeben.
+Das Interface besteht aus einem Array von Datenstrukturen.
+Dabei besteht ist jeder Arrayeintrag einem entsprechendem String zugeordnet.
+Die Root-NodeId für das Interface ist somit folgende: ``ns=4;s=GVL_SCADA.stHMIInterface[i]``,
+wobei ``i = 0`` dem ersten String, ``i = 1`` dem zweiten String etc. entspricht.
+
+Innerhalb eines Strings gibt es jeweils drei weitere Datenstrukturen, welche die drei Module eines Strings repräsentieren.
+Jedes Modul wiederum, besteht aus vier weiteren Datenstrukturen, welche die vier einzelnen Units innerhalb eines Moduls beschreiben.
+Zu guter letzt enthalten die Units Datenstrukturen für alle ihnen zugehörigen Aktoren und Sensoren.
+Diese sind anhand ihrer im R&I (siehe :download:`RuI_Uniper.pdf`) angegebenen Tag-Nummern benannt.
+Somit hat zum Beispiel, der Posolyt Temperatursensor, die Bezeichnung ``stT11``.
+Die komplette NodeId des Sensors der Unit eins im Modul eins im String eins wäre sommit:::
+
+    ns=4;s=GVL_SCADA.stHMIInterface[0].stHMIInterfaceModule1.stHMIInterfaceUnit1.stT11
+
+Innerhalb dieser Datenstruktur gibt es den Member ``rValue``, welcher den aktuellen Prozesswert enthält.
+Über die Datenstrukturen können noch mehr Informationen ausgelesen werden. Nachfolgend ist eine Liste mit NodeIds,
+welche die Werte auflistet, welche sich als interessant zu beobachten herausgestellt haben.
+
+
+*******
+NodeIds
+*******
+Eine Auflistung aller NodeIds, deren Datentyp, Einheit und Beschreibung ist in der Datei :download:`node_list.ods` zu finden.