Added logic to handle Check Addresses.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

src/editors/protocol104/foundation/cdc.ts

@@ -12,9 +12,12 @@ export const supportedCdcTypes =
 export type SupportedCdcType = typeof supportedCdcTypes[number];
 
 export type CreateFunction = (daiElement: Element, selectedTi: string, inverted: boolean) => Create[];
+export type CreateCheckFunction = (daiElement: Element, selectedTi: string) => Create[];
 export interface TiInformation {
   filter: string;
   create: CreateFunction;
+  checkFilter?: string;
+  checkCreate?: CreateCheckFunction;
   inverted?: boolean;
 }
 
@@ -62,7 +65,9 @@ export const cdcProcessings: Record<
     control: {
       '63': {
         filter: ':scope > SDI[name="Oper"] > SDI[name="ctlVal"] > DAI[name="f"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -85,7 +90,9 @@ export const cdcProcessings: Record<
     control: {
       '60': {
         filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -109,7 +116,9 @@ export const cdcProcessings: Record<
     control: {
       '60': {
         filter: ':scope > SDI[name="Oper"] > DAI[name=“ctlVal”]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -132,13 +141,15 @@ export const cdcProcessings: Record<
     monitor: {
       '31': {
         filter: ':scope > DAI[name="stVal"]',
-        create: createAddressAction
+        create: createAddressAction,
       },
     },
     control: {
       '59': {
         filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -161,7 +172,9 @@ export const cdcProcessings: Record<
     control: {
       '62': {
         filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -202,7 +215,9 @@ export const cdcProcessings: Record<
     control: {
       '62': {
         filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -239,7 +254,9 @@ export const cdcProcessings: Record<
     control: {
       '58': {
         filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
-        create: createAddressAction
+        create: createAddressAction,
+        checkFilter: ':scope > SDI[name="Oper"] > DAI[name="Check"]',
+        checkCreate: createCheckAddressAction,
       },
     }
   },
@@ -283,3 +300,23 @@ function createAddressAction(daiElement: Element, ti: string, inverted: boolean)
   }
   return [{new: {parent: daiElement, element: privateElement}}];
 }
+
+
+/**
+ * Create a new SCL Private element and add 104 Address element(s) below this.
+ * Set the attribute value of 'ti' to the passed ti value.
+ *
+ * @param daiElement - The DAI Element to use to set namespace on the root element and create new elements.
+ * @param ti         - The value to be set on the attribute 'ti'.
+ */
+function createCheckAddressAction(daiElement: Element, ti: string): Create[] {
+  addPrefixAndNamespaceToDocument(daiElement);
+
+  const privateElement = createPrivateElement(daiElement);
+  let addressElement = createPrivateAddress(daiElement, privateElement, ti);
+  addressElement.setAttribute('check', 'interlocking');
+  addressElement = createPrivateAddress(daiElement, privateElement, ti);
+  addressElement.setAttribute('check', 'synchrocheck');
+
+  return [{new: {parent: daiElement, element: privateElement}}];
+}

src/editors/protocol104/foundation/foundation.ts

@@ -5,7 +5,7 @@ import {
   newWizardEvent
 } from "../../../foundation.js";
 import { editAddressWizard } from "../wizards/address.js";
-import {CreateFunction, TiInformation} from "./cdc.js";
+import { TiInformation } from "./cdc.js";
 
 export const PRIVATE_TYPE_104 = "IEC_60870_5_104";
 
@@ -101,20 +101,6 @@ export function get104DetailsLine(address: Element): string {
     .join(', ');
 }
 
-/**
- * Indicates if the combination cdc/ti should handle/process the attribute "expected" of the Address Element.
- *
- * @param cdc - The Common Data Class.
- * @param ti  - The TI Value.
- * @returns true, if the combination should handle/process the attribute "expected".
- */
-export function hasExpectedValueField(cdc: string, ti: string): boolean {
-  return (cdc === 'ENC' && ['30', '45', '58'].includes(ti))
-    || (cdc === 'ENG' && ['45', '58'].includes(ti))
-    || (cdc === 'ENS' && ti === '30')
-    || (cdc === 'INS' && ti === '30');
-}
-
 /**
  * Indicates if the combination cdc/ti should handle/process the attribute "unitMultiplier" of the Address Element.
  *
@@ -195,9 +181,9 @@ export function createActions(
   tiInformation: TiInformation
 ): Create[] {
   const actions: Create[] = [];
-  const daiMonitorElements = doiElement.querySelectorAll(tiInformation.filter);
-  if (daiMonitorElements.length > 0) {
-    daiMonitorElements.forEach(daiElement => {
+  const daiElements = doiElement.querySelectorAll(tiInformation.filter);
+  if (daiElements.length > 0) {
+    daiElements.forEach(daiElement => {
       const createActions = tiInformation.create(daiElement, ti,
         (tiInformation.inverted ? inverted : false) // If the TI Allows it and the Engineer selected it, true will be passed.
       );
@@ -207,14 +193,54 @@ export function createActions(
         const privateElement = <Element>createAction.new.element;
         Array.from(privateElement.querySelectorAll('Address'))
           .forEach(addressElement => {
-            wizard.dispatchEvent(newWizardEvent(editAddressWizard(daiElement, addressElement)));
+            wizard.dispatchEvent(newWizardEvent(() => editAddressWizard(daiElement, addressElement)));
           });
       });
     });
   }
   return actions;
 }
 
+/**
+ * Create a list of Create Actions using the parameters passed. First search for the DAI Elements [name="Check"].
+ * Next create the action and add it to this list, also start the Edit Address Element wizard for all Address Elements
+ * created.
+ *
+ * @param doiElement     - The DOI Element.
+ * @param wizard         - The Wizard to dispatch the Open Wizard event on.
+ * @param ti             - The TI Value set on the new Address Elements.
+ * @param tiInformation  - Information about how to create the Address Elements for the passed TI.
+ * @returns A list of Create Action that will be added to the complex action.
+ */
+export function createCheckActions(
+  doiElement: Element,
+  wizard: Element,
+  ti: string,
+  tiInformation: TiInformation
+): Create[] {
+  const actions: Create[] = [];
+  if (tiInformation.checkFilter) {
+    const daiElements = doiElement.querySelectorAll(tiInformation.checkFilter);
+    if (daiElements.length > 0) {
+      daiElements.forEach(daiElement => {
+        if (tiInformation.checkCreate) {
+          const createActions = tiInformation.checkCreate(daiElement, ti);
+          actions.push(...createActions);
+
+          createActions.forEach(createAction => {
+            const privateElement = <Element>createAction.new.element;
+            Array.from(privateElement.querySelectorAll('Address'))
+              .forEach(addressElement => {
+                wizard.dispatchEvent(newWizardEvent(() => editAddressWizard(daiElement, addressElement)));
+              });
+          });
+        }
+      });
+    }
+  }
+  return actions;
+}
+
 /**
  * Enumeration stating the active view of the 104 plugin.
  */

src/editors/protocol104/wizards/address.ts

@@ -22,7 +22,6 @@ import '../../../wizard-select.js';
 import {
   getCdcValue,
   getFullPath,
-  hasExpectedValueField,
   hasScaleFields,
   hasUnitMultiplierField
 } from "../foundation/foundation.js";
@@ -39,10 +38,6 @@ export function updateValue(
 
     const casdu = getValue(inputs.find(i => i.label === 'casdu')!)!;
     const ioa = getValue(inputs.find(i => i.label === 'ioa')!);
-    const expectedValue =
-      ( hasExpectedValueField(cdc, ti)
-        ? getValue(inputs.find(i => i.label === 'expectedValue')!)
-        : null);
     const unitMultiplier =
       ( hasUnitMultiplierField(cdc, ti)
         ? getValue(inputs.find(i => i.label === 'unitMultiplier')!)
@@ -59,7 +54,6 @@ export function updateValue(
     if (
       casdu === addressElement.getAttribute('casdu') &&
       ioa === addressElement.getAttribute('ioa') &&
-      expectedValue === addressElement.getAttribute('expectedValue') &&
       unitMultiplier === addressElement.getAttribute('unitMultiplier') &&
       scaleMultiplier === addressElement.getAttribute('scaleMultiplier') &&
       scaleOffset === addressElement.getAttribute('scaleOffset')
@@ -71,7 +65,6 @@ export function updateValue(
       {
         casdu,
         ioa,
-        expectedValue,
         unitMultiplier,
         scaleMultiplier,
         scaleOffset,
@@ -141,17 +134,6 @@ export function renderDAIWizard(
           </wizard-textfield>`,
   ];
 
-  if (hasExpectedValueField(cdc, ti)) {
-    fields.push(html `
-      <wizard-textfield
-        label="expectedValue"
-        .maybeValue="${addressElement.getAttribute('expectedValue')}"
-        helper="${translate('protocol104.wizard.expectedValueHelper')}"
-        pattern="${patterns.integer}"
-        nullable>
-      </wizard-textfield>`);
-  }
-
   if (hasUnitMultiplierField(cdc, ti)) {
     const allowedMultipliers = ["m", "k", "M", "mu", "y", "z", "a",
       "f", "p", "n", "c", "d", "da", "h", "G", "T", "P", "E", "Z", "Y"];
@@ -192,6 +174,16 @@ export function renderDAIWizard(
       </wizard-textfield>`);
   }
 
+  if (addressElement.hasAttribute('expectedValue')) {
+    fields.push(html `
+      <wizard-textfield
+        label="expectedValue"
+        .maybeValue="${addressElement.getAttribute('expectedValue')}"
+        disabled
+        readonly>
+      </wizard-textfield>`);
+  }
+
   if (addressElement.hasAttribute('inverted')) {
     fields.push(html `
       <wizard-textfield

src/editors/protocol104/wizards/prepareAddress.ts

@@ -23,6 +23,7 @@ import {
 
 import {
   createActions,
+  createCheckActions,
   getCdcValue,
   getCtlModel,
   getFullPath
@@ -46,6 +47,8 @@ export function createAddressAction(doiElement: Element, monitorTis: string[], c
       actions: [],
       title: get('protocol104.values.addedAddress', { name: getFullPath(doiElement, 'IED') }),
     };
+
+    // Create all Monitor Addresses
     if (monitorTis.length > 0) {
       const selectedMonitorTi = getValue(inputs.find(i => i.label === 'monitorTi')!) ?? '';
       const monitorInverted = getSwitchValue(wizard, 'monitorInverted');
@@ -54,8 +57,14 @@ export function createAddressAction(doiElement: Element, monitorTis: string[], c
         filters.push(tiInformation.filter);
         complexAction.actions.push(...createActions(doiElement, wizard, selectedMonitorTi, monitorInverted, tiInformation));
       }
+
+      const monitorCheck = getSwitchValue(wizard, 'monitorCheck');
+      if (monitorCheck) {
+        complexAction.actions.push(...createCheckActions(doiElement, wizard, selectedMonitorTi, tiInformation));
+      }
     }
 
+    // Create all Control Addresses
     const ctlModel = getCtlModel(doiElement);
     if (controlTis.length > 0 && ctlModel !== null && ctlModel !== 'status-only') {
       const selectedControlTi = getValue(inputs.find(i => i.label === 'controlTi')!) ?? '';
@@ -65,6 +74,11 @@ export function createAddressAction(doiElement: Element, monitorTis: string[], c
         filters.push(tiInformation.filter);
         complexAction.actions.push(...createActions(doiElement, wizard, selectedControlTi, controlInverted, tiInformation));
       }
+
+      const controlCheck = getSwitchValue(wizard, 'controlCheck');
+      if (controlCheck) {
+        complexAction.actions.push(...createCheckActions(doiElement, wizard, selectedControlTi, tiInformation));
+      }
     }
 
     if (complexAction.actions.length > 0) {
@@ -83,6 +97,16 @@ export function createAddressAction(doiElement: Element, monitorTis: string[], c
   }
 }
 
+export function disableCheckSwitch(tiInformations: Record<string, TiInformation>): boolean {
+  let disableSwitch = true;
+  Object.values(tiInformations).forEach(tiInformation => {
+    if (tiInformation.checkFilter && tiInformation.checkCreate) {
+      disableSwitch = false;
+    }
+  });
+  return disableSwitch;
+}
+
 export function disableInvertedSwitch(tiInformations: Record<string, TiInformation>): boolean {
   let disableSwitch = true;
   Object.values(tiInformations).forEach(tiInformation => {
@@ -168,6 +192,12 @@ export function prepareAddressWizard(doiElement: Element): Wizard {
                             .disabled="${disableInvertedSwitch(cdcProcessing.monitor)}">
                 </mwc-switch>
               </mwc-formfield>`);
+      fields.push(
+        html `<mwc-formfield label="${translate('protocol104.wizard.monitorCheck')}">
+                <mwc-switch id="monitorCheck"
+                            .disabled="${disableCheckSwitch(cdcProcessing.monitor)}">
+                </mwc-switch>
+              </mwc-formfield>`);
     }
 
     if (controlTis.length > 0 && ctlModel !== null && ctlModel !== 'status-only') {
@@ -201,6 +231,12 @@ export function prepareAddressWizard(doiElement: Element): Wizard {
                             .disabled="${disableInvertedSwitch(cdcProcessing.control)}">
                 </mwc-switch>
               </mwc-formfield>`);
+      fields.push(
+        html `<mwc-formfield label="${translate('protocol104.wizard.controlCheck')}">
+                <mwc-switch id="controlCheck"
+                            .disabled="${disableCheckSwitch(cdcProcessing.control)}">
+                </mwc-switch>
+              </mwc-formfield>`);
     }
     return fields;
   }

src/translations/de.ts

@@ -393,8 +393,10 @@ export const de: Translations = {
       ioaHelper: '???',
       monitorTiHelper: '???',
       monitorInverted: '???',
+      monitorCheck: '???',
       controlTiHelper: '???',
       controlInverted: '???',
+      controlCheck: '???',
       expectedValueHelper: '???',
       unitMultiplierHelper: '???',
       scaleMultiplierHelper: '???',

src/translations/en.ts

@@ -390,8 +390,10 @@ export const en = {
       ioaHelper: 'IOA Value',
       monitorTiHelper: 'Monitor TI Value',
       monitorInverted: 'Created Inverted Addresses (Monitor)',
+      monitorCheck: 'Create Check Addresses (Monitor)',
       controlTiHelper: 'Control TI Value',
       controlInverted: 'Created Inverted Addresses (Control)',
+      controlCheck: 'Create Check Addresses (Control)',
       expectedValueHelper: 'Expected Value',
       unitMultiplierHelper: 'Unit Multiplier',
       scaleMultiplierHelper: 'Scale Multiplier',