Skip to content

Latest commit

 

History

History
83 lines (57 loc) · 3.34 KB

README.md

File metadata and controls

83 lines (57 loc) · 3.34 KB
Raw

RIKA2MQTT

logo

RIKA2MQTT is a free and opensource bridge enabling end-users to connect their RIKA firenet stove to an MQTT server. It goes both way, so you can monitor and also take control of your stove directly via MQTT.

Maven Central License: MIT join discord

Quality Gate Status Coverage Lines of Code code style Known Vulnerabilities OpenSSF Best Practices

Run it via docker

docker run \
    -e RIKA_EMAIL=<yourRikaFirenetAccount> \
    -e RIKA_PASSWORD=<yourPassword> \
    -e MQTT_HOST=127.0.0.1 \
    -e MQTT_USER=<optional> \
    -e MQTT_PASSWORD=<optional> \
    -d --name rika2mqtt cookiecodedev/rika2mqtt:latest

It will publish to the defined mqtt server in topic tele/rika2mqtt.

It can consume input commands (mqtt -> rika stove) via topic cmnd/rika2mqtt.

RIKA_EMAIL

The email of your rika-firenet account

RIKA_PASSWORD

The password of your rika-firenet account

MQTT_HOST

The host of your MQTT instance (ip or fqdn)

MQTT_USERNAME

The user to use to connect to MQTT (optional depends on your mqtt config)

MQTT_PASSWORD

The password associated to the user defined previously in MQTT_USER (optional depends on your mqtt config)

MQTT_COMMAND_TOPIC_NAME (Optional)

The MQTT topic used to send command to RIKA2MQTT Default: cmnd/rika2mqtt

MQTT_TELEMETRY_REPORT_TOPIC_NAME (Optional)

The MQTT topic used by RIKA2MQTT to publish RIKA status Default: tele/rika2mqtt

MQTT_ERROR_TOPIC_NAME (Optional)

The MQTT topic used by RIKA2MQTT to publish RIKA errors Default: tele/rika2mqtt-errors

MQTT_PORT (Optional)

The port of your MQTT instance Default: 1883

MQTT_URI_SCHEME (Optional)

The uri scheme to use to connect to the MQTT server Default: tcp://

Other docs:

Credits

Thanks to Freepik for providing the pellet stove icon used in the diagram