node-opcua-address-space 2.180.0 → 2.181.1

package/dist/impl/state_machine/ua_shelving_state_machine_ex.js

@@ -0,0 +1,249 @@
+"use strict";
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAShelvedStateMachineExImpl = exports.UAShelvedStateMachineExImplBase = void 0;
+exports._clear_timer_if_any = _clear_timer_if_any;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_value_1 = require("node-opcua-data-value");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const ua_alarm_condition_impl_js_1 = require("../alarms_and_conditions/ua_alarm_condition_impl.js");
+const finite_state_machine_js_1 = require("./finite_state_machine.js");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("ua_shelving_state_machine_ex");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("ua_shelving_state_machine_ex");
+class UAShelvedStateMachineExImplBase extends finite_state_machine_js_1.UAStateMachineImpl {
+    static promote(object) {
+        const shelvingState = object;
+        (0, finite_state_machine_js_1.promoteToStateMachine)(shelvingState);
+        Object.setPrototypeOf(shelvingState, exports.UAShelvedStateMachineExImpl.prototype);
+        shelvingState._timer = null;
+        if (shelvingState.unshelve) {
+            shelvingState.unshelve.bindMethod(_unshelve_method);
+        }
+        if (shelvingState.timedShelve) {
+            shelvingState.timedShelve.bindMethod(_timedShelve_method);
+        }
+        if (shelvingState.oneShotShelve) {
+            shelvingState.oneShotShelve.bindMethod(_oneShotShelve_method);
+        }
+        // install unshelveTime
+        if (shelvingState.unshelveTime) {
+            shelvingState.unshelveTime.minimumSamplingInterval = 500;
+            shelvingState.unshelveTime.bindVariable({
+                timestamped_get: _unShelveTimeFunc.bind(null, shelvingState)
+            }, true);
+        }
+        (0, node_opcua_assert_1.assert)(shelvingState instanceof exports.UAShelvedStateMachineExImpl);
+        return shelvingState;
+    }
+}
+exports.UAShelvedStateMachineExImplBase = UAShelvedStateMachineExImplBase;
+exports.UAShelvedStateMachineExImpl = UAShelvedStateMachineExImplBase;
+// The Unshelve Method sets the AlarmCondition to the Unshelved state. Normally, the MethodId found
+// the Shelving child of the Condition instance and the NodeId of the Shelving object as the ObjectId
+// are passed to the Call Service. However, some Servers do not expose Condition instances in the
+// IAddressSpace. Therefore all Servers shall also allow Clients to call the Unshelve Method by
+// specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the
+// ShelvedStateMachineType Node.
+// output => BadConditionNotShelved
+function _unshelve_method(inputArguments, context, callback) {
+    (0, node_opcua_assert_1.assert)(inputArguments.length === 0);
+    // var alarmNode = context.object.parent;
+    // if (!(alarmNode instanceof UAAlarmConditionImpl)) {
+    //     return callback(null, {statusCode: StatusCodes.BadNodeIdInvalid});
+    // }
+    //
+    // if (!alarmNode.getEnabledState() ) {
+    //     return callback(null, {statusCode: StatusCodes.BadConditionDisabled});
+    // }
+    const shelvingState = context.object;
+    (0, finite_state_machine_js_1.promoteToStateMachine)(shelvingState);
+    if (shelvingState.getCurrentState() === "Unshelved") {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadConditionNotShelved
+        });
+    }
+    shelvingState.setState("Unshelved");
+    shelvingState._unshelvedTime = new Date(); // now
+    _clear_timer_if_any(shelvingState);
+    (0, node_opcua_assert_1.assert)(!shelvingState._timer);
+    return callback(null, {
+        statusCode: node_opcua_status_code_1.StatusCodes.Good
+    });
+}
+function _clear_timer_if_any(shelvingState) {
+    if (shelvingState._timer) {
+        clearTimeout(shelvingState._timer);
+        shelvingState._timer = null;
+    }
+}
+function _automatically_unshelve(shelvingState) {
+    (0, node_opcua_assert_1.assert)(shelvingState._timer, "expecting timerId to be set");
+    shelvingState._timer = null;
+    // c8 ignore next
+    if (doDebug) {
+        debugLog("Automatically un-shelving variable ", shelvingState.browseName.toString());
+    }
+    if (shelvingState.getCurrentState() === "Unshelved") {
+        // just ignore !!!
+        return;
+        // throw new Error(StatusCodes.BadConditionNotShelved);
+    }
+    shelvingState.setState("Unshelved");
+    shelvingState._unshelvedTime = new Date(); // now
+    (0, node_opcua_assert_1.assert)(!shelvingState._timer);
+}
+function _start_timer_for_automatic_unshelve(shelvingState, duration) {
+    if (duration < 10 || duration >= 2 ** 31) {
+        throw new Error(` Invalid maxTimeShelved duration: ${duration}  must be [10,2**31] `);
+    }
+    (0, node_opcua_assert_1.assert)(!shelvingState._timer);
+    shelvingState._shelvedTime = new Date(); // now
+    shelvingState._duration = duration;
+    // c8 ignore next
+    if (doDebug) {
+        debugLog("shelvingState._duration", shelvingState._duration);
+    }
+    if (duration !== ua_alarm_condition_impl_js_1.UAAlarmConditionImplBase.MaxDuration) {
+        (0, node_opcua_assert_1.assert)(!shelvingState._timer);
+        shelvingState._timer = setTimeout(_automatically_unshelve.bind(null, shelvingState), shelvingState._duration);
+    }
+}
+// Spec 1.03:
+// The TimedShelve Method sets the AlarmCondition to the TimedShelved state
+// (parameters are defined in Table 38 and result codes are described in Table 39).
+// Normally, the MethodId found in the Shelving child of the Condition instance and the NodeId of the Shelving object
+// as the ObjectId are passed to the Call Service. However, some Servers do not expose Condition instances in the
+// IAddressSpace. Therefore all Servers shall also allow Clients to call the TimedShelve Method by specifying
+// ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ShelvedStateMachineType Node.
+//
+// Signature:   TimedShelve([in] Duration ShelvingTime);
+//
+// ShelvingTime Specifies a fixed time for which the Alarm is to be shelved. The Server may refuse
+//              the provided duration.
+//              If a MaxTimeShelved Property exist on the Alarm than the Shelving time shall be less than or equal
+//              to the value of this Property.
+// StatusCode :
+//               BadConditionAlreadyShelved The Alarm is already in TimedShelved state and the system does not allow
+//                                           a reset of the shelved timer.
+//               BadShelvingTimeOutOfRange
+function _timedShelve_method(inputArguments, context, callback) {
+    (0, node_opcua_assert_1.assert)(inputArguments.length === 1);
+    if (!context.object) {
+        return;
+    }
+    const shelvingState = context.object;
+    if (shelvingState.getCurrentState() !== "Unshelved") {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadConditionAlreadyShelved
+        });
+    }
+    // checking duration ...
+    const alarmNode = shelvingState.parent;
+    // c8 ignore next
+    if (!(alarmNode instanceof ua_alarm_condition_impl_js_1.UAAlarmConditionImpl)) {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid
+        });
+    }
+    const maxTimeShelved = alarmNode.getMaxTimeShelved();
+    (0, node_opcua_assert_1.assert)(Number.isFinite(maxTimeShelved));
+    (0, node_opcua_assert_1.assert)(inputArguments[0].dataType === node_opcua_variant_1.DataType.Double); // Duration
+    (0, node_opcua_assert_1.assert)(inputArguments[0] instanceof node_opcua_variant_1.Variant);
+    const proposedDuration = inputArguments[0].value; // as double (milliseconds)
+    if (proposedDuration > maxTimeShelved) {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadShelvingTimeOutOfRange
+        });
+    }
+    if (proposedDuration < 0) {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadShelvingTimeOutOfRange
+        });
+    }
+    _clear_timer_if_any(shelvingState);
+    shelvingState.setState("TimedShelved");
+    _start_timer_for_automatic_unshelve(shelvingState, proposedDuration);
+    return callback(null, {
+        statusCode: node_opcua_status_code_1.StatusCodes.Good
+    });
+}
+// Spec 1.03:
+// OneShotShelve Method
+// The OneShotShelve Method sets the AlarmCondition to the OneShotShelved state. Normally, the MethodId found in the
+// Shelving child of the Condition instance and the NodeId of the Shelving object as the ObjectId are passed to the
+// Call Service. However, some Servers do not expose Condition instances in the IAddressSpace. Therefore all Servers
+// shall also allow Clients to call the OneShotShelve Method by specifying ConditionId as the ObjectId. The Method
+// cannot be called with an ObjectId of the ShelvedStateMachineType Node
+function _oneShotShelve_method(inputArguments, context, callback) {
+    (0, node_opcua_assert_1.assert)(inputArguments.length === 0);
+    const shelvingState = context.object;
+    if (shelvingState.getCurrentState() === "OneShotShelved") {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadConditionAlreadyShelved
+        });
+    }
+    // checking duration ...
+    const alarmNode = shelvingState.parent;
+    // c8 ignore next
+    if (!(alarmNode instanceof ua_alarm_condition_impl_js_1.UAAlarmConditionImpl)) {
+        return callback(null, {
+            statusCode: node_opcua_status_code_1.StatusCodes.BadNodeIdInvalid
+        });
+    }
+    const maxTimeShelved = alarmNode.getMaxTimeShelved();
+    (0, node_opcua_assert_1.assert)(Number.isFinite(maxTimeShelved));
+    (0, node_opcua_assert_1.assert)(maxTimeShelved !== ua_alarm_condition_impl_js_1.UAAlarmConditionImplBase.MaxDuration);
+    // set automatic un-shelving timer
+    _clear_timer_if_any(shelvingState);
+    shelvingState.setState("OneShotShelved");
+    _start_timer_for_automatic_unshelve(shelvingState, maxTimeShelved);
+    return callback(null, {
+        statusCode: node_opcua_status_code_1.StatusCodes.Good
+    });
+}
+// from spec 1.03 :
+// * UnshelveTime specifies the remaining time in milliseconds until the Alarm automatically
+//   transitions into the Un-shelved state.
+// * For the TimedShelved state this time is initialized with the ShelvingTime argument of the
+//   TimedShelve Method call.
+// * For the OneShotShelved state the UnshelveTime will be a constant set to the maximum Duration
+//   except if a MaxTimeShelved Property is provided.
+function _unShelveTimeFunc(shelvingState) {
+    if (shelvingState.getCurrentState() === "Unshelved") {
+        return new node_opcua_data_value_1.DataValue({
+            statusCode: node_opcua_status_code_1.StatusCodes.BadConditionNotShelved,
+            value: { dataType: node_opcua_variant_1.DataType.Double, value: 0 }
+        });
+    }
+    if (!shelvingState._shelvedTime) {
+        return new node_opcua_data_value_1.DataValue({
+            statusCode: node_opcua_status_code_1.StatusCodes.BadConditionNotShelved,
+            value: { dataType: node_opcua_variant_1.DataType.Double, value: 0 }
+        });
+    }
+    if (shelvingState.getCurrentState() === "OneShotShelved" && shelvingState._duration === ua_alarm_condition_impl_js_1.UAAlarmConditionImplBase.MaxDuration) {
+        return new node_opcua_data_value_1.DataValue({
+            statusCode: node_opcua_status_code_1.StatusCodes.Good,
+            value: {
+                dataType: node_opcua_variant_1.DataType.Double,
+                value: ua_alarm_condition_impl_js_1.UAAlarmConditionImplBase.MaxDuration
+            }
+        });
+    }
+    const now = new Date();
+    let timeToAutomaticUnshelvedState = shelvingState._duration - (now.getTime() - shelvingState._shelvedTime.getTime());
+    // timeToAutomaticUnshelvedState should always be greater than (or equal) zero
+    timeToAutomaticUnshelvedState = Math.max(timeToAutomaticUnshelvedState, 0);
+    return new node_opcua_data_value_1.DataValue({
+        statusCode: node_opcua_status_code_1.StatusCodes.Good,
+        value: {
+            dataType: node_opcua_variant_1.DataType.Double, // duration
+            value: timeToAutomaticUnshelvedState
+        }
+    });
+}
+//# sourceMappingURL=ua_shelving_state_machine_ex.js.map

