node-opcua-address-space 2.98.0 → 2.98.2

package/dist/src/alarms_and_conditions/deviation_alarm_helper.d.ts

@@ -0,0 +1,9 @@
+import { DataValue } from "node-opcua-data-value";
+import { DataType } from "node-opcua-variant";
+import { UAVariableT } from "node-opcua-address-space-base";
+import { DeviationStuff } from "../../source/interfaces/alarms_and_conditions/deviation_stuff";
+import { InstallSetPointOptions } from "../../source/interfaces/alarms_and_conditions/install_setpoint_options";
+export declare function DeviationAlarmHelper_getSetpointNodeNode(this: DeviationStuff): UAVariableT<number, DataType.Double> | UAVariableT<number, DataType.Float> | undefined;
+export declare function DeviationAlarmHelper_getSetpointValue(this: DeviationStuff): number | null;
+export declare function DeviationAlarmHelper_onSetpointDataValueChange(this: DeviationStuff, dataValue: DataValue): void;
+export declare function DeviationAlarmHelper_install_setpoint(this: DeviationStuff, options: InstallSetPointOptions): void;

package/dist/src/alarms_and_conditions/deviation_alarm_helper.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviationAlarmHelper_install_setpoint = exports.DeviationAlarmHelper_onSetpointDataValueChange = exports.DeviationAlarmHelper_getSetpointValue = exports.DeviationAlarmHelper_getSetpointNodeNode = void 0;
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+function DeviationAlarmHelper_getSetpointNodeNode() {
+    (0, node_opcua_assert_1.assert)(this.setpointNode.readValue().value.dataType === node_opcua_variant_1.DataType.NodeId);
+    const nodeId = this.setpointNode.readValue().value.value;
+    const node = this.addressSpace.findNode(nodeId);
+    (0, node_opcua_assert_1.assert)(node === this.setpointNodeNode);
+    if (!node) {
+        return undefined;
+    }
+    return this.setpointNodeNode;
+}
+exports.DeviationAlarmHelper_getSetpointNodeNode = DeviationAlarmHelper_getSetpointNodeNode;
+function DeviationAlarmHelper_getSetpointValue() {
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(this, "setpointNode"));
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(this, "setpointNodeNode"));
+    if (!this.setpointNodeNode) {
+        return null;
+    }
+    const setpointDataValue = this.setpointNodeNode.readValue();
+    if (setpointDataValue.statusCode.isNotGood()) {
+        return null;
+    }
+    const node = this.getSetpointNodeNode();
+    if (!node) {
+        return null;
+    }
+    return node.readValue().value.value;
+}
+exports.DeviationAlarmHelper_getSetpointValue = DeviationAlarmHelper_getSetpointValue;
+function DeviationAlarmHelper_onSetpointDataValueChange(dataValue) {
+    this._setStateBasedOnInputValue(this.getInputNodeValue());
+}
+exports.DeviationAlarmHelper_onSetpointDataValueChange = DeviationAlarmHelper_onSetpointDataValueChange;
+function DeviationAlarmHelper_install_setpoint(options) {
+    (0, node_opcua_assert_1.assert)(this.setpointNode.browseName.toString() === "SetpointNode");
+    const addressSpace = this.addressSpace;
+    if (options.setpointNode) {
+        const setpointNodeNode = addressSpace._coerceNode(options.setpointNode);
+        (0, node_opcua_assert_1.assert)(setpointNodeNode, "Expecting a valid setpoint node");
+        this.setpointNodeNode = addressSpace._coerceNode(options.setpointNode);
+        this.setpointNode.setValueFromSource({ dataType: "NodeId", value: this.setpointNodeNode.nodeId });
+        // install inputNode monitoring for change
+        this.setpointNodeNode.on("value_changed", (newDataValue) => {
+            this._onSetpointDataValueChange(newDataValue);
+        });
+    }
+    else {
+        this.setpointNodeNode = undefined;
+        this.setpointNode.setValueFromSource({ dataType: "NodeId", value: node_opcua_nodeid_1.NodeId.nullNodeId });
+    }
+}
+exports.DeviationAlarmHelper_install_setpoint = DeviationAlarmHelper_install_setpoint;
+//# sourceMappingURL=deviation_alarm_helper.js.map

