node-red-contrib-s2 0.1.2 → 0.2.0

package/dist/nodes/s2-pebc-config/index.js

@@ -0,0 +1,10 @@
+"use strict";
+module.exports = function (RED) {
+    function S2PebcConfigNodeConstructor(config) {
+        RED.nodes.createNode(this, config);
+        this.gridConnection = config.gridConnection;
+        this.customMaxPowerW = config.customMaxPowerW != null ? Number(config.customMaxPowerW) : undefined;
+    }
+    RED.nodes.registerType('s2-pebc-config', S2PebcConfigNodeConstructor);
+};
+//# sourceMappingURL=index.js.map

package/dist/nodes/s2-pebc-config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/nodes/s2-pebc-config/index.ts"],"names":[],"mappings":";AAGA,iBAAS,UAAU,GAAe;IAChC,SAAS,2BAA2B,CAA0B,MAAkB;QAC9E,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAClC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAwB,CAAA;QACrD,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACpG,CAAC;IAED,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,2BAA2B,CAAC,CAAA;AACvE,CAAC,CAAA"}

package/dist/nodes/s2-rm/index.d.ts

@@ -2,20 +2,29 @@ import { NodeRedApp } from '../../types/node-red';
 /**
  * s2-rm node (S2 Resource Manager)
  *
- * Manages S2 protocol sessions for all connected CEMs. Sits between
- * the transport node (victron-virtual acload, s2-websocket, etc.) and the
- * rest of the flow.
+ * Generic S2 protocol state machine: handshake, control-type selection,
+ * generic instruction ack/routing. Control-type-specific behavior (OMBC mode
+ * resolution, PEBC schedule dispatch, etc.) lives in dedicated nodes
+ * (s2-ombc, s2-pebc, ...) wired downstream/alongside this node.
  *
  * Wiring:
  *   [transport port 2] -> [s2-rm input]
  *   [s2-rm port 1]     -> [transport input]
+ *   [s2-rm port 2]     -> [control-type node input]  (so it can observe SelectControlType/RevokeObject/etc.)
+ *   [s2-rm port 3]     -> [control-type node input]  (enriched instructions)
+ *   [control-type node command output] -> [s2-rm input]  (UpdateStatus/SystemDescription/PowerConstraints/InstructionStatus)
  *
- * Input msg.payload from transport:
- *   { command: 'Connect',          cemId, keepAliveInterval }
- *   { command: 'Message',          cemId, message }   <- message is a raw S2 JSON string
- *   { command: 'KeepAlive',        cemId }
- *   { command: 'PowerMeasurement', cemId, values }
- *   { command: 'Disconnect',       cemId }
+ * Input msg.payload from transport or a control-type node:
+ *   { command: 'Connect',           cemId, keepAliveInterval }
+ *   { command: 'Message',           cemId, message }   <- message is a raw S2 JSON string
+ *   { command: 'KeepAlive',         cemId }
+ *   { command: 'PowerMeasurement',  cemId, values }
+ *   { command: 'PowerConstraints',  constraints }
+ *   { command: 'Forecast',          cemId, forecast }
+ *   { command: 'Disconnect',        cemId }
+ *   { command: 'InstructionStatus', cemId, instructionId, status }
+ *   { command: 'UpdateStatus',         cemId, controlType, <namespaced status payload, e.g. ombc: {...}> }
+ *   { command: 'SystemDescription',    cemId, controlType, <namespaced system description payload, e.g. ombc: {...}> }
  *
  * Output port 1 - messages to send to the CEM (via transport input):
  *   { payload: { s2Signal: 'Message', message: <S2 message object> }, cemId }
@@ -27,8 +36,9 @@ import { NodeRedApp } from '../../types/node-red';
  *   { topic: 'Connected',    cemId: <string> }
  *   { topic: 'Disconnected', cemId: <string>, reason: 'cem_initiated' | 'keepalive_timeout' }
  *
- * Output port 3 - S2 instructions from CEM:
- *   { payload: <S2 instruction object>, cemId: <string> }
+ * Output port 3 - S2 instructions from CEM, enriched with the resolved control type:
+ *   { payload: <S2 instruction object>, cemId: <string>, controlType: <string>, <namespace key>: <S2 instruction object> }
+ *   e.g. for an OMBC.Instruction: { payload: {...}, cemId, controlType: 'OPERATION_MODE_BASED_CONTROL', ombc: {...} }
  */
 declare const _default: (RED: NodeRedApp) => void;
 export = _default;