package/dist/impl/state_machine/ua_shelving_state_machine_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_shelving_state_machine_ex.js","sourceRoot":"","sources":["../../../impl/state_machine/ua_shelving_state_machine_ex.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAoJH,kDAKC;AAlJD,yDAA2C;AAC3C,iEAAkD;AAClD,uDAAiE;AAGjE,mEAAqE;AACrE,2DAAyE;AAGzE,oGAAqH;AAErH,uEAAsF;AAEtF,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,8BAA8B,CAAC,CAAC;AAC/D,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,8BAA8B,CAAC,CAAC;AA4B/D,MAAa,+BAAgC,SAAQ,4CAAkB;IA2B5D,MAAM,CAAC,OAAO,CAAC,MAAgB;QAClC,MAAM,aAAa,GAAG,MAAqC,CAAC;QAC5D,IAAA,+CAAqB,EAAC,aAAa,CAAC,CAAC;QAErC,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,mCAA2B,CAAC,SAAS,CAAC,CAAC;QAC5E,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC;QAE5B,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;YACzB,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;YAC5B,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,aAAa,CAAC,aAAa,EAAE,CAAC;YAC9B,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QAClE,CAAC;QACD,uBAAuB;QACvB,IAAI,aAAa,CAAC,YAAY,EAAE,CAAC;YAC7B,aAAa,CAAC,YAAY,CAAC,uBAAuB,GAAG,GAAG,CAAC;YACzD,aAAa,CAAC,YAAY,CAAC,YAAY,CACnC;gBACI,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC;aAC/D,EACD,IAAI,CACP,CAAC;QACN,CAAC;QAED,IAAA,0BAAM,EAAC,aAAa,YAAY,mCAA2B,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC;IACzB,CAAC;CACJ;AAzDD,0EAyDC;AAEY,QAAA,2BAA2B,GAAG,+BAA+B,CAAC;AAE3E,mGAAmG;AACnG,qGAAqG;AACrG,iGAAiG;AACjG,+FAA+F;AAC/F,8FAA8F;AAC9F,gCAAgC;AAChC,mCAAmC;AACnC,SAAS,gBAAgB,CAAC,cAA6B,EAAE,OAAwB,EAAE,QAA4C;IAC3H,IAAA,0BAAM,EAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACpC,yCAAyC;IACzC,sDAAsD;IACtD,yEAAyE;IACzE,IAAI;IACJ,EAAE;IACF,uCAAuC;IACvC,6EAA6E;IAC7E,IAAI;IAEJ,MAAM,aAAa,GAAG,OAAO,CAAC,MAAqC,CAAC;IACpE,IAAA,+CAAqB,EAAC,aAAa,CAAC,CAAC;IAErC,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,WAAW,EAAE,CAAC;QAClD,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,sBAAsB;SACjD,CAAC,CAAC;IACP,CAAC;IACD,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAEpC,aAAa,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM;IAEjD,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACnC,IAAA,0BAAM,EAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAE9B,OAAO,QAAQ,CAAC,IAAI,EAAE;QAClB,UAAU,EAAE,oCAAW,CAAC,IAAI;KAC/B,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,mBAAmB,CAAC,aAA0C;IAC1E,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACvB,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACnC,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC;IAChC,CAAC;AACL,CAAC;AAED,SAAS,uBAAuB,CAAC,aAA0C;IACvE,IAAA,0BAAM,EAAC,aAAa,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;IAC5D,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B,iBAAiB;IACjB,IAAI,OAAO,EAAE,CAAC;QACV,QAAQ,CAAC,qCAAqC,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,WAAW,EAAE,CAAC;QAClD,kBAAkB;QAClB,OAAO;QACP,uDAAuD;IAC3D,CAAC;IACD,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACpC,aAAa,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM;IACjD,IAAA,0BAAM,EAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,mCAAmC,CAAC,aAA0C,EAAE,QAAgB;IACrG,IAAI,QAAQ,GAAG,EAAE,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,qCAAqC,QAAQ,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IACD,IAAA,0BAAM,EAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAE9B,aAAa,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM;IAC/C,aAAa,CAAC,SAAS,GAAG,QAAQ,CAAC;IAEnC,iBAAiB;IACjB,IAAI,OAAO,EAAE,CAAC;QACV,QAAQ,CAAC,yBAAyB,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,QAAQ,KAAK,qDAAwB,CAAC,WAAW,EAAE,CAAC;QACpD,IAAA,0BAAM,EAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC9B,aAAa,CAAC,MAAM,GAAG,UAAU,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClH,CAAC;AACL,CAAC;AAED,aAAa;AACb,2EAA2E;AAC3E,mFAAmF;AACnF,qHAAqH;AACrH,iHAAiH;AACjH,6GAA6G;AAC7G,iHAAiH;AACjH,EAAE;AACF,wDAAwD;AACxD,EAAE;AACF,kGAAkG;AAClG,sCAAsC;AACtC,kHAAkH;AAClH,8CAA8C;AAC9C,eAAe;AACf,oHAAoH;AACpH,0EAA0E;AAC1E,0CAA0C;AAE1C,SAAS,mBAAmB,CACxB,cAA6B,EAC7B,OAAwB,EACxB,QAA4C;IAE5C,IAAA,0BAAM,EAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACpC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO;IACX,CAAC;IACD,MAAM,aAAa,GAAG,OAAO,CAAC,MAAqC,CAAC;IAEpE,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,WAAW,EAAE,CAAC;QAClD,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,0BAA0B;SACrD,CAAC,CAAC;IACP,CAAC;IACD,wBAAwB;IACxB,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC;IAEvC,iBAAiB;IACjB,IAAI,CAAC,CAAC,SAAS,YAAY,iDAAoB,CAAC,EAAE,CAAC;QAC/C,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,gBAAgB;SAC3C,CAAC,CAAC;IACP,CAAC;IACD,MAAM,cAAc,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IACrD,IAAA,0BAAM,EAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;IAExC,IAAA,0BAAM,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,6BAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW;IACnE,IAAA,0BAAM,EAAC,cAAc,CAAC,CAAC,CAAC,YAAY,4BAAO,CAAC,CAAC;IAE7C,MAAM,gBAAgB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,2BAA2B;IAC7E,IAAI,gBAAgB,GAAG,cAAc,EAAE,CAAC;QACpC,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,yBAAyB;SACpD,CAAC,CAAC;IACP,CAAC;IAED,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,yBAAyB;SACpD,CAAC,CAAC;IACP,CAAC;IAED,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACnC,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,mCAAmC,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAErE,OAAO,QAAQ,CAAC,IAAI,EAAE;QAClB,UAAU,EAAE,oCAAW,CAAC,IAAI;KAC/B,CAAC,CAAC;AACP,CAAC;AAED,aAAa;AACb,uBAAuB;AACvB,oHAAoH;AACpH,mHAAmH;AACnH,oHAAoH;AACpH,kHAAkH;AAClH,wEAAwE;AACxE,SAAS,qBAAqB,CAE1B,cAAyB,EACzB,OAAwB,EACxB,QAA4C;IAE5C,IAAA,0BAAM,EAAC,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACpC,MAAM,aAAa,GAAG,OAAO,CAAC,MAAqC,CAAC;IACpE,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,gBAAgB,EAAE,CAAC;QACvD,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,0BAA0B;SACrD,CAAC,CAAC;IACP,CAAC;IACD,wBAAwB;IACxB,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC;IAEvC,iBAAiB;IACjB,IAAI,CAAC,CAAC,SAAS,YAAY,iDAAoB,CAAC,EAAE,CAAC;QAC/C,OAAO,QAAQ,CAAC,IAAI,EAAE;YAClB,UAAU,EAAE,oCAAW,CAAC,gBAAgB;SAC3C,CAAC,CAAC;IACP,CAAC;IAED,MAAM,cAAc,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IACrD,IAAA,0BAAM,EAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;IACxC,IAAA,0BAAM,EAAC,cAAc,KAAK,qDAAwB,CAAC,WAAW,CAAC,CAAC;IAEhE,kCAAkC;IAClC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACnC,aAAa,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACzC,mCAAmC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAEnE,OAAO,QAAQ,CAAC,IAAI,EAAE;QAClB,UAAU,EAAE,oCAAW,CAAC,IAAI;KAC/B,CAAC,CAAC;AACP,CAAC;AAED,mBAAmB;AACnB,4FAA4F;AAC5F,2CAA2C;AAC3C,8FAA8F;AAC9F,6BAA6B;AAC7B,iGAAiG;AACjG,qDAAqD;AACrD,SAAS,iBAAiB,CAAC,aAA0C;IACjE,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,WAAW,EAAE,CAAC;QAClD,OAAO,IAAI,iCAAS,CAAC;YACjB,UAAU,EAAE,oCAAW,CAAC,sBAAsB;YAC9C,KAAK,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;SACjD,CAAC,CAAC;IACP,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;QAC9B,OAAO,IAAI,iCAAS,CAAC;YACjB,UAAU,EAAE,oCAAW,CAAC,sBAAsB;YAC9C,KAAK,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;SACjD,CAAC,CAAC;IACP,CAAC;IACD,IAAI,aAAa,CAAC,eAAe,EAAE,KAAK,gBAAgB,IAAI,aAAa,CAAC,SAAS,KAAK,qDAAwB,CAAC,WAAW,EAAE,CAAC;QAC3H,OAAO,IAAI,iCAAS,CAAC;YACjB,UAAU,EAAE,oCAAW,CAAC,IAAI;YAC5B,KAAK,EAAE;gBACH,QAAQ,EAAE,6BAAQ,CAAC,MAAM;gBACzB,KAAK,EAAE,qDAAwB,CAAC,WAAW;aAC9C;SACJ,CAAC,CAAC;IACP,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IAEvB,IAAI,6BAA6B,GAAG,aAAa,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;IAErH,8EAA8E;IAC9E,6BAA6B,GAAG,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;IAC3E,OAAO,IAAI,iCAAS,CAAC;QACjB,UAAU,EAAE,oCAAW,CAAC,IAAI;QAC5B,KAAK,EAAE;YACH,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,WAAW;YACtC,KAAK,EAAE,6BAA6B;SACvC;KACJ,CAAC,CAAC;AACP,CAAC"}

