dannyyy/sunricher-mqtt repository overview

⁠MQTT implementation of Sunricher API

The original author of the the API and the MQTT bridge is https://github.com/magcode/sunricher-wifi-mqtt⁠

⁠Docker

To run the MQTT bridge in Docker the necessary sunricher.properties file must be mounted.

Example sunricher.properties

mqttServer=<protocol and host of MQTT broker>
mqttUsername=<mqtt username, can be empty>
mqttPassword=<mqtt password, can be empty>
mqttVersion=<mqtt version, can be empty, defaults to 3>
logLevel=<log level, e.g. ERROR,WARN,INFO,DEBUG,TRACE>
ledHost=<host of sunricher device>
topic=<mqtt topic>
disableWifi=<true|false>

⁠Running Example

⁠Test & Debug

docker run --rm -v /path/to/sunricher.properties:/usr/app/sunricher.properties dannyyy/sunricher-mqtt:latest

⁠Production

docker run -d -v /path/to/sunricher.properties:/usr/app/sunricher.properties dannyyy/sunricher-mqtt:2.0.2

⁠Kubernetes

This project repository (https://github.com/dannyyy/sunricher-wifi-mqtt⁠) also contains a sample manifest for Kubernetes

⁠Running Example

1. Create secret with name sunricher-properties and the content of sunricher.properties according to the main readme file.
2. Create target namespace (e.g. kubectl create namespace sunricher-mqtt)
3. Deploy container with kubectl apply -f sunricher-mqtt.yaml -n sunricher-mqtt