homebridge-enphase-envoy 9.3.4 → 9.3.5

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [9.3.5] - (31.08.2024)
+
+## Changes
+
+- required upcomming homebridge 2.x.x required
+- fix [#153](https://github.com/grzegorz914/homebridge-enphase-envoy/issues/153)
+- error handle improvements
+- increase axios timeout to 25sec
+- cleanup
+
 ## [9.3.4] - (27.08.2024)
 
 ## Changes

package/index.js

@@ -14,7 +14,7 @@ class EnvoyPlatform {
     }
     this.accessories = [];
 
-    api.on('didFinishLaunching', () => {
+    api.on('didFinishLaunching', async () => {
       for (const device of config.devices) {
         const deviceName = device.name ?? false;
         const envoyFirmware7xx = device.envoyFirmware7xx || false;
@@ -83,41 +83,53 @@ class EnvoyPlatform {
         }
 
         //envoy device
-        const envoyDevice = new EnvoyDevice(api, deviceName, host, envoyFirmware7xx, envoyFirmware7xxTokenGenerationMode, envoyPasswd, envoyToken, envoySerialNumber, enlightenUser, enlightenPasswd, envoyIdFile, envoyTokenFile, envoyInstallerPasswordFile, device);
-        envoyDevice.on('publishAccessory', (accessory) => {
-          api.publishExternalAccessories(CONSTANTS.PluginName, [accessory]);
-          log.success(`Device: ${host} ${deviceName}, published as external accessory.`);
-        })
-          .on('devInfo', (devInfo) => {
-            log.info(devInfo);
-          })
-          .on('success', (message) => {
-            log.success(`Device: ${host} ${deviceName}, ${message}`);
-          })
-          .on('message', (message) => {
-            log.info(`Device: ${host} ${deviceName}, ${message}`);
-          })
-          .on('debug', (message, debug) => {
-            debug = (debug !== null && debug !== undefined) ? `debug: ${message} ${JSON.stringify(debug, null, 2)}` : `${message}`
-            log.info(`Device: ${host} ${deviceName}, ${debug}`);
-          })
-          .on('warn', (message) => {
-            log.warn(`Device: ${host} ${deviceName}, ${message}`);
+        try {
+          this.envoyDevice = new EnvoyDevice(api, deviceName, host, envoyFirmware7xx, envoyFirmware7xxTokenGenerationMode, envoyPasswd, envoyToken, envoySerialNumber, enlightenUser, enlightenPasswd, envoyIdFile, envoyTokenFile, envoyInstallerPasswordFile, device);
+          this.envoyDevice.on('publishAccessory', (accessory) => {
+            api.publishExternalAccessories(CONSTANTS.PluginName, [accessory]);
+            log.success(`Device: ${host} ${deviceName}, published as external accessory.`);
           })
-          .on('error', async (error) => {
-            //stop impulse generator
-            envoyDevice.impulseGenerator.stop();
-
-            //handle error
-            const errorString = error.toString();
-            const tokenNotValid = envoyFirmware7xx && errorString.includes('status code 401');
-            const tokenExpired = envoyFirmware7xx && errorString.includes('JWT token expired');
-            const displayError = tokenNotValid ? log.warn(`Device: ${host} ${deviceName}, JWT token not valid, refreshing.`) : tokenExpired ? log.warn(`Device: ${host} ${deviceName}, ${error}, refreshing.`) : log.error(`Device: ${host} ${deviceName}, ${error}, trying again.`);
-
-            //wait and try connect again
-            await new Promise(resolve => setTimeout(resolve, 20000));
-            envoyDevice.start();
-          });
+            .on('devInfo', (devInfo) => {
+              log.info(devInfo);
+            })
+            .on('success', (message) => {
+              log.success(`Device: ${host} ${deviceName}, ${message}`);
+            })
+            .on('message', (message) => {
+              log.info(`Device: ${host} ${deviceName}, ${message}`);
+            })
+            .on('debug', (message, debug) => {
+              debug = (debug !== null && debug !== undefined) ? `debug: ${message} ${JSON.stringify(debug, null, 2)}` : `${message}`
+              log.info(`Device: ${host} ${deviceName}, ${debug}`);
+            })
+            .on('warn', (message) => {
+              log.warn(`Device: ${host} ${deviceName}, ${message}`);
+            })
+            .on('error', async (error) => {
+              //handle error
+              const errorString = error.toString();
+              const tokenNotValid = envoyFirmware7xx && errorString.includes('status code 401');
+              const tokenExpired = envoyFirmware7xx && errorString.includes('JWT token expired');
+              const displayError = tokenNotValid ? log.warn(`Device: ${host} ${deviceName}, JWT token not valid, refreshing.`) : tokenExpired ? log.warn(`Device: ${host} ${deviceName}, ${error}, refreshing.`) : log.error(`Device: ${host} ${deviceName}, ${error}, trying again.`);
+
+              //wait and try connect again
+              await new Promise(resolve => setTimeout(resolve, 20000));
+              await this.envoyDevice.start();
+            });
+
+          //start
+          await this.envoyDevice.start();
+        } catch (error) { //stop impulse generator
+          //handle error
+          const errorString = error.toString();
+          const tokenNotValid = envoyFirmware7xx && errorString.includes('status code 401');
+          const tokenExpired = envoyFirmware7xx && errorString.includes('JWT token expired');
+          const displayError = tokenNotValid ? log.warn(`Device: ${host} ${deviceName}, JWT token not valid, refreshing.`) : tokenExpired ? log.warn(`Device: ${host} ${deviceName}, ${error}, refreshing.`) : log.error(`Device: ${host} ${deviceName}, ${error}, trying again.`);
+
+          //wait and try connect again
+          await new Promise(resolve => setTimeout(resolve, 20000));
+          await this.envoyDevice.start();
+        }
       }
     });
   }

package/package.json

@@ -2,7 +2,7 @@
     "private": false,
     "displayName": "Enphase Envoy",
     "name": "homebridge-enphase-envoy",
-    "version": "9.3.4",
+    "version": "9.3.5",
     "description": "Homebridge plugin for Photovoltaic Energy System manufactured by Enphase.",
     "license": "MIT",
     "author": "grzegorz914",
@@ -29,11 +29,11 @@
     ],
     "engines": {
         "node": ">=18.0.0",
-        "homebridge": ">=1.8.0"
+        "homebridge": ">=2.0.0"
     },
     "dependencies": {
         "async-mqtt": "^2.6.3",
-        "axios": "^1.7.5",
+        "axios": "^1.7.7",
         "express": "^4.19.2",
         "fast-xml-parser": "^4.4.1"
     },

package/src/envoydevice.js

@@ -781,7 +781,7 @@ class EnvoyDevice extends EventEmitter {
             headers: {
                 Accept: 'application/json'
             },
-            timeout: 20000
+            timeout: 25000
         });
 
         //RESTFul server
@@ -853,6 +853,7 @@ class EnvoyDevice extends EventEmitter {
                 const updateHome = tokenExpired ? false : await this.updateHome();
                 const updateInventory = updateHome ? await this.updateInventory() : false;
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('updateMeters', async () => {
@@ -861,6 +862,7 @@ class EnvoyDevice extends EventEmitter {
                 const updateMeters = tokenExpired ? false : await this.updateMeters();
                 const updateMetersReading = updateMeters ? await this.updateMetersReading() : false;
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('updateMicroinvertersStatus', async () => {
@@ -868,6 +870,7 @@ class EnvoyDevice extends EventEmitter {
                 const tokenExpired = await this.checkJwtToken();
                 const updateMicroinvertersStatus = tokenExpired ? false : await this.updateMicroinvertersStatus();
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('updateProduction', async () => {
@@ -876,6 +879,7 @@ class EnvoyDevice extends EventEmitter {
                 const updateProduction = tokenExpired ? false : await this.updateProduction();
                 const updateProductionCt = updateProduction ? await this.updateProductionCt() : false;
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('updateEnsemble', async () => {
@@ -890,6 +894,7 @@ class EnvoyDevice extends EventEmitter {
                 const updateGenerator = updateEnsemble ? await this.updateGenerator() : false;
                 const updateGeneratorSettings = updateGenerator ? await this.updateGeneratorSettings() : false;
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('updateLiveData', async () => {
@@ -897,6 +902,7 @@ class EnvoyDevice extends EventEmitter {
                 const tokenExpired = await this.checkJwtToken();
                 const updateLiveData = tokenExpired ? false : await this.updateLiveData();
             } catch (error) {
+                this.impulseGenerator.stop();
                 this.emit('error', error);
             };
         }).on('state', (state) => {
@@ -937,8 +943,6 @@ class EnvoyDevice extends EventEmitter {
             //mqtt
             const mqtt = this.mqttConnected ? this.mqtt.emit('publish', 'Data Sampling', { state: state }) : false;
         });
-
-        this.start();
     };
 
     async start() {
@@ -1014,8 +1018,10 @@ class EnvoyDevice extends EventEmitter {
             const pushTimer4 = updateEnsemble ? this.timers.push({ name: 'updateEnsemble', sampling: this.ensembleDataRefreshTime }) : false;
             const pushTimer5 = updateLiveData ? this.timers.push({ name: 'updateLiveData', sampling: this.liveDataRefreshTime }) : false;
             this.impulseGenerator.start(this.timers);
+            return true;
         } catch (error) {
-            this.emit('error', error);
+            this.impulseGenerator.stop();
+            throw new Error(error);
         };
     };
 
@@ -1080,7 +1086,7 @@ class EnvoyDevice extends EventEmitter {
                     keepAlive: false,
                     rejectUnauthorized: false
                 }),
-                timeout: 20000
+                timeout: 25000
             });
 
             const response = await axiosInstanceToken(CONSTANTS.ApiUrls.CheckJwt);
@@ -1100,7 +1106,7 @@ class EnvoyDevice extends EventEmitter {
                     keepAlive: false,
                     rejectUnauthorized: false
                 }),
-                timeout: 20000
+                timeout: 25000
             });
 
             this.cookie = cookie;
@@ -1732,7 +1738,7 @@ class EnvoyDevice extends EventEmitter {
             const ensemblesInventoryInstalled = ensemblesInventory.length > 0;
             if (ensemblesInventoryInstalled) {
                 const type = CONSTANTS.ApiCodes[inventory[3].type] ?? 'Unknown';
-                ensembles.forEach((ensemble, index) => {
+                ensemblesInventory.forEach((ensemble, index) => {
                     const obj = {
                         type: type,
                         partNumber: CONSTANTS.PartNumbers[ensemble.part_num] ?? ensemble.part_num,