https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/Recent content in MQTT API on GbbOptimizer — PodręcznikHugoplhttps://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/sygnaly/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/sygnaly/<h1 id="sygnały-mqtt">Sygnały MQTT<a class="anchor" href="#sygna%c5%82y-mqtt">#</a></h1> <p>GbbOptimizer wysyła sygnały do zewnętrznych programów (np. Home Assistant) co godzinę, na podstawie prognozy dla bieżącej godziny.</p> <p>Parametry połączenia z MQTT (adres, port, TLS, ClientID) — patrz <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/zapytania-odpowiedzi/">Zapytania / Odpowiedzi</a>.</p> <blockquote class='book-hint note'> <ul> <li>Sygnały muszą być najpierw włączone w module <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/konfiguracja/rozladowanie/">Rozładowanie</a></li> <li>Dany sygnał nie jest wysyłany, jeśli parametr „X&quot; nie jest zdefiniowany (pole puste)</li> </ul></blockquote><h2 id="sygnały-binarne">Sygnały binarne<a class="anchor" href="#sygna%c5%82y-binarne">#</a></h2> <p>Zewnętrzny program może subskrybować następujące tematy:</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; jeśli SOC ≥ X, w przeciwnym razie &#34;0&#34;</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/zapytania-odpowiedzi/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/zapytania-odpowiedzi/<h1 id="zapytania-i-odpowiedzi-mqtt">Zapytania i odpowiedzi MQTT<a class="anchor" href="#zapytania-i-odpowiedzi-mqtt">#</a></h1> <p>GbbOptimizer obsługuje zapytania request/response przez MQTT. Zewnętrzny program wysyła zapytanie, a GbbOptimizer odpowiada z danymi.</p> <h2 id="połączenie">Połączenie<a class="anchor" href="#po%c5%82%c4%85czenie">#</a></h2> <p>Zewnętrzny program powinien połączyć się z MQTT z parametrami:</p> <table> <thead> <tr> <th>Parametr</th> <th>Wartość</th> </tr> </thead> <tbody> <tr> <td>Adres</td> <td>Patrz <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/referencje/serwery-mqtt/">serwery MQTT</a></td> </tr> <tr> <td>Port</td> <td>8883</td> </tr> <tr> <td>Użytkownik</td> <td><code>{PlantId}</code></td> </tr> <tr> <td>Hasło</td> <td><code>{PlantToken}</code></td> </tr> <tr> <td>UseTLS</td> <td>true</td> </tr> <tr> <td>ClientID</td> <td>musi kończyć się na <code>_{PlantId}</code></td> </tr> </tbody> </table> <h2 id="tematy">Tematy<a class="anchor" href="#tematy">#</a></h2> <table> <thead> <tr> <th>Kierunek</th> <th>Temat</th> </tr> </thead> <tbody> <tr> <td>Zapytanie →</td> <td><code>{PlantId}/ha_gbb/dataserver/serverrequest</code></td> </tr> <tr> <td>← Odpowiedź</td> <td><code>{PlantId}/ha_gbb/dataserver/serverresponse</code></td> </tr> </tbody> </table> <blockquote class='book-hint note'> <p>Dla kompatybilności wstecznej program obsługuje też <code>{PlantId}/dataserver/serverrequest</code> i <code>{PlantId}/dataserver/serverresponse</code> (nie rekomendowane).</p></blockquote><h2 id="odpowiedź-z-błędem">Odpowiedź z błędem<a class="anchor" href="#odpowied%c5%ba-z-b%c5%82%c4%99dem">#</a></h2> <p>Każde zapytanie może zwrócić błąd:</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/komendy-danych/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/komendy-danych/<h1 id="komendy-danych-mqtt">Komendy danych MQTT<a class="anchor" href="#komendy-danych-mqtt">#</a></h1> <p>Komendy pozwalające zewnętrznym programom zmieniać dane w GbbOptimizer. Każda komenda wysyła dane na dedykowany temat i otrzymuje wynik na <code>{PlantId}/ha_gbb/api/result</code>.</p> <h2 id="wynik-komend">Wynik komend<a class="anchor" href="#wynik-komend">#</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">Wynik każdej komendy danych — OK lub opis błędu</p></div> <table> <thead> <tr> <th>Pole</th> <th>Typ</th> <th>Opis</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td>string?</td> <td>Skopiowany z zapytania</td> </tr> <tr> <td><code>Result</code></td> <td>string</td> <td><code>&quot;OK&quot;</code> lub opis błędu</td> </tr> <tr> <td><code>Data</code></td> <td>object</td> <td>Dane z oryginalnego zapytania</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">Ustaw ręczne ceny energii</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>Pole</th> <th></th> <th>Typ</th> <th>Wymagane</th> <th>Opis</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>nie</td> <td>Tekst skopiowany do odpowiedzi</td> </tr> <tr> <td><code>Data</code></td> <td></td> <td>tablica</td> <td>tak</td> <td></td> </tr> <tr> <td></td> <td><code>Date</code></td> <td>date</td> <td>tak</td> <td>Data ceny</td> </tr> <tr> <td></td> <td><code>StartHour</code></td> <td>int (0-23)</td> <td>tak</td> <td>Godzina rozpoczęcia</td> </tr> <tr> <td></td> <td><code>StartMinute</code></td> <td>int (0-59)</td> <td>nie</td> <td>Minuta (domyślnie 0)</td> </tr> <tr> <td></td> <td><code>PurchasePrice</code></td> <td>decimal</td> <td>nie</td> <td>Cena zakupu</td> </tr> <tr> <td></td> <td><code>TransferPrice</code></td> <td>decimal</td> <td>nie</td> <td>Cena przesyłu</td> </tr> <tr> <td></td> <td><code>SalePrice</code></td> <td>decimal</td> <td>nie</td> <td>Cena sprzedaży</td> </tr> </tbody> </table> <p><strong>Przykład:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/tematy-ha/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/tematy-ha/<h1 id="tematy-mqtt-dla-home-assistant">Tematy MQTT dla Home Assistant<a class="anchor" href="#tematy-mqtt-dla-home-assistant">#</a></h1> <p>Tematy używane do komunikacji między GbbOptimizer a Home Assistant / GbbConnect.</p> <h2 id="dane-z-home-assistant-do-gbboptimizer">Dane z Home Assistant do GbbOptimizer<a class="anchor" href="#dane-z-home-assistant-do-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">Dane z czujników HA — liczniki narastające</p></div> <p><strong>Wymagane pola:</strong></p> <table> <thead> <tr> <th>Pole</th> <th>Typ</th> <th>Opis</th> </tr> </thead> <tbody> <tr> <td><code>soc_perc</code></td> <td>decimal</td> <td>SOC baterii (%). Użyj <code>V</code> jeśli zaznaczono „Steruj poprzez V”</td> </tr> <tr> <td><code>loads_total_kWh</code></td> <td>decimal</td> <td>Zużycie — licznik narastający</td> </tr> <tr> <td><code>fromgrid_total_kWh</code></td> <td>decimal</td> <td>Import z sieci — licznik narastający</td> </tr> <tr> <td><code>togrid_total_kWh</code></td> <td>decimal</td> <td>Eksport do sieci — licznik narastający</td> </tr> <tr> <td><code>pv_total_kWh</code></td> <td>decimal</td> <td>Produkcja PV — licznik narastający</td> </tr> </tbody> </table> <p><strong>Opcjonalne pola:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/modbus-in-mqtt/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/modbus-in-mqtt/<h1 id="protokół-modbusinmqtt">Protokół ModbusInMqtt<a class="anchor" href="#protok%c3%b3%c5%82-modbusinmqtt">#</a></h1> <p>Protokół komunikacji między GbbOptimizer a <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/referencje/slowniczek/#gbbconnect2" class="glossary-term" title="Lokalne oprogramowanie do bezpośredniego połączenia z falownikiem">GbbConnect2</a> — transfer komend Modbus przez 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">Komendy Modbus wysyłane do GbbConnect2</p></div> <table> <thead> <tr> <th>Pole</th> <th></th> <th>Typ</th> <th>Wymagane</th> <th>Opis</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>nie</td> <td>Tekst skopiowany do odpowiedzi</td> </tr> <tr> <td><code>Lines</code></td> <td></td> <td>tablica</td> <td>tak</td> <td></td> </tr> <tr> <td></td> <td><code>LineNo</code></td> <td>int</td> <td>tak</td> <td>Numer linii</td> </tr> <tr> <td></td> <td><code>Tag</code></td> <td>string</td> <td>nie</td> <td>Dowolny tekst skopiowany do odpowiedzi</td> </tr> <tr> <td></td> <td><code>Timestamp</code></td> <td>int</td> <td>nie</td> <td>Czas Unix UTC (sekundy)</td> </tr> <tr> <td></td> <td><code>Modbus</code></td> <td>string</td> <td>tak</td> <td>Komenda Modbus do przesłania do falownika</td> </tr> <tr> <td><code>LogLevel</code></td> <td></td> <td>string</td> <td>nie</td> <td>Zmień poziom logów: <code>OnlyErrors</code>, <code>Min</code>, <code>Max</code></td> </tr> <tr> <td><code>SendLastLog</code></td> <td></td> <td>int</td> <td>nie</td> <td>1 = dołącz logi do odpowiedzi (przyrostowo)</td> </tr> </tbody> </table> <p><strong>Przykład:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/tematy-evcc/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/mqtt-api/tematy-evcc/<h1 id="tematy-mqtt-dla-evcc">Tematy MQTT dla EVCC<a class="anchor" href="#tematy-mqtt-dla-evcc">#</a></h1> <p>Integracja GbbOptimizer z <a href="https://evcc.io/">evcc.io</a> przez MQTT.</p> <h2 id="konfiguracja">Konfiguracja<a class="anchor" href="#konfiguracja">#</a></h2> <p>W brokerze Mosquitto (lub HA) stwórz plik konfiguracji bridge:</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>adres MQTT<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>Adresy serwerów MQTT — patrz <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/referencje/serwery-mqtt/">serwery MQTT</a>.</p> <h2 id="dane-z-evcc-do-gbboptimizer">Dane z EVCC do GbbOptimizer<a class="anchor" href="#dane-z-evcc-do-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">Całkowita energia pobrana przez ładowarkę (kWh)</p>