package/dist/nodes/s2-rm/index.html

@@ -6,16 +6,13 @@
     defaults: {
       name: { value: '' },
       rmConfig: { value: '', type: 's2-rm-config', required: true },
-      cem: { value: '', type: 's2-cem-config', required: false },
-      controlTypeConfig: { value: '' },
-      providesPowerMeasurement: { value: '3_PHASE_SYMMETRIC' },
-      providesForecast: { value: false }
+      cem: { value: '', type: 's2-cem-config', required: false }
     },
     inputs: 1,
-    outputs: 4,
+    outputs: 3,
     icon: 's2-logo.svg',
-    outputLabels: ['to transport', 'from CEM', 'instructions', 'schedule'],
-    inputLabels: ['from transport'],
+    outputLabels: ['to transport', 'from CEM', 'instructions'],
+    inputLabels: ['from transport / control-type nodes'],
     label: function () {
       return this.name || 'S2 Resource Manager'
     },
@@ -23,53 +20,7 @@
       return this.name ? 'node_label_italic' : ''
     },
     oneditprepare: function () {
-      // Migrate legacy boolean to string value
-      if (this.providesPowerMeasurement === true) {
-        this.providesPowerMeasurement = '3_PHASE_SYMMETRIC'
-        $('#node-input-providesPowerMeasurement').val('3_PHASE_SYMMETRIC')
-      } else if (this.providesPowerMeasurement === false) {
-        this.providesPowerMeasurement = ''
-        $('#node-input-providesPowerMeasurement').val('')
-      }
-
-      $('#node-input-controlTypeConfig').typedInput({ types: ['json'] })
-
       window.__s2Common.initializeTooltips()
-
-      if (!this.controlTypeConfig) {
-        var modeId = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-          var r = Math.random() * 16 | 0
-          return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16)
-        })
-        var defaultConfig = {
-          OMBC: {
-            systemDescription: {
-              operationModes: [
-                {
-                  id: modeId,
-                  diagnostic_label: 'Normal operation',
-                  power_ranges: [
-                    {
-                      commodity_quantity: 'ELECTRIC.POWER.3_PHASE_SYMMETRIC',
-                      start_of_range: 0,
-                      end_of_range: 2500
-                    }
-                  ],
-                  abnormal_condition_only: false
-                }
-              ],
-              transitions: [],
-              timers: []
-            },
-            status: {
-              activeOperationModeId: modeId,
-              operationModeFactor: 1
-            }
-          }
-        }
-        $('#node-input-controlTypeConfig').typedInput('value', JSON.stringify(defaultConfig, null, 2))
-      }
-
     }
   })
 </script>
@@ -94,40 +45,19 @@
       <input type="text" id="node-input-cem">
     </div>
 
-    <div class="form-row">
-      <label for="node-input-controlTypeConfig"><i class="fa fa-code"></i> Control Type<i class="fa fa-info-circle tooltip-icon" data-tooltip="JSON configuration per control type. For OMBC: operation modes, power ranges, transitions and timers. Keys: OMBC.systemDescription.operationModes, OMBC.status.activeOperationModeId"></i></label>
-      <input type="text" id="node-input-controlTypeConfig">
-    </div>
-
-    <div class="form-row">
-      <label for="node-input-providesPowerMeasurement"><i class="fa fa-bolt"></i> Power Meas.<i class="fa fa-info-circle tooltip-icon" data-tooltip="Commodity quantities for power measurement. Advertised to the CEM in ResourceManagerDetails."></i></label>
-      <select id="node-input-providesPowerMeasurement" style="width: 70%;">
-        <option value="">None</option>
-        <option value="3_PHASE_SYMMETRIC">3-phase symmetric</option>
-        <option value="L1_L2_L3">Per phase (L1, L2, L3)</option>
-      </select>
-    </div>
-
-    <div class="form-row">
-      <label for="node-input-providesForecast">
-        <i class="fa fa-line-chart"></i> Forecast
-      </label>
-      <input type="checkbox" id="node-input-providesForecast" style="width: auto; margin-top: 6px;">
-      <span style="margin-left: 6px;">Provides power forecast</span>
-    </div>
-
   </div>
 </script>
 
 <link rel="stylesheet" href="resources/node-red-contrib-s2/s2-styles.css">
 
 <script type="text/html" data-help-name="s2-rm">
