MMM-VartaESS

This is a module for the MagicMirror².

This module shows live information about Varta Energy Storage Systems.

About

The module has the following features:

• Show live data of Varta Energy Storage Systems (ESS)
• Send power data to MMM-EnergyMonitor (see below)
• The data is fetched via Modbus TCP from the ESS

A word about extendability:

The module is designed in a way, that is is easily possible to support other battery manufacturers as well (depending on the fact that their devices have an interface to access data). If you have the need to support and use another battery manufacturer, please create an issue and/or create a pull request :).

Installing

The dependency modbus-serial needs to compile native code an therefore needs the GNU C++ compiler installed. So please make sure, you have installed it:

apt install g++

Clone this repo into your modules directory and install dependencies:

cd modules
git clone https://github.com/deg0nz/MMM-VartaESS.git
npm install 

Status

The current development status of this module is: maintained

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

Screenshots

// TODO: Add screenshot

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-VartaESS',
            config: {
                ip: "192.168.1.12", // Entering the IP of the power converter is mandatory
            }
        }
    ]
}

Configuration options

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

Option	Description
ip	Required The IP address if your ESS
port	Optional Modbus TCP port number of the ESS Type: int (port) Default: 504 (default Modbus TCP port)
clientId	Optional The client ID of Modbus TCP client of this module. If you have multiple clients asking for data in your ESS, this number should be unique Type: int (ID) Default: 10
updateInterval	Optional How often should the data be updated Type: int (milliseconds) Default: 3000 milliseconds (3 seconds)
showBatteryDisplay	Optional Turns showing a battery display on and off Type: boolean (on/off) Default: true on
colors	Optional Turns colors on and off Type: boolean (on/off) Default: true on
wattConversionOptions	Optional Configures if and how Watts should ge converted to kW, mW, gW 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)
broadcastGridPower	Optional Should grid power data be broadcasted to MMM-EnergyMonitor Type: boolean (on/off) Default: false off
broadcastBatteryPower	Optional Should battery power data be broadcasted to MMM-EnergyMonitor Type: boolean (on/off) Default: false off

Troubleshooting

Sometimes, the module cannot connect to the ESS correctly and the MM logs show a PortNotOpenError created by this module. I had no time to handle that error so far, but a restart of the MagicMirror application should fix the error. Make sure, that your clientId is unique in your network!

Special Thanks

• MichMich for creating the Magic Mirror Project
• hukl for creating the SMYCK color theme on which the default colors are based
• Sarawut Positwinyu for sharing the battery animation

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.