homebridge-solaxcloud-api 2.3.2 → 2.4.0

package/dist/outletAccessory.d.ts

@@ -1,101 +1,101 @@
-import { Service, AccessoryPlugin, Logging, CharacteristicGetCallback, API } from 'homebridge';
-import { SolaxPlatformAccessory } from './platformAccessory';
-/**
- * Solax Outlet Accessory.
- * Virtual outlet used to monitor and measure both power and total energy consumption from Solax devices.
- * Outlet use is inferred from a positive power comsumption.
- */
-export declare class SolaxOutletAccessory extends SolaxPlatformAccessory implements AccessoryPlugin {
-    /**
-     * Eve Homekit types helper
-     * */
-    private readonly eve;
-    /**
-     * Eve Service for fakegato.
-     */
-    private readonly eveService;
-    /**
-     * Outlet service with power meter.
-     */
-    private readonly outletService;
-    /**
-     * Current power reading in Watt.
-     */
-    private powerConsumption;
-    /**
-     * Total energy readings in KWh.
-     */
-    private totalEnergyConsumption;
-    /**
-     * Elgato Eve fake history service for energy and status.
-     */
-    private readonly loggingService;
-    /**
-     * Power series for smoothing operations.
-     */
-    private readonly powerSeries;
-    /**
-     * Last Exponential Moving Average.
-     */
-    private lastEMA;
-    /**
-     * Solax virtual outlet class constructor.
-     * @param {Logging} log The platform logging for homebridge.
-     * @param {API} api The API for Solax Cloud platform.
-     * @param {string} name The accessory name.
-     * @param {string} serial "Real world" serial number for this accessory.
-     * @param {string} model Accessory model.
-     */
-    constructor(log: Logging, api: API, name: string, serial: string, model: string);
-    /**
-     * Adds new power entry to series array of power values.
-     * @param {number} powerConsumption Power value to add (in Watts).
-     */
-    private addPowerEntry;
-    /**
-     * Gets array series with power consumption values.
-     * @returns {number[]} Array with power consumption values.
-     */
-    getPowerSeries(): number[];
-    /**
-     * Get outlet power from power series by smoothing data using the desired method and window size.
-     * @param {string} method Method to smooth data ('SMA' or 'EMA').
-     * @param {number} windowSize Window size for SMA or EMA.
-     * @returns {number} Power value after smoothing (rounded to nearest integer number).
-     */
-    getSmoothPowerConsumption(method: string, windowSize: number): number;
-    /**
-     * Gets the current power consumption value for this outlet.
-     * @returns {number} Outlet power consumption (Watt).
-     */
-    getPowerConsumptionValue(): number;
-    /**
-     * Gets the current power consumpion.
-     */
-    getPowerConsumption(callback: CharacteristicGetCallback): void;
-    /**
-     * Sets the current power consumption.
-     * @param {number} powerConsumption The power consumption to set. */
-    setPowerConsumption(powerConsumption: number): void;
-    /**
-     * Gets the total energy consumption value for this outlet.
-     * @returns {number} Outlet total energy consumption (Wh).
-     */
-    getTotalEnergyConsumptionValue(): number;
-    /**
-     * Gets the total energy consumpion.
-     */
-    getTotalEnergyConsumption(callback: CharacteristicGetCallback): void;
-    /**
-     * Sets the total energy consumption.
-     * @param {number} totalEnergyConsumption The total energy consumption to set.
-     */
-    setTotalEnergyConsumption(totalEnergyConsumption: number): void;
-    /**
-     * Gets the outlet state Characteristic based on its consumed power.
-     * @param {CharacteristicGetCallback} callback The callback.
-     */
-    getState(callback: CharacteristicGetCallback): void;
-    getServices(): Service[];
-}
+import { Service, AccessoryPlugin, Logging, CharacteristicGetCallback, API } from 'homebridge';
+import { SolaxPlatformAccessory } from './platformAccessory';
+/**
+ * Solax Outlet Accessory.
+ * Virtual outlet used to monitor and measure both power and total energy consumption from Solax devices.
+ * Outlet use is inferred from a positive power comsumption.
+ */
+export declare class SolaxOutletAccessory extends SolaxPlatformAccessory implements AccessoryPlugin {
+    /**
+     * Eve Homekit types helper
+     * */
+    private readonly eve;
+    /**
+     * Eve Service for fakegato.
+     */
+    private readonly eveService;
+    /**
+     * Outlet service with power meter.
+     */
+    private readonly outletService;
+    /**
+     * Current power reading in Watt.
+     */
+    private powerConsumption;
+    /**
+     * Total energy readings in KWh.
+     */
+    private totalEnergyConsumption;
+    /**
+     * Elgato Eve fake history service for energy and status.
+     */
+    private readonly loggingService;
+    /**
+     * Power series for smoothing operations.
+     */
+    private readonly powerSeries;
+    /**
+     * Last Exponential Moving Average.
+     */
+    private lastEMA;
+    /**
+     * Solax virtual outlet class constructor.
+     * @param {Logging} log The platform logging for homebridge.
+     * @param {API} api The API for Solax Cloud platform.
+     * @param {string} name The accessory name.
+     * @param {string} serial "Real world" serial number for this accessory.
+     * @param {string} model Accessory model.
+     */
+    constructor(log: Logging, api: API, name: string, serial: string, model: string);
+    /**
+     * Adds new power entry to series array of power values.
+     * @param {number} powerConsumption Power value to add (in Watts).
+     */
+    private addPowerEntry;
+    /**
+     * Gets array series with power consumption values.
+     * @returns {number[]} Array with power consumption values.
+     */
+    getPowerSeries(): number[];
+    /**
+     * Get outlet power from power series by smoothing data using the desired method and window size.
+     * @param {string} method Method to smooth data ('SMA' or 'EMA').
+     * @param {number} windowSize Window size for SMA or EMA.
+     * @returns {number} Power value after smoothing (rounded to nearest integer number).
+     */
+    getSmoothPowerConsumption(method: string, windowSize: number): number;
+    /**
+     * Gets the current power consumption value for this outlet.
+     * @returns {number} Outlet power consumption (Watt).
+     */
+    getPowerConsumptionValue(): number;
+    /**
+     * Gets the current power consumpion.
+     */
+    getPowerConsumption(callback: CharacteristicGetCallback): void;
+    /**
+     * Sets the current power consumption.
+     * @param {number} powerConsumption The power consumption to set. */
+    setPowerConsumption(powerConsumption: number): void;
+    /**
+     * Gets the total energy consumption value for this outlet.
+     * @returns {number} Outlet total energy consumption (Wh).
+     */
+    getTotalEnergyConsumptionValue(): number;
+    /**
+     * Gets the total energy consumpion.
+     */
+    getTotalEnergyConsumption(callback: CharacteristicGetCallback): void;
+    /**
+     * Sets the total energy consumption.
+     * @param {number} totalEnergyConsumption The total energy consumption to set.
+     */
+    setTotalEnergyConsumption(totalEnergyConsumption: number): void;
+    /**
+     * Gets the outlet state Characteristic based on its consumed power.
+     * @param {CharacteristicGetCallback} callback The callback.
+     */
+    getState(callback: CharacteristicGetCallback): void;
+    getServices(): Service[];
+}
 //# sourceMappingURL=outletAccessory.d.ts.map

