https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/Recent content in MQTT API on GbbOptimizer — ManualHugoenhttps://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/signals/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/signals/<h1 id="mqtt-signals">MQTT Signals<a class="anchor" href="#mqtt-signals">#</a></h1> <p>GbbOptimizer sends signals to external programs (e.g. Home Assistant) every hour, based on the forecast for the current hour.</p> <p>MQTT connection parameters (address, port, TLS, ClientID) — see <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/request-response/">Request / Response</a>.</p> <blockquote class='book-hint note'> <ul> <li>Signals must first be enabled in the <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/configuration/discharging/">Discharge</a> module</li> <li>A given signal is not sent if the &ldquo;X&rdquo; parameter is not defined (field empty)</li> </ul></blockquote><h2 id="binary-signals">Binary Signals<a class="anchor" href="#binary-signals">#</a></h2> <p>External programs can subscribe to the following topics:</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; if SOC ≥ X, otherwise &#34;0&#34;</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/request-response/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/request-response/<h1 id="mqtt-request-and-response">MQTT Request and Response<a class="anchor" href="#mqtt-request-and-response">#</a></h1> <p>GbbOptimizer supports request/response queries over MQTT. An external program sends a request and GbbOptimizer replies with data.</p> <h2 id="connection">Connection<a class="anchor" href="#connection">#</a></h2> <p>The external program should connect to MQTT with the following parameters:</p> <table> <thead> <tr> <th>Parameter</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Address</td> <td>See <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/references/mqtt-servers/">MQTT servers</a></td> </tr> <tr> <td>Port</td> <td>8883</td> </tr> <tr> <td>Username</td> <td><code>{PlantId}</code></td> </tr> <tr> <td>Password</td> <td><code>{PlantToken}</code></td> </tr> <tr> <td>UseTLS</td> <td>true</td> </tr> <tr> <td>ClientID</td> <td>must end with <code>_{PlantId}</code></td> </tr> </tbody> </table> <h2 id="topics">Topics<a class="anchor" href="#topics">#</a></h2> <table> <thead> <tr> <th>Direction</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>For backward compatibility the program also handles <code>{PlantId}/dataserver/serverrequest</code> and <code>{PlantId}/dataserver/serverresponse</code> (not recommended).</p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/data-commands/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/data-commands/<h1 id="mqtt-data-commands">MQTT Data Commands<a class="anchor" href="#mqtt-data-commands">#</a></h1> <p>Commands that allow external programs to modify data in GbbOptimizer. Each command sends data to a dedicated topic and receives a result on <code>{PlantId}/ha_gbb/api/result</code>.</p> <h2 id="command-result">Command Result<a class="anchor" href="#command-result">#</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">Result of each data command — OK or error description</p></div> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td>string?</td> <td>Copied from the request</td> </tr> <tr> <td><code>Result</code></td> <td>string</td> <td><code>&quot;OK&quot;</code> or error description</td> </tr> <tr> <td><code>Data</code></td> <td>object</td> <td>Data from the original 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">Set manual energy prices</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>Field</th> <th></th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>no</td> <td>Text copied to the response</td> </tr> <tr> <td><code>Data</code></td> <td></td> <td>array</td> <td>yes</td> <td></td> </tr> <tr> <td></td> <td><code>Date</code></td> <td>date</td> <td>yes</td> <td>Price date</td> </tr> <tr> <td></td> <td><code>StartHour</code></td> <td>int (0-23)</td> <td>yes</td> <td>Start hour</td> </tr> <tr> <td></td> <td><code>StartMinute</code></td> <td>int (0-59)</td> <td>no</td> <td>Minute (default 0)</td> </tr> <tr> <td></td> <td><code>PurchasePrice</code></td> <td>decimal</td> <td>no</td> <td>Purchase price</td> </tr> <tr> <td></td> <td><code>TransferPrice</code></td> <td>decimal</td> <td>no</td> <td>Transfer price</td> </tr> <tr> <td></td> <td><code>SalePrice</code></td> <td>decimal</td> <td>no</td> <td>Sale price</td> </tr> </tbody> </table> <p><strong>Example:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/ha-topics/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/ha-topics/<h1 id="mqtt-topics-for-home-assistant">MQTT Topics for Home Assistant<a class="anchor" href="#mqtt-topics-for-home-assistant">#</a></h1> <p>Topics used for communication between GbbOptimizer and Home Assistant / GbbConnect.</p> <h2 id="data-from-home-assistant-to-gbboptimizer">Data from Home Assistant to GbbOptimizer<a class="anchor" href="#data-from-home-assistant-to-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">HA sensor data — cumulative counters</p></div> <p><strong>Required fields:</strong></p> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>soc_perc</code></td> <td>decimal</td> <td>Battery SOC (%). Use <code>V</code> if &ldquo;Control via V&rdquo; is checked</td> </tr> <tr> <td><code>loads_total_kWh</code></td> <td>decimal</td> <td>Consumption — cumulative counter</td> </tr> <tr> <td><code>fromgrid_total_kWh</code></td> <td>decimal</td> <td>Grid import — cumulative counter</td> </tr> <tr> <td><code>togrid_total_kWh</code></td> <td>decimal</td> <td>Grid export — cumulative counter</td> </tr> <tr> <td><code>pv_total_kWh</code></td> <td>decimal</td> <td>PV production — cumulative counter</td> </tr> </tbody> </table> <p><strong>Optional fields:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/modbus-in-mqtt/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/modbus-in-mqtt/<h1 id="modbusinmqtt-protocol">ModbusInMqtt Protocol<a class="anchor" href="#modbusinmqtt-protocol">#</a></h1> <p>Communication protocol between GbbOptimizer and <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/references/glossary/#gbbconnect2" class="glossary-term" title="Local software for direct inverter connection">GbbConnect2</a> — transferring Modbus commands over 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 commands sent to GbbConnect2</p></div> <table> <thead> <tr> <th>Field</th> <th></th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>OrderId</code></td> <td></td> <td>string</td> <td>no</td> <td>Text copied to the response</td> </tr> <tr> <td><code>Lines</code></td> <td></td> <td>array</td> <td>yes</td> <td></td> </tr> <tr> <td></td> <td><code>LineNo</code></td> <td>int</td> <td>yes</td> <td>Line number</td> </tr> <tr> <td></td> <td><code>Tag</code></td> <td>string</td> <td>no</td> <td>Arbitrary text copied to the response</td> </tr> <tr> <td></td> <td><code>Timestamp</code></td> <td>int</td> <td>no</td> <td>Unix UTC time (seconds)</td> </tr> <tr> <td></td> <td><code>Modbus</code></td> <td>string</td> <td>yes</td> <td>Modbus command to be sent to the inverter</td> </tr> <tr> <td><code>LogLevel</code></td> <td></td> <td>string</td> <td>no</td> <td>Change log level: <code>OnlyErrors</code>, <code>Min</code>, <code>Max</code></td> </tr> <tr> <td><code>SendLastLog</code></td> <td></td> <td>int</td> <td>no</td> <td>1 = attach logs to response (incrementally)</td> </tr> </tbody> </table> <p><strong>Example:</strong></p>https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/evcc-topics/Mon, 01 Jan 0001 00:00:00 +0000https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/mqtt-api/evcc-topics/<h1 id="mqtt-topics-for-evcc">MQTT Topics for EVCC<a class="anchor" href="#mqtt-topics-for-evcc">#</a></h1> <p>GbbOptimizer integration with <a href="https://evcc.io/">evcc.io</a> via MQTT.</p> <h2 id="configuration">Configuration<a class="anchor" href="#configuration">#</a></h2> <p>In the Mosquitto (or HA) broker, create a bridge configuration file:</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 address<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 server addresses — see <a href="https://krzysztofhajdamowicz.github.io/rewrite-GbbOptimizer-manual/en/references/mqtt-servers/">MQTT servers</a>.</p> <h2 id="data-from-evcc-to-gbboptimizer">Data from EVCC to GbbOptimizer<a class="anchor" href="#data-from-evcc-to-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">Total energy consumed by the charger (kWh)</p>