Konektor MQTT v3
Publikujte aktuálne údaje zariadení a stratégií do vlastného brokera MQTT a prijímajte z neho príkazy.
→ Prehľad
Konektor MQTT v3 pripája kontrolér ako klienta k brokeru MQTT, ktorý si zvolíte, napríklad k brokeru systému správy budovy, systému SCADA alebo platformy domácej automatizácie. Kontrolér potom publikuje aktuálne hodnoty všetkých zariadení a stratégií, ceny elektriny a správu keep-alive a počúva príkazy, ako sú zadané hodnoty zariadení, zapnutie a vypnutie stratégie, rozvrhy External EMS a nastavenia rozvodnej siete.
Konektor je vypnutý, kým nezadáte Host. Je nezávislý od pripojenia k Reduxi Cloud; obe môžu bežať súčasne.
Každý, kto môže na vašom brokeri publikovať do príkazových topicov kontroléra, môže meniť zadané hodnoty zariadení, vypínať stratégie, meniť limity rozvodnej siete a reštartovať kontrolér. Používajte broker s overovaním používateľov, dajte kontroléru vlastný účet a právo zápisu do controllers/<Unit ID>/…/set a controllers/<Unit ID>/commands/… povoľte iba dôveryhodným klientom.
1 Pripojenie k brokeru
2 Parametre
Stav
| Parameter | Čo robí | Jednotka / predvolená hodnota |
|---|---|---|
| Client | ID klienta MQTT, ktoré kontrolér používa. Je to Unit ID kontroléra a tvorí aj každý topic: controllers/<Unit ID>/…. Len na čítanie. |
text |
| Host | Broker, na ktorý ukazuje uložená konfigurácia. Prázdne = konektor vypnutý. Len na čítanie. | text |
| Connected | Zelená značka zaškrtnutia = pripojený k brokeru; červený krížik = nepripojený. Len na čítanie. | — |
| Ikona obnovenia | Načíta stav znova. | — |
Mqtt connection
| Parameter | Čo robí | Jednotka / predvolená hodnota |
|---|---|---|
| Host | Názov hostiteľa alebo adresa IP brokera. Ak chcete konektor vypnúť, ponechajte prázdne. | text · prázdne = vypnuté |
| Port | Port TCP brokera. | číslo · predvolene 1883 |
| Username | Používateľské meno na brokeri. Voliteľné. | text |
| Password | Heslo na brokeri. Používa sa iba spolu s Username. Pole zobrazuje heslo ako čistý text. | text |
| Use SSL | Yes otvorí spojenie so šifrovaním TLS. Ak ste ho nikdy nenastavili, zapne sa automaticky, keď je uložený reťazec CA servera alebo certifikát klienta. | Yes / No · predvolene No |
| Verify server cert | Yes overí certifikát brokera voči Server CA chain (alebo voči vstavaným dôveryhodným certifikačným autoritám kontroléra, ak nie je nahraný žiadny reťazec). No prijme akýkoľvek certifikát: spojenie je šifrované, ale kontrolér nekontroluje, s kým komunikuje. Používa sa iba pri Use SSL = Yes. | Yes / No · predvolene No |
| Server CA chain (PEM format) | Certifikát (reťazec) autority, ktorá podpísala certifikát brokera. Kliknite na Choose File a vyberte súbor PEM. Po uložení pole namiesto toho zobrazuje tlačidlo Download. | súbor PEM |
| Client public certificate (PEM format) | Vlastný certifikát klienta kontroléra pre brokery, ktoré overujú klientov certifikátom (vzájomné TLS, mutual TLS). Vyžaduje zodpovedajúci súkromný kľúč. | súbor PEM |
| Client private key (PEM format) | Súkromný kľúč certifikátu klienta. | súbor PEM |
Súkromný kľúč klienta a heslo brokera umožňujú prístup k vášmu brokeru. Súbory uchovávajte na bezpečnom mieste, neposielajte ich e-mailom a nenechávajte kópie na zdieľaných počítačoch. Každý, kto má prístup na túto stránku v Reduxi Configurator, si môže stiahnuť uložené certifikáty a zobraziť heslo.
Uložený certifikát zobrazuje iba tlačidlo Download. Ak chcete nahrať iný, kliknite na Clear connection configuration a potom zadajte celé pripojenie znova s novými súbormi.
Additional topics
| Parameter | Čo robí | Jednotka / predvolená hodnota |
|---|---|---|
| Name or path | Topic na publikovanie, relatívny voči controllers/<Unit ID>/. Napríklad site/name sa publikuje ako controllers/<Unit ID>/site/name. Riadky s prázdnym názvom sa preskočia. |
text |
| Payload | Pevný text publikovaný v danom topicu. | text |
| Add | Pridá prázdny riadok. | — |
| Ikona koša | Odstráni riadok. Prejaví sa po Save. | — |
Dodatočné topicy sa publikujú spolu s metadátami kontroléra: pri každom pripojení konektora k brokeru a pri každom odoslaní commands/refresh brokerom.
Publikovanie a tlačidlá
| Parameter | Čo robí | Jednotka / predvolená hodnota |
|---|---|---|
| Readout interval | Ako často kontrolér publikuje nameranú a zadanú hodnotu každého zariadenia a nameranú hodnotu, stav a hodnoty parametrov každej stratégie. Nižšie hodnoty dávajú aktuálnejšie údaje, ale viac prevádzky. | s · prázdne = 60 s · minimum 0.25 s |
| Uložte | Uloží nastavenia a reštartuje konektor. Zaznamená sa v Audit log ako CONNECTOR_EDIT. |
— |
| Clear connection configuration | Po potvrdení Are you sure to clear MQTT settings? (Yes / Cancel) vymaže hostiteľa, port, používateľské meno, heslo, nastavenia SSL a všetky certifikáty. Konektor sa vypne. Readout interval a Additional topics sa zachovajú. | — |
Po Clear connection configuration kontrolér cez MQTT už nepublikuje údaje ani neprijíma príkazy. Systém, ktorý sa na údaje spolieha alebo posiela rozvrhy External EMS, ich prestane prijímať alebo doručovať. Ak sa chcete znova pripojiť, musíte znova zadať heslo a nahrať certifikáty.
3 Topicy
Všetky topicy začínajú controllers/<Unit ID>/. Kontrolér publikuje s QoS 0 a bez príznaku retain a príkazové topicy odoberá s QoS 1. Dáta sú vo formáte JSON alebo ako jednoduché hodnoty; úplné formáty dát sú v článku centra pomoci „Reduxi Controller - MQTT API“.
Publikuje kontrolér:
| Topic | Obsah | Kedy |
|---|---|---|
identifier |
Identifikácia kontroléra (unit ID, verzie, …) | Pri pripojení a pri commands/refresh
|
settings/interval/readout, settings/interval/keepAlive
|
Aktuálne intervaly v ms | Pri pripojení a pri refresh |
devices/list, devices/types, devices/<id>/info
|
Nakonfigurované zariadenia a ich typy | Pri pripojení a pri refresh |
strategies/list, strategies/types, strategies/<id>/info, strategies/<id>/parameters/list, strategies/<id>/parameters/<id>/info
|
Nakonfigurované stratégie a ich parametre | Pri pripojení a pri refresh |
<additional topic> |
Payload z Additional topics | Pri pripojení a pri refresh |
devices/<id>/readout |
Aktuálne hodnoty zariadenia | Pri každom intervale odčítania |
devices/<id>/setpoint |
Aktuálna zadaná hodnota zariadenia | Pri každom intervale odčítania |
strategies/<id>/active, strategies/<id>/readout, strategies/<id>/parameters/<id>/value
|
Zapnutie a vypnutie stratégie, aktuálne hodnoty, hodnoty parametrov | Pri každom intervale odčítania |
prices |
Ceny elektriny na dnes a zajtra | Pri pripojení, pri zmene cien, pri prices/refresh
|
strategies/<id>/externalEMS/<type> |
Uložený rozvrh External EMS (battery, evse, hvac, pv) |
Pri …/externalEMS/<type>/refresh
|
keepAlive |
Aktuálny čas (Unix ms) | Pri každom intervale keep-alive, predvolene 60 s |
Príkazy, ktoré kontrolér prijíma:
| Topic | Účinok |
|---|---|
commands/refresh |
Znova publikuje topicy s metadátami. |
commands/reboot |
Reštartuje kontrolér asi o 5 s. |
prices/refresh |
Znova publikuje prices. |
settings/interval/readout/set |
Zmení interval odčítania (ms) a uloží ho. |
settings/interval/keepAlive/set |
Zmení interval keep-alive (ms) a uloží ho. |
devices/<id>/setpoint/set |
Nastaví zadanú hodnotu zariadenia. |
strategies/<id>/parameters/<id>/value/set |
Nastaví parameter stratégie. |
strategies/<id>/active/set |
Zapne alebo vypne stratégiu. |
strategies/<id>/externalEMS/<type>/set |
Nahrá rozvrh External EMS pre battery, evse, hvac alebo pv. Ignoruje sa, pokiaľ stratégia nemá režim optimalizácie External EMS. |
strategies/<id>/externalEMS/<type>/refresh |
Publikuje uložený rozvrh External EMS. |
settings/grid/set |
Zmení nastavenia rozvodnej siete (lokalita, poistky, limit importu a exportu), voliteľne aj vo vybraných stratégiách. |
settings/grid/set prepíše hodnoty v Settings → Grid a, ak je to požadované, aj limity stratégií: rovnaký účinok ako uloženie stránky Grid settings. devices/<id>/setpoint/set zapíše zadanú hodnotu priamo do zariadenia. Neposielajte zadané hodnoty zariadenia, ktoré ovláda aj stratégia, inak sa budú navzájom prepisovať.
4 Riešenie problémov
| Príznak | Čo skontrolovať |
|---|---|
| Connected zostáva červené | Host a Port sú správne; kontrolér dosiahne broker (TCP port test na hostiteľa a port brokera); používateľské meno a heslo; pri TLS reťazec CA zodpovedá certifikátu brokera, alebo skúste Verify server cert = No, aby ste problém zúžili. |
| Pripojený, ale na brokeri nie sú žiadne údaje | Odoberajte controllers/# a skontrolujte hodnotu Client: topicy používajú Unit ID presne tak, ako je tam zobrazené. |
| Príkazy nemajú účinok | Klient, ktorý ich posiela, má na brokeri právo publikovať; topic používa správne ID zariadenia alebo stratégie (pozrite devices/list, strategies/list). |
5 Kontrolný zoznam
- Host a Port zodpovedajú brokeru a Connected po obnovení zobrazuje zelenú značku zaškrtnutia.
- Na produkčných lokalitách: Use SSL = Yes, reťazec CA je nahraný a Verify server cert = Yes.
- Údaje prichádzajú pod
controllers/<Unit ID>/v nastavenom Readout interval. - Právo zápisu do príkazových topicov je obmedzené na dôveryhodných klientov na brokeri.
- Súbory certifikátov a heslá sú bezpečne uložené mimo kontroléra.