homebridge-solaxcloud-api 2.3.3 → 2.4.0

package/dist/platformInverter.d.ts

@@ -1,177 +1,181 @@
-import { AccessoryPlugin, API, Logging, PlatformConfig } from 'homebridge';
-/**
- * Inverter brand.
- */
-export declare const INVERTER_BRAND: {
-    SOLAX: number;
-    QCELLS: number;
-};
-/**
- * Standard names for accessories.
- */
-export declare const ACCESSORY_KEYS: {
-    pv: string;
-    inverterToBattery: string;
-    inverterFromBattery: string;
-    inverterAC: string;
-    inverterToGrid: string;
-    inverterToHouse: string;
-    gridToHouse: string;
-};
-/**
- * SolaxCloudAPIPlatformInverter.
- * This class is the main constructor for your inverter accessories
- * to be used by Homebridge.
- */
-export declare class SolaxCloudAPIPlatformInverter {
-    private readonly log;
-    private readonly config;
-    private readonly api;
-    /**
-     * Inverter brand.
-     */
-    private brand;
-    /**
-     * Inverter name.
-     */
-    private name;
-    /**
-     * Inverter serial number.
-     **/
-    private sn;
-    /**
-     * Whether this inverter has a battery.
-     **/
-    private batteryInstalled;
-    /**
-     * Size of window for statistical smoothing operations.
-     */
-    private smoothingWindow;
-    /**
-     * API for retrieving data from Solax cloud.
-     */
-    private solaxCloudAPI;
-    /**
-     * Virtual motion sensor triggered by data updates from Solax Cloud.
-     */
-    private motionUpdate;
-    /**
-     * Battery information for this inverter gathered from Solax Cloud.
-     */
-    private battery;
-    /**
-     * Outlets with raw data gathered from Solax Cloud.
-     */
-    private rawOutlets;
-    /**
-      * Smooth data outlets.
-      * These outlets present smoothed values based on the raw data figures to
-      * prevent events like the temporary passage of a cloud to directly affect values.
-      */
-    private smoothOutlets;
-    /**
-      * Ambient light sensors for Power Consumption (pure Home App config).
-      */
-    private rawLightSensors;
-    /**
-      * Ambient light sensors for smooth power consumption lights.
-      * These lights present smoothed values based on the raw data figures to
-      * prevent events like the temporary passage of a cloud to directly affect values.
-      */
-    private smoothLightSensors;
-    /** Array with all accessories */
-    private solaxAccessories;
-    /**
-      * Platform inverter constructor.
-      * @param log
-      * @param config
-      * @param api
-      * @param brand
-      * @param tokenId
-      * @param sn
-      * @param name
-      * @param hasBattery
-      * @param smoothingWindow
-      * @returns
-      */
-    constructor(log: Logging, config: PlatformConfig, api: API, brand: number, tokenId: string, sn: string, name: string, hasBattery: boolean, smoothingWindow: number);
-    /**
-     * Gets the inverter brand name.
-     * @param {number} brand Inverter brand type.
-     * @returns Inverter brand name.
-     */
-    static getInverterBrandName(brand: number): string;
-    /**
-      * Update all platform accessory status based on the values read from the API.
-      * @param {SolaxCloudAPIResponse} apiData API data from Solax Cloud.
-      */
-    private updateAccessories;
-    /**
-     * Sets the battery charge state for this inverter.
-     * @param {number} state The desired battery charge state.
-     */
-    setBatteryChargeState(state: number): void;
-    /**
-     * Gets the battery charge state for this inverter.
-     * @returns {number} Battery charge state.
-     */
-    getBatteryChargeState(): number;
-    /**
-     * Sets the current battery level for this inverter.
-     * @param {number} percentage Battery level to set (percentage).
-     */
-    setBatteryLevel(percentage: number): void;
-    /**
-     * Gets the current battery level for this inverter.
-     * @returns {number} The current battery level (percentage).
-     */
-    getBatteryLevel(): number;
-    /**
-     * Sets virtual update motion detector to true to notify of new data update.
-     */
-    setMotionUpdate(): void;
-    /**
-     * Gets raw accessory power for this inverter.
-     * @param {string} key Accessory key.
-     * @returns {number} Power consumptions for this accessory.
-     */
-    getRawPower(key: string): number;
-    /**
-     * Sets raw accessory power for this inverter.
-     * @param {string} key Accessory key.
-     * @param {number} power Power to set (in Watt).
-     */
-    setRawPower(key: string, power: number): void;
-    /**
-     * Gets raw accessory energy for this inverter.
-     * @param {string} key Accessory key.
-     * @returns {number} The energy consumption for the desired acessory (in Wh).
-     */
-    getRawEnergy(key: string): number;
-    /**
-     * Sets raw accessory energy for this inverter.
-     * @param {string} key Accessory key.
-     * @param {number} energy Energy consumption to set (in Wh).
-     */
-    setRawEnergy(key: string, energy: number): void;
-    /**
-     * Sets smooth accessory power from raw accessory power for this inverter.
-     * @param {string} key Accessory key.
-     */
-    setSmoothPower(key: string): void;
-    /**
-     * Update data from this inverter by using the Solax Cloud API
-     */
-    updateInverterDataFromCloud(): void;
-    /**
-     * Returns whether this inverter has a battery installed.
-     * @returns {boolean} Whether this inverter battery has a battery installed.
-     */
-    hasBattery(): boolean;
-    /**
-     * Get array with full list of accessories for this inverter.
-     * @returns {AccessoryPlugin[]} Array of accessories for this inverter.
-     */
-    getAccessories(): AccessoryPlugin[];
-}
+import { AccessoryPlugin, API, Logging, PlatformConfig } from 'homebridge';
+/**
+ * Inverter brand.
+ */
+export declare const INVERTER_BRAND: {
+    SOLAX: number;
+    QCELLS: number;
+};
+/**
+ * Standard names for accessories.
+ */
+export declare const ACCESSORY_KEYS: {
+    pv: string;
+    inverterToBattery: string;
+    inverterFromBattery: string;
+    inverterAC: string;
+    inverterToGrid: string;
+    inverterToHouse: string;
+    gridToHouse: string;
+};
+/**
+ * SolaxCloudAPIPlatformInverter.
+ * This class is the main constructor for your inverter accessories
+ * to be used by Homebridge.
+ */
+export declare class SolaxCloudAPIPlatformInverter {
+    private readonly log;
+    private readonly config;
+    private readonly api;
+    /**
+     * Inverter name.
+     */
+    private name;
+    /**
+     * Inverter serial number.
+     **/
+    private sn;
+    /**
+     * Whether this inverter has a battery.
+     **/
+    private batteryInstalled;
+    /**
+     * Size of window for statistical smoothing operations.
+     */
+    private smoothingWindow;
+    /**
+     * API for retrieving data from Solax cloud.
+     */
+    private solaxCloudAPI?;
+    /**
+     * Inverter brand name.
+     */
+    private brandName;
+    /**
+     * Whether this inverter is a virtual accessory.
+     */
+    private virtual;
+    /**
+     * Virtual motion sensor triggered by data updates from Solax Cloud.
+     */
+    private motionUpdate;
+    /**
+     * Battery information for this inverter gathered from Solax Cloud.
+     */
+    private battery;
+    /**
+     * Outlets with raw data gathered from Solax Cloud.
+     */
+    private rawOutlets;
+    /**
+      * Smooth data outlets.
+      * These outlets present smoothed values based on the raw data figures to
+      * prevent events like the temporary passage of a cloud to directly affect values.
+      */
+    private smoothOutlets;
+    /**
+      * Ambient light sensors for Power Consumption (pure Home App config).
+      */
+    private rawLightSensors;
+    /**
+      * Ambient light sensors for smooth power consumption lights.
+      * These lights present smoothed values based on the raw data figures to
+      * prevent events like the temporary passage of a cloud to directly affect values.
+      */
+    private smoothLightSensors;
+    /** Array with all accessories */
+    private solaxAccessories;
+    /**
+      * Platform inverter constructor.
+      * @param log
+      * @param config
+      * @param api
+      * @param brand
+      * @param tokenId
+      * @param sn
+      * @param name
+      * @param hasBattery
+      * @param smoothingWindow
+      * @returns
+      */
+    constructor(log: Logging, config: PlatformConfig, api: API, brand: number, tokenId: string, sn: string, name: string, hasBattery: boolean, smoothingWindow: number, virtual?: boolean, brandName?: string);
+    /**
+     * Gets the inverter brand name.
+     * @param {number} brand Inverter brand type.
+     * @returns Inverter brand name.
+     */
+    static getInverterBrandName(brand: number): string;
+    /**
+      * Update all platform accessory status based on the values read from the API.
+      * @param {SolaxCloudAPIResponse} apiData API data from Solax Cloud.
+      */
+    private updateAccessories;
+    /**
+     * Sets the battery charge state for this inverter.
+     * @param {number} state The desired battery charge state.
+     */
+    setBatteryChargeState(state: number): void;
+    /**
+     * Gets the battery charge state for this inverter.
+     * @returns {number} Battery charge state.
+     */
+    getBatteryChargeState(): number;
+    /**
+     * Sets the current battery level for this inverter.
+     * @param {number} percentage Battery level to set (percentage).
+     */
+    setBatteryLevel(percentage: number): void;
+    /**
+     * Gets the current battery level for this inverter.
+     * @returns {number} The current battery level (percentage).
+     */
+    getBatteryLevel(): number;
+    /**
+     * Sets virtual update motion detector to true to notify of new data update.
+     */
+    setMotionUpdate(): void;
+    /**
+     * Gets raw accessory power for this inverter.
+     * @param {string} key Accessory key.
+     * @returns {number} Power consumptions for this accessory.
+     */
+    getRawPower(key: string): number;
+    /**
+     * Sets raw accessory power for this inverter.
+     * @param {string} key Accessory key.
+     * @param {number} power Power to set (in Watt).
+     */
+    setRawPower(key: string, power: number): void;
+    /**
+     * Gets raw accessory energy for this inverter.
+     * @param {string} key Accessory key.
+     * @returns {number} The energy consumption for the desired acessory (in Wh).
+     */
+    getRawEnergy(key: string): number;
+    /**
+     * Sets raw accessory energy for this inverter.
+     * @param {string} key Accessory key.
+     * @param {number} energy Energy consumption to set (in Wh).
+     */
+    setRawEnergy(key: string, energy: number): void;
+    /**
+     * Sets smooth accessory power from raw accessory power for this inverter.
+     * @param {string} key Accessory key.
+     */
+    setSmoothPower(key: string): void;
+    /**
+     * Update data from this inverter by using the Solax Cloud API
+     */
+    updateInverterDataFromCloud(): void;
+    /**
+     * Returns whether this inverter has a battery installed.
+     * @returns {boolean} Whether this inverter battery has a battery installed.
+     */
+    hasBattery(): boolean;
+    /**
+     * Get array with full list of accessories for this inverter.
+     * @returns {AccessoryPlugin[]} Array of accessories for this inverter.
+     */
+    getAccessories(): AccessoryPlugin[];
+}
 //# sourceMappingURL=platformInverter.d.ts.map