package/dist/src/alarms_and_conditions/deviation_alarm_helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviation_alarm_helper.js","sourceRoot":"","sources":["../../../src/alarms_and_conditions/deviation_alarm_helper.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAA2C;AAE3C,2DAA8C;AAE9C,yDAA2C;AAM3C,SAAgB,wCAAwC;IAGpD,IAAA,0BAAM,EAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,6BAAQ,CAAC,MAAM,CAAC,CAAC;IAEzE,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;IACzD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChD,IAAA,0BAAM,EAAC,IAAI,KAAK,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACvC,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,SAAS,CAAC;KACpB;IACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;AACjC,CAAC;AAZD,4FAYC;AAED,SAAgB,qCAAqC;IACjD,IAAA,0BAAM,EAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IACnE,IAAA,0BAAM,EAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACvE,IAAI,CAAE,IAAI,CAAC,gBAAgB,EAAE;QACzB,OAAO,IAAI,CAAC;KACf;IACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;IAC5D,IAAI,iBAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE;QAC1C,OAAO,IAAI,CAAC;KACf;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;IACxC,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,IAAI,CAAC;KACf;IACD,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;AACxC,CAAC;AAfD,sFAeC;AAED,SAAgB,8CAA8C,CAAuB,SAAoB;IACrG,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;AAC9D,CAAC;AAFD,wGAEC;AAED,SAAgB,qCAAqC,CAAuB,OAA+B;IAEvG,IAAA,0BAAM,EAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,cAAc,CAAC,CAAC;IAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,YAAmC,CAAC;IAE9D,IAAI,OAAO,CAAC,YAAY,EAAE;QACtB,MAAM,gBAAgB,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACxE,IAAA,0BAAM,EAAC,gBAAgB,EAAE,iCAAiC,CAAC,CAAC;QAC5D,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAA0C,CAAC;QAChH,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;QAClG,0CAA0C;QAC1C,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,YAAuB,EAAE,EAAE;YAClE,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;KACN;SAAM;QACH,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,0BAAM,CAAC,UAAU,EAAE,CAAC,CAAC;KAC1F;AACL,CAAC;AAnBD,sFAmBC"}

package/dist/src/alarms_and_conditions/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+export * from "./condition_info_impl";
+export * from "./condition_snapshot_impl";
+export * from "./ua_condition_impl";
+export * from "./ua_acknowledgeable_condition_impl";
+export * from "./ua_discrete_alarm_impl";
+export * from "./ua_exclusive_deviation_alarm_impl";
+export * from "./ua_exclusive_level_alarm_impl";
+export * from "./ua_exclusive_limit_alarm_impl";
+export * from "./ua_limit_alarm_impl";
+export * from "./ua_non_exclusive_deviation_alarm_impl";
+export * from "./ua_non_exclusive_limit_alarm_impl";
+export * from "./ua_alarm_condition_impl";
+export * from "./ua_certificate_expiration_alarm_impl";

