node-opcua-address-space 2.113.1 → 2.113.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.113.1",
+    "version": "2.113.2",
     "description": "pure nodejs OPCUA SDK - module address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -84,7 +84,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "5990ba93b03458f3d7304c36a99e5eb814bbcf3c",
+    "gitHead": "d72e73db4c07d27ea2da81ccbd258e63ad6c640b",
     "files": [
         "dist",
         "distHelpers",

package/source/interfaces/alarms_and_conditions/condition_info_i.ts

@@ -13,6 +13,7 @@ export interface ConditionInfoOptions {
 
     time?: Date | null;
     receiveTime?: Date | null;
+
 }
 
 export interface ConditionInfo {

package/source/interfaces/alarms_and_conditions/condition_snapshot.ts

@@ -11,20 +11,24 @@ import { StatusCode } from "node-opcua-status-code";
 import { TimeZoneDataType } from "node-opcua-types";
 import { UtcTime } from "../state_machine/ua_state_machine_type";
 import { ISetStateOptions } from "../i_set_state_options";
+import { IConditionVariableTypeSetterOptions } from "../i_condition_variable_type_setter_options";
 
 export interface ConditionSnapshot {
-    on(eventName: "value_changed", eventHandler: (node: UAVariable, variant: Variant) => void): this;
+    on(
+        eventName: "valueChanged",
+        eventHandler: (node: UAVariable, variant: Variant, options: { sourceTimestamp: Date }) => void
+    ): this;
 }
 
-
 export interface ConditionSnapshot extends EventEmitter {
     // static normalizeName = normalizeName;
 
+    emit(eventName: "valueChanged", node: UAVariable, variant: Variant, options: { sourceTimestamp: Date }): boolean;
+    emit(eventName: string | symbol): boolean;
     condition: BaseNode;
     eventData: IEventData | null;
     branchId: NodeId | null;
 
-   
     /**
      * @method getBrandId
      * @return {NodeId}
@@ -87,7 +91,7 @@ export interface ConditionSnapshot extends EventEmitter {
      * @method setComment
      * @param txtMessage {LocalizedText}
      */
-    setComment(txtMessage: LocalizedTextLike): void;
+    setComment(txtMessage: LocalizedTextLike, options?: IConditionVariableTypeSetterOptions): void;
     /**
      *
      * @method setMessage
@@ -130,7 +134,7 @@ export interface ConditionSnapshot extends EventEmitter {
      * @method setQuality
      * @param quality {StatusCode}
      */
-    setQuality(quality: StatusCode): void;
+    setQuality(quality: StatusCode, options?: IConditionVariableTypeSetterOptions): void;
     /**
      * @method getQuality
      * @return {StatusCode}
@@ -170,7 +174,7 @@ export interface ConditionSnapshot extends EventEmitter {
      * @method setSeverity
      * @param severity {UInt16}
      */
-    setSeverity(severity: UInt16): void;
+    setSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
 
     /**
      * @method getSeverity
@@ -189,7 +193,7 @@ export interface ConditionSnapshot extends EventEmitter {
      * @method setLastSeverity
      * @param severity {UInt16}
      */
-    setLastSeverity(severity: UInt16): void;
+    setLastSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
     /**
      * @method getLastSeverity
      * @return {UInt16}

package/source/interfaces/i_condition_variable_type_setter_options.ts

@@ -0,0 +1,5 @@
+
+
+export interface IConditionVariableTypeSetterOptions {
+    sourceTimestamp?: Date;
+}

package/src/alarms_and_conditions/condition.ts

@@ -6,13 +6,15 @@ import { assert } from "node-opcua-assert";
 import { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
 import { minDate } from "node-opcua-basic-types";
 import { StatusCode, StatusCodes } from "node-opcua-status-code";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
 import { ConditionSnapshotImpl } from "./condition_snapshot_impl";
 
 export function _setAckedState(
     self: ConditionSnapshotImpl,
     requestedAckedState: boolean,
     conditionEventId?: Buffer,
-    comment?: string | LocalizedText | LocalizedTextLike
+    comment?: string | LocalizedText | LocalizedTextLike,
+    options?: ISetStateOptions
 ): StatusCode {
     assert(self instanceof ConditionSnapshotImpl);
 
@@ -21,7 +23,7 @@ export function _setAckedState(
     if (ackedState && requestedAckedState) {
         return StatusCodes.BadConditionBranchAlreadyAcked;
     }
-    self._set_twoStateVariable("AckedState", requestedAckedState,/* effective transition time will be now*/);
+    self._set_twoStateVariable("AckedState", requestedAckedState, options);
     return StatusCodes.Good;
 }
 

package/src/alarms_and_conditions/condition_snapshot_impl.ts

@@ -16,6 +16,7 @@ import { TimeZoneDataType } from "node-opcua-types";
 import { DataType, Variant } from "node-opcua-variant";
 
 import { ConditionSnapshot } from "../../source/interfaces/alarms_and_conditions/condition_snapshot";
+import { IConditionVariableTypeSetterOptions } from "../../source/interfaces/i_condition_variable_type_setter_options";
 import { UtcTime } from "../../source/interfaces/state_machine/ua_state_machine_type";
 import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
 import { EventData } from "../event_data";
@@ -36,7 +37,6 @@ function _visit(self: any, node: BaseNode, prefix: string): void {
     for (const aggregate of aggregates) {
         if (aggregate.nodeClass === NodeClass.Variable) {
             const name = aggregate.browseName.toString();
-           
             const key = prefix + name;
 
             // istanbul ignore next
@@ -65,7 +65,7 @@ function _installOnChangeEventHandlers(self: any, node: BaseNode, prefix: string
     for (const aggregate of aggregates) {
         if (aggregate.nodeClass === NodeClass.Variable) {
             const name = aggregate.browseName.toString();
-        
+
             const key = prefix + name;
 
             // istanbul ignore next
@@ -92,7 +92,7 @@ function _ensure_condition_values_correctness(self: any, node: BaseNode, prefix:
     for (const aggregate of aggregates) {
         if (aggregate.nodeClass === NodeClass.Variable) {
             const name = aggregate.browseName.toString();
-            
+
             const key = prefix + name;
 
             const snapshot_value = self._map[key].toString();
@@ -146,7 +146,6 @@ const _varTable = {
     Time: 1
 };
 
-
 type FullBrowsePath = string;
 export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnapshot {
     public static normalizeName = normalizeName;
@@ -238,7 +237,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         return variant.value;
     }
 
-    public _set_var(varName: string, dataType: DataType, value: unknown): void {
+    public _set_var(varName: string, dataType: DataType, value: unknown, options?: IConditionVariableTypeSetterOptions): void {
         const key = normalizeName(varName);
         // istanbul ignore next
         if (!Object.prototype.hasOwnProperty.call(this._map, key)) {
@@ -253,11 +252,21 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
             value
         });
 
-        if (this._map[key + ".SourceTimestamp"]) {
-            this._map[key + ".SourceTimestamp"] = new Variant({
+        const sourceTimestamp = options?.sourceTimestamp || new Date();
+        const sourceTimestampKey = key + ".SourceTimestamp";
+        if (this._map[sourceTimestampKey]) {
+            // from spec 1.03 : 5.3 condition variables
+            // a condition VariableType has a sourceTimeStamp exposed property
+            // SourceTimestamp indicates the time of the last change of the Value of this ConditionVariable.
+            // It shall be the same time that would be returned from the Read Service inside the DataValue
+            // structure for the ConditionVariable Value Attribute.
+            const variant = new Variant({
                 dataType: DataType.DateTime,
-                value: new Date()
+                value: sourceTimestamp
             });
+            this._map[sourceTimestampKey] = variant;
+            const node = this._node_index[sourceTimestampKey];
+            this.emit("valueChanged", node, variant, { sourceTimestamp });
         }
 
         const variant = this._map[key];
@@ -268,7 +277,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
             return;
         }
         assert(node.nodeClass === NodeClass.Variable);
-        this.emit("value_changed", node, variant);
+        this.emit("valueChanged", node, variant, { sourceTimestamp });
     }
 
     /**
@@ -363,9 +372,9 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @method setComment
      * @param txtMessage {LocalizedText}
      */
-    public setComment(txtMessage: LocalizedTextLike): void {
+    public setComment(txtMessage: LocalizedTextLike, options?: IConditionVariableTypeSetterOptions): void {
         const txtMessage1 = coerceLocalizedText(txtMessage);
-        this._set_var("Comment", DataType.LocalizedText, txtMessage1);
+        this._set_var("Comment", DataType.LocalizedText, txtMessage1, options);
     }
 
     /**
@@ -416,8 +425,8 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @method setQuality
      * @param quality {StatusCode}
      */
-    public setQuality(quality: StatusCode): void {
-        this._set_var("Quality", DataType.StatusCode, quality);
+    public setQuality(quality: StatusCode, options?: IConditionVariableTypeSetterOptions): void {
+        this._set_var("Quality", DataType.StatusCode, quality, options);
     }
 
     /**
@@ -462,13 +471,15 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @method setSeverity
      * @param severity {UInt16}
      */
-    public setSeverity(severity: UInt16): void {
+    public setSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void {
         assert(isFinite(severity), "expecting a UInt16");
 
         // record automatically last severity
         const lastSeverity = this.getSeverity();
-        this.setLastSeverity(lastSeverity);
-        this._set_var("Severity", DataType.UInt16, severity);
+        const sourceTimestamp = this.getSeveritySourceTimestamp();
+        this.setLastSeverity(lastSeverity, { sourceTimestamp });
+
+        this._set_var("Severity", DataType.UInt16, severity, options);
     }
 
     /**
@@ -481,6 +492,10 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         const value = this._get_var("Severity");
         return +value;
     }
+    public getSeveritySourceTimestamp(): Date {
+        const c = this.condition as UAConditionImpl;
+        return c.severity.readValue().sourceTimestamp || new Date();
+    }
 
     /*
      * as per spec 1.0.3 - part 9:
@@ -493,9 +508,9 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @method setLastSeverity
      * @param severity {UInt16}
      */
-    public setLastSeverity(severity: UInt16): void {
+    public setLastSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void {
         severity = +severity;
-        return this._set_var("LastSeverity", DataType.UInt16, severity);
+        return this._set_var("LastSeverity", DataType.UInt16, severity, options);
     }
 
     /**
@@ -527,8 +542,8 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @param time {Date} : UTCTime
      */
     public setReceiveTime(time: UtcTime): void {
-        assert(time instanceof Date);
-        return this._set_var("ReceiveTime", DataType.DateTime, time);
+        if (!(time instanceof Date)) { throw new Error("setReceiveTime expecting a Date")};
+        return this._set_var("ReceiveTime", DataType.DateTime, time, { sourceTimestamp: time });
     }
 
     /**
@@ -541,8 +556,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @param time {Date}
      */
     public setTime(time: Date): void {
-        assert(time instanceof Date);
-        return this._set_var("Time", DataType.DateTime, time);
+        return this._set_var("Time", DataType.DateTime, time, { sourceTimestamp: time });
     }
 
     /**
@@ -605,10 +619,9 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         return this._get_twoStateVariable("AckedState");
     }
 
-    public setAckedState(ackedState: boolean): StatusCode {
+    public setAckedState(ackedState: boolean, options?: ISetStateOptions): StatusCode {
         ackedState = !!ackedState;
-
-        return _setAckedState(this, ackedState);
+        return _setAckedState(this, ackedState, undefined, undefined, options);
     }
 
     public getConfirmedState(): boolean {
@@ -669,11 +682,30 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         return StatusCodes.Good;
     }
 
-    // tslint:disable:no-empty
+    public setLatchedState(newLatchedState: boolean, options?: ISetStateOptions): StatusCode {
+        this._set_twoStateVariable("LatchedState", newLatchedState, options);
+        return StatusCodes.Good;
+    }
+    public getLatchedState(): boolean {
+        return this._get_twoStateVariable("LatchedState");
+    }
+    public setOutOfServiceState(newOutOfServiceState: boolean, options?: ISetStateOptions): StatusCode {
+        this._set_twoStateVariable("OutOfServiceState", newOutOfServiceState, options);
+        return StatusCodes.Good;
+    }
+    public getOutOfServiceState(): boolean {
+        return this._get_twoStateVariable("OutOfServiceState");
+    }
+    public setSilentState(newSilentState: boolean, options?: ISetStateOptions): StatusCode {
+        this._set_twoStateVariable("SilentState", newSilentState, options);
+        return StatusCodes.Good;
+    }
+    public getSilentState(): boolean {
+        return this._get_twoStateVariable("SilentState");
+    }
     public setShelvingState(): void {
-        // todo
+        throw new Error("Method not implemented.");
     }
-
     public toString(): string {
         //   public condition: any = null;
         //   public eventData: any = null;
@@ -739,7 +771,8 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
             assert(twoStateNode instanceof UATwoStateVariableImpl);
             twoStateNode.setValue(value as boolean, options);
         }
-        this.emit("value_changed", node, variant);
+        const sourceTimestamp = options?.effectiveTransitionTime || new Date();
+        this.emit("valueChanged", node, variant, { sourceTimestamp });
     }
 
     protected _get_twoStateVariable(varName: string): any {

package/src/alarms_and_conditions/ua_condition_impl.ts

@@ -215,9 +215,8 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
         // the implication of this convention is that interacting with the condition variable
         // shall be made by using branch0, any value change made
         // using the standard setValueFromSource mechanism will not be work properly.
-        this._branch0.on("value_changed", (node: UAVariable, variant: Variant) => {
-            assert(node.nodeClass === NodeClass.Variable);
-            node.setValueFromSource(variant);
+        this._branch0.on("valueChanged", (node: UAVariable, variant: Variant, options: { sourceTimestamp: Date }) => {
+            node.setValueFromSource(variant, StatusCodes.Good, options.sourceTimestamp);
         });
     }
 
@@ -347,7 +346,7 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
      * @param requestedEnabledState {Boolean}
      * @private
      */
-    public setEnabledState(requestedEnabledState: boolean, options?:ISetStateOptions): StatusCode {
+    public setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode {
         return this._setEnabledState(requestedEnabledState, options);
     }
 
@@ -518,11 +517,11 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
 
         if (Object.prototype.hasOwnProperty.call(conditionInfo, "severity") && conditionInfo.severity !== null) {
             assert(isFinite(conditionInfo.severity!));
-            branch.setSeverity(conditionInfo.severity!);
+            branch.setSeverity(conditionInfo.severity!, { sourceTimestamp: time });
         }
         if (Object.prototype.hasOwnProperty.call(conditionInfo, "quality") && conditionInfo.quality !== null) {
             assert(conditionInfo.quality instanceof StatusCode);
-            branch.setQuality(conditionInfo.quality!);
+            branch.setQuality(conditionInfo.quality!, { sourceTimestamp: time });
         }
         if (Object.prototype.hasOwnProperty.call(conditionInfo, "retain") && conditionInfo.retain !== null) {
             assert(typeof conditionInfo.retain === "boolean");
@@ -1209,12 +1208,6 @@ function _create_new_branch_id() {
     return makeNodeId(randomGuid(), 1);
 }
 
-function _update_sourceTimestamp<T, DT extends DataType>(this: UAConditionVariable<T, DT>, dataValue: DataValue /*, indexRange*/) {
-    this.sourceTimestamp.setValueFromSource({
-        dataType: DataType.DateTime,
-        value: dataValue.sourceTimestamp
-    });
-}
 
 // tslint:disable:no-console
 function _install_condition_variable_type<T, DT extends DataType>(node: UAConditionVariable<T, DT>) {
@@ -1228,15 +1221,6 @@ function _install_condition_variable_type<T, DT extends DataType>(node: UACondit
     }
     node.accessLevel = makeAccessLevelFlag("CurrentRead");
 
-    // from spec 1.03 : 5.3 condition variables
-    // a condition VariableType has a sourceTimeStamp exposed property
-    // SourceTimestamp indicates the time of the last change of the Value of this ConditionVariable.
-    // It shall be the same time that would be returned from the Read Service inside the DataValue
-    // structure for the ConditionVariable Value Attribute.
-
-    assert(node.typeDefinitionObj.browseName.toString() === "ConditionVariableType");
-    assert(node.sourceTimestamp.browseName.toString() === "SourceTimestamp");
-    node.on("value_changed", _update_sourceTimestamp);
 }
 
 /**