Added sphinx documentation

This commit is contained in:
Matthias Heisig
2025-04-28 17:15:57 +02:00
parent 94381dc704
commit 0d201a140a
86 changed files with 10280 additions and 0 deletions

211
docs/build/html/GVLs.html vendored Normal file
View File

@@ -0,0 +1,211 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GVLs &mdash; Uniper Dokumentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/translations.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="genindex.html" />
<link rel="search" title="Suche" href="search.html" />
<link rel="next" title="POUs" href="POUs.html" />
<link rel="prev" title="DUTs" href="DUTs.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Uniper
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" aria-label="Dokumentation durchsuchen" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="DUTs.html">DUTs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">GVLs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#gvl-config">GVL_CONFIG</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gvl-modbus">GVL_MODBUS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gvl-scada">GVL_SCADA</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="POUs.html">POUs</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Uniper</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">GVLs</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/GVLs.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="gvls">
<h1>GVLs<a class="headerlink" href="#gvls" title="Permalink to this heading"></a></h1>
<section id="gvl-config">
<h2>GVL_CONFIG<a class="headerlink" href="#gvl-config" title="Permalink to this heading"></a></h2>
<dl class="plc gvl">
<dt class="sig sig-object plc" id="GVL_CONFIG">
<em class="property"><span class="pre">GVL</span><span class="w"> </span></em><span class="sig-name descname"><span class="n"><span class="pre">GVL_CONFIG</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#GVL_CONFIG" title="Link zu dieser Definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">VAR_GLOBAL CONSTANT<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uiNumberOfStrings</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">UINT</span></code></span>) =========================== Number of active strings ===========================</p></li>
<li><p><strong>uiNumberOfUnits</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">UINT</span></code></span>) </p></li>
</ul>
</dd>
<dt class="field-even">VAR_GLOBAL PERSISTENT<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>axStringEnabled</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ARRAY[0..uiNumberOfStrings-1]</span> <span class="pre">OF</span> <span class="pre">BOOL</span></code></span>) </p></li>
<li><p><strong>stUnitConfig</strong> (<span><a class="reference internal" href="DUTs.html#ST_UNIT_CONFIG" title="ST_UNIT_CONFIG"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_UNIT_CONFIG</span></code></a></span>) =========================== Unit hardware config ===========================</p></li>
<li><p><strong>stConfigSCSCurrent</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_ANALOG_IO_CONFIG</span></code></span>) =========================== SCS Current measurement settings ===========================</p></li>
<li><p><strong>stEWLSCSCurrent</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_ANALOG_EW_LEVELS</span></code></span>) </p></li>
<li><p><strong>stEWDSCSCurrent</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_ANALOG_EW_DELAYS</span></code></span>) </p></li>
<li><p><strong>rPumpPosolytOnPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) =========================== General settings =========================== Pump posolyt on power in %</p></li>
<li><p><strong>rPumpNegolytOnPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Pump negolyt on power in %</p></li>
<li><p><strong>rPumpPosolytDisChrgPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Pump posolyt discharge segment without inverter power in %</p></li>
<li><p><strong>rPumpNegolytDisChrgPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Pump posolyt discharge segment without inverter power in %</p></li>
<li><p><strong>rPumpshutoffThreshold</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Unit voltage pumps shutoff threshold (Volt)</p></li>
<li><p><strong>rMinimumUnitVoltage</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Minimum unit voltage required for inverter startup (Volt)</p></li>
<li><p><strong>rMaximumUnitVoltage</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Maximum unit voltage for fully charged (Volt)</p></li>
<li><p><strong>rDeltaUnitVoltageShutdownDischarge</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Delta value to minimum unit voltage for shutdown discharge (Volt)</p></li>
<li><p><strong>rMaxAbsDiffVoltageUnitsOnModule</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Maximum absolute voltage difference between units in the same module</p></li>
<li><p><strong>rMaxAbsDiffVoltageModulesInString</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Maximum absolute voltage difference between Modules (Volt)</p></li>
<li><p><strong>diMinimumAbsPowerForEnable</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">DINT</span></code></span>) Minimum absolute power command to enable battery (Watt)</p></li>
<li><p><strong>diMaxStringChargingPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">DINT</span></code></span>) Maximum allowed charging power (Watt) per String 24.000 W -&gt; 2.000 W per Unit</p></li>
<li><p><strong>diMaxStringDischargePower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">DINT</span></code></span>) Maximum allowed discharging power (Watt) per String 24.000 W -&gt; 2.000 W per Unit</p></li>
<li><p><strong>sInverterIpString1</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">STRING</span></code></span>) Inverter ip address for string 1</p></li>
<li><p><strong>sInverterIpString2</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">STRING</span></code></span>) Inverter ip address for string 2</p></li>
<li><p><strong>rAbsShutdownDischargePower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Absolute shutdown discharge power (Watt) 12.000 W -&gt; 1.000 W per unit</p></li>
<li><p><strong>xShutdownDischargeWithInverter</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">BOOL</span></code></span>) Allow inverter fast shutdown discharge</p></li>
<li><p><strong>rStringFullyChargedVoltage</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) String fully charged voltage (Volt) 960 V -&gt; 80 V per Unit</p></li>
<li><p><strong>rStringEmptyVoltage</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) String empty voltage (Volt) (617V is needed for the inverter to start up -&gt; 55.0V per Segment)</p></li>
<li><p><strong>timUnitStartupTime</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">TIME</span></code></span>) Unit wait startup time</p></li>
<li><p><strong>timUnitBalancingStartupTime</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">TIME</span></code></span>) Unit balancing wait startup time</p></li>
<li><p><strong>timStringReadyTimeout</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">TIME</span></code></span>) All modules in string not ready timeout</p></li>
<li><p><strong>timIsoErrorTimeout</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">TIME</span></code></span>) Timeout for isolation error</p></li>
<li><p><strong>rBalancingFactor</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">REAL</span></code></span>) Balancing factor</p></li>
<li><p><strong>xDummy</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">BOOL</span></code></span>) Attr: analysis := -33, Dummy to deactivate functions</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="gvl-modbus">
<h2>GVL_MODBUS<a class="headerlink" href="#gvl-modbus" title="Permalink to this heading"></a></h2>
<dl class="plc gvl">
<dt class="sig sig-object plc" id="GVL_MODBUS">
<em class="property"><span class="pre">GVL</span><span class="w"> </span></em><span class="sig-name descname"><span class="n"><span class="pre">GVL_MODBUS</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#GVL_MODBUS" title="Link zu dieser Definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">VAR_GLOBAL<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>stModbusEMSComm</strong> (<span><a class="reference internal" href="DUTs.html#ST_EMS_MODBUS_INTERFACE" title="ST_EMS_MODBUS_INTERFACE"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_EMS_MODBUS_INTERFACE</span></code></a></span>) Modbus interface to customer EMS</p></li>
<li><p><strong>stBMSErrorReg</strong> (<span><a class="reference internal" href="DUTs.html#ST_MODBUS_REG_13" title="ST_MODBUS_REG_13"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_MODBUS_REG_13</span></code></a></span>) Addr: 13.000</p></li>
<li><p><strong>awWarningsUnitsActive</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ARRAY[0..(GVL_CONFIG.uiNumberOfUnits-1)]</span> <span class="pre">OF</span> <span class="pre">U_UNIT_WARNING_REGISTER</span></code></span>) Addr: 14.000 -&gt; 14.047 Index 0 -&gt; Unit 1, Index 1 -&gt; Unit 2 etc.</p></li>
<li><p><strong>awErrorsUnitsActive</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ARRAY[0..(GVL_CONFIG.uiNumberOfUnits-1)]</span> <span class="pre">OF</span> <span class="pre">U_UNIT_ERROR_REGISTER</span></code></span>) Addr: 15.000 -&gt; 15.047 Index 0 -&gt; Unit 1, Index 1 -&gt; Unit 2 etc.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="gvl-scada">
<h2>GVL_SCADA<a class="headerlink" href="#gvl-scada" title="Permalink to this heading"></a></h2>
<dl class="plc gvl">
<dt class="sig sig-object plc" id="GVL_SCADA">
<em class="property"><span class="pre">GVL</span><span class="w"> </span></em><span class="sig-name descname"><span class="n"><span class="pre">GVL_SCADA</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#GVL_SCADA" title="Link zu dieser Definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">VAR_GLOBAL<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>stHMIInterface</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ARRAY[0..1]</span> <span class="pre">OF</span> <span class="pre">ST_STRING_HMI_INTERFACE</span></code></span>) Array for string HMI</p></li>
<li><p><strong>stAckAlarmsButton</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_HMI_CONTROL_BUTTON</span></code></span>) Acknowledge alarm button</p></li>
<li><p><strong>stAutomaticModeHMI</strong> (<span><a class="reference internal" href="DUTs.html#ST_AUTO_HMI_INTERFACE" title="ST_AUTO_HMI_INTERFACE"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">ST_AUTO_HMI_INTERFACE</span></code></a></span>) HMI interface to control the battery throught the HMI</p></li>
<li><p><strong>eRequestedControlMode</strong> (<span><a class="reference internal" href="DUTs.html#E_BMS_CONTROL_MODE" title="E_BMS_CONTROL_MODE"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">E_BMS_CONTROL_MODE</span></code></a></span>) Requested control mode by HMI</p></li>
<li><p><strong>eCurrentControlMode</strong> (<span><a class="reference internal" href="DUTs.html#E_BMS_CONTROL_MODE" title="E_BMS_CONTROL_MODE"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">E_BMS_CONTROL_MODE</span></code></a></span>) Current control mode</p></li>
<li><p><strong>xCanChangeControlMode</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">BOOL</span></code></span>) Can change current control mode</p></li>
<li><p><strong>diCurrentBatteryPower</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">DINT</span></code></span>) Current battery power</p></li>
<li><p><strong>lrChargedPowerValueWH</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">LREAL</span></code></span>) Last power charged value</p></li>
<li><p><strong>lrDischargedPowerValueWH</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">LREAL</span></code></span>) Last power discharged value</p></li>
<li><p><strong>lrLastCycleUtilityPowerValueWh</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">LREAL</span></code></span>) Last discharged utility power value</p></li>
<li><p><strong>eCycleStatus</strong> (<span><a class="reference internal" href="DUTs.html#E_CYCLE_STATUS" title="E_CYCLE_STATUS"><code class="xref plc plc-type docutils literal notranslate"><span class="pre">E_CYCLE_STATUS</span></code></a></span>) Cycle status</p></li>
<li><p><strong>xDummy</strong> (<span><code class="xref plc plc-type docutils literal notranslate"><span class="pre">BOOL</span></code></span>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="DUTs.html" class="btn btn-neutral float-left" title="DUTs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="POUs.html" class="btn btn-neutral float-right" title="POUs" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, M.Heisig.</p>
</div>
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>