feat(wizards/sampledvaluecontrol): add create wizard (openscd#744)

* feat(wizards/sampledvaluecontrol): add create wizard

* refactor(wizards/sampledvaluecontrol): render only falsy multicast checkbox

The attribute `multicast` allows to select between 9-1 and 9-2 type sampled value stream. As 9-1 is deprecated and has not been used widely the setting can only be set from false to true not the other way around. To not confuse the user multicast checkbox is only shown when false

* refactor(wizards/sampledvaluecontrol): limit sampledvalue data picker

-  lnClass TCTR and TVTR
- data object cdc SAV
- data attributes name instMag and q

* fix(wizards/sampledvaluecontrol): create action for undefined multicast input

* fix(wizard/sampledvaluecontrol): translation for missing access point

* fix(wizards/sampledvaluecontrol): make use of the proper data picker for SampledValueControl blocks

* test(wizards/sampledvaluecontrol): add unit tests

* test(wizards/sampledvaluecontrol): add integration tests

* test(wizards/sampledvaluecontrol): add integration tests

* refactor(wizards/sampledvaluecontrol): add translation

* refactor(wizards/sampledvaluecontrol): better wording

* test(wizards): update smv control wizard snapshots

* test(wizards): update smvcontrol wizard snapshots

Co-authored-by: cad <[email protected]>
Co-authored-by: Christian Dinkel <[email protected]>

Author: JakobVogelsang

src/translations/de.ts

@@ -60,6 +60,7 @@ export const de: Translations = {
     sampleRate: 'Abtastrate zu Telegram hinzufügen',
     security: 'Potentiel in Zukunft für z.B. digitale Signature',
     synchSourceId: 'Identität der Zeitquelle zu Telegram hinzufügen',
+    SampledValueControl: 'Sampled Value Kontrollblock',
     iedName: 'Referenziertes IED',
     ldInst: 'Referenziertes logisches Gerät',
     prefix: 'Präfix des logischen Knotens',
@@ -541,6 +542,8 @@ export const de: Translations = {
     action: {
       addaddress: 'SMV bearbeitet ({{identity}})',
     },
+    missingaccp:
+      'AccessPoint is nicht verbunden. SMV kann nicht hinzugefügt werden.',
   },
   subscriber: {
     title: 'Subscriber Update',
@@ -618,6 +621,11 @@ export const de: Translations = {
   gsecontrol: {
     wizard: { location: 'Ablageort der GOOSE wählen' },
   },
+  samvpledvaluecontrol: {
+    wizard: {
+      location: 'Ablageort des Select Sampled Value Control Block wählen',
+    },
+  },
   add: 'Hinzufügen',
   new: 'Neu',
   remove: 'Entfernen',

src/translations/en.ts

@@ -58,6 +58,7 @@ export const en = {
     sampleRate: 'Add sample rate to SMV packet',
     security: 'Potential future use. e.g. digital signature',
     synchSourceId: 'Add sync source id to SMV packet',
+    SampledValueControl: 'Sampled Value Control Block',
     iedName: 'Referenced IED',
     ldInst: 'Referenced Logical Device',
     prefix: 'Prefix of the Logical Node',
@@ -537,6 +538,7 @@ export const en = {
     action: {
       addaddress: 'Edit SMV ({{identity}})',
     },
+    missingaccp: 'AccessPoint is not connected. SMV cannot be created.',
   },
   subscriber: {
     title: 'Subscriber update',
@@ -612,6 +614,9 @@ export const en = {
   gsecontrol: {
     wizard: { location: 'Select GOOSE Control Block Location' },
   },
+  samvpledvaluecontrol: {
+    wizard: { location: 'Select Sampled Value Control Block Location' },
+  },
   add: 'Add',
   new: 'New',
   remove: 'Remove',

src/wizards/address.ts

@@ -14,7 +14,9 @@ interface ContentOptions {
   attributes: Record<string, string | null>;
 }
 
-export function contentGseWizard(content: ContentOptions): TemplateResult[] {
+export function contentGseOrSmvWizard(
+  content: ContentOptions
+): TemplateResult[] {
   return [
     html`<mwc-formfield
       label="${translate('connectedap.wizard.addschemainsttype')}"

src/wizards/foundation/enums.ts

@@ -56,7 +56,7 @@ export const valKindEnum = ['Spec', 'Conf', 'RO', 'Set'];
 
 export const smpModEnum = ['SmpPerPeriod', 'SmpPerSec', 'SecPerSmp'];
 
-export const securityEnableEnum = [
+export const securityEnabledEnum = [
   'None',
   'Signature',
   'SignatureAndEncryption',

src/wizards/foundation/finder.ts

@@ -88,3 +88,61 @@ export function dataAttributePicker(server: Element): TemplateResult {
     .getTitle=${(path: string[]) => path[path.length - 1]}
   ></finder-list>`;
 }
+
+export function getSMVDataChildren(parent: Element): Element[] {
+  if (parent.tagName === 'Server')
+    return Array.from(parent.children).filter(
+      child =>
+        child.tagName === 'LDevice' &&
+        child.querySelector('LN[lnClass="TCTR"],LN[lnClass="TVTR"]')
+    );
+
+  if (parent.tagName === 'LDevice')
+    return Array.from(parent.children).filter(
+      child =>
+        child.tagName === 'LN' &&
+        (child.getAttribute('lnClass') === 'TCTR' ||
+          child.getAttribute('lnClass') === 'TVTR')
+    );
+
+  const id =
+    parent.tagName === 'LN' || parent.tagName === 'LN0'
+      ? parent.getAttribute('lnType')
+      : parent.getAttribute('type');
+  const dataType = parent.ownerDocument.querySelector(
+    `LNodeType[id="${id}"], DOType[id="${id}"], DAType[id="${id}"]`
+  );
+
+  if (!dataType) return [];
+
+  if (dataType?.tagName === 'LNodeType') {
+    return Array.from(dataType.querySelectorAll('DO') ?? []).filter(dO =>
+      dO.ownerDocument.querySelector(
+        `DOType[id="${dO.getAttribute('type')}"][cdc="SAV"]`
+      )
+    );
+  }
+
+  if (dataType?.tagName === 'DOType') {
+    return Array.from(dataType.querySelectorAll('DA') ?? []).filter(
+      dA =>
+        dA.getAttribute('name') === 'instMag' || dA.getAttribute('name') === 'q'
+    );
+  }
+
+  return Array.from(
+    parent.ownerDocument.querySelectorAll(
+      `LNodeType[id="${id}"] > DO, DOType[id="${id}"] > SDO, DOType[id="${id}"] > DA, DAType[id="${id}"] > BDA`
+    )
+  );
+}
+
+export function sampledValueDataPicker(server: Element): TemplateResult {
+  return html`<finder-list
+    multi
+    paths=${JSON.stringify([['Server: ' + identity(server)]])}
+    .read=${getReader(server, getSMVDataChildren)}
+    .getDisplayString=${getDisplayString}
+    .getTitle=${(path: string[]) => path[path.length - 1]}
+  ></finder-list>`;
+}

src/wizards/gse.ts

@@ -15,7 +15,7 @@ import {
   WizardActor,
   WizardInputElement,
 } from '../foundation.js';
-import { contentGseWizard, updateAddress } from './address.js';
+import { contentGseOrSmvWizard, updateAddress } from './address.js';
 
 export function getMTimeAction(
   type: 'MinTime' | 'MaxTime',
@@ -146,7 +146,7 @@ export function editGseWizard(element: Element): Wizard {
         action: updateGSEAction(element),
       },
       content: [
-        ...contentGseWizard({ hasInstType, attributes }),
+        ...contentGseOrSmvWizard({ hasInstType, attributes }),
         html`<wizard-textfield
           label="MinTime"
           .maybeValue=${minTime}

src/wizards/gsecontrol.ts

@@ -35,7 +35,7 @@ import {
 import { maxLength, patterns } from './foundation/limits.js';
 import { editDataSetWizard } from './dataset.js';
 import { editGseWizard } from './gse.js';
-import { securityEnableEnum } from './foundation/enums.js';
+import { securityEnabledEnum } from './foundation/enums.js';
 import { dataAttributePicker, iEDPicker } from './foundation/finder.js';
 import { FinderList } from '../finder-list.js';
 import { newFCDA } from './fcda.js';
@@ -45,7 +45,7 @@ import {
   uniqueAppId,
   uniqueMacAddress,
 } from './foundation/scl.js';
-import { contentGseWizard, createAddressElement } from './address.js';
+import { contentGseOrSmvWizard, createAddressElement } from './address.js';
 
 interface ContentOptions {
   name: string | null;
@@ -119,7 +119,7 @@ export function contentGseControlWizard(
       nullable
       required
       helper="${translate('scl.securityEnable')}"
-      >${securityEnableEnum.map(
+      >${securityEnabledEnum.map(
         type => html`<mwc-list-item value="${type}">${type}</mwc-list-item>`
       )}</wizard-select
     >`,
@@ -267,7 +267,7 @@ export function createGseControlWizard(ln0OrLn: Element): Wizard {
         {
           title: get('wizard.title.add', { tagName: 'GSE' }),
           content: [
-            ...contentGseWizard({ hasInstType, attributes }),
+            ...contentGseOrSmvWizard({ hasInstType, attributes }),
             html`<wizard-textfield
               label="MinTime"
               .maybeValue=${minTime}