node-opcua-address-space 2.113.0 → 2.113.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.113.0",
+    "version": "2.113.1",
     "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": "36db335391fedd39726990a1b37f7768da16466a",
+    "gitHead": "5990ba93b03458f3d7304c36a99e5eb814bbcf3c",
     "files": [
         "dist",
         "distHelpers",

package/source/interfaces/alarms_and_conditions/condition_info_i.ts

@@ -10,6 +10,9 @@ export interface ConditionInfoOptions {
     quality?: StatusCode | null;
     severity?: UInt16 | null;
     retain?: boolean | null;
+
+    time?: Date | null;
+    receiveTime?: Date | null;
 }
 
 export interface ConditionInfo {

package/source/interfaces/alarms_and_conditions/condition_snapshot.ts

@@ -10,6 +10,7 @@ import { NodeId } from "node-opcua-nodeid";
 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";
 
 export interface ConditionSnapshot {
     on(eventName: "value_changed", eventHandler: (node: UAVariable, variant: Variant) => void): this;
@@ -62,7 +63,7 @@ export interface ConditionSnapshot extends EventEmitter {
      * @param value {Boolean}
      * @return void
      */
-    setEnabledState(value: boolean): void;
+    setEnabledState(value: boolean, options?: ISetStateOptions): void;
     /**
      * @method getEnabledStateAsString
      * @return {String}

package/source/interfaces/alarms_and_conditions/ua_condition_ex.ts

@@ -4,10 +4,11 @@ import { NodeId } from "node-opcua-nodeid";
 import { UACondition_Base } from "node-opcua-nodeset-ua";
 import { StatusCode } from "node-opcua-status-code";
 import { TimeZoneDataType } from "node-opcua-types";
+import { DataType } from "node-opcua-basic-types";
+import { ISetStateOptions } from "../i_set_state_options";
 import { UATwoStateVariableEx } from "../../ua_two_state_variable_ex";
 import { ConditionInfoOptions } from "./condition_info_i";
 import { ConditionSnapshot } from "./condition_snapshot";
-import { DataType } from "node-opcua-basic-types";
 
 
 
@@ -26,6 +27,7 @@ export interface UAConditionHelper {
     on(eventName: "branch_deleted", eventHandler: (branchId: string) => void): this;
 }
 
+
 export interface UAConditionHelper extends UABaseEventHelper {
     getBranchCount(): number;
     getBranches(): ConditionSnapshot[];
@@ -34,7 +36,7 @@ export interface UAConditionHelper extends UABaseEventHelper {
     deleteBranch(branch: ConditionSnapshot): void;
     getEnabledState(): boolean;
     getEnabledStateAsString(): string;
-    setEnabledState(requestedEnabledState: boolean): StatusCode;
+    setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode;
     setReceiveTime(time: Date): void;
     setLocalTime(time: TimeZoneDataType): void;
     setTime(time: Date): void;

package/source/interfaces/data_access/ua_multistate_discrete_ex.ts

@@ -13,6 +13,7 @@ import { DataType, Variant } from "node-opcua-variant";
 import { StatusCode } from "node-opcua-status-code";
 import { UAMultiStateDiscrete_Base } from "node-opcua-nodeset-ua";
 import { UAVariableT } from "node-opcua-address-space-base";
+import { ISetStateOptions } from "../i_set_state_options";
 
 export { UAMultiStateDiscrete } from "node-opcua-nodeset-ua";
 
@@ -21,6 +22,6 @@ export interface UAMultiStateDiscreteEx<T, DT extends DataType> extends UAVariab
     getValue(): number;
     getValueAsString(): string;
     getIndex(value: string): number;
-    setValue(value: string | number): void;
+    setValue(value: string | number, options?: ISetStateOptions): void;
     checkVariantCompatibility(value: Variant): StatusCode;
 }

package/source/interfaces/data_access/ua_multistate_value_discrete_ex.ts

@@ -5,6 +5,7 @@ import { DataType, Variant } from "node-opcua-variant";
 import { Int64, UInt64 } from "node-opcua-basic-types";
 import { UAMultiStateValueDiscrete_Base } from "node-opcua-nodeset-ua";
 import { UAVariableT } from "node-opcua-address-space-base";
+import { ISetStateOptions } from "../i_set_state_options";
 
 /**
  * @see https://reference.opcfoundation.org/v104/Core/docs/Part8/5.3.3/#5.3.3.4
@@ -27,7 +28,7 @@ export interface UAMultiStateValueDiscreteEx<T, DT extends DataType>
     getValueAsString(): string;
     getValueAsNumber(): number;
 
-    setValue(value: string | number | Int64): void;
+    setValue(value: string | number | Int64, options?: ISetStateOptions): void;
 
     findValueAsText(value: number | UInt64): Variant;
 }

package/source/interfaces/data_access/ua_two_state_discrete_ex.ts

@@ -2,6 +2,7 @@ import { LocalizedTextLike } from "node-opcua-data-model";
 import { DataType } from "node-opcua-variant";
 import { UAVariableT } from "node-opcua-address-space-base";
 import { UATwoStateDiscrete_Base } from "node-opcua-nodeset-ua";
+import { ISetStateOptions } from "../i_set_state_options";
 
 /**
  * @see https://reference.opcfoundation.org/v104/Core/VariableTypes/TwoStateDiscreteType/
@@ -10,5 +11,5 @@ export interface UATwoStateDiscreteEx extends UAVariableT<boolean, DataType.Bool
     // --- helpers ---
     getValue(): boolean;
     getValueAsString(): string;
-    setValue(value: boolean | LocalizedTextLike): void;
+    setValue(value: boolean | LocalizedTextLike, options?: ISetStateOptions): void;
 }

package/source/interfaces/i_set_state_options.ts

@@ -0,0 +1,4 @@
+export interface ISetStateOptions {
+    transitionTime?: Date;
+    effectiveTransitionTime?: Date;
+}

package/source/ua_two_state_variable_ex.ts

@@ -5,6 +5,7 @@ import { UAVariableT } from "node-opcua-address-space-base";
 import { LocalizedText } from "node-opcua-data-model";
 import { UAStateVariable, UATwoStateVariable_Base } from "node-opcua-nodeset-ua";
 import { DataType } from "node-opcua-variant";
+import { ISetStateOptions } from "./interfaces/i_set_state_options";
 
 /**
  * @see https://reference.opcfoundation.org/v104/Core/docs/Part9/5.2/
@@ -18,7 +19,7 @@ export interface UATwoStateVariableHelper {
     readonly isTrueSubStateOf: UAStateVariable<LocalizedText> | null;
 
     // --- helpers ---
-    setValue(boolValue: boolean): void;
+    setValue(boolValue: boolean, options?: ISetStateOptions): void;
 
     getValue(): boolean;
 

package/src/alarms_and_conditions/condition.ts

@@ -21,7 +21,7 @@ export function _setAckedState(
     if (ackedState && requestedAckedState) {
         return StatusCodes.BadConditionBranchAlreadyAcked;
     }
-    self._set_twoStateVariable("AckedState", requestedAckedState);
+    self._set_twoStateVariable("AckedState", requestedAckedState,/* effective transition time will be now*/);
     return StatusCodes.Good;
 }
 

package/src/alarms_and_conditions/condition_snapshot_impl.ts

@@ -17,6 +17,7 @@ import { DataType, Variant } from "node-opcua-variant";
 
 import { ConditionSnapshot } from "../../source/interfaces/alarms_and_conditions/condition_snapshot";
 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";
 import { UATwoStateVariableImpl } from "../state_machine/ua_two_state_variable";
 import { _setAckedState } from "./condition";
@@ -136,6 +137,7 @@ const _varTable = {
     "EnabledState.EffectiveDisplayName": 1,
     "EnabledState.Id": 1,
     "EnabledState.TransitionTime": 1,
+    "EnabledState.EffectiveTransitionTime": 1,
     EventId: 1,
     EventType: 1,
     LocalTime: 1,
@@ -143,6 +145,8 @@ const _varTable = {
     SourceNode: 1,
     Time: 1
 };
+
+
 type FullBrowsePath = string;
 export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnapshot {
     public static normalizeName = normalizeName;
@@ -327,8 +331,8 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @param value {Boolean}
      * @return void
      */
-    public setEnabledState(value: boolean): void {
-        return this._set_twoStateVariable("EnabledState", value);
+    public setEnabledState(value: boolean, options?: ISetStateOptions): void {
+        return this._set_twoStateVariable("EnabledState", value, options);
     }
 
     /**
@@ -613,7 +617,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         return this._get_twoStateVariable("ConfirmedState");
     }
 
-    public setConfirmedStateIfExists(confirmedState: boolean): void {
+    public setConfirmedStateIfExists(confirmedState: boolean, options?: ISetStateOptions): void {
         confirmedState = !!confirmedState;
         const acknowledgeableCondition = this.condition as UAAcknowledgeableCondition;
         if (!acknowledgeableCondition.confirmedState) {
@@ -622,7 +626,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
             return;
         }
         // todo deal with Error code BadConditionBranchAlreadyConfirmed
-        return this._set_twoStateVariable("ConfirmedState", confirmedState);
+        return this._set_twoStateVariable("ConfirmedState", confirmedState, options);
     }
 
     public setConfirmedState(confirmedState: boolean): void {
@@ -647,21 +651,21 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @method setSuppressedState
      * @param suppressed {Boolean}
      */
-    public setSuppressedState(suppressed: boolean): void {
+    public setSuppressedState(suppressed: boolean, options?: ISetStateOptions): void {
         suppressed = !!suppressed;
-        this._set_twoStateVariable("SuppressedState", suppressed);
+        this._set_twoStateVariable("SuppressedState", suppressed, options);
     }
 
     public getActiveState(): boolean {
         return this._get_twoStateVariable("ActiveState");
     }
 
-    public setActiveState(newActiveState: boolean): StatusCode {
+    public setActiveState(newActiveState: boolean, options?: ISetStateOptions): StatusCode {
         // xx var activeState = self.getActiveState();
         // xx if (activeState === newActiveState) {
         // xx     return StatusCodes.Bad;
         // xx }
-        this._set_twoStateVariable("ActiveState", newActiveState);
+        this._set_twoStateVariable("ActiveState", newActiveState, options);
         return StatusCodes.Good;
     }
 
@@ -704,7 +708,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
      * @param value
      * @private
      */
-    public _set_twoStateVariable(varName: string, value: boolean): void {
+    public _set_twoStateVariable(varName: string, value: boolean, options?: ISetStateOptions): void {
         value = !!value;
 
         const hrKey = ConditionSnapshotImpl.normalizeName(varName);
@@ -733,7 +737,7 @@ export class ConditionSnapshotImpl extends EventEmitter implements ConditionSnap
         // also change ConditionNode if we are on currentBranch
         if (this.isCurrentBranch()) {
             assert(twoStateNode instanceof UATwoStateVariableImpl);
-            twoStateNode.setValue(value as boolean);
+            twoStateNode.setValue(value as boolean, options);
         }
         this.emit("value_changed", node, variant);
     }

package/src/alarms_and_conditions/ua_condition_impl.ts

@@ -41,6 +41,7 @@ import { ConditionInfoOptions } from "../../source/interfaces/alarms_and_conditi
 import { UAConditionEx } from "../../source/interfaces/alarms_and_conditions/ua_condition_ex";
 import { ConditionSnapshot } from "../../source/interfaces/alarms_and_conditions/condition_snapshot";
 import { InstantiateConditionOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_condition_options";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
 
 import { AddressSpacePrivate } from "../address_space_private";
 import { _install_TwoStateVariable_machinery } from "../state_machine/ua_two_state_variable";
@@ -277,7 +278,7 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
      * returns {StatusCode} StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled
      * @private
      */
-    public _setEnabledState(requestedEnabledState: boolean): StatusCode {
+    public _setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode {
         assert(typeof requestedEnabledState === "boolean");
 
         const enabledState = this.getEnabledState();
@@ -288,7 +289,7 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
             return StatusCodes.BadConditionAlreadyDisabled;
         }
 
-        this._branch0.setEnabledState(requestedEnabledState);
+        this._branch0.setEnabledState(requestedEnabledState, options);
         // conditionNode.enabledState.setValue(requestedEnabledState);
 
         // xx assert(conditionNode.enabledState.id.readValue().value.value === requestedEnabledState,"sanity check 1");
@@ -346,8 +347,8 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
      * @param requestedEnabledState {Boolean}
      * @private
      */
-    public setEnabledState(requestedEnabledState: boolean): StatusCode {
-        return this._setEnabledState(requestedEnabledState);
+    public setEnabledState(requestedEnabledState: boolean, options?:ISetStateOptions): StatusCode {
+        return this._setEnabledState(requestedEnabledState, options);
     }
 
     /**
@@ -491,11 +492,13 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
 
         const branch = this.currentBranch();
 
-        const now = new Date();
+        const currentDefaultDate = new Date();
+        const time = conditionInfo.time || currentDefaultDate;
+        const receiveTime = conditionInfo.receiveTime || currentDefaultDate;
         // install the eventTimestamp
         // set the received Time
-        branch.setTime(now);
-        branch.setReceiveTime(now);
+        branch.setTime(time);
+        branch.setReceiveTime(receiveTime);
 
         // note : in 1.04 LocalTime property is optional
         if (Object.prototype.hasOwnProperty.call(this, "localTime")) {

package/src/data_access/ua_multistate_discrete_impl.ts

@@ -11,6 +11,8 @@ import { BindVariableOptions, INamespace, UAVariable, UAProperty } from "node-op
 import { UAMultiStateDiscrete, UAMultiStateDiscrete_Base } from "node-opcua-nodeset-ua";
 import { registerNodePromoter } from "../../source/loader/register_node_promoter";
 import { UAVariableImpl } from "../ua_variable_impl";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
+
 import { AddMultiStateDiscreteOptions } from "../../source/address_space_ts";
 import { add_dataItem_stuff } from "./add_dataItem_stuff";
 
@@ -21,7 +23,7 @@ export interface UAMultiStateDiscreteEx<T, DT extends DataType> extends UAMultiS
     getValue(): number;
     getValueAsString(): string;
     getIndex(value: string): number;
-    setValue(value: string | number): void;
+    setValue(value: string | number, options?: ISetStateOptions): void;
     checkVariantCompatibility(value: Variant): StatusCode;
 }
 
@@ -50,13 +52,13 @@ export class UAMultiStateDiscreteImpl<T, DT extends DataType> extends UAVariable
         return index;
     }
 
-    public setValue(value: string | number): void {
+    public setValue(value: string | number, options?: ISetStateOptions): void {
         if (typeof value === "string") {
             const index = this.getIndex(value);
             if (index < 0) {
                 throw new Error("UAMultiStateDiscrete#setValue invalid multi state value provided : " + value);
             }
-            return this.setValue(index);
+            return this.setValue(index, options);
         }
         const arrayEnumStrings = this.enumStrings.readValue().value.value;
         if (value >= arrayEnumStrings.length) {

package/src/data_access/ua_multistate_value_discrete_impl.ts

@@ -17,6 +17,7 @@ import { registerNodePromoter } from "../../source/loader/register_node_promoter
 import { coerceEnumValues } from "../../source/helpers/coerce_enum_value";
 import { UAMultiStateValueDiscreteEx } from "../../source/interfaces/data_access/ua_multistate_value_discrete_ex";
 import { AddMultiStateValueDiscreteOptions } from "../../source/address_space_ts";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
 import { UAVariableImpl } from "../ua_variable_impl";
 
 import { add_dataItem_stuff } from "./add_dataItem_stuff";
@@ -50,7 +51,7 @@ export class UAMultiStateValueDiscreteImpl<T, DT extends DataType>
     extends UAVariableImpl
     implements UAMultiStateValueDiscreteEx<T, DT>
 {
-    public setValue(value: string | number | Int64): void {
+    public setValue(value: string | number | Int64, options?: ISetStateOptions): void {
         if (typeof value === "string") {
             const enumValues = this.enumValues.readValue().value.value;
             const selected = enumValues.filter((a: any) => a.displayName.text === value)[0];
@@ -60,7 +61,7 @@ export class UAMultiStateValueDiscreteImpl<T, DT extends DataType>
                 throw new Error("cannot find enum string " + value + " in " + enumValues.toString());
             }
         } else {
-            this._setValue(coerceUInt64(value));
+            this._setValue(coerceUInt64(value), options);
         }
     }
 
@@ -116,7 +117,7 @@ export class UAMultiStateValueDiscreteImpl<T, DT extends DataType>
      *
      * @private
      */
-    public _setValue(value: Int64): void {
+    public _setValue(value: Int64, options?: ISetStateOptions): void {
         // check that value is in bound
         if (!this._isValueInRange(coerceInt32(value))) {
             throw new Error("UAMultiStateValueDiscrete#_setValue out of range " + value);
@@ -301,4 +302,4 @@ export function validateDataType(dataTypeValue: any): void {
     if (typeof dataTypeValue !== "number" || validTypes.indexOf(dataTypeValue) < 0) {
         throw new Error(`Invalid DataType in UAMultiStateValueDiscrete => ${dataTypeValue.toString()}`);
     }
-}
+}

package/src/data_access/ua_two_state_discrete_impl.ts

@@ -10,9 +10,11 @@ import { UAVariableImpl } from "../ua_variable_impl";
 import { registerNodePromoter } from "../../source/loader/register_node_promoter";
 import { AddTwoStateDiscreteOptions } from "../../source/address_space_ts";
 import { UATwoStateDiscreteEx } from "../../source/interfaces/data_access/ua_two_state_discrete_ex";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
 
 import { add_dataItem_stuff } from "./add_dataItem_stuff";
 
+
 export interface UATwoStateDiscreteImpl {
     falseState: UAProperty<LocalizedText, /*c*/ DataType.LocalizedText>;
     trueState: UAProperty<LocalizedText, /*c*/ DataType.LocalizedText>;
@@ -58,15 +60,15 @@ export class UATwoStateDiscreteImpl extends UAVariableImpl implements UATwoState
             );
         }
     }
-    setValue(value: boolean | LocalizedTextLike): void {
+    setValue(value: boolean | LocalizedTextLike, options?: ISetStateOptions): void {
         if (typeof value === "boolean") {
             this.setValueFromSource({ dataType: DataType.Boolean, value });
         } else {
             const text: string = (typeof value === "string" ? value : value.text) || "";
             if (text === this.getTrueStateAsString()) {
-                this.setValue(true);
+                this.setValue(true, options);
             } else if (text === this.getFalseStateAsString()) {
-                this.setValue(false);
+                this.setValue(false, options);
             } else {
                 throw new Error("setValue invalid value " + value);
             }

package/src/state_machine/ua_two_state_variable.ts

@@ -21,6 +21,8 @@ import { AddTwoStateVariableOptions } from "../../source/address_space_ts";
 import { UATwoStateVariableEx } from "../../source/ua_two_state_variable_ex";
 // private types
 import { UAVariableImpl, UAVariableImplT } from "../ua_variable_impl";
+import { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
+
 
 const hasTrueSubState_ReferenceTypeNodeId = resolveNodeId("HasTrueSubState");
 const hasFalseSubState_ReferenceTypeNodeId = resolveNodeId("HasFalseSubState");
@@ -54,19 +56,23 @@ const hasFalseSubState_ReferenceTypeNodeId = resolveNodeId("HasFalseSubState");
 //                  TwoStateVariableType
 //                                                  <StateIdentifier> Defined in Clause 5.4.3 Optional
 
-function _updateTransitionTime(node: UATwoStateVariableEx, _subState?: UAVariable) {
+function _updateTransitionTime(node: UATwoStateVariableEx, _subState?: UAVariable, options?: ISetStateOptions) {
     // TransitionTime specifies the time when the current state was entered.
     if (node.transitionTime) {
-        node.transitionTime.setValueFromSource({ dataType: DataType.DateTime, value: new Date() });
+        const transitionTime = options?.transitionTime || new Date();
+        node.transitionTime.setValueFromSource({ dataType: DataType.DateTime, value: transitionTime });
     }
 }
 
-function _updateEffectiveTransitionTime(node: UATwoStateVariableImpl) {
+function _updateEffectiveTransitionTime(node: UATwoStateVariableImpl,options?: ISetStateOptions) {
     if (node.effectiveTransitionTime) {
+        
+        const effectiveTransitionTime = options?.effectiveTransitionTime || new Date();
+
         // because subStateNode ",subStateNode.browseName.toString());
         node.effectiveTransitionTime.setValueFromSource({
             dataType: DataType.DateTime,
-            value: new Date()
+            value: effectiveTransitionTime
         });
     }
 }
@@ -308,7 +314,7 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
      * @method setValue
      * @param boolValue {Boolean}
      */
-    public setValue(boolValue: boolean): void {
+    public setValue(boolValue: boolean, options?: ISetStateOptions): void {
         assert(typeof boolValue === "boolean");
         const dataValue = this.id!.readValue();
         const oldValue = dataValue.value.value;
@@ -317,8 +323,8 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
         }
         //
         this.id.setValueFromSource(new Variant({ dataType: DataType.Boolean, value: boolValue }));
-        _updateTransitionTime(this);
-        _updateEffectiveTransitionTime(this);
+        _updateTransitionTime(this, undefined, options);
+        _updateEffectiveTransitionTime(this, options);
     }
 
     /**
@@ -369,7 +375,7 @@ export class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataT
             const addressSpace = this.addressSpace;
             // add event handle
             const subState = addressSpace.findNode(reference.nodeId) as UAVariable;
-            subState.on("value_changed", _updateEffectiveTransitionTime.bind(null, this));
+            subState.on("value_changed", _updateEffectiveTransitionTime.bind(null, this, undefined));
         }
     }
 }