.. include:: ./macros.txt
.. include:: ./units.txt

.. Uniper Dokumentation documentation master file, created by
   sphinx-quickstart on Tue May 13 11:42:50 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Uniper Dokumentation
====================

Willkommen zur Dokumentation des Uniperprojektes.

.. note::

   Die aktuelle Version der Dokumentation wurde generiert am |timestamp|.

.. warning::

   Der aktuelle Stand der Schnittstellen zwischen BMS und EMS, sowie über diese übermittelten Fehlermdeldungen,
   sind noch nicht final und können sich noch ändern.

Die Dokumentation gliedert sich in folgende Teile:

#. Generelle Übersicht
#. Betriebsmodi
#. OPC-UA Schnittstellenbeschreibung
#. Modbus-TCP/IP Schnittstellenbeschreibung
#. Fehlermeldungen
#. Entwickler Handbuch

Der erste Teil soll ein Bild über das gesamte System vermitteln:

- Wie ist die Batterie aufgebaut
- Welche Sicherheitsfunktionen sind vorhanden
- Wie ist die Kommunikation zwischen den einzelnen Komponenten geregelt

Der zweite Teil handelt von den möglichen Betriebsarten der Batterie:

- Automatik Remote
- Automatik Lokal
- Manuell
- Balancing
- Safety Check

Im drittel Teil wird die zur verfügung gestellte OPC-UA-Schnittstelle beschrieben:

- Verbindung zum OPC-UA-Server aufbauen
- Welche Werte können gelesen werden und was bedeuten sie

Im vierten Teil wird die Kommunikationsschnittstelle zwischen BMS und EMS beschrieben

- Allgemeine Verbindungsparameter
- Registerbeschreibungen
- Watchdog
- Verhalten bei Verbindungsabbruch

Der fünfte Teil handelt von den möglichen auftretenden Fehlern und wie sie zu beheben sind:

- Fehlermeldungen vom BMS an das EMS
- Fehlermeldungen per OPC-UA-Server

Der letzte Teil ist für die CMBlu eigenen Entwickler gedacht und beschreibt die Coding- und 
Dokumentations-Regeln

Alle genannten Abschnitte sind hier zu finden:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   ./general_overview/changelog
   ./modbus/EMS_Schnittstelle