package/dist/src/alarms_and_conditions/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+__exportStar(require("./condition_info_impl"), exports);
+__exportStar(require("./condition_snapshot_impl"), exports);
+__exportStar(require("./ua_condition_impl"), exports);
+__exportStar(require("./ua_acknowledgeable_condition_impl"), exports);
+__exportStar(require("./ua_discrete_alarm_impl"), exports);
+__exportStar(require("./ua_exclusive_deviation_alarm_impl"), exports);
+__exportStar(require("./ua_exclusive_level_alarm_impl"), exports);
+__exportStar(require("./ua_exclusive_limit_alarm_impl"), exports);
+__exportStar(require("./ua_limit_alarm_impl"), exports);
+__exportStar(require("./ua_non_exclusive_deviation_alarm_impl"), exports);
+__exportStar(require("./ua_non_exclusive_limit_alarm_impl"), exports);
+__exportStar(require("./ua_alarm_condition_impl"), exports);
+__exportStar(require("./ua_certificate_expiration_alarm_impl"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/alarms_and_conditions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/alarms_and_conditions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,wDAAsC;AACtC,4DAA0C;AAC1C,sDAAoC;AACpC,sEAAoD;AACpD,2DAAyC;AACzC,sEAAoD;AACpD,kEAAgD;AAChD,kEAAgD;AAChD,wDAAsC;AACtC,0EAAwD;AACxD,sEAAoD;AACpD,4DAA0C;AAC1C,yEAAuD"}

package/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import { NodeId } from "node-opcua-nodeid";
+import { StatusCode } from "node-opcua-status-code";
+import { VariantOptions } from "node-opcua-variant";
+import { INamespace, UAEventType } from "node-opcua-address-space-base";
+import { AddressSpacePrivate } from "../address_space_private";
+import { UAAcknowledgeableConditionEx } from "../../source/interfaces/alarms_and_conditions/ua_acknowledgeable_condition_ex";
+import { ConditionSnapshot } from "../../source/interfaces/alarms_and_conditions/condition_snapshot";
+import { InstantiateAlarmConditionOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_alarm_condition_options";
+import { UAConditionImpl } from "./ua_condition_impl";
+export declare interface UAAcknowledgeableConditionImpl extends UAAcknowledgeableConditionEx, UAConditionImpl {
+    on(eventName: string, eventHandler: any): this;
+}
+export declare class UAAcknowledgeableConditionImpl extends UAConditionImpl implements UAAcknowledgeableConditionEx {
+    /**
+     */
+    static instantiate(namespace: INamespace, conditionTypeId: UAEventType | NodeId | string, options: InstantiateAlarmConditionOptions, data?: Record<string, VariantOptions>): UAAcknowledgeableConditionImpl;
+    static install_method_handle_on_type(addressSpace: AddressSpacePrivate): void;
+    _raiseAuditConditionAcknowledgeEvent(branch: ConditionSnapshot): void;
+    _raiseAuditConditionConfirmEvent(branch: ConditionSnapshot): void;
+    _acknowledge_branch(conditionEventId: Buffer, comment: string | LocalizedTextLike | LocalizedText, branch: ConditionSnapshot, message: string): StatusCode;
+    /**
+     * @method _confirm_branch
+     * @param conditionEventId The ConditionEventId field shall contain the id of the Event that was conformed
+     * @param comment
+     * @param branch
+     * @param message
+     * @private
+     */
+    _confirm_branch(conditionEventId: Buffer, comment: string | LocalizedTextLike, branch: ConditionSnapshot, message: string): void;
+    /**
+     * @method autoConfirmBranch
+     * @param branch
+     * @param comment
+     */
+    autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void;
+    /**
+     * @method acknowledgeAndAutoConfirmBranch
+     * @param branch {ConditionSnapshot}
+     * @param comment {String|LocalizedText}
+     */
+    acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: string | LocalizedTextLike | LocalizedText): void;
+}

package/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAAcknowledgeableConditionImpl = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const ua_two_state_variable_1 = require("../state_machine/ua_two_state_variable");
+const condition_1 = require("./condition");
+const condition_snapshot_impl_1 = require("./condition_snapshot_impl");
+const ua_condition_impl_1 = require("./ua_condition_impl");
+class UAAcknowledgeableConditionImpl extends ua_condition_impl_1.UAConditionImpl {
+    /**
+     */
+    static instantiate(namespace, conditionTypeId, options, data) {
+        const conditionNode = ua_condition_impl_1.UAConditionImpl.instantiate(namespace, conditionTypeId, options, data);
+        Object.setPrototypeOf(conditionNode, UAAcknowledgeableConditionImpl.prototype);
+        // ----------------------- Install Acknowledge-able Condition stuff
+        // install ackedState - Mandatory
+        /**
+         * @property ackedState
+         * @type TwoStateVariable
+         */
+        (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(conditionNode.ackedState, {
+            falseState: "Unacknowledged",
+            trueState: "Acknowledged"
+        });
+        /**
+         * @property acknowledge
+         * @type UAMethod
+         */
+        conditionNode.acknowledge.bindMethod(_acknowledge_method);
+        // install confirmedState - Optional
+        /**
+         * @property confirmedState
+         * @type TwoStateVariable
+         */
+        if (conditionNode.confirmedState) {
+            (0, ua_two_state_variable_1._install_TwoStateVariable_machinery)(conditionNode.confirmedState, {
+                falseState: "Unconfirmed",
+                trueState: "Confirmed"
+            });
+        }
+        // install confirm Method - Optional
+        /**
+         * @property confirm
+         * @type UAMethod
+         */
+        if (conditionNode.confirm) {
+            conditionNode.confirm.bindMethod(_confirm_method);
+        }
+        (0, node_opcua_assert_1.assert)(conditionNode instanceof UAAcknowledgeableConditionImpl);
+        return conditionNode;
+    }
+    static install_method_handle_on_type(addressSpace) {
+        var _a;
+        const acknowledgeableConditionType = addressSpace.findEventType("AcknowledgeableConditionType");
+        (0, node_opcua_assert_1.assert)(acknowledgeableConditionType !== null);
+        acknowledgeableConditionType.acknowledge.bindMethod(_acknowledge_method);
+        (_a = acknowledgeableConditionType.confirm) === null || _a === void 0 ? void 0 : _a.bindMethod(_confirm_method);
+    }
+    _raiseAuditConditionAcknowledgeEvent(branch) {
+        // raise the AuditConditionAcknowledgeEventType
+        const eventData = {
+            actionTimeStamp: { dataType: node_opcua_variant_1.DataType.DateTime, value: new Date() },
+            // xx branchId: branch.branchId.readValue().value,
+            // AuditEventType
+            clientAuditEntryId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            clientUserId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            // The ConditionEventId field shall contain the id of the event for which the comment was added
+            conditionEventId: { dataType: node_opcua_variant_1.DataType.ByteString, value: branch.getEventId() },
+            // The Comment contains the actual comment that was added
+            comment: { dataType: node_opcua_variant_1.DataType.LocalizedText, value: branch.getComment() },
+            inputArguments: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            methodId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            serverId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            status: {
+                dataType: node_opcua_variant_1.DataType.StatusCode,
+                value: node_opcua_status_code_1.StatusCodes.Good
+            }
+        };
+        this.raiseEvent("AuditConditionAcknowledgeEventType", eventData);
+    }
+    _raiseAuditConditionConfirmEvent(branch) {
+        // raise the AuditConditionConfirmEventType
+        const eventData = {
+            actionTimeStamp: { dataType: node_opcua_variant_1.DataType.DateTime, value: new Date() },
+            // ConditionEventId The ConditionEventId field shall contain the id of the Event that was confirmed
+            conditionEventId: { dataType: node_opcua_variant_1.DataType.ByteString, value: branch.getEventId() },
+            // xx branchId: branch.branchId.readValue().value,
+            // AuditEventType
+            clientAuditEntryId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            clientUserId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            comment: { dataType: node_opcua_variant_1.DataType.LocalizedText, value: branch.getComment() },
+            inputArguments: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            methodId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            serverId: {
+                dataType: node_opcua_variant_1.DataType.Null
+            },
+            status: {
+                dataType: node_opcua_variant_1.DataType.StatusCode,
+                value: node_opcua_status_code_1.StatusCodes.Good
+            }
+        };
+        this.raiseEvent("AuditConditionConfirmEventType", eventData);
+    }
+    _acknowledge_branch(conditionEventId, comment, branch, message) {
+        (0, node_opcua_assert_1.assert)(typeof message === "string");
+        const statusCode = (0, condition_1._setAckedState)(branch, true, conditionEventId, comment);
+        if (statusCode.isNotGood()) {
+            return statusCode;
+        }
+        if (this.confirmedState) {
+            // alarm has a confirmed state !
+            // we should be waiting for confirmation now
+            branch.setConfirmedState(false);
+            branch.setRetain(true);
+        }
+        else {
+            branch.setRetain(false);
+        }
+        branch.setComment(comment);
+        this.raiseNewBranchState(branch);
+        this._raiseAuditConditionAcknowledgeEvent(branch);
+        /**
+         * @event acknowledged
+         * @param  eventId   {Buffer|null}
+         * @param  comment   {LocalizedText}
+         * @param  branch    {ConditionSnapshot}
+         * raised when the alarm branch has been acknowledged
+         */
+        this.emit("acknowledged", conditionEventId, comment, branch);
+        return node_opcua_status_code_1.StatusCodes.Good;
+    }
+    /**
+     * @method _confirm_branch
+     * @param conditionEventId The ConditionEventId field shall contain the id of the Event that was conformed
+     * @param comment
+     * @param branch
+     * @param message
+     * @private
+     */
+    _confirm_branch(conditionEventId, comment, branch, message) {
+        (0, node_opcua_assert_1.assert)(typeof message === "string");
+        (0, node_opcua_assert_1.assert)(comment instanceof node_opcua_data_model_1.LocalizedText);
+        // xx var eventId = branch.getEventId();
+        (0, node_opcua_assert_1.assert)(branch.getEventId().toString("hex") === conditionEventId.toString("hex"));
+        branch.setConfirmedState(true);
+        // once confirmed a branch do not need to be retained
+        branch.setRetain(false);
+        branch.setComment(comment);
+        this._raiseAuditConditionCommentEvent(message, conditionEventId, comment);
+        this._raiseAuditConditionConfirmEvent(branch);
+        this.raiseNewBranchState(branch);
+        /**
+         * @event confirmed
+         * @param  eventId
+         * @param  comment
+         * @param  eventId
+         * raised when the alarm branch has been confirmed
+         */
+        this.emit("confirmed", conditionEventId, comment, branch);
+    }
+    /**
+     * @method autoConfirmBranch
+     * @param branch
+     * @param comment
+     */
+    autoConfirmBranch(branch, comment) {
+        (0, node_opcua_assert_1.assert)(branch instanceof condition_snapshot_impl_1.ConditionSnapshotImpl);
+        if (!this.confirmedState) {
+            // no confirmedState => ignoring
+            return;
+        }
+        (0, node_opcua_assert_1.assert)(!branch.getConfirmedState(), "already confirmed ?");
+        const conditionEventId = branch.getEventId();
+        // tslint:disable-next-line:no-console
+        console.log("autoConfirmBranch getAckedState ", branch.getAckedState());
+        this._confirm_branch(conditionEventId, comment, branch, "Server/Confirm");
+    }
+    /**
+     * @method acknowledgeAndAutoConfirmBranch
+     * @param branch {ConditionSnapshot}
+     * @param comment {String|LocalizedText}
+     */
+    acknowledgeAndAutoConfirmBranch(branch, comment) {
+        comment = node_opcua_data_model_1.LocalizedText.coerce(comment);
+        const conditionEventId = branch.getEventId();
+        branch.setRetain(false);
+        this._acknowledge_branch(conditionEventId, comment, branch, "Server/Acknowledge");
+        this.autoConfirmBranch(branch, comment);
+    }
+}
+exports.UAAcknowledgeableConditionImpl = UAAcknowledgeableConditionImpl;
+function _acknowledge_method(inputArguments, context, callback) {
+    ua_condition_impl_1.UAConditionImpl.with_condition_method(inputArguments, context, callback, (conditionEventId, comment, branch, conditionNode) => {
+        const ackConditionNode = conditionNode;
+        // precondition checking
+        (0, node_opcua_assert_1.assert)(!conditionEventId || conditionEventId instanceof Buffer, "must have a valid eventId or  null");
+        (0, node_opcua_assert_1.assert)(comment instanceof node_opcua_data_model_1.LocalizedText, "expecting a comment as LocalizedText");
+        (0, node_opcua_assert_1.assert)(conditionNode instanceof UAAcknowledgeableConditionImpl);
+        ackConditionNode._acknowledge_branch(conditionEventId, comment, branch, "Method/Acknowledged");
+        return node_opcua_status_code_1.StatusCodes.Good;
+    });
+}
+/*
+ *
+ * param inputArguments {Variant[]}
+ * param context        {Object}
+ * param callback       {Function}
+ *
+ * @private
+ */
+function _confirm_method(inputArguments, context, callback) {
+    ua_condition_impl_1.UAConditionImpl.with_condition_method(inputArguments, context, callback, (eventId, comment, branch, conditionNode) => {
+        (0, node_opcua_assert_1.assert)(eventId instanceof Buffer);
+        (0, node_opcua_assert_1.assert)(branch.getEventId() instanceof Buffer);
+        (0, node_opcua_assert_1.assert)(branch.getEventId().toString("hex") === eventId.toString("hex"));
+        const ackConditionNode = conditionNode;
+        if (branch.getConfirmedState()) {
+            return node_opcua_status_code_1.StatusCodes.BadConditionBranchAlreadyConfirmed;
+        }
+        ackConditionNode._confirm_branch(eventId, comment, branch, "Method/Confirm");
+        return node_opcua_status_code_1.StatusCodes.Good;
+    });
+}
+//# sourceMappingURL=ua_acknowledgeable_condition_impl.js.map

package/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_acknowledgeable_condition_impl.js","sourceRoot":"","sources":["../../../src/alarms_and_conditions/ua_acknowledgeable_condition_impl.ts"],"names":[],"mappings":";;;AAIA,yDAA2C;AAC3C,iEAAyE;AAEzE,mEAA4E;AAC5E,2DAA2E;AAK3E,kFAA6F;AAK7F,2CAA6C;AAC7C,uEAAkE;AAClE,2DAAuD;AAOvD,MAAa,8BAA+B,SAAQ,mCAAe;IAC/D;OACG;IACI,MAAM,CAAC,WAAW,CACrB,SAAqB,EACrB,eAA8C,EAC9C,OAAyC,EACzC,IAAqC;QAErC,MAAM,aAAa,GAAG,mCAAe,CAAC,WAAW,CAC7C,SAAS,EACT,eAAe,EACf,OAAO,EACP,IAAI,CAC2B,CAAC;QAEpC,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAE/E,mEAAmE;QACnE,iCAAiC;QACjC;;;WAGG;QACH,IAAA,2DAAmC,EAAC,aAAa,CAAC,UAAU,EAAE;YAC1D,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,cAAc;SAC5B,CAAC,CAAC;QAEH;;;WAGG;QACH,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAE1D,oCAAoC;QACpC;;;WAGG;QACH,IAAI,aAAa,CAAC,cAAc,EAAE;YAC9B,IAAA,2DAAmC,EAAC,aAAa,CAAC,cAAc,EAAE;gBAC9D,UAAU,EAAE,aAAa;gBACzB,SAAS,EAAE,WAAW;aACzB,CAAC,CAAC;SACN;QAED,oCAAoC;QACpC;;;WAGG;QACH,IAAI,aAAa,CAAC,OAAO,EAAE;YACvB,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;SACrD;QACD,IAAA,0BAAM,EAAC,aAAa,YAAY,8BAA8B,CAAC,CAAC;QAChE,OAAO,aAAa,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,6BAA6B,CAAC,YAAiC;;QACzE,MAAM,4BAA4B,GAAG,YAAY,CAAC,aAAa,CAC3D,8BAA8B,CACa,CAAC;QAChD,IAAA,0BAAM,EAAC,4BAA4B,KAAK,IAAI,CAAC,CAAC;QAC9C,4BAA4B,CAAC,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QACzE,MAAA,4BAA4B,CAAC,OAAO,0CAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACtE,CAAC;IAEM,oCAAoC,CAAC,MAAyB;QACjE,+CAA+C;QAC/C,MAAM,SAAS,GAAmB;YAC9B,eAAe,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,IAAI,EAAE,EAAE;YACnE,kDAAkD;YAElD,iBAAiB;YACjB,kBAAkB,EAAE;gBAChB,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YAED,YAAY,EAAE;gBACV,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YAED,+FAA+F;YAC/F,gBAAgB,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YAE/E,yDAAyD;YACzD,OAAO,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YAEzE,cAAc,EAAE;gBACZ,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,QAAQ,EAAE;gBACN,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,QAAQ,EAAE;gBACN,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,MAAM,EAAE;gBACJ,QAAQ,EAAE,6BAAQ,CAAC,UAAU;gBAC7B,KAAK,EAAE,oCAAW,CAAC,IAAI;aAC1B;SACJ,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;IAEM,gCAAgC,CAAC,MAAyB;QAC7D,2CAA2C;QAC3C,MAAM,SAAS,GAAmB;YAC9B,eAAe,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,IAAI,EAAE,EAAE;YAEnE,mGAAmG;YACnG,gBAAgB,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YAC/E,kDAAkD;YAElD,iBAAiB;YACjB,kBAAkB,EAAE;gBAChB,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,YAAY,EAAE;gBACV,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,OAAO,EAAE,EAAE,QAAQ,EAAE,6BAAQ,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE;YACzE,cAAc,EAAE;gBACZ,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,QAAQ,EAAE;gBACN,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,QAAQ,EAAE;gBACN,QAAQ,EAAE,6BAAQ,CAAC,IAAI;aAC1B;YACD,MAAM,EAAE;gBACJ,QAAQ,EAAE,6BAAQ,CAAC,UAAU;gBAC7B,KAAK,EAAE,oCAAW,CAAC,IAAI;aAC1B;SACJ,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,gCAAgC,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAEM,mBAAmB,CACtB,gBAAwB,EACxB,OAAmD,EACnD,MAAyB,EACzB,OAAe;QAEf,IAAA,0BAAM,EAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG,IAAA,0BAAc,EAAC,MAA+B,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACpG,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE;YACxB,OAAO,UAAU,CAAC;SACrB;QAED,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,gCAAgC;YAChC,4CAA4C;YAC5C,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SAC1B;aAAM;YACH,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC3B;QAED,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE3B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,CAAC,oCAAoC,CAAC,MAAM,CAAC,CAAC;QAElD;;;;;;WAMG;QACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE7D,OAAO,oCAAW,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAClB,gBAAwB,EACxB,OAAmC,EACnC,MAAyB,EACzB,OAAe;QAEf,IAAA,0BAAM,EAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC;QACpC,IAAA,0BAAM,EAAC,OAAO,YAAY,qCAAa,CAAC,CAAC;QAEzC,wCAAwC;QACxC,IAAA,0BAAM,EAAC,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACjF,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE/B,qDAAqD;QACrD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE3B,IAAI,CAAC,gCAAgC,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAEjC;;;;;;WAMG;QACH,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,MAAyB,EAAE,OAA0B;QAC1E,IAAA,0BAAM,EAAC,MAAM,YAAY,+CAAqB,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACtB,gCAAgC;YAChC,OAAO;SACV;QACD,IAAA,0BAAM,EAAC,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,qBAAqB,CAAC,CAAC;QAC3D,MAAM,gBAAgB,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QAC7C,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,+BAA+B,CAAC,MAAyB,EAAE,OAAmD;QACjH,OAAO,GAAG,qCAAa,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC;QACzC,MAAM,gBAAgB,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QAC7C,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;QAClF,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACJ;AA1PD,wEA0PC;AAED,SAAS,mBAAmB,CACxB,cAA6B,EAC7B,OAAwB,EACxB,QAA4C;IAE5C,mCAAe,CAAC,qBAAqB,CACjC,cAAc,EACd,OAAO,EACP,QAAQ,EACR,CAAC,gBAAwB,EAAE,OAAsB,EAAE,MAAyB,EAAE,aAA8B,EAAE,EAAE;QAC5G,MAAM,gBAAgB,GAAG,aAA+C,CAAC;QACzE,wBAAwB;QACxB,IAAA,0BAAM,EAAC,CAAC,gBAAgB,IAAI,gBAAgB,YAAY,MAAM,EAAE,oCAAoC,CAAC,CAAC;QACtG,IAAA,0BAAM,EAAC,OAAO,YAAY,qCAAa,EAAE,sCAAsC,CAAC,CAAC;QACjF,IAAA,0BAAM,EAAC,aAAa,YAAY,8BAA8B,CAAC,CAAC;QAChE,gBAAgB,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC/F,OAAO,oCAAW,CAAC,IAAI,CAAC;IAC5B,CAAC,CACJ,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,cAA6B,EAAE,OAAwB,EAAE,QAA4C;IAC1H,mCAAe,CAAC,qBAAqB,CACjC,cAAc,EACd,OAAO,EACP,QAAQ,EACR,CAAC,OAAe,EAAE,OAAsB,EAAE,MAAyB,EAAE,aAA8B,EAAE,EAAE;QACnG,IAAA,0BAAM,EAAC,OAAO,YAAY,MAAM,CAAC,CAAC;QAClC,IAAA,0BAAM,EAAC,MAAM,CAAC,UAAU,EAAE,YAAY,MAAM,CAAC,CAAC;QAC9C,IAAA,0BAAM,EAAC,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAExE,MAAM,gBAAgB,GAAG,aAA+C,CAAC;QACzE,IAAI,MAAM,CAAC,iBAAiB,EAAE,EAAE;YAC5B,OAAO,oCAAW,CAAC,kCAAkC,CAAC;SACzD;QACD,gBAAgB,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAC7E,OAAO,oCAAW,CAAC,IAAI,CAAC;IAC5B,CAAC,CACJ,CAAC;AACN,CAAC"}

package/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts

@@ -0,0 +1,93 @@
+import { DataValue } from "node-opcua-data-value";
+import { NodeId } from "node-opcua-nodeid";
+import { VariantOptions } from "node-opcua-variant";
+import { BaseNode, INamespace, UAEventType, UAVariable } from "node-opcua-address-space-base";
+import { ConditionInfo } from "../../source/interfaces/alarms_and_conditions/condition_info_i";
+import { UAAlarmConditionEx } from "../../source/interfaces/alarms_and_conditions/ua_alarm_condition_ex";
+import { InstantiateAlarmConditionOptions } from "../../source/interfaces/alarms_and_conditions/instantiate_alarm_condition_options";
+import { UAAcknowledgeableConditionImpl } from "./ua_acknowledgeable_condition_impl";
+export declare interface UAAlarmConditionImpl extends UAAlarmConditionEx, UAAcknowledgeableConditionImpl {
+    on(eventName: string, eventHandler: any): this;
+}
+export declare class UAAlarmConditionImpl extends UAAcknowledgeableConditionImpl implements UAAlarmConditionEx {
+    static MaxDuration: number;
+    static instantiate(namespace: INamespace, alarmConditionTypeId: UAEventType | string | NodeId, options: InstantiateAlarmConditionOptions, data?: Record<string, VariantOptions>): UAAlarmConditionImpl;
+    dispose(): void;
+    activateAlarm(): void;
+    deactivateAlarm(retain?: boolean): void;
+    /**
+     * @deprecated use deactivateAlarm instead (with no s after de-activate)
+     */
+    protected desactivateAlarm(): void;
+    isSuppressedOrShelved(): boolean;
+    getSuppressedOrShelved(): boolean;
+    /**
+     *
+     * note: duration must be greater than 10ms and lesser than 2**31 ms
+     */
+    setMaxTimeShelved(duration: number): void;
+    /**
+     * note: return a  Duration
+     */
+    getMaxTimeShelved(): number;
+    /**
+     * @method getInputNodeNode
+     * @return {BaseNode} return the node in the address space pointed by the inputNode value
+     *
+     * Note: please note the difference between alarm.inputNode
+     *    *  alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input
+     *       node in its value.
+     *    *  getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and
+     *       whose node id is stored in alarm.inputNode
+     */
+    getInputNodeNode(): UAVariable | null;
+    /**
+     * @method getInputNodeValue
+     * @return {*}
+     */
+    getInputNodeValue(): any | null;
+    updateState(): void;
+    protected _onInputDataValueChange(newValue: DataValue): void;
+    /**
+     * @method installInputNodeMonitoring
+     * install mechanism that listen to input node datavalue changes so that alarm status
+     * can be automatically updated appropriatly.
+     * @param inputNode {BaseNode}
+     * @return {void}
+     * @protected
+     */
+    installInputNodeMonitoring(inputNode: BaseNode | NodeId): void;
+    getCurrentConditionInfo(): ConditionInfo;
+    /***
+     * @method  _calculateConditionInfo
+     * @param stateData {Object}   the new calculated state of the alarm
+     * @param isActive  {Boolean}
+     * @param value     {Number}   the new value of the limit alarm
+     * @param oldCondition  {ConditionInfo} given for information purpose
+     * @param oldCondition.severity
+     * @param oldCondition.quality
+     * @param oldCondition.message
+     * @param oldCondition.retain
+     * @return {ConditionInfo} the new condition info
+     *
+     * this method need to be overridden by the instantiate to allow custom message and severity
+     * to be set based on specific context of the alarm.
+     *
+     * @example
+     *
+     *
+     *    var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...});
+     *    myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) {
+     *       var percent = Math.ceil(value * 100);
+     *       return new ConditionInfo({
+     *            message: "Tank is almost " + percent + "% full",
+     *            severity: 100,
+     *            quality: StatusCodes.Good
+     *      });
+     *    };
+     *
+     */
+    _calculateConditionInfo(stateData: string | null, isActive: boolean, value: string, oldCondition: ConditionInfo): ConditionInfo;
+    _signalInitialCondition(): void;
+    _signalNewCondition(stateName: string | null, isActive?: boolean, value?: string): void;
+}