Giter VIP home page Giter VIP logo

mmm-shellyemmeter's Introduction

Shelly-EM Meter

Description

This is a simple MagicMirror² module to display data from a Shelly EM sensor on Magic Mirror and is inspired by the project Shelly-PM.

The Shelly EM is a Wi-Fi current and voltage meter that allows you to monitor the consumption of any household appliance, electrical circuit and office equipment.

I use it for monitoring my photovoltaic system.

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 EM 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.

How to find Shelly IP on a router

  • Make sure you have access rights to your router.
  • Enter 192.168.1.1 (usually it is) in the address bar of any web browser.
  • Type your router username and password.
  • Find the DHCP client table or client list.
  • Open the client list or DHCP client table.
  • Click on the device to reveal its IP address.

Prerequisites

  • You need to have a MagicMirror² up and running, also a Shelly EM sensor with a fixed IP.
  • The default 'clock' module must be active because the 'ShellyEMMeter' module uses the events fired by 'clock' to call Shelly on the lan.

Configuration

Include this in your config.js file:

{
    module: "MMM-ShellyEMMeter",
			position: "top_right",
			header: "Shelly EM Meter",
			config: {
				refreshInterval: 15, // in seconds
				localuri: "http://192.168.1.185/status"
			}
},

Screenshot

shelly-EM screen

Installing

Go to your MagicMirror directory

cd mounts/modules
git clone https://github.com/mgarrix/MMM-ShellyEMMeter

cd MMM-ShellyEMMeter
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 localuri to your device's IP address and refreshInterval to set the refresh interval (in seconds).

If you want a language other than English and Italian, you can add it inside the translations folder.

Restart MagicMirror and enjoy.

mmm-shellyemmeter's People

Contributors

mgarrix avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.