https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/Recent content in MQTT API on GbbOptimizer — HandleidingHugonlhttps://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/signals/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/signals/<h1 id="mqtt-signalen">MQTT-signalen<a class="anchor" href="#mqtt-signalen">#</a></h1> <p>GbbOptimizer verstuurt elk uur signalen naar externe programma&rsquo;s (bijv. Home Assistant) op basis van de prognose voor het lopende uur.</p> <p>MQTT-verbindingsparameters (adres, poort, TLS, ClientID) — zie <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/requests-responses/">Requests / Responses</a>.</p> <blockquote class='book-hint note'> <ul> <li>Signalen moeten eerst worden ingeschakeld in de module <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/configuration/discharging/">Ontladen</a></li> <li>Een signaal wordt niet verstuurd als de parameter „X&quot; niet is gedefinieerd (veld leeg)</li> </ul></blockquote><h2 id="binaire-signalen">Binaire signalen<a class="anchor" href="#binaire-signalen">#</a></h2> <p>Een extern programma kan de volgende topics abonneren:</p> <div class="mqtt-topic-card mqtt-direction--publish"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--publish">PUB</span> <code class="mqtt-topic-path">{PlantId}/signals/SOCHigherEqThanX</code><span class="mqtt-badge mqtt-qos">QoS 0</span></div> <p class="mqtt-topic-description">&#34;1&#34; als SOC ≥ X, anders &#34;0&#34;</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/requests-responses/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/requests-responses/<h1 id="mqtt-requests-en--responses">MQTT-requests en -responses<a class="anchor" href="#mqtt-requests-en--responses">#</a></h1> <p>GbbOptimizer ondersteunt request/response-queries via MQTT. Een extern programma stuurt een request en GbbOptimizer antwoordt met de gegevens.</p> <h2 id="verbinding">Verbinding<a class="anchor" href="#verbinding">#</a></h2> <p>Het externe programma moet verbinding maken met MQTT met de volgende parameters:</p> <table> <thead> <tr> <th>Parameter</th> <th>Waarde</th> </tr> </thead> <tbody> <tr> <td>Adres</td> <td>Zie <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/references/mqtt-servers/">MQTT-servers</a></td> </tr> <tr> <td>Poort</td> <td>8883</td> </tr> <tr> <td>Gebruiker</td> <td><code>{PlantId}</code></td> </tr> <tr> <td>Wachtwoord</td> <td><code>{PlantToken}</code></td> </tr> <tr> <td>UseTLS</td> <td>true</td> </tr> <tr> <td>ClientID</td> <td>moet eindigen op <code>_{PlantId}</code></td> </tr> </tbody> </table> <h2 id="topics">Topics<a class="anchor" href="#topics">#</a></h2> <table> <thead> <tr> <th>Richting</th> <th>Topic</th> </tr> </thead> <tbody> <tr> <td>Request →</td> <td><code>{PlantId}/ha_gbb/dataserver/serverrequest</code></td> </tr> <tr> <td>← Response</td> <td><code>{PlantId}/ha_gbb/dataserver/serverresponse</code></td> </tr> </tbody> </table> <blockquote class='book-hint note'> <p>Voor achterwaartse compatibiliteit ondersteunt het programma ook <code>{PlantId}/dataserver/serverrequest</code> en <code>{PlantId}/dataserver/serverresponse</code> (niet aanbevolen).</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/data-commands/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/data-commands/<h1 id="mqtt-datacommandos">MQTT-datacommando&rsquo;s<a class="anchor" href="#mqtt-datacommandos">#</a></h1> <p>Commando&rsquo;s waarmee externe programma&rsquo;s gegevens in GbbOptimizer kunnen wijzigen. Elk commando stuurt data naar een speciaal topic en ontvangt het resultaat op <code>{PlantId}/ha_gbb/api/result</code>.</p> <h2 id="commandoresultaat">Commandoresultaat<a class="anchor" href="#commandoresultaat">#</a></h2> <div class="mqtt-topic-card mqtt-direction--publish"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--publish">PUB</span> <code class="mqtt-topic-path">{PlantId}/ha_gbb/api/result</code></div> <p class="mqtt-topic-description">Resultaat van elk datacommando — OK of foutbeschrijving</p></div> <table> <thead> <tr> <th>Veld</th> <th>Type</th> <th>Beschrijving</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td>string?</td> <td>Gekopieerd uit de request</td> </tr> <tr> <td><code>Result</code></td> <td>string</td> <td><code>&quot;OK&quot;</code> of foutbeschrijving</td> </tr> <tr> <td><code>Data</code></td> <td>object</td> <td>Gegevens uit de oorspronkelijke request</td> </tr> </tbody> </table> <hr> <details class="mqtt-endpoint" id="endpoint-setmanualprices"> <summary class="mqtt-endpoint-summary"><span class="mqtt-badge mqtt-direction--subscribe">SUB</span><span class="mqtt-endpoint-name">SetManualPrices</span> <span class="mqtt-endpoint-description">Handmatige energieprijzen instellen</span></summary> <div class="mqtt-endpoint-body"> <div class="mqtt-topic-row"><span class="mqtt-badge mqtt-direction--subscribe">SUB</span><code class="mqtt-topic-path">{PlantId}/ha_gbb/api/setmanualprices</code> </div><div class="mqtt-endpoint-content"> <table> <thead> <tr> <th>Veld</th> <th></th> <th>Type</th> <th>Vereist</th> <th>Beschrijving</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>nee</td> <td>Tekst die naar het antwoord wordt gekopieerd</td> </tr> <tr> <td><code>Data</code></td> <td></td> <td>array</td> <td>ja</td> <td></td> </tr> <tr> <td></td> <td><code>Date</code></td> <td>date</td> <td>ja</td> <td>Datum van de prijs</td> </tr> <tr> <td></td> <td><code>StartHour</code></td> <td>int (0-23)</td> <td>ja</td> <td>Beginuur</td> </tr> <tr> <td></td> <td><code>StartMinute</code></td> <td>int (0-59)</td> <td>nee</td> <td>Minuut (standaard 0)</td> </tr> <tr> <td></td> <td><code>PurchasePrice</code></td> <td>decimal</td> <td>nee</td> <td>Inkoopprijs</td> </tr> <tr> <td></td> <td><code>TransferPrice</code></td> <td>decimal</td> <td>nee</td> <td>Transportprijs</td> </tr> <tr> <td></td> <td><code>SalePrice</code></td> <td>decimal</td> <td>nee</td> <td>Verkoopprijs</td> </tr> </tbody> </table> <p><strong>Voorbeeld:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/ha-topics/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/ha-topics/<h1 id="mqtt-topics-voor-home-assistant">MQTT-topics voor Home Assistant<a class="anchor" href="#mqtt-topics-voor-home-assistant">#</a></h1> <p>Topics gebruikt voor communicatie tussen GbbOptimizer en Home Assistant / GbbConnect.</p> <h2 id="gegevens-van-home-assistant-naar-gbboptimizer">Gegevens van Home Assistant naar GbbOptimizer<a class="anchor" href="#gegevens-van-home-assistant-naar-gbboptimizer">#</a></h2> <div class="mqtt-topic-card mqtt-direction--subscribe"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--subscribe">SUB</span> <code class="mqtt-topic-path">{PlantId}/ha_gbb/sensor</code><span class="mqtt-badge mqtt-qos">QoS 0</span></div> <p class="mqtt-topic-description">Gegevens van HA-sensoren — cumulatieve tellers</p></div> <p><strong>Verplichte velden:</strong></p> <table> <thead> <tr> <th>Veld</th> <th>Type</th> <th>Beschrijving</th> </tr> </thead> <tbody> <tr> <td><code>soc_perc</code></td> <td>decimal</td> <td>Batterij-SOC (%). Gebruik <code>V</code> indien „Aansturing via V&quot; is aangevinkt</td> </tr> <tr> <td><code>loads_total_kWh</code></td> <td>decimal</td> <td>Verbruik — cumulatieve teller</td> </tr> <tr> <td><code>fromgrid_total_kWh</code></td> <td>decimal</td> <td>Import uit het net — cumulatieve teller</td> </tr> <tr> <td><code>togrid_total_kWh</code></td> <td>decimal</td> <td>Export naar het net — cumulatieve teller</td> </tr> <tr> <td><code>pv_total_kWh</code></td> <td>decimal</td> <td>PV-productie — cumulatieve teller</td> </tr> </tbody> </table> <p><strong>Optionele velden:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/modbus-in-mqtt/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/modbus-in-mqtt/<h1 id="modbusinmqtt-protocol">ModbusInMqtt-protocol<a class="anchor" href="#modbusinmqtt-protocol">#</a></h1> <p>Protocol voor communicatie tussen GbbOptimizer en <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/references/glossary/#gbbconnect2" class="glossary-term" title="Lokale software voor directe verbinding met de omvormer">GbbConnect2</a> — het overbrengen van Modbus-commando&rsquo;s via MQTT.</p> <h2 id="gbboptimizer--gbbconnect2">GbbOptimizer → GbbConnect2<a class="anchor" href="#gbboptimizer--gbbconnect2">#</a></h2> <div class="mqtt-topic-card mqtt-direction--publish"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--publish">PUB</span> <code class="mqtt-topic-path">{PlantId}/ModbusInMqtt/toDevice</code></div> <p class="mqtt-topic-description">Modbus-commando&#39;s verstuurd naar GbbConnect2</p></div> <table> <thead> <tr> <th>Veld</th> <th></th> <th>Type</th> <th>Vereist</th> <th>Beschrijving</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>nee</td> <td>Tekst die naar het antwoord wordt gekopieerd</td> </tr> <tr> <td><code>Lines</code></td> <td></td> <td>array</td> <td>ja</td> <td></td> </tr> <tr> <td></td> <td><code>LineNo</code></td> <td>int</td> <td>ja</td> <td>Regelnummer</td> </tr> <tr> <td></td> <td><code>Tag</code></td> <td>string</td> <td>nee</td> <td>Willekeurige tekst die naar het antwoord wordt gekopieerd</td> </tr> <tr> <td></td> <td><code>Timestamp</code></td> <td>int</td> <td>nee</td> <td>Unix-tijd UTC (seconden)</td> </tr> <tr> <td></td> <td><code>Modbus</code></td> <td>string</td> <td>ja</td> <td>Modbus-commando om naar de omvormer te sturen</td> </tr> <tr> <td><code>LogLevel</code></td> <td></td> <td>string</td> <td>nee</td> <td>Wijzig logniveau: <code>OnlyErrors</code>, <code>Min</code>, <code>Max</code></td> </tr> <tr> <td><code>SendLastLog</code></td> <td></td> <td>int</td> <td>nee</td> <td>1 = logs bij het antwoord voegen (incrementeel)</td> </tr> </tbody> </table> <p><strong>Voorbeeld:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/evcc-topics/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/mqtt-api/evcc-topics/<h1 id="mqtt-topics-voor-evcc">MQTT-topics voor EVCC<a class="anchor" href="#mqtt-topics-voor-evcc">#</a></h1> <p>Integratie van GbbOptimizer met <a href="https://evcc.io/">evcc.io</a> via MQTT.</p> <h2 id="configuratie">Configuratie<a class="anchor" href="#configuratie">#</a></h2> <p>Maak in de Mosquitto-broker (of HA) een bridge-configuratiebestand:</p> <div class="highlight"><div style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"> <table style="border-spacing:0;padding:0;margin:0;border:0;"><tr><td style="vertical-align:top;padding:0;margin:0;border:0;"> <pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">1 </span><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">2 </span><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">3 </span><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">4 </span><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">5 </span><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">6 </span></code></pre></td> <td style="vertical-align:top;padding:0;margin:0;border:0;;width:100%"> <pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span>connection GbbOptimizer_<span style="color:#f92672">&lt;</span>PlantId<span style="color:#f92672">&gt;</span> </span></span><span style="display:flex;"><span>remote_username <span style="color:#f92672">&lt;</span>PlantId<span style="color:#f92672">&gt;</span> </span></span><span style="display:flex;"><span>remote_password <span style="color:#f92672">&lt;</span>PlantToken<span style="color:#f92672">&gt;</span> </span></span><span style="display:flex;"><span>address <span style="color:#f92672">&lt;</span>MQTT<span style="color:#f92672">-</span>adres<span style="color:#f92672">&gt;</span>:<span style="color:#ae81ff">8883</span> </span></span><span style="display:flex;"><span>bridge_capath <span style="color:#f92672">/</span>etc<span style="color:#f92672">/</span>ssl<span style="color:#f92672">/</span>certs </span></span><span style="display:flex;"><span>topic <span style="color:#75715e"># both 2 evcc/loadpoints/ &lt;PlantId&gt;/evcc/site/loadpoints/</span></span></span></code></pre></td></tr></table> </div> </div><p>MQTT-serveradressen — zie <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/nl/references/mqtt-servers/">MQTT-servers</a>.</p> <h2 id="gegevens-van-evcc-naar-gbboptimizer">Gegevens van EVCC naar GbbOptimizer<a class="anchor" href="#gegevens-van-evcc-naar-gbboptimizer">#</a></h2> <div class="mqtt-topic-card mqtt-direction--subscribe"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--subscribe">SUB</span> <code class="mqtt-topic-path">{PlantId}/evcc/site/statistic/total/chargedKWh</code></div> <p class="mqtt-topic-description">Totale door de lader opgenomen energie (kWh)</p></div> <h2 id="commandos-van-gbboptimizer-naar-evcc">Commando&rsquo;s van GbbOptimizer naar EVCC<a class="anchor" href="#commandos-van-gbboptimizer-naar-evcc">#</a></h2> <div class="mqtt-topic-card mqtt-direction--publish"> <div class="mqtt-topic-header"> <span class="mqtt-badge mqtt-direction--publish">PUB</span> <code class="mqtt-topic-path">{PlantId}/evcc/loadpoints/{chargerId}/mode</code></div> <p class="mqtt-topic-description">Laadmodus: off of now</p>