MMM-EnergyMonitor

This is a module for the MagicMirror².

This module visualizes current energy production and consumption of your home. It is meant to be used when you have a electric power generator (such as a photovoltaic system) and a battery (optional) installed in your home.

About

The module has the following features:

• Show live data of power production and consumption of your home
• The module is developed to be used in center regions of the MagicMirror. If you want to use it somewhere else, please feel free to submit a Pull Request.
• This module was developed as a companion to MMM-Fronius2 and MMM-VartaESS to visualize their data. But other data sources are supported as well.

Attention: This module depends on external data sources. It cannot be used as standalone module. Please refer to the "Data Sources" section below!

Installing

This module has no external dependencies (apart from the data sources mentiones above). Just clone it:

cd modules
git clone https://github.com/deg0nz/MMM-EnergyMonitor.git

Status

The current development status of this module is: maintained

This means: I'm open for feature requests, pull requests, bug reports, ...

Screenshots

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-EnergyMonitor',
            position: 'middle_center'
        }
    ]
}

Configuration options

Note: You should test various combinations of width, height and lineWidth that work for your mirror resolution. All the other values are calculated and should scale automatically

Please refer to MMM-EnergyMonitor default configuration to prevent syntax errors.

Option	Description
energyStorage	Optional Configure if you have Energy Storage System installed in your home and it should be displayed by the module Type: boolean (yes/no) Default: true (yes - ESS installed)
height	Optional The height of the module Type: CSS size value Default: 600px (600 Pixel)
width	Optional The width of the module Type: CSS size value Default: 700px (700 Pixel)
lineWidth	Optional Thickness of the lines pointing to the center Type: CSS size value Default: 10px (10 Pixel)
updateInterval	Optional How often should the UI be updated Type: int (milliseconds) Default: 3000 milliseconds (3 seconds)
resetCycles	Optional After how many UI update cycles without new data should the values be reset to 0. Note: resetCycles * updateInterval musst be greater than the interval that updates the actual data! Type: int (cycles) Default: 3 cycles
logNotifications	Optional If the module should log the data notifications/updates it receives. This value is good for debugging if the module shows weird values. Type: boolean (on/off) Default: false off
wattConversionOptions	Optional Configures if and how Watts should get converted to kW Type: object See configuration below
wattConversionOptions.enabled	Optional Turns the feature on/off Type: boolean (on/off) Default: true (on)
wattConversionOptions.threshold	Optional At which value should numbers be converted Type: int (Watt) Default: 1200 Watt
wattConversionOptions.numDecimalDigits	Optional To how many decimal digits should the converted value be shortened (keep this value low to prevent UI glitches) Type: int Default: 2 (example: 1.45 kW)
iconCssClasses	Optional Changes the default CSS classes of the icons. Currently, Font Awesome free icons v5 are supported. Attention: don't forget the fas prefix as shown in the examples below! Type: object See object properties below
iconCssClasses.home	Optional Icon for the home Type: string (CSS classes) Default: fas fa-home (Home icon)
iconCssClasses.grid	Optional Icon for the power grid Type: string (CSS classes) Default: fas fa-plug (Plug icon)
iconCssClasses.energyStorage	Optional Icon for the energy storage Type: string (CSS classes) Default: fas fa-battery-half (Battery half full)
iconCssClasses.localPowerSource	Optional Icon for the local power source (e.g. Power) Type: string (CSS classes) Default: fas fa-solar-panel (Solar panel)

Data Sources

Per default, the companion modules MMM-Fronius2 and MMM-VartaESS are able to send data to this module. You can use other modules as data sources for this module.

All the values are expected to be from the point of view of the corresponding system. Negative values are interpreted as pulling energy from the system. Positive values are interpreted as pushing energy into the system.

Other modules can send the following notifications to update data for this module:

Notification	Unit	What is updated	Interpretation
MMM-EnergyMonitor_ENERGY_STORAGE_POWER_UPDATE	Watt	Energy Storage	Negative values ar interpreted as drawing power from the energy storage. Positive values are interpreted as charging the energy storage.
MMM-EnergyMonitor_GRID_POWER_UPDATE	Watt	Grid Power	Negative values ar interpreted as drawing power from the grid. Positive values are interpreted as feeding back into the grid.
MMM-EnergyMonitor_SOLAR_POWER_UPDATE	Watt	Solar Power	The currently produced solar powwer. This value must always be 0 or positive.

Special Thanks

• MichMich for creating the Magic Mirror Project
• hukl for creating the SMYCK color theme on which the default colors are based

Issues

If you find any problems, bugs or have questions, please open a GitHub issue in this repository.

Disclaimer

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.