Konektor MQTT v3
Publikujte aktuální data zařízení a strategií do vlastního brokeru MQTT a přijímejte z něj příkazy.
→ Přehled
Konektor MQTT v3 připojí řídicí jednotku jako klienta k brokeru MQTT, který si zvolíte, například k brokeru systému správy budovy, systému SCADA nebo platformy pro domácí automatizaci. Řídicí jednotka poté publikuje aktuální hodnoty všech zařízení a strategií, ceny elektřiny a zprávu keep-alive a naslouchá příkazům, například setpointům zařízení, zapnutí a vypnutí strategie, plánům externího EMS a nastavení sítě.
Konektor je vypnutý, dokud nezadáte Host. Je nezávislý na připojení k Reduxi Cloud; obě mohou běžet současně.
Kdokoli, kdo může na vašem brokeru publikovat do příkazových topiců řídicí jednotky, může měnit setpointy zařízení, vypínat strategie, měnit limity sítě a restartovat řídicí jednotku. Použijte broker s ověřením uživatele, dejte řídicí jednotce vlastní účet a právo zápisu do controllers/<Unit ID>/…/set a controllers/<Unit ID>/commands/… povolte pouze důvěryhodným klientům.
1 Připojení k brokeru
2 Parametry
Status
| Parametr | Co dělá | Jednotka / výchozí hodnota |
|---|---|---|
| Client | ID klienta MQTT, které řídicí jednotka používá. Je to Unit ID řídicí jednotky a tvoří také každý topic: controllers/<Unit ID>/…. Pouze pro čtení. |
text |
| Host | Broker, na který ukazuje uložená konfigurace. Prázdné = konektor vypnutý. Pouze pro čtení. | text |
| Connected | Zelená značka zatržení = připojeno k brokeru; červený křížek = nepřipojeno. Pouze pro čtení. | — |
| Ikona obnovení | Znovu načte stav. | — |
Mqtt connection
| Parametr | Co dělá | Jednotka / výchozí hodnota |
|---|---|---|
| Host | Název hostitele nebo adresa IP brokeru. Chcete-li konektor vypnout, ponechte prázdné. | text · prázdné = vypnuto |
| Port | Port TCP brokeru. | číslo · výchozí 1883 |
| Username | Uživatelské jméno na brokeru. Volitelné. | text |
| Password | Heslo na brokeru. Používá se pouze společně s Username. Pole zobrazuje heslo jako prostý text. | text |
| Use SSL | Yes naváže spojení se šifrováním TLS. Pokud jste jej nikdy nenastavili, zapne se automaticky, jakmile je uložen řetězec CA serveru nebo klientský certifikát. | Yes / No · výchozí No |
| Verify server cert | Yes zkontroluje certifikát brokeru podle Server CA chain (nebo podle vestavěných důvěryhodných autorit řídicí jednotky, pokud není nahrán žádný řetězec). No přijme jakýkoli certifikát: spojení je šifrované, ale řídicí jednotka nekontroluje, s kým komunikuje. Používá se pouze při Use SSL = Yes. | Yes / No · výchozí No |
| Server CA chain (PEM format) | Certifikát (řetězec) autority, která podepsala certifikát brokeru. Klikněte na Choose File a vyberte soubor PEM. Po uložení pole místo toho zobrazuje tlačítko Download. | soubor PEM |
| Client public certificate (PEM format) | Vlastní klientský certifikát řídicí jednotky pro brokery, které ověřují klienty certifikátem (vzájemné TLS). Vyžaduje odpovídající soukromý klíč. | soubor PEM |
| Client private key (PEM format) | Soukromý klíč klientského certifikátu. | soubor PEM |
Soukromý klíč klienta a heslo k brokeru dávají přístup k vašemu brokeru. Soubory uchovávejte na bezpečném místě, neposílejte je e-mailem a nenechávejte jejich kopie na sdílených počítačích. Kdokoli s přístupem k této stránce Configurator si může stáhnout uložené certifikáty a zobrazit heslo.
U uloženého certifikátu se zobrazuje pouze tlačítko Download. Chcete-li nahrát jiný, klikněte na Clear connection configuration a poté zadejte celé připojení znovu s novými soubory.
Additional topics
| Parametr | Co dělá | Jednotka / výchozí hodnota |
|---|---|---|
| Name or path | Topic, který se má publikovat, vzhledem k controllers/<Unit ID>/. Například site/name se publikuje jako controllers/<Unit ID>/site/name. Řádky s prázdným názvem se přeskočí. |
text |
| Payload | Pevný text publikovaný v tomto topicu. | text |
| Add | Přidá prázdný řádek. | — |
| Ikona koše | Odstraní řádek. Projeví se po Save. | — |
Další topicy se publikují společně s metadaty řídicí jednotky: při každém připojení konektoru k brokeru a při každém odeslání commands/refresh brokerem.
Publikování a tlačítka
| Parametr | Co dělá | Jednotka / výchozí hodnota |
|---|---|---|
| Readout interval | Jak často řídicí jednotka publikuje odečet a setpoint každého zařízení a odečet, stav a hodnoty parametrů každé strategie. Nižší hodnoty dávají aktuálnější data, ale vyšší provoz. | s · prázdné = 60 s · minimum 0.25 s |
| Uložte | Uloží nastavení a restartuje konektor. Zaznamená se do Audit log jako CONNECTOR_EDIT. |
— |
| Clear connection configuration | Po potvrzení Are you sure to clear MQTT settings? (Yes / Cancel) odstraní host, port, uživatelské jméno, heslo, nastavení SSL a všechny certifikáty. Konektor se vypne. Readout interval a Additional topics zůstanou zachovány. | — |
Po Clear connection configuration řídicí jednotka přes MQTT již nepublikuje data a nepřijímá příkazy. Systém, který na datech závisí nebo odesílá plány externího EMS, je přestane přijímat nebo doručovat. Pro opětovné připojení musíte znovu zadat heslo a nahrát certifikáty.
3 Topicy
Všechny topicy začínají controllers/<Unit ID>/. Řídicí jednotka publikuje s QoS 0 a bez příznaku retain a příkazové topicy odebírá s QoS 1. Payloady jsou JSON nebo prosté hodnoty; úplné formáty payloadů jsou v článku nápovědy „Reduxi Controller - MQTT API“.
Publikuje řídicí jednotka:
| Topic | Obsah | Kdy |
|---|---|---|
identifier |
Identifikace řídicí jednotky (Unit ID, verze, …) | Při připojení a při commands/refresh
|
settings/interval/readout, settings/interval/keepAlive
|
Aktuální intervaly v ms | Při připojení a při obnovení |
devices/list, devices/types, devices/<id>/info
|
Nakonfigurovaná zařízení a jejich typy | Při připojení a při obnovení |
strategies/list, strategies/types, strategies/<id>/info, strategies/<id>/parameters/list, strategies/<id>/parameters/<id>/info
|
Nakonfigurované strategie a jejich parametry | Při připojení a při obnovení |
<additional topic> |
Payload z Additional topics | Při připojení a při obnovení |
devices/<id>/readout |
Aktuální hodnoty zařízení | V každém intervalu odečtu |
devices/<id>/setpoint |
Aktuální setpoint zařízení | V každém intervalu odečtu |
strategies/<id>/active, strategies/<id>/readout, strategies/<id>/parameters/<id>/value
|
Zapnutí a vypnutí strategie, aktuální hodnoty, hodnoty parametrů | V každém intervalu odečtu |
prices |
Ceny elektřiny na dnešek a zítřek | Při připojení, při změně cen, při prices/refresh
|
strategies/<id>/externalEMS/<type> |
Uložený plán externího EMS (battery, evse, hvac, pv) |
Při …/externalEMS/<type>/refresh
|
keepAlive |
Aktuální čas (Unix ms) | V každém intervalu keep-alive, výchozí 60 s |
Příkazy, které řídicí jednotka přijímá:
| Topic | Účinek |
|---|---|
commands/refresh |
Znovu publikuje topicy s metadaty. |
commands/reboot |
Restartuje řídicí jednotku přibližně o 5 s později. |
prices/refresh |
Znovu publikuje prices. |
settings/interval/readout/set |
Změní interval odečtu (ms) a uloží jej. |
settings/interval/keepAlive/set |
Změní interval keep-alive (ms) a uloží jej. |
devices/<id>/setpoint/set |
Nastaví setpoint zařízení. |
strategies/<id>/parameters/<id>/value/set |
Nastaví parametr strategie. |
strategies/<id>/active/set |
Zapne nebo vypne strategii. |
strategies/<id>/externalEMS/<type>/set |
Nahraje plán externího EMS pro battery, evse, hvac nebo pv. Ignoruje se, pokud strategie nemá režim optimalizace External EMS. |
strategies/<id>/externalEMS/<type>/refresh |
Publikuje uložený plán externího EMS. |
settings/grid/set |
Změní nastavení sítě (poloha, pojistky, limit odběru a dodávky), volitelně i ve vybraných strategiích. |
settings/grid/set přepíše hodnoty v Settings → Grid a na požádání i limity strategií – stejný účinek jako uložení stránky Grid settings. devices/<id>/setpoint/set zapíše setpoint přímo do zařízení. Neposílejte setpointy zařízení, které řídí také strategie, jinak se budou vzájemně přepisovat.
4 Řešení potíží
| Příznak | Co zkontrolovat |
|---|---|
| Connected zůstává červené | Host a Port jsou správně; řídicí jednotka dosáhne na broker (TCP port test na hostitele a port brokeru); uživatelské jméno a heslo; u TLS řetězec CA odpovídá certifikátu brokeru, nebo zkuste Verify server cert = No a zúžíte tak příčinu problému. |
| Připojeno, ale na brokeru nejsou žádná data | Odebírejte controllers/# a zkontrolujte hodnotu Client: topicy používají Unit ID přesně tak, jak je tam zobrazeno. |
| Příkazy nemají žádný účinek | Klient, který je odesílá, má na brokeru právo publikovat; topic používá správné ID zařízení nebo strategie (viz devices/list, strategies/list). |
5 Kontrolní seznam
- Host a Port odpovídají brokeru a Connected po obnovení zobrazuje zelenou značku zatržení.
- Na ostrých objektech: Use SSL = Yes, řetězec CA je nahrán a Verify server cert = Yes.
- Data přicházejí pod
controllers/<Unit ID>/v nastaveném Readout interval. - Právo zápisu do příkazových topiců je omezeno na důvěryhodné klienty na brokeru.
- Soubory certifikátů a hesla jsou bezpečně uložena mimo řídicí jednotku.