package/dist/platformInverter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"platformInverter.d.ts","sourceRoot":"","sources":["../src/platformInverter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAY3E;;GAEG;AACH,eAAO,MAAM,cAAc;;;CAG1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;CAQ1B,CAAC;AA4BF;;;;GAIG;AACH,qBAAa,6BAA6B;IACxC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAU;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAE1B;;OAEG;IACH,OAAO,CAAC,KAAK,CAAS;IAEtB;;OAEG;IACH,OAAO,CAAC,IAAI,CAAS;IAErB;;QAEI;IACJ,OAAO,CAAC,EAAE,CAAS;IAEnB;;QAEI;IACJ,OAAO,CAAC,gBAAgB,CAAU;IAElC;;OAEG;IACH,OAAO,CAAC,eAAe,CAAS;IAEhC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAgB;IAErC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAwB;IAE5C;;OAEG;IACH,OAAO,CAAC,OAAO,CAAyB;IAExC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAwB;IAE1C;;;;QAII;IACJ,OAAO,CAAC,aAAa,CAAwB;IAE7C;;QAEI;IACJ,OAAO,CAAC,eAAe,CAA6B;IAEpD;;;;QAII;IACJ,OAAO,CAAC,kBAAkB,CAA6B;IAEvD,iCAAiC;IACjC,OAAO,CAAC,gBAAgB,CAAyB;IAEjD;;;;;;;;;;;;QAYI;gBACS,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,EACzD,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAC1C,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EACjC,eAAe,EAAE,MAAM;IAmLzB;;;;OAIG;WACW,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IASzD;;;QAGI;IACJ,OAAO,CAAC,iBAAiB;IAuCzB;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM;IAI1C;;;OAGG;IACI,qBAAqB,IAAI,MAAM;IAItC;;;OAGG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM;IAIzC;;;OAGG;IACI,eAAe,IAAI,MAAM;IAIhC;;OAEG;IACI,eAAe;IAItB;;;;OAIG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIvC;;;;OAIG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAQ7C;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIxC;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAI/C;;;OAGG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM;IAUjC;;OAEG;IACI,2BAA2B;IAoBlC;;;OAGG;IACI,UAAU,IAAI,OAAO;IAI5B;;;OAGG;IACI,cAAc,IAAI,eAAe,EAAE;CAI3C"}
+{"version":3,"file":"platformInverter.d.ts","sourceRoot":"","sources":["../src/platformInverter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAY3E;;GAEG;AACH,eAAO,MAAM,cAAc;;;CAG1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;CAQ1B,CAAC;AA4BF;;;;GAIG;AACH,qBAAa,6BAA6B;IACxC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAU;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;IAE1B;;OAEG;IACH,OAAO,CAAC,IAAI,CAAS;IAErB;;QAEI;IACJ,OAAO,CAAC,EAAE,CAAS;IAEnB;;QAEI;IACJ,OAAO,CAAC,gBAAgB,CAAU;IAElC;;OAEG;IACH,OAAO,CAAC,eAAe,CAAS;IAEhC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAC,CAAgB;IAEtC;;OAEG;IACH,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;IACH,OAAO,CAAC,YAAY,CAAwB;IAE5C;;OAEG;IACH,OAAO,CAAC,OAAO,CAAyB;IAExC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAwB;IAE1C;;;;QAII;IACJ,OAAO,CAAC,aAAa,CAAwB;IAE7C;;QAEI;IACJ,OAAO,CAAC,eAAe,CAA6B;IAEpD;;;;QAII;IACJ,OAAO,CAAC,kBAAkB,CAA6B;IAEvD,iCAAiC;IACjC,OAAO,CAAC,gBAAgB,CAAyB;IAEjD;;;;;;;;;;;;QAYI;gBACS,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,EACzD,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAC1C,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EACjC,eAAe,EAAE,MAAM,EACvB,OAAO,UAAQ,EACf,SAAS,SAA4D;IAqLvE;;;;OAIG;WACW,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IASzD;;;QAGI;IACJ,OAAO,CAAC,iBAAiB;IAuCzB;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM;IAI1C;;;OAGG;IACI,qBAAqB,IAAI,MAAM;IAItC;;;OAGG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM;IAIzC;;;OAGG;IACI,eAAe,IAAI,MAAM;IAIhC;;OAEG;IACI,eAAe;IAItB;;;;OAIG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIvC;;;;OAIG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAQ7C;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIxC;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAI/C;;;OAGG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM;IAUjC;;OAEG;IACI,2BAA2B;IAwBlC;;;OAGG;IACI,UAAU,IAAI,OAAO;IAI5B;;;OAGG;IACI,cAAc,IAAI,eAAe,EAAE;CAI3C"}