Skip to content

Docker containerized version of the json-live-data-server from resol-vbus.

License

Notifications You must be signed in to change notification settings

cRemE-fReSh/resol-vbus_json-live-data-server_docker

Repository files navigation

Containerized Resol VBUS to Data Server

Docker containerized version of the json-live-data-server from resol-vbus.
It's a simple webserver to publish data (JSON and prometheus) of an tcp based vbus device.
Relevant configuration parameters are configurable via docker environment variables.
There's no need to create a customized docker file per configuration.

Versioning

Versioning is analog to resol-vbus version.

Docker Hub

example workflow
example workflow
Docker container ready to pull from Docker Hub:
https://registry.hub.docker.com/r/cftechnologies/vbustowebserver/

Docker Environment Variables

Description

VBUSIP: The host name / IP address of the VBus/LAN or Datalogger device.
VBUSPASSWORD: The password for the VBus/LAN or Datalogger device.
HTTPPORT: The port number for the HTTP server to listen to.
LOGGINGINTERVAL: The inteval in milliseconds between two writes of the logging file.

Example

VBUSIP=192.168.0.2
VBUSPASSWORD=vbus
HTTPPORT=3333
LOGGINGINTERVAL=10000

Node-RED Example Flows

Home Assistant

Below an example (just import to your node red flow) to fetch data from the server via JSON and write it into HA Entities.

[{"id":"866f040.a0dc","type":"tab","label":"Solarthermie","disabled":false,"info":""},{"id":"9dfb4a61.a2689","type":"http request","z":"866f040.a0dc","name":"","method":"GET","ret":"obj","paytoqs":"ignore","url":"http://192.168.188.45:3333/api/v1/live-data","tls":"","persist":false,"proxy":"","authType":"","credentials":{},"x":370,"y":120,"wires":[["359fd186707d75b5","c893040cde3b088a","a06b7e907cedafb7","5f23bb57b752de12"]]},{"id":"3d61cadb.e05996","type":"inject","z":"866f040.a0dc","name":"1min","repeat":"60","crontab":"","once":false,"onceDelay":"","topic":"","payload":"","payloadType":"date","x":210,"y":120,"wires":[["9dfb4a61.a2689"]]},{"id":"359fd186707d75b5","type":"ha-entity","z":"866f040.a0dc","name":"SolarTempCollektor","server":"ed0e528f.b8b9f","version":1,"debugenabled":false,"outputs":1,"entityType":"sensor","config":[{"property":"name","value":"SolarTempCollektor"},{"property":"device_class","value":"temperature"},{"property":"icon","value":"mdi:solar-panel"},{"property":"unit_of_measurement","value":"°C"}],"state":"payload[1].rawValue","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":780,"y":120,"wires":[[]]},{"id":"c893040cde3b088a","type":"ha-entity","z":"866f040.a0dc","name":"Solar_Temp_WaterBufferVesselBelow","server":"ed0e528f.b8b9f","version":1,"debugenabled":false,"outputs":1,"entityType":"sensor","config":[{"property":"name","value":"SolarTempWaterBufferVesselBelow"},{"property":"device_class","value":"temperature"},{"property":"icon","value":"mdi:thermometer-low"},{"property":"unit_of_measurement","value":"°C"}],"state":"payload[2].rawValue","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":790,"y":180,"wires":[[]]},{"id":"a06b7e907cedafb7","type":"ha-entity","z":"866f040.a0dc","name":"Solar_Temp_Pipe","server":"ed0e528f.b8b9f","version":1,"debugenabled":false,"outputs":1,"entityType":"sensor","config":[{"property":"name","value":"SolarTempPipe"},{"property":"device_class","value":"temperature"},{"property":"icon","value":"mdi:pipe"},{"property":"unit_of_measurement","value":"°C"}],"state":"payload[3].rawValue","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":770,"y":240,"wires":[[]]},{"id":"5f23bb57b752de12","type":"ha-entity","z":"866f040.a0dc","name":"Solar_PumpSpeed","server":"ed0e528f.b8b9f","version":1,"debugenabled":false,"outputs":1,"entityType":"sensor","config":[{"property":"name","value":"SolarPumpSpeed"},{"property":"device_class","value":"power_factor"},{"property":"icon","value":"mdi:pump"},{"property":"unit_of_measurement","value":"%"}],"state":"payload[11].rawValue","stateType":"msg","attributes":[],"resend":true,"outputLocation":"","outputLocationType":"none","inputOverride":"allow","outputOnStateChange":false,"outputPayload":"$entity().state ? \"on\": \"off\"","outputPayloadType":"jsonata","x":770,"y":300,"wires":[[]]},{"id":"ed0e528f.b8b9f","type":"server","name":"Home Assistant","version":1,"legacy":false,"addon":true,"rejectUnauthorizedCerts":true,"ha_boolean":"y|yes|true|on|home|open","connectionDelay":true,"cacheJson":true}]

