Merge pull request #34 from longzheng/sunspec-optimize

Optimize SunSpec connection to reduce control loop latency
longzheng · Oct 2, 2024 · 9a90736 · 9a90736
2 parents 8b31ca3 + 8aaaf10
commit 9a90736
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 141 deletions.
diff --git a/src/coordinator/helpers/inverterController.ts b/src/coordinator/helpers/inverterController.ts
@@ -111,7 +111,7 @@ export class InverterController {
             const end = performance.now();
             const duration = end - start;
 
-            this.logger.trace({ duration }, 'run time');
+            this.logger.trace({ duration }, 'Updated inverter control values');
 
             // update the inverter at most every 1 second
             const delay = Math.max(1000 - duration, 0);

diff --git a/src/coordinator/helpers/inverterSample.ts b/src/coordinator/helpers/inverterSample.ts
@@ -76,7 +76,10 @@ export class InvertersPoller extends EventEmitter<{
 
         this.derSampleCache = derSample;
 
-        this.logger.trace({ derSample }, 'generated DER sample');
+        this.logger.trace(
+            { derSample, successInvertersCount: successInvertersData.length },
+            'generated DER sample',
+        );
 
         this.emit('data', derSample);
     }

diff --git a/src/inverter/inverterDataPollerBase.ts b/src/inverter/inverterDataPollerBase.ts
@@ -60,30 +60,25 @@ export abstract class InverterDataPollerBase extends EventEmitter<{
     protected async startPolling() {
         const start = performance.now();
 
-        this.logger.trace('polling inverter data');
-
         const inverterData = await this.getInverterData();
 
-        this.logger.trace({ inverterData }, 'polled inverter data');
-
         this.inverterDataCache = inverterData;
 
-        this.emit('data', inverterData);
-
         const end = performance.now();
+        const duration = end - start;
+
+        this.logger.trace({ duration, inverterData }, 'polled inverter data');
 
         // this loop must meet sampling requirements and dynamic export requirements
         // Energex SEP2 Client Handbook specifies "As per the standard, samples should be taken every 200ms (10 cycles). If not capable of sampling this frequently, 1 second samples may be sufficient."
         // SA Power Networks – Dynamic Exports Utility Interconnection Handbook specifies "Average readings shall be generated by sampling at least every 5 seconds. For example, sample rates of less than 5 seconds are permitted."
-        const duration = end - start;
-
-        this.logger.trace({ duration }, 'run time');
-
         // we don't want to run this loop any more frequently than the polling interval to prevent overloading the connection
         const delay = Math.max(this.pollingIntervalMs - duration, 0);
 
         this.pollingTimer = setTimeout(() => {
             void this.startPolling();
         }, delay);
+
+        this.emit('data', inverterData);
     }
 }
diff --git a/src/inverter/sunspec/index.ts b/src/inverter/sunspec/index.ts
@@ -61,6 +61,8 @@ export class SunSpecInverterDataPoller extends InverterDataPollerBase {
 
     override async getInverterData(): Promise<Result<InverterData>> {
         try {
+            const start = performance.now();
+
             const models = {
                 inverter: await this.inverterConnection.getInverterModel(),
                 nameplate: await this.inverterConnection.getNameplateModel(),
@@ -69,7 +71,10 @@ export class SunSpecInverterDataPoller extends InverterDataPollerBase {
                 controls: await this.inverterConnection.getControlsModel(),
             };
 
-            this.logger.trace({ models }, 'received model data');
+            const end = performance.now();
+            const duration = end - start;
+
+            this.logger.trace({ duration, models }, 'Got inverter data');
 
             this.cachedControlsModel = models.controls;
 
@@ -234,13 +239,23 @@ export function generateControlsModelWriteFromInverterConfiguration({
                     targetSolarPowerRatio: 0,
                     controlsModel,
                 }),
+                // revert WMaxLimtPct in 60 seconds
+                // this is a safety measure in case the SunSpec connection is lost
+                // we want to revert the inverter to the default which is assumed to be safe
+                // we assume we will write another config witin 60 seconds to reset this timeout
+                WMaxLimPct_RvrtTms: 60,
                 VArPct_Ena: VArPct_Ena.DISABLED,
                 OutPFSet_Ena: OutPFSet_Ena.DISABLED,
             };
         case 'limit':
             return {
                 ...controlsModel,
                 Conn: Conn.CONNECT,
+                // revert Conn in 60 seconds
+                // this is a safety measure in case the SunSpec connection is lost
+                // we want to revert the inverter to the default which is assumed to be safe
+                // we assume we will write another config witin 60 seconds to reset this timeout
+                Conn_RvrtTms: 60,
                 WMaxLim_Ena: WMaxLim_Ena.ENABLED,
                 WMaxLimPct: getWMaxLimPctFromTargetSolarPowerRatio({
                     targetSolarPowerRatio:

diff --git a/src/meters/mqtt/index.ts b/src/meters/mqtt/index.ts
@@ -1,14 +1,13 @@
 import mqtt from 'mqtt';
 import type { Config } from '../../helpers/config.js';
-import type { z } from 'zod';
 import { SiteSamplePollerBase } from '../siteSamplePollerBase.js';
-import type { SiteSampleData } from '../siteSample.js';
+import type { SiteSample } from '../siteSample.js';
 import { siteSampleDataSchema } from '../siteSample.js';
 import type { Result } from '../../helpers/result.js';
 
 export class MqttSiteSamplePoller extends SiteSamplePollerBase {
     private client: mqtt.MqttClient;
-    private cachedMessage: z.infer<typeof siteSampleDataSchema> | null = null;
+    private cachedMessage: SiteSample | null = null;
 
     constructor({
         mqttConfig,
@@ -39,14 +38,14 @@ export class MqttSiteSamplePoller extends SiteSamplePollerBase {
                 return;
             }
 
-            this.cachedMessage = result.data;
+            this.cachedMessage = { date: new Date(), ...result.data };
         });
 
         void this.startPolling();
     }
 
     // eslint-disable-next-line @typescript-eslint/require-await
-    override async getSiteSampleData(): Promise<Result<SiteSampleData>> {
+    override async getSiteSample(): Promise<Result<SiteSample>> {
         if (!this.cachedMessage) {
             return {
                 success: false,

diff --git a/src/meters/powerwall2/index.ts b/src/meters/powerwall2/index.ts
@@ -1,5 +1,5 @@
 import { SiteSamplePollerBase } from '../siteSamplePollerBase.js';
-import type { SiteSampleData } from '../siteSample.js';
+import type { SiteSample } from '../siteSample.js';
 import { Powerwall2Client } from './client.js';
 import type { z } from 'zod';
 import type { metersSiteSchema } from './api.js';
@@ -27,11 +27,19 @@ export class Powerwall2SiteSamplePoller extends SiteSamplePollerBase {
         void this.startPolling();
     }
 
-    override async getSiteSampleData(): Promise<Result<SiteSampleData>> {
+    override async getSiteSample(): Promise<Result<SiteSample>> {
         try {
+            const start = performance.now();
+
             const metersSiteData = await this.client.getMetersSite();
 
-            this.logger.trace({ metersSiteData }, 'received data');
+            const end = performance.now();
+            const duration = end - start;
+
+            this.logger.trace(
+                { duration, metersSiteData },
+                'polled Powerwall meter site data',
+            );
 
             const siteSample = generateSiteSample({
                 meter: metersSiteData,
@@ -55,14 +63,15 @@ export function generateSiteSample({
     meter,
 }: {
     meter: z.infer<typeof metersSiteSchema>;
-}): SiteSampleData {
+}): SiteSample {
     const firstMeter = meter[0];
 
     if (!firstMeter) {
         throw new Error('no meter found');
     }
 
     return {
+        date: new Date(),
         realPower: {
             type: 'perPhaseNet',
             phaseA: firstMeter.Cached_readings.real_power_a,

diff --git a/src/meters/siteSamplePollerBase.ts b/src/meters/siteSamplePollerBase.ts
@@ -1,7 +1,7 @@
 import type { Logger } from 'pino';
 import { logger as pinoLogger } from '../helpers/logger.js';
 import EventEmitter from 'node:events';
-import type { SiteSample, SiteSampleData } from './siteSample.js';
+import type { SiteSample } from './siteSample.js';
 import type { Result } from '../helpers/result.js';
 
 export abstract class SiteSamplePollerBase extends EventEmitter<{
@@ -41,7 +41,7 @@ export abstract class SiteSamplePollerBase extends EventEmitter<{
         this.onDestroy();
     }
 
-    abstract getSiteSampleData(): Promise<Result<SiteSampleData>>;
+    abstract getSiteSample(): Promise<Result<SiteSample>>;
 
     abstract onDestroy(): void;
 
@@ -51,47 +51,34 @@ export abstract class SiteSamplePollerBase extends EventEmitter<{
 
     protected async startPolling() {
         const start = performance.now();
-        const now = new Date();
 
-        this.logger.trace('polling site sample data');
+        const siteSample = await this.getSiteSample();
 
-        const siteSampleData = await this.getSiteSampleData();
-
-        if (siteSampleData.success) {
-            const siteSample: SiteSample = {
-                // append current date to the site sample data
-                date: now,
-                ...siteSampleData.value,
-            };
-
-            this.logger.trace({ siteSample }, 'polled site sample data');
+        const end = performance.now();
+        const duration = end - start;
 
-            this.siteSampleCache = siteSample;
+        if (siteSample.success) {
+            this.siteSampleCache = siteSample.value;
 
-            this.emit('data', {
-                siteSample,
-            });
+            this.logger.trace({ duration, siteSample }, 'polled site sample');
         } else {
-            this.logger.error(
-                siteSampleData.error,
-                'Error polling site sample data',
-            );
+            this.logger.error(siteSample.error, 'Error polling site sample');
         }
 
-        const end = performance.now();
-
         // this loop must meet sampling requirements and dynamic export requirements
         // Energex SEP2 Client Handbook specifies "As per the standard, samples should be taken every 200ms (10 cycles). If not capable of sampling this frequently, 1 second samples may be sufficient."
         // SA Power Networks – Dynamic Exports Utility Interconnection Handbook specifies "Average readings shall be generated by sampling at least every 5 seconds. For example, sample rates of less than 5 seconds are permitted."
-        const duration = end - start;
-
-        this.logger.trace({ duration }, 'run time');
-
         // we don't want to run this loop any more frequently than the polling interval to prevent overloading the connection
         const delay = Math.max(this.pollingIntervalMs - duration, 0);
 
         this.pollingTimer = setTimeout(() => {
             void this.startPolling();
         }, delay);
+
+        if (siteSample.success) {
+            this.emit('data', {
+                siteSample: siteSample.value,
+            });
+        }
     }
 }
diff --git a/src/meters/sunspec/index.ts b/src/meters/sunspec/index.ts
@@ -1,5 +1,5 @@
 import type { MeterSunSpecConnection } from '../../sunspec/connection/meter.js';
-import type { SiteSampleData } from '../siteSample.js';
+import type { SiteSample } from '../siteSample.js';
 import { SiteSamplePollerBase } from '../siteSamplePollerBase.js';
 import { assertNonNull } from '../../helpers/null.js';
 import { getMeterMetrics } from '../../sunspec/helpers/meterMetrics.js';
@@ -38,11 +38,19 @@ export class SunSpecMeterSiteSamplePoller extends SiteSamplePollerBase {
         void this.startPolling();
     }
 
-    override async getSiteSampleData(): Promise<Result<SiteSampleData>> {
+    override async getSiteSample(): Promise<Result<SiteSample>> {
         try {
+            const start = performance.now();
+
             const meterModel = await this.meterConnection.getMeterModel();
 
-            this.logger.trace({ meterModel }, 'received data');
+            const end = performance.now();
+            const duration = end - start;
+
+            this.logger.trace(
+                { duration, meterModel },
+                'polled SunSpec meter data',
+            );
 
             const siteSample = (() => {
                 const sample = generateSiteSample({
@@ -78,10 +86,11 @@ export class SunSpecMeterSiteSamplePoller extends SiteSamplePollerBase {
     }
 }
 
-function generateSiteSample({ meter }: { meter: MeterModel }): SiteSampleData {
+function generateSiteSample({ meter }: { meter: MeterModel }): SiteSample {
     const meterMetrics = getMeterMetrics(meter);
 
     return {
+        date: new Date(),
         realPower: meterMetrics.WphA
             ? {
                   type: 'perPhaseNet',
@@ -117,9 +126,9 @@ function convertConsumptionMeteringToFeedInMetering({
     siteSample,
     derSample,
 }: {
-    siteSample: SiteSampleData;
+    siteSample: SiteSample;
     derSample: DerSample | null;
-}): SiteSampleData {
+}): SiteSample {
     if (!derSample) {
         throw new Error(
             'Cannot convert consumption metering to feed-in metering without DER data',
@@ -132,20 +141,18 @@ function convertConsumptionMeteringToFeedInMetering({
     });
 
     return {
+        ...siteSample,
         realPower: siteRealPower,
-        reactivePower: siteSample.reactivePower,
-        voltage: siteSample.voltage,
-        frequency: siteSample.frequency,
     };
 }
 
 export function convertConsumptionRealPowerToFeedInRealPower({
     consumptionRealPower,
     derRealPower,
 }: {
-    consumptionRealPower: SiteSampleData['realPower'];
+    consumptionRealPower: SiteSample['realPower'];
     derRealPower: DerSample['realPower'];
-}): SiteSampleData['realPower'] {
+}): SiteSample['realPower'] {
     if (
         consumptionRealPower.type === 'perPhaseNet' &&
         derRealPower.type === 'perPhaseNet'