package/dist/impl/state_machine/ua_two_state_variable.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { BaseNode, BindVariableOptions, INamespace, ISessionContext, UAReference, UAVariable } from "node-opcua-address-space-base";
+import { type LocalizedText, type LocalizedTextLike, type QualifiedNameLike } from "node-opcua-data-model";
+import type { DataValueT } from "node-opcua-data-value";
+import { type NodeId } from "node-opcua-nodeid";
+import type { NumericRange } from "node-opcua-numeric-range";
+import { type StatusCode, type StatusCodeCallback } from "node-opcua-status-code";
+import { DataType } from "node-opcua-variant";
+import type { AddTwoStateVariableOptions } from "../../api/address_space_ts.js";
+import type { ISetStateOptions } from "../../api/interfaces/i_set_state_options.js";
+import type { UATwoStateVariableEx } from "../../api/ua_two_state_variable_ex.js";
+import { UAVariableImplT } from "../ua_variable_impl.js";
+export declare function _install_TwoStateVariable_machinery(node: UAVariable, options: TwoStateVariableInitializeOptions): UATwoStateVariableEx;
+export declare function promoteToTwoStateVariable(node: UAVariable): UATwoStateVariableEx;
+export interface TwoStateVariableInitializeOptions {
+    trueState?: LocalizedTextLike;
+    falseState?: LocalizedTextLike;
+    isFalseSubStateOf?: NodeId | string | BaseNode;
+    isTrueSubStateOf?: NodeId | string | BaseNode;
+    value?: boolean | BindVariableOptions;
+}
+export declare interface UATwoStateVariableImpl extends UATwoStateVariableEx {
+    on(): this;
+    once(): this;
+    readValue(context?: ISessionContext | null, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike | null): DataValueT<LocalizedText, DataType.LocalizedText>;
+    writeValue(context: ISessionContext, dataValue: DataValueT<LocalizedText, DataType.LocalizedText>, indexRange: NumericRange | null, callback: StatusCodeCallback): void;
+    writeValue(context: ISessionContext, dataValue: DataValueT<LocalizedText, DataType.LocalizedText>, callback: StatusCodeCallback): void;
+    writeValue(context: ISessionContext, dataValue: DataValueT<LocalizedText, DataType.LocalizedText>, indexRange?: NumericRange | null): Promise<StatusCode>;
+}
+/***
+ * @class UATwoStateVariable
+ */
+export declare class UATwoStateVariableImpl extends UAVariableImplT<LocalizedText, DataType.LocalizedText> implements UATwoStateVariableEx {
+    private _trueState?;
+    private _falseState?;
+    get isFalseSubStateOf(): UATwoStateVariableEx;
+    get isTrueSubStateOf(): UATwoStateVariableEx;
+    initialize(options: TwoStateVariableInitializeOptions): void;
+    _postInitialize(): void;
+    /**
+     */
+    setValue(boolValue: boolean, options?: ISetStateOptions): void;
+    /**
+     */
+    getValue(): boolean;
+    /**
+     */
+    getValueAsString(): string;
+    getTrueState(): LocalizedText;
+    getFalseState(): LocalizedText;
+    _add_backward_reference(reference: UAReference): void;
+}
+export declare function _addTwoStateVariable(namespace: INamespace, options: AddTwoStateVariableOptions): UATwoStateVariableEx;

