Renaming limiters to setpoints

config.schema.json

@@ -4,7 +4,7 @@
     "config": {
       "type": "object",
       "properties": {
-        "limiters": {
+        "setpoints": {
           "type": "object",
           "properties": {
             "csipAus": {
@@ -154,7 +154,7 @@
             }
           },
           "additionalProperties": false,
-          "description": "Limiters configuration"
+          "description": "Setpoints configuration"
         },
         "inverters": {
           "type": "array",
@@ -509,7 +509,7 @@
         }
       },
       "required": [
-        "limiters",
+        "setpoints",
         "inverters",
         "inverterControl",
         "meter"

config/config.example.json

@@ -1,5 +1,5 @@
 {
-    "limiters": {
+    "setpoints": {
     },
     "inverters": [
         {
@@ -25,4 +25,4 @@
         "unitId": 240,
         "location": "feedin"
     }
-}
+}

docs/configuration/limiters.md → docs/configuration/setpoints.md

@@ -1,8 +1,8 @@
-# Limiters
+# Setpoints
 
-One or more limiters can be configured to set the operating envelope of the site. 
+One or more setpoints can be configured to set the operating envelope of the site. 
 
-All limiters are restrictive, that is a combination of multiple limiters will evaluate all limiters and enforce the most prohibitive value of each control type at any one time.
+All setpoints are restrictive, that is a combination of multiple setpoints will evaluate all setpoints and enforce the most prohibitive value of each control type at any one time.
 
 [[toc]]
 
@@ -23,16 +23,16 @@ The software supports 6 control modes mapped to the CSIP-AUS Dynamic Operating E
 
 ## CSIP-AUS dynamic connection
 
-Apply dynamic limits from an Australian energy utility CSIP-AUS server.
+Apply dynamic limits from an Australian energy utility CSIP-AUS server using a setpoint.
 
 > [!IMPORTANT]
 > This CSIP-AUS client cannot run without device certificates (and manufacturer certificates). See the [CSIP-AUS section](/csip-aus) for more information.
 
-To use the CSIP-AUS limiter, add following property to `config.json`
+To use the CSIP-AUS provided limits as a setpoint, add following property to `config.json`
 
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "csipAus": {
             "host": "https://sep2-test.energyq.com.au", // (string) required: the CSIP-AUS server host
             "dcapUri": "/api/v2/dcap", // (string) required: the device capability discovery URI
@@ -43,13 +43,15 @@ To use the CSIP-AUS limiter, add following property to `config.json`
 }
 ```
 
+The `nmi` is not required for Energex/Ergon Energy/Energy Queensland.
+
 ## Fixed limit
 
-To set fixed limits (such as for fixed export limits), add the following property to `config.json`
+To use a setpoint to specify fixed limits (such as for fixed export limits), add the following property to `config.json`
 
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "fixed": {
             "connect": true, // (true/false) optional: whether the inverters should be connected to the grid
             "exportLimitWatts": 5000, // (number) optional: the maximum export limit in watts
@@ -64,14 +66,14 @@ To set fixed limits (such as for fixed export limits), add the following propert
 
 ## MQTT
 
-To set limits based on a MQTT topic, add the following property to `config.json`
+To specify setpoint limits based on a MQTT topic, add the following property to `config.json`
 
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "mqtt": {
             "host": "mqtt://192.168.1.123",
-            "topic": "limits"
+            "topic": "setpoints"
         }
     }
     ...
@@ -103,12 +105,12 @@ For example
 
 ## Negative feed-in
 
-To set a zero export limit based on negative feed-in, add the following property to `config.json`
+To set a zero export limit setpoint based on negative feed-in, add the following property to `config.json`
 
 For Amber Electric:
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "negativeFeedIn": {
             "type": "amber", // (string) required: the source of the negative feed-in data
             "apiKey": "asdf", // (string) required: the Amber API key
@@ -121,12 +123,12 @@ For Amber Electric:
 
 ## Two-way tariffs
 
-To set a zero export limit based on two-way tariffs, add the following property to `config.json`
+To set a zero export limit setpoint based on two-way tariffs, add the following property to `config.json`
 
 For [Ausgrid solar tariff](https://www.ausgrid.com.au/Connections/Solar-and-batteries/Solar-tariffs) EA029:
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "twoWayTariff": {
             "type": "ausgridEA029"
         }
@@ -138,11 +140,11 @@ For [Ausgrid solar tariff](https://www.ausgrid.com.au/Connections/Solar-and-batt
 For [SAPN RELE2W](https://www.sapowernetworks.com.au/public/download.jsp?id=328119) tariff:
 ```js
 {
-    "limiters": {
+    "setpoints": {
         "twoWayTariff": {
             "type": "sapnRELE2W"
         }
     }
     ...
 }
-```
+```

docs/guide/index.md

@@ -24,7 +24,7 @@ flowchart LR
     ODE <--> SunSpec & Modbus & HTTP & Proprietary & MQTT
     Protocols <--> I & M
 
-    subgraph Limiters
+    subgraph Setpoints
     DC["Dynamic exports"]
     F["Fixed/zero export"]
     T["Two-way tariffs"]
@@ -41,8 +41,8 @@ flowchart LR
     end
 ```
 
-### Limiters
-The system uses one or more "limiters" to set the operating envelope of the site. All limiters are restrictive, that is a combination of multiple limiters will evaluate all limiters and enforce the most prohibitive value of each control type at any one time. [Learn more about configuring limiters](/configuration/limiters).
+### Setpoints
+The system uses one or more "setpoints" to set the operating envelope of the site. All setpoints are restrictive, that is a combination of multiple setpoints will evaluate all setpoints and enforce the most prohibitive value of each control type at any one time. [Learn more about configuring setpoints](/configuration/setpoints).
 
 ### Inverters
 The system supports one or more inverters to measure the site's generation metrics and control the power output. [Learn more about configuring inverters](/configuration/inverters).

eslint.config.mjs

@@ -18,7 +18,7 @@ export default tseslint.config(
         ignores: [
             'dist/',
             'logs/',
-            'src/limiters/negativeFeedIn/amber/api.d.ts',
+            'src/setpoints/negativeFeedIn/amber/api.d.ts',
             'src/ui/gen/',
             'docs/.vitepress/cache',
             'docs/.vitepress/dist',

package.json

@@ -16,7 +16,7 @@
     "cert:device-generate": "tsx scripts/certDeviceGenerate.ts",
     "cert:lfdi": "tsx scripts/certLfdi.ts",
     "generate:config-json-schema": "tsx scripts/generateConfigJsonSchema.ts",
-    "generate:amber-api": "openapi-typescript https://raw.githubusercontent.com/amberelectric/public-api/main/swagger.json -o ./src/limiters/negativeFeedIn/amber/api.d.ts",
+    "generate:amber-api": "openapi-typescript https://raw.githubusercontent.com/amberelectric/public-api/main/swagger.json -o ./src/setpoints/negativeFeedIn/amber/api.d.ts",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs"
@@ -122,4 +122,4 @@
     "xml2js": "^0.6.2",
     "zod": "^3.24.2"
   }
-}
+}

src/coordinator/helpers/inverterController.ts

@@ -10,12 +10,12 @@ import {
     writeLoadWatts,
 } from '../../helpers/influxdb.js';
 import { type SiteSample } from '../../meters/siteSample.js';
-import { type Limiters } from '../../limiters/index.js';
+import { type Setpoints } from '../../setpoints/index.js';
 import {
     objectEntriesWithType,
     objectFromEntriesWithType,
 } from '../../helpers/object.js';
-import { type Config, type LimiterKeys } from '../../helpers/config.js';
+import { type Config, type SetpointKeys } from '../../helpers/config.js';
 import { cappedChange } from '../../helpers/math.js';
 import { type DerSample } from './derSample.js';
 import { CappedArrayStack } from '../../helpers/cappedArrayStack.js';
@@ -74,11 +74,11 @@ export class InverterController {
     private cachedDerSample = new CappedArrayStack<DerSample>({ limit: 100 });
     private cachedSiteSample = new CappedArrayStack<SiteSample>({ limit: 100 });
     private logger: Logger;
-    private limiters: Limiters;
+    private setpoints: Setpoints;
     private loadWattsCache: number | null = null;
     private controlLimitsCache: {
-        controlLimitsByLimiter: Record<
-            LimiterKeys,
+        controlLimitsBySetpoint: Record<
+            SetpointKeys,
             InverterControlLimit | null
         >;
         activeInverterControlLimit: ActiveInverterControlLimit;
@@ -101,19 +101,19 @@ export class InverterController {
 
     constructor({
         config,
-        limiters,
+        setpoints,
         onControl,
     }: {
         config: Config;
-        limiters: Limiters;
+        setpoints: Setpoints;
         onControl: (
             inverterConfiguration: InverterConfiguration,
         ) => Promise<void>;
     }) {
         this.publish = new Publish({ config });
         this.secondsToSample = config.inverterControl.sampleSeconds;
         this.intervalSeconds = config.inverterControl.intervalSeconds;
-        this.limiters = limiters;
+        this.setpoints = setpoints;
         this.logger = pinoLogger.child({ module: 'InverterController' });
         this.abortController = new AbortController();
         this.onControl = onControl;
@@ -165,15 +165,15 @@ export class InverterController {
     private updateControlLimitsLoop() {
         const start = performance.now();
 
-        const controlLimitsByLimiter = objectFromEntriesWithType(
-            objectEntriesWithType(this.limiters).map(([key, limiter]) => [
+        const controlLimitsBySetpoint = objectFromEntriesWithType(
+            objectEntriesWithType(this.setpoints).map(([key, setpoint]) => [
                 key,
-                limiter?.getInverterControlLimit() ?? null,
+                setpoint?.getInverterControlLimit() ?? null,
             ]),
         );
 
         const activeInverterControlLimit = getActiveInverterControlLimit(
-            Object.values(controlLimitsByLimiter),
+            Object.values(controlLimitsBySetpoint),
         );
 
         writeActiveControlLimit({ limit: activeInverterControlLimit });
@@ -183,7 +183,7 @@ export class InverterController {
         });
 
         this.controlLimitsCache = {
-            controlLimitsByLimiter,
+            controlLimitsBySetpoint,
             activeInverterControlLimit,
         };
 

src/coordinator/index.ts

@@ -11,16 +11,16 @@ import { getSep2Instance } from '../sep2/index.js';
 import { getSiteSamplePollerInstance } from './helpers/siteSample.js';
 import { type SiteSamplePollerBase } from '../meters/siteSamplePollerBase.js';
 import { InvertersPoller } from './helpers/inverterSample.js';
-import { destroyLimiters, type Limiters } from '../limiters/index.js';
-import { getLimiters } from '../limiters/index.js';
+import { destroySetpoints, type Setpoints } from '../setpoints/index.js';
+import { getSetpoints } from '../setpoints/index.js';
 
 const logger = pinoLogger.child({ module: 'coordinator' });
 
 export type Coordinator = {
     inverterController: InverterController;
     invertersPoller: InvertersPoller;
     siteSamplePoller: SiteSamplePollerBase;
-    limiters: Limiters;
+    setpoints: Setpoints;
     destroy: () => void;
 };
 
@@ -41,14 +41,14 @@ export function createCoordinator(): Coordinator {
         rampRateHelper,
     });
 
-    const limiters = getLimiters({
+    const setpoints = getSetpoints({
         config,
         sep2Instance,
     });
 
     const inverterController = new InverterController({
         config,
-        limiters,
+        setpoints,
         onControl: (InverterController) =>
             invertersPoller.onControl(InverterController),
     });
@@ -76,14 +76,14 @@ export function createCoordinator(): Coordinator {
         inverterController,
         invertersPoller,
         siteSamplePoller,
-        limiters,
+        setpoints,
         destroy: () => {
             logger.info('Destroying coordinator');
             sep2Instance?.destroy();
             siteSamplePoller.destroy();
             invertersPoller.destroy();
             inverterController.destroy();
-            destroyLimiters(limiters);
+            destroySetpoints(setpoints);
         },
     };
 }

src/helpers/config.ts

@@ -44,7 +44,7 @@ const modbusSchema = z.object({
 export type ModbusSchema = z.infer<typeof modbusSchema>;
 
 export const configSchema = z.object({
-    limiters: z
+    setpoints: z
         .object({
             csipAus: z
                 .object({
@@ -146,7 +146,7 @@ export const configSchema = z.object({
                 .optional()
                 .describe('If defined, limit by MQTT'),
         })
-        .describe('Limiters configuration'),
+        .describe('Setpoints configuration'),
     inverters: z
         .array(
             z.union([
@@ -317,7 +317,7 @@ A longer time will smooth out load changes but may result in overshoot.`,
 
 export type Config = z.infer<typeof configSchema>;
 
-export type LimiterKeys = keyof Config['limiters'];
+export type SetpointKeys = keyof Config['setpoints'];
 
 export function getConfigPath() {
     return `${env.CONFIG_DIR}/config.json`;