Homematic

Below an example (just import to your node red flow) to fetch data from the server via JSON and write it into Homematic System Variables.

[{"id":"866f040.a0dc","type":"tab","label":"Solaralage","disabled":false,"info":""},{"id":"9dfb4a61.a2689","type":"http request","z":"866f040.a0dc","name":"","method":"GET","ret":"obj","paytoqs":false,"url":"http://192.168.188.45:3333/api/v1/live-data","tls":"","persist":false,"proxy":"","authType":"","x":370,"y":120,"wires":[["4c32479d.39a7a8","3b55917c.f95a8e","c4d405c2.647c4","27c8b952.ec734e"]]},{"id":"4c32479d.39a7a8","type":"change","z":"866f040.a0dc","name":"Value[1]","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload[1].rawValue","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":120,"wires":[["dd8a6941.ec48b8","bd02c6dd.ffce"]]},{"id":"dd8a6941.ec48b8","type":"ccu-sysvar","z":"866f040.a0dc","name":"Solar_Temp_Kollektor","ccuConfig":"69e820bd.716","topic":"ReGaHSS/${Name}","change":true,"cache":true,"x":780,"y":120,"wires":[[]]},{"id":"3b55917c.f95a8e","type":"change","z":"866f040.a0dc","name":"Value[2]","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload[2].rawValue","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":180,"wires":[["3fd1c7b7.a81178"]]},{"id":"3fd1c7b7.a81178","type":"ccu-sysvar","z":"866f040.a0dc","name":"Solar_Temp_Puffer_Unten","ccuConfig":"69e820bd.716","topic":"ReGaHSS/${Name}","change":true,"cache":true,"x":800,"y":180,"wires":[[]]},{"id":"c4d405c2.647c4","type":"change","z":"866f040.a0dc","name":"Value[11]","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload[11].rawValue","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":300,"wires":[["21bc8fbe.2d3078"]]},{"id":"21bc8fbe.2d3078","type":"ccu-sysvar","z":"866f040.a0dc","name":"Solar_Speed_Pump","ccuConfig":"69e820bd.716","topic":"ReGaHSS/${Name}","change":false,"cache":true,"x":780,"y":300,"wires":[[]]},{"id":"3d61cadb.e05996","type":"inject","z":"866f040.a0dc","name":"1min","topic":"","payload":"","payloadType":"date","repeat":"60","crontab":"","once":false,"onceDelay":"","x":210,"y":120,"wires":[["9dfb4a61.a2689"]]},{"id":"bd02c6dd.ffce","type":"debug","z":"866f040.a0dc","name":"Debug","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","x":730,"y":80,"wires":[]},{"id":"27c8b952.ec734e","type":"change","z":"866f040.a0dc","name":"Value[3]","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload[3].rawValue","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":240,"wires":[["8248bdd1.a010d8"]]},{"id":"8248bdd1.a010d8","type":"ccu-sysvar","z":"866f040.a0dc","name":"Solar_Temp_Leitung","ccuConfig":"69e820bd.716","topic":"ReGaHSS/${Name}","change":true,"cache":true,"x":780,"y":240,"wires":[[]]},{"id":"69e820bd.716","type":"ccu-connection","z":"","name":"Home","host":"192.168.188.24","regaEnabled":true,"bcrfEnabled":true,"iprfEnabled":true,"virtEnabled":true,"bcwiEnabled":false,"cuxdEnabled":false,"regaPoll":true,"regaInterval":"30","rpcPingTimeout":"60","rpcInitAddress":"192.168.188.45","rpcServerHost":"127.0.0.1","rpcBinPort":"3047","rpcXmlPort":"3048","queueTimeout":"5000","queuePause":"250","contextStore":""}]

Usage of the git repo

  • download/clone repo
  • build image from dockerfile

Contribution

Thanks to danielwippermann for the original source of the server and the resol-vbus library!

About

Docker containerized version of the json-live-data-server from resol-vbus.

Resources

License

Stars

Watchers

Forks

Packages

No packages published