package/dist/impl/state_machine/ua_two_state_variable.js

@@ -0,0 +1,323 @@
+"use strict";
+/**
+ * @module node-opcua-address-space
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UATwoStateVariableImpl = void 0;
+exports._install_TwoStateVariable_machinery = _install_TwoStateVariable_machinery;
+exports.promoteToTwoStateVariable = promoteToTwoStateVariable;
+exports._addTwoStateVariable = _addTwoStateVariable;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_constants_1 = require("node-opcua-constants");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+// public interfaces
+const register_node_promoter_js_1 = require("../../api/loader/register_node_promoter.js");
+// private types
+const ua_variable_impl_js_1 = require("../ua_variable_impl.js");
+const hasTrueSubState_ReferenceTypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasTrueSubState");
+const hasFalseSubState_ReferenceTypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasFalseSubState");
+// Release 1.03 12 OPC Unified Architecture, Part 9
+// Two-state state machines
+// Most states defined in this standard are simple – i.e. they are either TRUE or FALSE. The
+// TwoStateVariableType is introduced specifically for this use case. More complex states are
+// modelled by using a StateMachineType defined in Part 5.
+// The TwoStateVariableType is derived from the StateVariableType.
+//
+// Attribute        Value
+// BrowseName       TwoStateVariableType
+// DataType         LocalizedText
+// ValueRank        -1 (-1 = Scalar)
+// IsAbstract       False
+//
+// Subtype of the StateVariableType defined in Part 5.
+// Note that a Reference to this subtype is not shown in the definition of the StateVariableType
+//
+// References      NodeClass BrowseName              DataType      TypeDefinition Modelling Rule
+// HasProperty     Variable  Id                      Boolean       PropertyType   Mandatory
+// HasProperty     Variable  TransitionTime          UtcTime       PropertyType   Optional
+// HasProperty     Variable  EffectiveTransitionTime UtcTime       PropertyType   Optional
+// HasProperty     Variable  TrueState               LocalizedText PropertyType   Optional
+// HasProperty     Variable  FalseState              LocalizedText PropertyType   Optional
+// HasTrueSubState StateMachine or
+//                 TwoStateVariableType
+//                                                  <StateIdentifier> Defined in Clause 5.4.2 Optional
+// HasFalseSubState StateMachine or
+//                  TwoStateVariableType
+//                                                  <StateIdentifier> Defined in Clause 5.4.3 Optional
+function _updateTransitionTime(node, _subState, options) {
+    // TransitionTime specifies the time when the current state was entered.
+    if (node.transitionTime) {
+        const transitionTime = options?.transitionTime || new Date();
+        node.transitionTime.setValueFromSource({ dataType: node_opcua_variant_1.DataType.DateTime, value: transitionTime });
+    }
+}
+function _updateEffectiveTransitionTime(node, options) {
+    if (node.effectiveTransitionTime) {
+        const effectiveTransitionTime = options?.effectiveTransitionTime || new Date();
+        // because subStateNode ",subStateNode.browseName.toString());
+        node.effectiveTransitionTime.setValueFromSource({
+            dataType: node_opcua_variant_1.DataType.DateTime,
+            value: effectiveTransitionTime
+        });
+    }
+}
+function _getEffectiveDisplayName(node) {
+    const humanReadableString = _getHumanReadableString(node);
+    if (humanReadableString.statusCode.isNotGood()) {
+        return humanReadableString;
+    }
+    const boolValue = node.getValue();
+    let subStateNodes;
+    if (boolValue) {
+        subStateNodes = node.findReferencesExAsObject("HasTrueSubState", node_opcua_data_model_1.BrowseDirection.Forward);
+    }
+    else {
+        subStateNodes = node.findReferencesExAsObject("HasFalseSubState", node_opcua_data_model_1.BrowseDirection.Forward);
+    }
+    const _states = subStateNodes.forEach((_n) => {
+        // todo happen
+    });
+    return humanReadableString;
+}
+function _getHumanReadableString(node) {
+    const dataValue = node.id.readValue();
+    if (dataValue.statusCode.isNotGood()) {
+        const _c = dataValue.clone();
+        _c.value = new node_opcua_variant_1.Variant({
+            dataType: node_opcua_variant_1.DataType.LocalizedText,
+            value: (0, node_opcua_data_model_1.coerceLocalizedTextStrict)("")
+        });
+        return _c;
+    }
+    (0, node_opcua_assert_1.assert)(dataValue.value.dataType === node_opcua_variant_1.DataType.Boolean);
+    const boolValue = dataValue.value.value;
+    // The Value Attribute of a TwoStateVariable contains the current state as a human readable name.
+    // The EnabledState for example, might contain the name “Enabled” when TRUE and “Disabled” when FALSE.
+    const dataValue2 = dataValue.clone();
+    dataValue2.value = new node_opcua_variant_1.Variant({
+        dataType: node_opcua_variant_1.DataType.LocalizedText,
+        value: boolValue ? node.getTrueState() : node.getFalseState()
+    });
+    return dataValue2;
+}
+function _install_TwoStateVariable_machinery(node, options) {
+    (0, node_opcua_assert_1.assert)(node.dataTypeObj.browseName.toString() === "LocalizedText");
+    (0, node_opcua_assert_1.assert)(node.minimumSamplingInterval === 0);
+    (0, node_opcua_assert_1.assert)(node.typeDefinitionObj.browseName.toString() === "TwoStateVariableType");
+    (0, node_opcua_assert_1.assert)(node.dataTypeObj.browseName.toString() === "LocalizedText");
+    (0, node_opcua_assert_1.assert)(Object.hasOwn(node, "valueRank") && (node.valueRank === -1 || node.valueRank === 0));
+    // promote node into a UATwoStateVariable
+    const _node = promoteToTwoStateVariable(node);
+    node.initialize(options);
+    return _node;
+}
+function promoteToTwoStateVariable(node) {
+    if (node instanceof UATwoStateVariableImpl) {
+        return node;
+    }
+    // c8 ignore next
+    if (!(node instanceof ua_variable_impl_js_1.UAVariableImpl)) {
+        throw new Error("Trying to promote a invalid object");
+    }
+    Object.setPrototypeOf(node, UATwoStateVariableImpl.prototype);
+    return node;
+}
+(0, register_node_promoter_js_1.registerNodePromoter)(node_opcua_constants_1.VariableTypeIds.TwoStateVariableType, promoteToTwoStateVariable);
+/***
+ * @class UATwoStateVariable
+ */
+// biome-ignore lint/suspicious/noUnsafeDeclarationMerging: interface adds typed members/overloads for this class
+class UATwoStateVariableImpl extends ua_variable_impl_js_1.UAVariableImplT {
+    _trueState;
+    _falseState;
+    get isFalseSubStateOf() {
+        return super.isFalseSubStateOf;
+    }
+    get isTrueSubStateOf() {
+        return super.isTrueSubStateOf;
+    }
+    initialize(options) {
+        if (options.trueState) {
+            (0, node_opcua_assert_1.assert)(!!options.falseState);
+            (0, node_opcua_assert_1.assert)(typeof options.trueState === "string");
+            (0, node_opcua_assert_1.assert)(typeof options.falseState === "string");
+            if (this.trueState) {
+                this.trueState.setValueFromSource({
+                    dataType: node_opcua_variant_1.DataType.LocalizedText,
+                    value: (0, node_opcua_data_model_1.coerceLocalizedText)(options.trueState)
+                });
+            }
+            else {
+                this._trueState = (0, node_opcua_data_model_1.coerceLocalizedTextStrict)(options.trueState).text ?? undefined;
+            }
+            if (this.falseState) {
+                this.falseState.setValueFromSource({
+                    dataType: node_opcua_variant_1.DataType.LocalizedText,
+                    value: (0, node_opcua_data_model_1.coerceLocalizedText)(options.falseState)
+                });
+            }
+            else {
+                this._falseState = (0, node_opcua_data_model_1.coerceLocalizedTextStrict)(options.falseState).text ?? undefined;
+            }
+        }
+        // handle isTrueSubStateOf
+        if (options.isTrueSubStateOf) {
+            this.addReference({
+                isForward: false,
+                nodeId: options.isTrueSubStateOf,
+                referenceType: "HasTrueSubState"
+            });
+        }
+        if (options.isFalseSubStateOf) {
+            this.addReference({
+                isForward: false,
+                nodeId: options.isFalseSubStateOf,
+                referenceType: "HasFalseSubState"
+            });
+        }
+        if (options.value === undefined) {
+            this.id.setValueFromSource({
+                dataType: "Boolean",
+                value: false
+            }, node_opcua_status_code_1.StatusCodes.UncertainInitialValue);
+        }
+        else if (typeof options.value === "boolean") {
+            this.id.setValueFromSource({
+                dataType: "Boolean",
+                value: options.value
+            }, node_opcua_status_code_1.StatusCodes.Good);
+        }
+        else if (Object.hasOwn(options.value, "dataType")) {
+            (0, node_opcua_assert_1.assert)(options.value.dataType === node_opcua_variant_1.DataType.Boolean);
+            this.id.setValueFromSource(options.value, node_opcua_status_code_1.StatusCodes.Good);
+        }
+        else {
+            this.id.bindVariable(options.value);
+        }
+        this._postInitialize();
+    }
+    _postInitialize() {
+        if (this.effectiveTransitionTime) {
+            // install "value_changed" event handler on SubState that are already defined
+            const subStates = this.getTrueSubStates().concat(this.getFalseSubStates());
+            for (const subState of subStates) {
+                subState.on("value_changed", () => _updateEffectiveTransitionTime(this));
+            }
+        }
+        // it should be possible to define a trueState and falseState LocalizedText even if
+        // the trueState or FalseState node is not exposed. Therefore we need to store their value
+        // into dedicated variables.
+        this.id.on("value_changed", () => {
+            this._internal_set_dataValue(_getHumanReadableString(this));
+        });
+        this._internal_set_dataValue(_getHumanReadableString(this));
+        // todo : also set the effectiveDisplayName if present
+        // from spec Part 5
+        // Release 1.03 OPC Unified Architecture, Part 5
+        // EffectiveDisplayName contains a human readable name for the current state of the state
+        // machine after taking the state of any SubStateMachines in account. There is no rule specified
+        // for which state or sub-state should be used. It is up to the Server and will depend on the
+        // semantics of the StateMachineType
+        //
+        // EffectiveDisplayName will be constructed by adding the EnabledState
+        // and the State of the addTrue state
+        if (this.effectiveDisplayName) {
+            const effectiveDisplayName = this.effectiveDisplayName;
+            this.id.on("value_changed", () => {
+                effectiveDisplayName._internal_set_dataValue(_getEffectiveDisplayName(this));
+            });
+            effectiveDisplayName._internal_set_dataValue(_getEffectiveDisplayName(this));
+        }
+    }
+    /**
+     */
+    setValue(boolValue, options) {
+        (0, node_opcua_assert_1.assert)(typeof boolValue === "boolean");
+        const dataValue = this.id?.readValue();
+        const oldValue = dataValue.value.value;
+        if (dataValue.statusCode.isGood() && boolValue === oldValue) {
+            return; // nothing to do
+        }
+        //
+        this.id.setValueFromSource(new node_opcua_variant_1.Variant({ dataType: node_opcua_variant_1.DataType.Boolean, value: boolValue }));
+        _updateTransitionTime(this, undefined, options);
+        _updateEffectiveTransitionTime(this, options);
+    }
+    /**
+     */
+    getValue() {
+        const dataValue = this.id?.readValue();
+        (0, node_opcua_assert_1.assert)(dataValue.statusCode.isGood());
+        (0, node_opcua_assert_1.assert)(dataValue.value.dataType === node_opcua_variant_1.DataType.Boolean);
+        return dataValue.value.value;
+    }
+    /**
+     */
+    getValueAsString() {
+        const dataValue = this.readValue();
+        (0, node_opcua_assert_1.assert)(dataValue.statusCode.isGood());
+        (0, node_opcua_assert_1.assert)(dataValue.value.dataType === node_opcua_variant_1.DataType.LocalizedText);
+        return dataValue.value.value.text?.toString() || "";
+    }
+    getTrueState() {
+        return this.trueState ? this.trueState.readValue().value.value : (0, node_opcua_data_model_1.coerceLocalizedTextStrict)(this._trueState || "TRUE");
+    }
+    getFalseState() {
+        return this.falseState ? this.falseState.readValue().value.value : (0, node_opcua_data_model_1.coerceLocalizedTextStrict)(this._falseState || "FALSE");
+    }
+    // TODO : shall we care about overloading the remove_backward_reference method ?
+    // some TrueSubState and FalseSubState relationship may be added later
+    // so we need a mechanism to keep adding the "value_changed" event handle on subStates that
+    // will be defined later.
+    // install change detection on sub State
+    // this is useful to change the effective transitionTime
+    // EffectiveTransitionTime specifies the time when the current state or one of its sub states was entered.
+    // If, for example, a LevelAlarm is active and – while active – switches several times between High and
+    // HighHigh, then the TransitionTime stays at the point in time where the Alarm became active whereas the
+    // EffectiveTransitionTime changes with each shift of a sub state.
+    _add_backward_reference(reference) {
+        super._add_backward_reference(reference);
+        if (reference.isForward &&
+            ((0, node_opcua_nodeid_1.sameNodeId)(reference.referenceType, hasTrueSubState_ReferenceTypeNodeId) ||
+                (0, node_opcua_nodeid_1.sameNodeId)(reference.referenceType, hasFalseSubState_ReferenceTypeNodeId))) {
+            const addressSpace = this.addressSpace;
+            // add event handle
+            const subState = addressSpace.findNode(reference.nodeId);
+            subState.on("value_changed", _updateEffectiveTransitionTime.bind(null, this, undefined));
+        }
+    }
+}
+exports.UATwoStateVariableImpl = UATwoStateVariableImpl;
+function _addTwoStateVariable(namespace, options) {
+    const addressSpace = namespace.addressSpace;
+    const twoStateVariableType = addressSpace.findVariableType("TwoStateVariableType");
+    if (!twoStateVariableType) {
+        throw new Error("cannot find TwoStateVariableType");
+    }
+    options.optionals = options.optionals || [];
+    if (options.trueState) {
+        options.optionals.push("TrueState");
+    }
+    if (options.falseState) {
+        options.optionals.push("FalseState");
+    }
+    // we want event based changes...
+    options.minimumSamplingInterval = 0;
+    const node = twoStateVariableType.instantiate({
+        browseName: options.browseName,
+        nodeId: options.nodeId,
+        description: options.description,
+        componentOf: options.componentOf,
+        organizedBy: options.organizedBy,
+        modellingRule: options.modellingRule,
+        dataType: (0, node_opcua_nodeid_1.resolveNodeId)(node_opcua_variant_1.DataType.LocalizedText),
+        minimumSamplingInterval: options.minimumSamplingInterval,
+        optionals: options.optionals
+    });
+    const _node = _install_TwoStateVariable_machinery(node, options);
+    return _node;
+}
+//# sourceMappingURL=ua_two_state_variable.js.map