Type alias CreateSampledValueControlOptions

Type declaration

• Optional skipCheck?: boolean

  If true, skips check for unique SampledValueControl name, whether datSet is pointing to valid DataSet and whether additional SampledValueControl is allowed in IED/AccessPoint.

• Optional smv?: {
      apName?: string;
      appId?: string;
      mac?: string;
      vlanId?: string;
      vlanPriority?: string;
  }

  • Optional apName?: string

    The AccessPoint that shall publish the sampled value stream. Default the AccessPoint holding the Server element

  • Optional appId?: string

    APPID within P element in the SMV element

  • Optional mac?: string

    MAC-Address within P element in the SMV element

  • Optional vlanId?: string

    VLAN-ID within P element in the SMV element

  • Optional vlanPriority?: string

    VLAN-PRIORITY within P element in the SMV element

• Optional smvControl?: {
      confRev?: string | null;
      datSet?: string | null;
      desc?: string;
      multicast?: "true" | "false";
      name?: string;
      nofASDU?: string;
      securityEnable?: "None" | "Signature" | "SignatureAndEncryption";
      smpMod?: "SmpPerPeriod" | "SmpPerSec" | "SecPerSmp";
      smpRate?: string;
      smvID?: string;
  }

  • Optional confRev?: string | null

    User-defined configuration revision (confRev). Overwrites logic to to set confRev acc. to IEC 61850.

  • Optional datSet?: string | null

    Reference to an existing DataSet

  • Optional desc?: string

  • Optional multicast?: "true" | "false"

    Whether the SampledValueControl is multicast. Set to true if missing

  • Optional name?: string

    SampledValueControl name. Must be unique. When missing a unique name starting with newSampledValueControl_xx is set

  • Optional nofASDU?: string

    How many samples are packed into one ethernet packet. Set to '1' if missing

  • Optional securityEnable?: "None" | "Signature" | "SignatureAndEncryption"

    The security setting of the sample value stream

  • Optional smpMod?: "SmpPerPeriod" | "SmpPerSec" | "SecPerSmp"

    The sample mode of the sample value stream

  • Optional smpRate?: string

    The sample rate of the sampled value stream. Set to '80' is missing

  • Optional smvID?: string

    Id for the new SampledValueControl. Default is IED.name/LDevice.inst/LLN0/SampledValueControl.name

• Optional smvOpts?: {
      dataSet?: "true" | "false";
      refreshTime?: "true" | "false";
      sampleRate?: "true" | "false";
      sampleSynchronized?: "true" | "false";
      security?: "true" | "false";
      synchSourceId?: "true" | "false";
      timestamp?: "true" | "false";
  }

  • Optional dataSet?: "true" | "false"

    Whether dataSet reference is part if the SV stream. Defaults to false.

  • Optional refreshTime?: "true" | "false"

    Whether refresh time is part if the SV stream. Defaults to false.

  • Optional sampleRate?: "true" | "false"

    Whether sampled rate is part if the SV stream. Defaults to false.

  • Optional sampleSynchronized?: "true" | "false"

    Whether synchronized setting is part if the SV stream. Defaults to true.

  • Optional security?: "true" | "false"

    Whether security setting is part if the SV stream. Defaults to false.

  • Optional synchSourceId?: "true" | "false"

    Whether sync source ID is part if the SV stream. Defaults to false.

  • Optional timestamp?: "true" | "false"

    Whether refresh time is part if the SV stream. Defaults to false.