Merge pull request openscd#803 from openscd/104-add-control-address

feat(104/Address): Added "Control" handling of CDC and first part of refactoring after discussion.

Author: Dennis Labordus

src/editors/protocol104/foundation/cdc.ts

@@ -5,10 +5,13 @@ import {addPrefixAndNamespaceToDocument, createPrivateAddress, createPrivateElem
 /**
  * List of supported Common Data Classes in the 104 protocol.
  */
-export const supportedCdcTypes = ['ACT', 'ASG', 'BCR', 'CMV', 'DPS', 'ING', 'INS', 'MV', 'SEC', 'SPG', 'SPS'] as const;
+export const supportedCdcTypes =
+  [ 'ACT', 'APC', 'ASG', 'BAC', 'BCR', 'BSC', 'CMV',
+    'DPC', 'DPS', 'INC', 'ING', 'INS', 'ISC', 'MV',
+    'SEC', 'SPC', 'SPG', 'SPS'] as const;
 export type SupportedCdcType = typeof supportedCdcTypes[number];
 
-type CreateFunction = (daiElement: Element, selectedTi: string) => Create[];
+export type CreateFunction = (daiElement: Element, selectedTi: string) => Create[];
 
 /**
  * Record with configuration information on how to create Address elements for the 104 protocol.
@@ -35,60 +38,137 @@ export const cdcProcessings: Record<
   ACT: {
     monitor: {
       '30': {
-        filter: 'DAI[name="general"], DAI[name="phsA"], DAI[name="phsB"], DAI[name="phsC"], DAI[name="neut"]',
+        filter: ':scope > DAI[name="general"], ' +
+          ':scope > DAI[name="phsA"], ' +
+          ':scope > DAI[name="phsB"], ' +
+          ':scope > DAI[name="phsC"], ' +
+          ':scope > DAI[name="neut"]',
         create: createSingleAddressAction
       },
       '39': {
-        filter: 'DAI[name="general"]',
+        filter: ':scope > DAI[name="general"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  APC: {
+    monitor: {
+      '36': {
+        filter: ':scope > SDI[name="mxVal"] > DAI[name="f"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '63': {
+        filter: ':scope > SDI[name="Oper"] > SDI[name="ctlVal"] > DAI[name="f"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   ASG: {
     monitor: {
       '63': {
-        filter: 'SDI[name="setMag"] > DAI[name="f"]',
+        filter: ':scope > SDI[name="setMag"] > DAI[name="f"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  BAC: {
+    monitor: {
+      '36': {
+        filter: ':scope > SDI[name="mxVal"] > DAI[name="f"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '60': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   BCR: {
     monitor: {
       '37': {
-        filter: 'DAI[name="actVal"], DAI[name="frVal"]',
+        filter: ':scope > DAI[name="actVal"], ' +
+          ':scope > DAI[name="frVal"]',
         create: createSingleAddressAction
       },
     },
     control: {}
   },
+  BSC: {
+    monitor: {
+      '32': {
+        filter: ':scope > SDI[name="valWTr"] > DAI[name="posVal"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '60': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name=“ctlVal”]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   CMV: {
     monitor: {
       '35': {
-        filter: 'SDI[name="mag"] > DAI[name="i"], SDI[name="ang"] > DAI[name="i"]',
+        filter: ':scope > SDI[name="mag"] > DAI[name="i"], ' +
+          ':scope > SDI[name="ang"] > DAI[name="i"]',
         create: createSingleAddressAction
       },
       '36': {
-        filter: 'SDI[name="mag"] > DAI[name="f"], SDI[name="ang"] > DAI[name="f"]',
+        filter: ':scope > SDI[name="mag"] > DAI[name="f"], ' +
+          ':scope > SDI[name="ang"] > DAI[name="f"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  DPC: {
+    monitor: {
+      '31': {
+        filter: ':scope > DAI[name="stVal"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '59': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   DPS: {
     monitor: {
       '31': {
-        filter: 'DAI[name="stVal"]',
+        filter: ':scope > DAI[name="stVal"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  INC: {
+    monitor: {
+      '35': {
+        filter: ':scope > DAI[name="stVal"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '62': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   ING: {
     monitor: {
       '62': {
-        filter: 'DAI[name="setVal"]',
+        filter: ':scope > DAI[name="setVal"]',
         create: createSingleAddressAction
       }
     },
@@ -97,28 +177,42 @@ export const cdcProcessings: Record<
   INS: {
     monitor: {
       '30': {
-        filter: 'DAI[name="stVal"]',
+        filter: ':scope > DAI[name="stVal"]',
         create: createInvertedAddressAction
       },
       '33': {
-        filter: 'DAI[name="stVal"]',
+        filter: ':scope > DAI[name="stVal"]',
         create: createSingleAddressAction
       },
       '35': {
-        filter: 'DAI[name="stVal"]',
+        filter: ':scope > DAI[name="stVal"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  ISC: {
+    monitor: {
+      '32': {
+        filter: ':scope > SDI[name="valWTr"] > DAI[name="posVal"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '62': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   MV: {
     monitor: {
       '35': {
-        filter: 'SDI[name="mag"] > DAI[name="i"]',
+        filter: ':scope > SDI[name="mag"] > DAI[name="i"]',
         create: createSingleAddressAction
       },
       '36': {
-        filter: 'SDI[name="mag"] > DAI[name="f"]',
+        filter: ':scope > SDI[name="mag"] > DAI[name="f"]',
         create: createSingleAddressAction
       }
     },
@@ -127,16 +221,30 @@ export const cdcProcessings: Record<
   SEC: {
     monitor: {
       '37': {
-        filter: 'DAI[name="cnt"]',
+        filter: ':scope > DAI[name="cnt"]',
         create: createSingleAddressAction
       }
     },
     control: {}
   },
+  SPC: {
+    monitor: {
+      '30': {
+        filter: ':scope > DAI[name="stVal"]',
+        create: createSingleAddressAction
+      },
+    },
+    control: {
+      '58': {
+        filter: ':scope > SDI[name="Oper"] > DAI[name="ctlVal"]',
+        create: createSingleAddressAction
+      },
+    }
+  },
   SPG: {
     monitor: {
       '58': {
-        filter: 'DAI[name="setVal"]',
+        filter: ':scope > DAI[name="setVal"]',
         create: createSingleAddressAction
       }
     },
@@ -145,7 +253,7 @@ export const cdcProcessings: Record<
   SPS: {
     monitor: {
       '30': {
-        filter: 'DAI[name="stVal"]',
+        filter: ':scope > DAI[name="stVal"]',
         create: createSingleAddressAction
       }
     },

src/editors/protocol104/foundation/foundation.ts

@@ -1,7 +1,11 @@
 import {
+  Create,
   getInstanceAttribute,
-  getNameAttribute
+  getNameAttribute,
+  newWizardEvent
 } from "../../../foundation.js";
+import { editAddressWizard } from "../wizards/address.js";
+import { CreateFunction } from "./cdc.js";
 
 export const PRIVATE_TYPE_104 = "IEC_60870_5_104";
 
@@ -135,6 +139,80 @@ export function hasScaleFields(cdc: string, ti: string): boolean {
   return (cdc === 'MV' && ['35', '36'].includes(ti));
 }
 
+/**
+ * Search for a DAI Element below the passed DOI Element.
+ *
+ * @param doiElement - The DOI Element to search on.
+ * @param name       - The name of the DAI Element to search for.
+ * @returns The found DAI Element or null, if not found.
+ */
+export function getDaiElement(doiElement: Element, name: string): Element | null {
+  return doiElement.querySelector(`:scope > DAI[name="${name}"]`);
+}
+
+/**
+ * Search for the Value of a DAI Element below the passed DOI Element.
+ *
+ * @param doiElement - The DOI Element to search on.
+ * @param name       - The name of the DAI Element to search for.
+ * @returns The value (Val) of the found DAI Element or null, if not found.
+ */
+export function getDaiValue(doiElement: Element, name: string): string | null {
+  const daiElement = getDaiElement(doiElement, name);
+  if (daiElement) {
+    return daiElement.querySelector(':scope > Val')?.textContent ?? null;
+  }
+  return null;
+}
+
+/**
+ * Search for the DAI Element 'ctlModel', this one indicates if control Addresses need to be created.
+ *
+ * @param doiElement - The DOI Element.
+ * @returns The value of the CtlModel.
+ */
+export function getCtlModel(doiElement: Element): string | null {
+  return getDaiValue(doiElement, 'ctlModel');
+}
+
+/**
+ * Create a list of Create Actions using the parameters passed. First search for the DAI Elements
+ * that can be effected. 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 filter         - The Filter used to find the DAI Elements.
+ * @param createFunction - The Function used to create the new Private/Address Elements.
+ * @returns A list of Create Action that will be added to the complex action.
+ */
+export function createActions(
+  doiElement: Element,
+  wizard: Element,
+  ti: string,
+  filter: string,
+  createFunction: CreateFunction
+): Create[] {
+  const actions: Create[] = [];
+  const daiMonitorElements = doiElement.querySelectorAll(filter);
+  if (daiMonitorElements.length > 0) {
+    daiMonitorElements.forEach(daiElement => {
+      const createActions = createFunction(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/foundation/private.ts

@@ -2,7 +2,6 @@ export const PROTOCOL_104_PRIVATE = "IEC_60870_5_104";
 export const PROTOCOL_104_NS = "http://www.iec.ch/61850-80-1/2007/IEC_60870-5-104";
 export const PROTOCOL_104_PREFIX = "IEC_60870_5_104";
 
-
 /**
  * Will add the namespace of the 104 Protocol to the Root Element of the Document (SCL) as prefix to
  * be used with all 104 elements (Address).

src/editors/protocol104/wizards/doi.ts

@@ -14,6 +14,7 @@ import '../../../wizard-textfield.js';
 
 import {
   getCdcValue,
+  getCtlModel,
   getFullPath,
   PRIVATE_TYPE_104
 } from "../foundation/foundation.js";
@@ -60,6 +61,16 @@ export function renderDOIWizard(doiElement: Element): TemplateResult[] {
     );
   }
 
+  const ctlModel = getCtlModel(doiElement);
+  if (ctlModel !== null) {
+    fields.push(html `<wizard-textfield
+                          label="ctlModel"
+                          .maybeValue=${ctlModel}
+                          disabled
+                          readonly>
+                        </wizard-textfield>`);
+  }
+
   return fields;
 }