Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.12 KB

README.md

File metadata and controls

61 lines (42 loc) · 2.12 KB
Raw

Shelly-PM

Description

This is a simple module for MagicMirror² to display ONE Shelly PM sensor data (temperature and power).

Feel free to extend to fulfill your own needs, This fulfills my needs. See the configuration and some pictures here.

The module uses the Shelly HT API over LAN to get the sensor data. For details, check here. For it to work properly, it's best to have a static IP for your Shelly. Since it's using LAN connection, no authentication is needed towards the API.

Feel free to enhance :)

Screenshot crop

shelly-HT screen

Prerequisites

  • You need to have a MagicMirror up and running, also a Shelly PM sensor with a fixed IP.
  • If you want a language other than en or de please add it under translations.
  • If you want consumption data for a day, enable shelly cloud and add the correct server path, device ID and authorization key to the configuration.

Configuration

Include this (or multiple instances of it) in your config.js file:

{
    module: "MMM-Shelly-PM",
    header: "Shelly-PM",
    position: "top_left",
    config: {
        //Your Shelly PM needs to have a fixed IP (or your LAN must be supporting mDNS)
        ShellyApiPath: "http://192.168.0.149/rpc/Shelly.GetStatus",
        RefreshInterval: "5000" //milliseconds
        negativeDisplay: true,

        cloudServerPath: "https://shelly-XX-eu.shelly.cloud/statistics/relay/consumption",
        deviceId: "3c6XXXXXX",
        authKey: "XXXXX",
        RefreshIntervalCloud: "60000", //milliseconds, here 1 minute

        broadcastToEnergyMonitor: true, // broadcast to MMM-EnergyMonitor
    }
}

Installing

Go to your MagicMirror directory

cd modules
git clone https://github.com/stefanjacobs/MMM-Shelly-PM
npm install

Check out the config.sample.js in the module directory. Copy the content to your config.js and change as necessary. You have to change ShellyApiPath to your device's IP address.

Restart MagicMirror and enjoy.