Omnik data logger architectuur

Het Archimate schema hieronder toont hoe de Omnik data logger componenten werken in jouw omgeving. De oranje onderdelen tonen de omnik datalogger software onderdelen en functies. De blauwe delen tonen hoe de functies kunnen worden gebruikt en hoe ze met elkaar samenwerken. De DSMR net data (Slimme meter via tcp) (magenta) voedt de calculatie voor het berekenen van het verbruik en kan ook uitvoeren naar de output plugins.

Omnik data logger architectuur

De omnikportal client en gespecialiseerde Omnik PV services (en API's) zijn niet langer beschikbaar sinds de 19de april 2021

AppDaemon

Integratie met AppDaemon 4 is optioneel en is ook ondersteund met HACS. Dit is niet ondersteund via de Docker images. Het staat je toe om de code eenvoudig te integreren met Home Assistant en verzekert je er van altijd de laatste versie geïnstalleerd te hebben. Je kun Omnik datalogger ook via Docker of via PIP en te installeren als een service (systemd).

De AppDaemon Add-on kan worden geïnstalleerd vanuit Home Assistant's Build-in Add-on store (via het Supervisor menu) dat wordt meegeïnstalleerd met Home Assistant. De Add-on store is er alleen als je Home Assistant als supervised platform installeert met Home Assistant OS.

Home Assistent Community Store (HACS)

HACS is een community store voor Home Assistant. Het is een custom integratie (NIET ondersteund door Home Assistant) die je toestaat om vele custom integraties, automatiseringen en thema's te installeren. Om dit te installeren, volg je de instructies op https://hacs.xyz. Het gebruik van HACS is optioneel. Je kunt ook de Omnik data logger bestanden (uitgepakte ZIP) op de juiste plaats uit te pakken, maar dat is niet aan te raden.

Klanten

Omnik data logger heeft 3 clients die kunnen worden ingezet voor de data collectie. Je moet er één kiezen. Als je meerdere omvormers hebt, kies dan zo mogelijk een client waarmee je ze allemaal kunt aansluiten. De beschikbare clients zijn:

  • Lokale proxy (met 3 plug-ins)
  • tcpclient
  • solarmanpv

De omnikportal client is niet langer beschikbaar in de laatste versie van Omnik data logger

Solarman PV

Deze client werkt op de zelfde manier als de omnikportal client, maar met een andere API met een betere data kwaliteit. De API is minder veilig (geen data encryptie). De client heeft een configureerbare polling interval en gebruikt je omnik/solarman account om toegang te krijgen tot de API.

TCP-client

Dit is de enige client die ik niet zelf kon testen en is bepasserd op de code van Wouter van de Zwan en pollt je omvormers rechtstreeks via tcp poort 8899 met een configureerbare interval. De data die terugkomt (99 bytes) mist een staart maar heeft verder het zelfde formaat als de data die statisch door de omvormers wordt doorgestuurd naar de SolarMAN logger diensten via 176.58.117.69:10004 (128 bytes).

Lokale proxy

De localproxy client gebruikt onderschepte data om te verwerken. De client wordt geholpen door het omnikloggerproxy script dat elders in het netwerk kan draaien in het netwerk waar je omvormers actief zijn. Om het script in staat te stellen te onderscheppen moet er een statische route voor 176.58.117.69/32 (Subnet mask 255.255.255.255) naar het IP adres van het systeem waarop omnikdataloggerproxy draait worden gemaakt. Met de local proxy client kun je meerdere plugins gelijktijdig laden, dat lijkt zinloos als je maar een proces hebt voor het loggen van een omvormer, maar kan handig zijn bij het debuggen :-)

tcp_proxy (lokale proxy-plug-in)

Je kunt direct het verkeer onderscheppen met de localproxy plugin, door de tcp_proxy plugin te gebruiken (dit werkt overigens niet fijn samen met Home Assistant supervised), maar je kunt ook het omnikloggerproxyscript (in forward mode) er nog tussen plakken. Het gebruik van deze plugin vereist dat poort 10004 geopend kan worden en zo het logger verkeer te herrouteren.

mqtt_proxy (lokale proxy-plug-in)

Als je er voor kiest het omnikloggerproxy script in te zetten dan heb je ook de mogelijkheid om MQTT forwarding te gebruiken. Dit zorgt er voor dat de binaire data updates (128 bytes) via MQTT worden gepubliceerd. Omnik data logger van via de localproxy client met mqtt_proxy plugin de updates vervolgens verwerken. In combinatie met AppDaemon kun je ook de hassapi plugin gebruiken, waardoor je direct aansluit op Home Assistant.

hassapi (lokale proxy-plug-in)

Alleen beschikbaar wanneer je Omnik data logger gebruikt icm AppDaemon en in combinatie met de Home Assistant Community Store (HACS). Wanneer er is geïnstalleerd met AppDaemon lam Omnik datalogger worden geconfigureerd vanuit de apps.yaml congfig van AppDaemon en kun je de logging benaderen via de ingebouwde Home Assistant API door direct de entity_id van het Datalogger object in te stellen.

Uitvoer plug-ins

Je kunt (meerdere) output plugins configureren om de data van je omvormers en slimme meter naar een InfluxDB te sturen, een MQTT broker of naar pvoutput.org. Een plugin voor MySQL/MariaDB en CSV export volgt mogelijk later. Laat me weten als hier een behoefte voor is.

Documentatie

Zie de de geavanceerde README.md (Engelstalig) op https://github.com/jbouwh/omnikdatalogger voor meer details over de configuratie van Omnik datalogger en het omnikdataloggerproxy script. wiki pagina's zullen je helpen te kiezen tussen de beschikbare plugins en clients. Er zijn ook Nederlandstalige Wiki pagina's op deze website te vinden.