-  <p>Manages S2 protocol sessions for connected CEMs. Handles the S2 handshake, sends ResourceManagerDetails, and responds to SelectControlType.</p>
+  <p>Generic S2 protocol state machine for connected CEMs. Handles the S2 handshake, sends ResourceManagerDetails, and acknowledges/routes instructions - independent of any specific control type's semantics.</p>
   <p>RM identity (resource ID, name, control types) is configured in the linked <b>s2-rm-config</b> node, shared with the transport node.</p>
+  <p>Control-type-specific behavior (OMBC mode resolution, PEBC schedule dispatch, etc.) lives in dedicated nodes - <b>s2-ombc</b>, <b>s2-pebc</b> - wired to this node's "from CEM" and "instructions" outputs, with their command output wired back to this node's input.</p>
   <h3>Input</h3>
   <dl class="message-properties">
     <dt>payload <span class="property-type">object</span></dt>
-    <dd>Command from transport: <code>{ command, cemId, ... }</code></dd>
+    <dd>Command from transport or a control-type node: <code>{ command, cemId, ... }</code>. Commands: <code>Connect</code>, <code>Message</code>, <code>KeepAlive</code>, <code>PowerMeasurement</code>, <code>PowerConstraints</code>, <code>Forecast</code>, <code>Disconnect</code>, <code>InstructionStatus</code>, <code>UpdateStatus</code>, <code>SystemDescription</code>.</dd>
   </dl>
   <h3>Outputs</h3>
   <ol class="node-ports">
@@ -140,7 +70,7 @@
     <li>From CEM
       <dl class="message-properties">
         <dt>payload <span class="property-type">object</span></dt>
-        <dd>S2 messages received from the CEM (HandshakeResponse, SelectControlType, ReceptionStatus, etc.).</dd>
+        <dd>S2 messages received from the CEM (HandshakeResponse, SelectControlType, ReceptionStatus, RevokeObject, etc.). Wire this to control-type nodes so they can observe control-type selection and revocations.</dd>
         <dt>cemId <span class="property-type">string</span></dt>
         <dd>ID of the CEM that sent the message.</dd>
       </dl>
@@ -151,16 +81,10 @@
         <dd>Control instructions from the CEM (OMBC.Instruction, PEBC.Instruction, etc.).</dd>
         <dt>cemId <span class="property-type">string</span></dt>
         <dd>ID of the CEM that sent the instruction.</dd>
-      </dl>
-    </li>
-    <li>Schedule
-      <dl class="message-properties">
-        <dt>payload.commodityQuantity <span class="property-type">string</span></dt>
-        <dd>Commodity quantity for all elements (e.g. <code>ELECTRIC.POWER.3_PHASE_SYMMETRIC</code>).</dd>
-        <dt>payload.elements <span class="property-type">array</span></dt>
-        <dd>Full accumulated PEBC schedule as an array of <code>{ startTime, endTime, durationSec, lowerBound, upperBound }</code>. Emitted each time the schedule is updated. Use this to program DESS schedule slots or similar downstream consumers.</dd>
-        <dt>cemId <span class="property-type">string</span></dt>
-        <dd>ID of the CEM that issued the schedule.</dd>
+        <dt>controlType <span class="property-type">string</span></dt>
+        <dd>Resolved S2 control type of the instruction, e.g. <code>OPERATION_MODE_BASED_CONTROL</code>.</dd>
+        <dt>ombc / pebc / frbc / ddbc / ppbc <span class="property-type">object</span></dt>
+        <dd>The instruction payload, namespaced under the key matching <code>controlType</code>, for easy Switch-node routing to the matching control-type node.</dd>
       </dl>
     </li>
   </ol>