Skip to content
This is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/). This module reads from a YouLess energy meter in your network to display realtime energy usage information.
JavaScript CSS
Branch: master
Clone or download
Markus Eckert
Markus Eckert URL correction
Latest commit ff06fc2 Dec 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public module added Dec 20, 2018
.gitignore module added Dec 20, 2018
CHANGELOG.md module added Dec 20, 2018
LICENSE.md module added Dec 20, 2018
MMM-YouLess2.js Bugfix Dec 20, 2018
README.md first commit Dec 20, 2018
node_helper.js module added Dec 20, 2018
package-lock.json module added Dec 20, 2018
package.json URL correction Dec 20, 2018

README.md

MagicMirrorModule-YouLess2

It´s a Fork from https://github.com/QNimbus/MMM-YouLess

This is a module for the MagicMirror². This module reads from a YouLess energy meter in your network to display realtime energy usage information.

Installation

  1. Navigate into your MagicMirror's modules folder and run:
$ git clone https://github.com/eckonator/MMM-YouLess2.git
  1. Install the dependencies:
$ cd MMM-YouLess2 && npm install --only=production

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: 'MMM-YouLess2',
            config: {
                // required settings
                youlessHost: "192.168.178.77",          // or youless.home.network.nl
                updateInterval: 30 * 1000,          	// every 30 seconds
                
                // optional settings
                totalGauge: 5000,                       // max watt for drawing circle
                gaugeUniqueId: "YouLess2_Gauge_1",      // must be unique, if you have multiple instances, rename the second one, e.g.: YouLess2_Gauge_2
                gaugeValueLabel: "Watt",                // gauge value label, directly after the value
                gaugeLabel: "Stromlast",                // gauge label in bottom of the gauge
                gaugeStyle: "Arch",                     // possible Options: Full | Arch | Semi
                
                // change it, if you know what you do
                initialLoadDelay: 0, 	            	// 0 seconds delay
                retryDelay: 2 * 1000,	            	// retry after 2 seconds
                gaugeStripe: 0,                         // possible Options: 0 | 1
                gaugeSize: 250,                         // size of the gauge
                gaugeColor: "#ffffff",                  // color of the active gauge
                gaugeBackColor: "rgba(255,255,255,.3)", // color of the inactive gauge
                gaugeCircleWidth: 16,                   // with of the gauge circle
                gaugeAnimationstep: 0,                  // filling gauge with or without animation
                gaugeAnimateCircleColors: false,        // animate circle colors
                gaugeAnimateTextColors: false,          // animate texte colors
                gaugeLabelColor: "#ffffff",             // label color
                gaugeTextSize: .11                      // text size
            }
        }
    ]
}

Configuration options

Option Description
youlessHost Required Your YouLess ip address or hostname
Default value: 192.168.178.77
Type: string
updateInterval Optional Interval at which the module fetches new data

Default value: 30 * 1000 milliseconds (30 seconds)
Type: int(milliseconds)
initialLoadDelay Optional Initial delay when module is first loaded

Default value: 0 milliseconds (0 seconds)
Type: int(milliseconds)
retryDelay Optional If no data is received, retry again after delay

Default value: 2 * 1000 milliseconds (2 seconds)
Type: int(milliseconds)
totalGauge Required Max watt for drawing circle

Default value: 5000 Watt
Type: int(Watt)
gaugeUniqueId Required Must be unique, if you have multiple instances, rename the second one, e.g.: YouLess2_Gauge_2

Default value: YouLess2_Gauge_1
Type: string
gaugeValueLabel Optional Gauge value label, directly after the value

Default value: Watt
Type: string
gaugeLabel Optional Gauge label in bottom of the gauge

Default value: Stromlast
Type: string
gaugeStyle Optional Possible Options: Full / Arch / Semi

Default value: Arch
Type: string
gaugeStripe Optional possible Options: 0/1

Default value: 0
Type: boolean
gaugeSize Optional size of the gauge

Default value: 250
Type: int (pixel)
gaugeColor Optional color of the active gauge

Default value: #ffffff
Type: string
gaugeBackColor Optional color of the inactive gauge

Default value: rgba(255,255,255,.3)
Type: string
gaugeCircleWidth Optional with of the gauge circle

Default value: 16
Type: int (pixel)
gaugeAnimationstep Optional filling gauge with or without animation

Default value: 0
Type: boolean
gaugeAnimateCircleColors Optional animate circle colors

Default value: false
Type: boolean
gaugeAnimateTextColors Optional animate texte colors

Default value: false
Type: boolean
gaugeLabelColor Optional label color

Default value: #ffffff
Type: string
gaugeTextSize Optional text size

Default value: .11
Type: int (em)

Building from TypeScript source

Todo...

Screenshots

alt text

You can’t perform that action at this time.