cernoch / shelly-logger

Logs the power consumption from Shelly Plugs

shelly-logger

Service that reads Shelly Plug metering statistics and saves it into InfluxDB 2 database.

Intead of using this project, you could hook MQTT stream. But that only gives you instantaneous power (shellies/<model>-<deviceid>/relay/0/power). This project also logs the counters value, which has the by-minute-averages done by the Plug. This should increase the accuracy of the measurements.

Quickstart

Create a docker-compose.yml file:

version: '3.4'
services:
  thumbsup-cron:
    image: "ghcr.io/cernoch/shelly-logger:latest"
    user: [IDEALLY_A_NON_ROOT_USER_ON_YOUR_PC]
    restart: always
    volumes:
      - "[PATH_TO_CONFIG_FILE]:/etc/shelly-logger:ro"

And the just docker compose up --detach.

The [PATH_TO_CONFIG_FILE] directory must contain the config.json file adjusted to your own setup.

How to build yourself

$ git clone https://github.com/cernoch/shelly-logger.git
$ cd shelly-logger
$ docker build -t ghcr.io/cernoch/shelly-logger:latest .

How to release

• Release commit is tagged as v[MAJOR].[PATCH].
• Backwards compatible changes may only bump the PATCH version.
• When bumping the PATCH version, just tag the commit & push.
• When bumping the MAJOR version, also update the ghcr.io/cernoch/shelly-logger:[MAJOR] tag in .github/workflows/main.yml.