MMM-EnphaseSolar.js

/* 
 * Magic Mirror
 * Module: MMM-EnphaseSolar
 * By Matt Thurling
 *
 * MIT Licensed.
 */

Module.register("MMM-EnphaseSolar",{

    defaults: {
        gatewayHost: "",
        token: "",
        refreshInterval: 1000 * 60 * 1, // 1 minute
        displayCurrentProduction: true,
        displayCurrentUsage: true,
        displayNetOutput: true,
        displayTodaysProduction: true,
        displayTodaysUsage: true,
        displayLastUpdate: true,
        displayLastUpdateFormat: "ddd HH:mm:ss",
        debug: false,
    },

    start: function() {
        Log.info("Starting module: " + this.name);

        this.currentProduction = {
            title: this.translate('CURRENT_PRODUCTION') + ":",
            suffix: this.translate('SUFFIX_KILOWATT'),
            value: this.translate('LOADING')
        };
        this.currentUsage = {
            title: this.translate('CURRENT_USAGE') + ":",
            suffix: this.translate('SUFFIX_KILOWATT'),
            value: this.translate('LOADING')
        };
        this.netOutput = {
            importingTitle: this.translate('IMPORTING') + ":",
            exportingTitle: this.translate('EXPORTING') + ":",
            suffix: this.translate('SUFFIX_KILOWATT'),
            value: this.translate('LOADING')
        };
        this.todaysProduction = {
            title: this.translate('PRODUCED_TODAY') + ":",
            suffix: this.translate('SUFFIX_KILOWATTHOUR'),
            value: this.translate('LOADING')
        };
        this.todaysUsage = {
            title: this.translate('USED_TODAY') + ":",
            suffix: this.translate('SUFFIX_KILOWATTHOUR'),
            value: this.translate('LOADING')
        }
        this.lastUpdated = Date.now() / 1000;

        this.loaded = false;
        this.getEnphaseSolarData();

        var self = this;

        setInterval(function() {
            self.getEnphaseSolarData();
            self.updateDom();
        }, this.config.refreshInterval);
    },

    //Import additional CSS Styles
    getStyles: function() {
        return ['MMM-EnphaseSolar.css']
    },

    getEnphaseSolarData: function() {
        Log.info("MMM-EnphaseSolar: getting data");

        this.sendSocketNotification("GET_ENPHASE_SOLAR", {
            config: this.config,
            sessionId: this.sessionId
        });
    },

    socketNotificationReceived: function(notification, payload) {
        if (notification === "ENPHASE_SOLAR_DATA") {
            this.sessionId = payload.sessionId;
            for (const productionData of payload.production) {
                if (productionData.type === "eim") {
                    // current production can be slightly negative when nothing is being produced so zero it in that case
                    this.currentProduction.value = productionData.wNow < 0 ? 0 : (productionData.wNow / 1000).toFixed(2);
                    this.todaysProduction.value = (productionData.whToday / 1000).toFixed(2);
                    this.lastUpdated = productionData.readingTime;
                }
            }
            for (const consumptionData of payload.consumption) {
                if (consumptionData.measurementType === "total-consumption") {
                    this.currentUsage.value = (consumptionData.wNow / 1000).toFixed(2);
                    this.todaysUsage.value = (consumptionData.whToday / 1000).toFixed(2);
                } else if (consumptionData.measurementType === "net-consumption") {
                    this.netOutput.value = (consumptionData.wNow / 1000).toFixed(2);
                }
            }

            this.loaded = true;
            this.updateDom();
        }
    },

    getDom: function() {
        var wrapper = document.createElement("div");

        if (!this.config.gatewayHost || !this.config.token) {
            wrapper.innerHTML = this.translate('ERROR_MISSING_CONFIG');
            return wrapper;
        }

        //Display loading while waiting for API response
        if (!this.loaded) {
            wrapper.innerHTML = this.translate('LOADING');
            return wrapper;
        }

        var tableElement = document.createElement("table");

        if (this.config.displayCurrentProduction) {
            tableElement.appendChild(this.addRow(this.currentProduction.title, this.currentProduction.value, this.currentProduction.suffix, 'current-production'));
        }

        if (this.config.displayCurrentUsage) {
            tableElement.appendChild(this.addRow(this.currentUsage.title, this.currentUsage.value, this.currentUsage.suffix, 'current-usage'));
        }

        if (this.config.displayNetOutput) {
            var netOutputTitle;
            var netOutputClass;
            if (this.netOutput.value > 0) {
                netOutputTitle = this.netOutput.importingTitle;
                netOutputClass = 'net-output-importing';
            } else {
                netOutputTitle = this.netOutput.exportingTitle;
                netOutputClass = 'net-output-exporting';
            }
            tableElement.appendChild(this.addRow(netOutputTitle, Math.abs(this.netOutput.value), this.netOutput.suffix, netOutputClass));
        }

        if (this.config.displayTodaysProduction) {
            tableElement.appendChild(this.addRow(this.todaysProduction.title, this.todaysProduction.value, this.todaysProduction.suffix, 'todays-production'));
        }

        if (this.config.displayTodaysUsage) {
            tableElement.appendChild(this.addRow(this.todaysUsage.title, this.todaysUsage.value, this.todaysUsage.suffix, 'todays-usage'));
        }

        wrapper.appendChild(tableElement);

        if (this.config.displayLastUpdate) {
            var updateinfo = document.createElement("div");
            updateinfo.className = "xsmall light";
            updateinfo.innerHTML = this.translate('LAST_UPDATED') + ": " + moment.unix(this.lastUpdated).format(this.config.displayLastUpdateFormat);
            wrapper.appendChild(updateinfo);
        }

        return wrapper;
    },

    addRow: function(title, value, suffix, className) {
        var rowElement = document.createElement("tr");

        var titleElement = document.createElement("td");
        titleElement.innerHTML = title;
        titleElement.className = "title-" + className + " medium regular bright";
        rowElement.appendChild(titleElement);

        var dataElement = document.createElement("td");
        dataElement.innerHTML = value + " " + suffix;
        dataElement.className = "data-" + className + " medium light normal";
        rowElement.appendChild(dataElement);

        return rowElement;
    },

    getTranslations() {
        return {
            en: 'translations/en.json',
        };
    },
});