package/dist/outletAccessory.js

@@ -1,188 +1,188 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SolaxOutletAccessory = void 0;
-const platformAccessory_1 = require("./platformAccessory");
-const statistics_1 = require("./statistics");
-const homebridge_lib_1 = require("homebridge-lib");
-const fakegato_history_1 = __importDefault(require("fakegato-history"));
-/**
- * Maximum size for the outlet power series.
- */
-const MAX_POWER_SERIES_SIZE = 1024;
-/**
- * Solax Outlet Accessory.
- * Virtual outlet used to monitor and measure both power and total energy consumption from Solax devices.
- * Outlet use is inferred from a positive power comsumption.
- */
-class SolaxOutletAccessory extends platformAccessory_1.SolaxPlatformAccessory {
-    /**
-     * Solax virtual outlet class constructor.
-     * @param {Logging} log The platform logging for homebridge.
-     * @param {API} api The API for Solax Cloud platform.
-     * @param {string} name The accessory name.
-     * @param {string} serial "Real world" serial number for this accessory.
-     * @param {string} model Accessory model.
-     */
-    constructor(log, api, name, serial, model) {
-        super(log, api, name, serial, model);
-        /**
-         * Current power reading in Watt.
-         */
-        this.powerConsumption = 0;
-        /**
-         * Total energy readings in KWh.
-         */
-        this.totalEnergyConsumption = 0.0;
-        /**
-         * Power series for smoothing operations.
-         */
-        this.powerSeries = [];
-        /**
-         * Last Exponential Moving Average.
-         */
-        this.lastEMA = 0;
-        this.log.debug(`Creating outlet "${this.name}"`);
-        // init fakegato objects
-        this.eve = new homebridge_lib_1.EveHomeKitTypes(this.api);
-        this.eveService = (0, fakegato_history_1.default)(this.api);
-        // create power meter service
-        this.outletService = new this.eve.Services.Outlet(this.name);
-        // outlet on/off state
-        this.outletService.getCharacteristic(this.api.hap.Characteristic.On)
-            .on("get" /* GET */, this.getState.bind(this));
-        // in use
-        //this.outletService.getCharacteristic(hap.Characteristic.OutletInUse).on(hap.CharacteristicEventTypes.GET, this.getState.bind(this));
-        // current consumption
-        this.outletService.getCharacteristic(this.eve.Characteristics.CurrentConsumption)
-            .on("get" /* GET */, this.getPowerConsumption.bind(this));
-        // total consumption
-        this.outletService.getCharacteristic(this.eve.Characteristics.TotalConsumption)
-            .on("get" /* GET */, this.getTotalEnergyConsumption.bind(this));
-        // history logging services
-        this.loggingService = new this.eveService('energy', this, { storage: 'fs', log: this.log, disableRepeatLastData: true });
-        log.info(`Outlet "${name}" created!`);
-    }
-    /**
-     * Adds new power entry to series array of power values.
-     * @param {number} powerConsumption Power value to add (in Watts).
-     */
-    addPowerEntry(powerConsumption) {
-        // check if we reached the limit
-        if (this.powerSeries.length === MAX_POWER_SERIES_SIZE) {
-            // remove first element
-            this.powerSeries.shift();
-        }
-        // add new element
-        this.powerSeries.push(powerConsumption);
-    }
-    /**
-     * Gets array series with power consumption values.
-     * @returns {number[]} Array with power consumption values.
-     */
-    getPowerSeries() {
-        return this.powerSeries;
-    }
-    /**
-     * Get outlet power from power series by smoothing data using the desired method and window size.
-     * @param {string} method Method to smooth data ('SMA' or 'EMA').
-     * @param {number} windowSize Window size for SMA or EMA.
-     * @returns {number} Power value after smoothing (rounded to nearest integer number).
-     */
-    getSmoothPowerConsumption(method, windowSize) {
-        this.log.debug(`${this.name}: GET Power Smooth (method=${method}, window=${windowSize})`);
-        let result = 0;
-        // get power series for window size
-        const series = this.getPowerSeries().slice(-windowSize);
-        // calculate simple moving average from given window size
-        const [sma] = statistics_1.Statistics.simpleMovingAverage(series, Math.min(windowSize, series.length));
-        // check if we have enough data for averaging
-        switch (method) {
-            case 'sma':
-                result = sma;
-                this.log.debug(`${this.name}: simple moving average (window data=[${series}], power=${result}W)`);
-                break;
-            case 'ema':
-                if (series.length < windowSize) {
-                    result = sma;
-                    this.log.debug(`${this.name}: exponential moving average (window data=[${series}], last EMA=none, power=${result}W)`);
-                }
-                else {
-                    const lastPowerValue = series[series.length - 1];
-                    const weight = 2 / (windowSize + 1);
-                    result = (lastPowerValue - this.lastEMA) * weight + this.lastEMA;
-                    this.log.debug(`${this.name}: exponential moving average (window data=[${series}], last EMA=${this.lastEMA}, power=${result}W)`);
-                }
-                this.lastEMA = result;
-        }
-        return result;
-    }
-    /**
-     * Gets the current power consumption value for this outlet.
-     * @returns {number} Outlet power consumption (Watt).
-     */
-    getPowerConsumptionValue() {
-        return this.powerConsumption;
-    }
-    /**
-     * Gets the current power consumpion.
-     */
-    getPowerConsumption(callback) {
-        this.log.debug(`${this.name}: GET Power (power=${this.powerConsumption}W)`);
-        callback(null, this.powerConsumption);
-    }
-    /**
-     * Sets the current power consumption.
-     * @param {number} powerConsumption The power consumption to set. */
-    setPowerConsumption(powerConsumption) {
-        this.log.debug(`${this.name}: SET Power (power=${powerConsumption}W)`);
-        this.powerConsumption = powerConsumption >= 0 ? powerConsumption : 0;
-        this.outletService.getCharacteristic(this.eve.Characteristics.CurrentConsumption).updateValue(this.powerConsumption);
-        // add entries to history
-        this.loggingService.addEntry({ time: Math.round(new Date().valueOf() / 1000), power: this.powerConsumption });
-        // add new value to power series
-        this.addPowerEntry(this.powerConsumption);
-    }
-    /**
-     * Gets the total energy consumption value for this outlet.
-     * @returns {number} Outlet total energy consumption (Wh).
-     */
-    getTotalEnergyConsumptionValue() {
-        return this.totalEnergyConsumption;
-    }
-    /**
-     * Gets the total energy consumpion.
-     */
-    getTotalEnergyConsumption(callback) {
-        this.log.debug(`${this.name}: GET Total Energy (energy=${this.totalEnergyConsumption}kWh)`);
-        callback(null, this.totalEnergyConsumption);
-    }
-    /**
-     * Sets the total energy consumption.
-     * @param {number} totalEnergyConsumption The total energy consumption to set.
-     */
-    setTotalEnergyConsumption(totalEnergyConsumption) {
-        this.log.debug(`${this.name}: SET Total Energy (energy=${totalEnergyConsumption}kWh)`);
-        this.totalEnergyConsumption = totalEnergyConsumption;
-        this.outletService.getCharacteristic(this.eve.Characteristics.TotalConsumption).updateValue(this.totalEnergyConsumption);
-    }
-    /**
-     * Gets the outlet state Characteristic based on its consumed power.
-     * @param {CharacteristicGetCallback} callback The callback.
-     */
-    getState(callback) {
-        this.log.debug(`${this.name}: GET State (power=${this.powerConsumption}W)`);
-        callback(null, this.powerConsumption > 0);
-    }
-    /*
-     * This method is called directly after creation of this instance.
-     * It should return all services which should be added to the accessory.
-     */
-    getServices() {
-        return [this.informationService, this.outletService, this.loggingService];
-    }
-}
-exports.SolaxOutletAccessory = SolaxOutletAccessory;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolaxOutletAccessory = void 0;
+const platformAccessory_1 = require("./platformAccessory");
+const statistics_1 = require("./statistics");
+const homebridge_lib_1 = require("homebridge-lib");
+const fakegato_history_1 = __importDefault(require("fakegato-history"));
+/**
+ * Maximum size for the outlet power series.
+ */
+const MAX_POWER_SERIES_SIZE = 1024;
+/**
+ * Solax Outlet Accessory.
+ * Virtual outlet used to monitor and measure both power and total energy consumption from Solax devices.
+ * Outlet use is inferred from a positive power comsumption.
+ */
+class SolaxOutletAccessory extends platformAccessory_1.SolaxPlatformAccessory {
+    /**
+     * Solax virtual outlet class constructor.
+     * @param {Logging} log The platform logging for homebridge.
+     * @param {API} api The API for Solax Cloud platform.
+     * @param {string} name The accessory name.
+     * @param {string} serial "Real world" serial number for this accessory.
+     * @param {string} model Accessory model.
+     */
+    constructor(log, api, name, serial, model) {
+        super(log, api, name, serial, model);
+        /**
+         * Current power reading in Watt.
+         */
+        this.powerConsumption = 0;
+        /**
+         * Total energy readings in KWh.
+         */
+        this.totalEnergyConsumption = 0.0;
+        /**
+         * Power series for smoothing operations.
+         */
+        this.powerSeries = [];
+        /**
+         * Last Exponential Moving Average.
+         */
+        this.lastEMA = 0;
+        this.log.debug(`Creating outlet "${this.name}"`);
+        // init fakegato objects
+        this.eve = new homebridge_lib_1.EveHomeKitTypes(this.api);
+        this.eveService = (0, fakegato_history_1.default)(this.api);
+        // create power meter service
+        this.outletService = new this.eve.Services.Outlet(this.name);
+        // outlet on/off state
+        this.outletService.getCharacteristic(this.api.hap.Characteristic.On)
+            .on("get" /* GET */, this.getState.bind(this));
+        // in use
+        //this.outletService.getCharacteristic(hap.Characteristic.OutletInUse).on(hap.CharacteristicEventTypes.GET, this.getState.bind(this));
+        // current consumption
+        this.outletService.getCharacteristic(this.eve.Characteristics.CurrentConsumption)
+            .on("get" /* GET */, this.getPowerConsumption.bind(this));
+        // total consumption
+        this.outletService.getCharacteristic(this.eve.Characteristics.TotalConsumption)
+            .on("get" /* GET */, this.getTotalEnergyConsumption.bind(this));
+        // history logging services
+        this.loggingService = new this.eveService('energy', this, { storage: 'fs', log: this.log, disableRepeatLastData: true });
+        log.info(`Outlet "${name}" created!`);
+    }
+    /**
+     * Adds new power entry to series array of power values.
+     * @param {number} powerConsumption Power value to add (in Watts).
+     */
+    addPowerEntry(powerConsumption) {
+        // check if we reached the limit
+        if (this.powerSeries.length === MAX_POWER_SERIES_SIZE) {
+            // remove first element
+            this.powerSeries.shift();
+        }
+        // add new element
+        this.powerSeries.push(powerConsumption);
+    }
+    /**
+     * Gets array series with power consumption values.
+     * @returns {number[]} Array with power consumption values.
+     */
+    getPowerSeries() {
+        return this.powerSeries;
+    }
+    /**
+     * Get outlet power from power series by smoothing data using the desired method and window size.
+     * @param {string} method Method to smooth data ('SMA' or 'EMA').
+     * @param {number} windowSize Window size for SMA or EMA.
+     * @returns {number} Power value after smoothing (rounded to nearest integer number).
+     */
+    getSmoothPowerConsumption(method, windowSize) {
+        this.log.debug(`${this.name}: GET Power Smooth (method=${method}, window=${windowSize})`);
+        let result = 0;
+        // get power series for window size
+        const series = this.getPowerSeries().slice(-windowSize);
+        // calculate simple moving average from given window size
+        const [sma] = statistics_1.Statistics.simpleMovingAverage(series, Math.min(windowSize, series.length));
+        // check if we have enough data for averaging
+        switch (method) {
+            case 'sma':
+                result = sma;
+                this.log.debug(`${this.name}: simple moving average (window data=[${series}], power=${result}W)`);
+                break;
+            case 'ema':
+                if (series.length < windowSize) {
+                    result = sma;
+                    this.log.debug(`${this.name}: exponential moving average (window data=[${series}], last EMA=none, power=${result}W)`);
+                }
+                else {
+                    const lastPowerValue = series[series.length - 1];
+                    const weight = 2 / (windowSize + 1);
+                    result = (lastPowerValue - this.lastEMA) * weight + this.lastEMA;
+                    this.log.debug(`${this.name}: exponential moving average (window data=[${series}], last EMA=${this.lastEMA}, power=${result}W)`);
+                }
+                this.lastEMA = result;
+        }
+        return result;
+    }
+    /**
+     * Gets the current power consumption value for this outlet.
+     * @returns {number} Outlet power consumption (Watt).
+     */
+    getPowerConsumptionValue() {
+        return this.powerConsumption;
+    }
+    /**
+     * Gets the current power consumpion.
+     */
+    getPowerConsumption(callback) {
+        this.log.debug(`${this.name}: GET Power (power=${this.powerConsumption}W)`);
+        callback(null, this.powerConsumption);
+    }
+    /**
+     * Sets the current power consumption.
+     * @param {number} powerConsumption The power consumption to set. */
+    setPowerConsumption(powerConsumption) {
+        this.log.debug(`${this.name}: SET Power (power=${powerConsumption}W)`);
+        this.powerConsumption = powerConsumption >= 0 ? powerConsumption : 0;
+        this.outletService.getCharacteristic(this.eve.Characteristics.CurrentConsumption).updateValue(this.powerConsumption);
+        // add entries to history
+        this.loggingService.addEntry({ time: Math.round(new Date().valueOf() / 1000), power: this.powerConsumption });
+        // add new value to power series
+        this.addPowerEntry(this.powerConsumption);
+    }
+    /**
+     * Gets the total energy consumption value for this outlet.
+     * @returns {number} Outlet total energy consumption (Wh).
+     */
+    getTotalEnergyConsumptionValue() {
+        return this.totalEnergyConsumption;
+    }
+    /**
+     * Gets the total energy consumpion.
+     */
+    getTotalEnergyConsumption(callback) {
+        this.log.debug(`${this.name}: GET Total Energy (energy=${this.totalEnergyConsumption}kWh)`);
+        callback(null, this.totalEnergyConsumption);
+    }
+    /**
+     * Sets the total energy consumption.
+     * @param {number} totalEnergyConsumption The total energy consumption to set.
+     */
+    setTotalEnergyConsumption(totalEnergyConsumption) {
+        this.log.debug(`${this.name}: SET Total Energy (energy=${totalEnergyConsumption}kWh)`);
+        this.totalEnergyConsumption = totalEnergyConsumption;
+        this.outletService.getCharacteristic(this.eve.Characteristics.TotalConsumption).updateValue(this.totalEnergyConsumption);
+    }
+    /**
+     * Gets the outlet state Characteristic based on its consumed power.
+     * @param {CharacteristicGetCallback} callback The callback.
+     */
+    getState(callback) {
+        this.log.debug(`${this.name}: GET State (power=${this.powerConsumption}W)`);
+        callback(null, this.powerConsumption > 0);
+    }
+    /*
+     * This method is called directly after creation of this instance.
+     * It should return all services which should be added to the accessory.
+     */
+    getServices() {
+        return [this.informationService, this.outletService, this.loggingService];
+    }
+}
+exports.SolaxOutletAccessory = SolaxOutletAccessory;
 //# sourceMappingURL=outletAccessory.js.map