node-opcua-address-space 2.180.0 → 2.181.0

package/api/helpers/resolve_opaque_on_address_space.ts

@@ -0,0 +1,26 @@
+import type { IAddressSpace } from "node-opcua-address-space-base";
+import { resolveDynamicExtensionObject } from "node-opcua-client-dynamic-extension-object";
+import { Variant } from "node-opcua-variant";
+import { ensureDatatypeExtracted } from "../loader/ensure_datatype_extracted.js";
+import { PseudoSession } from "../pseudo_session.js";
+
+export async function resolveOpaqueOnAddressSpace(
+    addressSpace: IAddressSpace,
+    variants: (Variant | null) | (Variant | null)[]
+): Promise<void> {
+    if (!variants) {
+        return;
+    }
+    const session = new PseudoSession(addressSpace);
+    const extraDataTypeManager = await ensureDatatypeExtracted(addressSpace);
+    if (variants instanceof Variant) {
+        await resolveDynamicExtensionObject(session, variants, extraDataTypeManager);
+        return;
+    }
+    // resolve opaque data structure from inputArguments
+    for (const variant of variants) {
+        if (variant) {
+            await resolveDynamicExtensionObject(session, variant, extraDataTypeManager);
+        }
+    }
+}

package/api/index.ts

@@ -0,0 +1,210 @@
+/**
+ * @module node-opcua-address-space
+ */
+
+export * from "node-opcua-address-space-base";
+export * from "node-opcua-nodeset-ua";
+// ---------------------------------------------------------------------------------------
+// Implementation, exported only so that it keeps being exported.
+//
+// These reached consumers through the old `main`, and are kept and marked internal so the
+// run-time surface does not change: the documentation excludes them, and they go at 3.0.
+//
+// This block started at 52 names. The ones with real use are now published above with the
+// rest of the API - scanning downstream code found `promoteToStateMachine` in five separate
+// projects and a dozen more names in others, so dropping the block wholesale, as first
+// planned, would have broken working code to tidy a list.
+//
+// What is left is the *Impl classes and the underscore helpers. Nothing new belongs here.
+// ---------------------------------------------------------------------------------------
+/** @internal */
+export {
+    ConditionInfoImpl,
+    ConditionSnapshotImpl,
+    OneDayDuration,
+    promoteToCertificateExpirationAlarm,
+    TwoWeeksDuration,
+    UAAcknowledgeableConditionImpl,
+    UAAcknowledgeableConditionImplBase,
+    UAAlarmConditionImpl,
+    UAAlarmConditionImplBase,
+    UACertificateExpirationAlarmImpl,
+    UAConditionImpl,
+    UAConditionImplBase,
+    UADiscreteAlarmImpl,
+    UADiscreteAlarmImplBase,
+    UAExclusiveDeviationAlarmImpl,
+    UAExclusiveDeviationAlarmImplBase,
+    UAExclusiveLevelAlarmImpl,
+    UAExclusiveLimitAlarmImpl,
+    UAExclusiveLimitAlarmImplBase,
+    UALimitAlarmImpl,
+    UALimitAlarmImplBase,
+    UANonExclusiveDeviationAlarmImpl,
+    UANonExclusiveDeviationAlarmImplBase,
+    UANonExclusiveLimitAlarmImpl,
+    UANonExclusiveLimitAlarmImplBase
+} from "../impl/alarms_and_conditions/index.js";
+export { instantiateCertificateExpirationAlarm } from "../impl/alarms_and_conditions/ua_certificate_expiration_alarm_impl.js";
+/** The event name a node emits when one of its attributes changes. */
+export { childAccessorNamesShadowedBy, makeAttributeEventName } from "../impl/base_node_impl.js";
+/** @internal */
+export { add_dataItem_stuff } from "../impl/data_access/add_dataItem_stuff.js";
+/** @internal */
+export { adjustDataValueStatusCode } from "../impl/data_access/adjust_datavalue_status_code.js";
+/** @see promoteToStateMachine */
+/** @internal */
+export {
+    _addMultiStateDiscrete,
+    promoteToMultiStateDiscrete,
+    UAMultiStateDiscreteImpl,
+    UAMultiStateDiscreteImplBase
+} from "../impl/data_access/ua_multistate_discrete_impl.js";
+/** @see promoteToStateMachine */
+// validateDataType is deprecated
+/** @internal */
+export {
+    _addMultiStateValueDiscrete,
+    promoteToMultiStateValueDiscrete,
+    UAMultiStateValueDiscreteImpl,
+    UAMultiStateValueDiscreteImplBase,
+    validateDataType,
+    validateIsNumericDataType
+} from "../impl/data_access/ua_multistate_value_discrete_impl.js";
+/** @see promoteToStateMachine */
+/** @internal */
+export {
+    _addTwoStateDiscrete,
+    promoteToTwoStateDiscrete,
+    UATwoStateDiscreteImpl,
+    UATwoStateDiscreteImplBase
+} from "../impl/data_access/ua_two_state_discrete_impl.js";
+export * from "../impl/event_data.js";
+/** Building and maintaining a variable whose value is an array of extension objects. */
+export { addElement, bindExtObjArrayNode, createExtObjArrayNode, removeElement } from "../impl/extension_object_array_node.js";
+/** The default historian, installed through {@link AddressSpace.historizerFactory}. */
+export { VariableHistorian } from "../impl/historical_access/address_space_historical_data_node.js";
+/** @internal */
+export { isNonEmptyQualifiedName, NamespaceImpl } from "../impl/namespace_impl.js";
+/** How node ids are assigned within a namespace. */
+export { ConstructNodeIdOptions, NamespaceOptions, NodeIdManager } from "../impl/nodeid_manager.js";
+/** Rewrites the server's namespace array to match the namespaces actually loaded. */
+export { adjustNamespaceArray } from "../impl/nodeset_tools/adjust_namespace_array.js";
+export * from "../impl/nodeset_tools/construct_namespace_dependency.js";
+/** A namespace's data types as an OPC binary schema (BSD) document. */
+export { dumpToBSD } from "../impl/nodeset_tools/dump_to_bsd.js";
+export {
+    type NamespaceToImageOptions,
+    NodesetExportError,
+    namespaceToImage,
+    namespaceToRecords,
+    type ToNodesetRecordsOptions
+} from "../impl/nodeset_tools/nodeset_to_records.js";
+/** @internal */
+export { sortByBrowseName } from "../impl/nodeset_tools/nodeset_to_xml.js";
+export * from "../impl/private_namespace.js";
+/** Following a reference to the node, or the reference type, it points at. */
+export { resolveReferenceNode, resolveReferenceType } from "../impl/reference_impl.js";
+/**
+ * Upgrading a node to the typed view of what it already is.
+ *
+ * Loading a nodeset gives plain nodes; promoting one returns the same node seen through the
+ * interface for its type, with the helpers that go with it.
+ */
+export { promoteToStateMachine, promoteToStateMachineType } from "../impl/state_machine/finite_state_machine.js";
+export { validateDataTypeCorrectness } from "../impl/validate_data_type_correctness.js";
+export * from "./address_space_public.js";
+export * from "./address_space_ts.js";
+export { ContinuationPointManager } from "./continuation_points/continuation_point_manager.js";
+export { adjustBrowseDirection } from "./helpers/adjust_browse_direction.js";
+export * from "./helpers/argument_list.js";
+export * from "./helpers/call_helpers.js";
+export * from "./helpers/dump_tools.js";
+export * from "./helpers/ensure_secure_access.js";
+export * from "./helpers/make_optionals_map.js";
+export { resolveOpaqueOnAddressSpace } from "./helpers/resolve_opaque_on_address_space.js";
+export * from "./interfaces/alarms_and_conditions/condition_info_i.js";
+export * from "./interfaces/alarms_and_conditions/condition_snapshot.js";
+export * from "./interfaces/alarms_and_conditions/instantiate_alarm_condition_options.js";
+export * from "./interfaces/alarms_and_conditions/instantiate_condition_options.js";
+export * from "./interfaces/alarms_and_conditions/instantiate_exclusive_limit_alarm_options.js";
+export * from "./interfaces/alarms_and_conditions/instantiate_limit_alarm_options.js";
+export * from "./interfaces/alarms_and_conditions/instantiate_off_normal_alarm_options.js";
+export * from "./interfaces/alarms_and_conditions/ua_acknowledgeable_condition_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_alarm_condition_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_base_event_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_certificate_expiration_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_condition_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_discrete_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_exclusive_deviation_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_exclusive_limit_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_limit_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_non_exclusive_deviation_alarm_ex.js";
+export * from "./interfaces/alarms_and_conditions/ua_non_exclusive_limit_alarm_ex.js";
+export * from "./interfaces/data_access/ua_multistate_discrete_ex.js";
+export * from "./interfaces/data_access/ua_multistate_value_discrete_ex.js";
+export * from "./interfaces/data_access/ua_two_state_discrete_ex.js";
+export * from "./interfaces/data_access/ua_y_array_item_ex.js";
+export * from "./interfaces/extension_object_constructor.js";
+export * from "./interfaces/nodeset_loader_options.js";
+export * from "./interfaces/state_machine/ua_exclusive_limit_state_machine_type_ex.js";
+export * from "./interfaces/state_machine/ua_finite_state_machine_type.js";
+export * from "./interfaces/state_machine/ua_program_state_machine_type.js";
+export * from "./interfaces/state_machine/ua_shelved_state_machine_ex.js";
+export * from "./interfaces/state_machine/ua_state_machine_type.js";
+export * from "./interfaces/state_machine/ua_transition_ex.js";
+export * from "./interfaces/ua_subscription_diagnostics_variable_ex.js";
+export { ensureDatatypeExtracted, ensureDatatypeExtractedWithCallback } from "./loader/ensure_datatype_extracted.js";
+export * from "./loader/generateAddressSpaceRaw.js";
+export {
+    imageLinesToRecords,
+    imageNodesetRecords,
+    inflatedImageLines,
+    isNodesetImage,
+    NodesetImageError,
+    type NodesetImageHeader,
+    type NodesetImageTrailer,
+    NodesetImageWriter,
+    type NodesetImageWriterOptions,
+    nodesetImageProblem,
+    type ReadNodesetImageOptions,
+    readNodesetImageInfo,
+    setImageInflater
+} from "./loader/nodeset_image.js";
+export { decodeValue, encodeValue, type JsonNodeId, type JsonQualifiedName, type JsonValue } from "./loader/nodeset_image_codec.js";
+export {
+    MemoryNodesetImageStore,
+    type NodesetImageStore,
+    nodesetImageKey,
+    sharedMemoryNodesetImageStore
+} from "./loader/nodeset_image_store.js";
+export {
+    NODESET_RECORD_SCHEMA,
+    type NodesetDataTypeDefinitionRecord,
+    type NodesetDefinitionField,
+    type NodesetHeaderRecord,
+    type NodesetModelRecord,
+    type NodesetNodeRecord,
+    type NodesetRecord,
+    type NodesetRecordConsumer,
+    type NodesetRecordProducer,
+    type NodesetReferenceRecord,
+    type NodesetRolePermissionRecord,
+    recordBytes,
+    XmlExtensionObjectFragment
+} from "./loader/nodeset_record.js";
+export type { NamedNodesetSource, NodesetChunk, NodesetChunkStream, NodesetSource } from "./loader/nodeset_source.js";
+export { sha256Hex } from "./loader/nodeset_source.js";
+export * from "./loader/nodeset_source_helpers.js";
+export { type NodesetToImageOptions, nodesetToImage } from "./loader/nodeset_to_image.js";
+export { makeXmlNodesetRecordReader, type XmlNodesetRecordReader, xmlNodesetRecords } from "./loader/nodeset_xml_producer.js";
+export * from "./loader/register_node_promoter.js";
+export * from "./namespace.js";
+export type { INamespaceAlarmAndCondition } from "./namespace_alarm_and_condition.js";
+export * from "./namespace_data_access.js";
+export * from "./pseudo_session.js";
+export * from "./session_context.js";
+export * from "./set_namespace_meta_data.js";
+export * from "./ua_addin.js";
+export * from "./ua_interface.js";
+export * from "./ua_root_folder.js";

package/api/interfaces/alarms_and_conditions/condition_info_i.ts

@@ -0,0 +1,60 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { UInt16 } from "node-opcua-basic-types";
+import type { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import type { StatusCode } from "node-opcua-status-code";
+import { ConditionInfoImpl } from "../../../impl/alarms_and_conditions/condition_info_impl.js";
+
+export interface ConditionInfoOptions {
+    message?: string | LocalizedTextLike | null;
+    quality?: StatusCode | null;
+    severity?: UInt16 | null;
+    retain?: boolean | null;
+
+    time?: Date | null;
+    receiveTime?: Date | null;
+}
+
+export interface ConditionInfo {
+    message: LocalizedText | null;
+    quality: StatusCode | null;
+    severity: UInt16 | null;
+    retain: boolean | null;
+    isDifferentFrom(otherConditionInfo: ConditionInfo): boolean;
+}
+
+/**
+ * The static side of {@link ConditionInfo}, so that `new ConditionInfo({...})` works.
+ *
+ * Naming the constructor separately keeps the published surface to what a caller needs: a way
+ * to build one. The class behind it carries nothing else, but stating the shape here means the
+ * implementation can change without the API following it.
+ */
+export interface ConditionInfoConstructor {
+    new (options: ConditionInfoOptions): ConditionInfo;
+}
+
+/**
+ * Builds the message, severity, quality and retain flag that a condition reports.
+ *
+ * ```ts
+ * alarm.calculateConditionInfo = (state, isActive, value, oldConditionInfo) =>
+ *     new ConditionInfo({
+ *         message: `Tank is almost ${Math.ceil(value * 100)}% full`,
+ *         severity: 100,
+ *         quality: StatusCodes.Good,
+ *         retain: true
+ *     });
+ * ```
+ *
+ * The interface of the same name above is the shape of the result; this is the constructor
+ * for it. A type and a value may share a name, which is what lets both live here - and one
+ * module has to own the name, or `export *` from two of them is ambiguous.
+ *
+ * The documentation for the alarm override point has called `new ConditionInfo({...})` for
+ * years while only the type was exported and the sole constructor was an internal class, so
+ * the example did not run as written and code following it had to reach into the
+ * implementation to find one.
+ */
+export const ConditionInfo: ConditionInfoConstructor = ConditionInfoImpl;

package/api/interfaces/alarms_and_conditions/condition_snapshot.ts

@@ -0,0 +1,236 @@
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+import type { EventEmitter } from "node:events";
+import type { IEventData, UAVariable } from "node-opcua-address-space-base";
+import type { UInt16 } from "node-opcua-basic-types";
+import type { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import type { NodeId } from "node-opcua-nodeid";
+import type { StatusCode } from "node-opcua-status-code";
+import type { TimeZoneDataType } from "node-opcua-types";
+import type { Variant } from "node-opcua-variant";
+import type { IConditionVariableTypeSetterOptions } from "../i_condition_variable_type_setter_options.js";
+import type { ISetStateOptions } from "../i_set_state_options.js";
+import type { UtcTime } from "../state_machine/ua_state_machine_type.js";
+import type { UAConditionEx } from "./ua_condition_ex.js";
+
+export interface ConditionSnapshot {
+    on(
+        eventName: "valueChanged",
+        eventHandler: (node: UAVariable, variant: Variant, options: { sourceTimestamp: Date }) => void
+    ): this;
+}
+
+export interface ConditionSnapshot extends EventEmitter {
+    // static normalizeName = normalizeName;
+
+    emit(eventName: "valueChanged", node: UAVariable, variant: Variant, options: { sourceTimestamp: Date }): boolean;
+    emit(eventName: string | symbol): boolean;
+    condition: UAConditionEx;
+    eventData: IEventData | null;
+    branchId: NodeId | null;
+
+    /**
+     */
+    getBranchId(): NodeId;
+    /**
+     */
+    getEventId(): Buffer;
+    /**
+     */
+    getRetain(): boolean;
+    /**
+     */
+    setRetain(retainFlag: boolean): void;
+
+    /**
+     */
+    renewEventId(): void;
+
+    /**
+     */
+    getEnabledState(): boolean;
+    /**
+     */
+    setEnabledState(value: boolean, options?: ISetStateOptions): void;
+    /**
+     */
+    getEnabledStateAsString(): string;
+    /**
+     */
+    getComment(): LocalizedText;
+
+    /**
+     * Set condition comment
+     *
+     * Comment contains the last comment provided for a certain state (ConditionBranch). It may
+     * have been provided by an AddComment Method, some other Method or in some other
+     * manner. The initial value of this Variable is null, unless it is provided in some other manner. If
+     * a Method provides as an option the ability to set a Comment, then the value of this Variable is
+     * reset to null if an optional comment is not provided.
+     *
+     */
+    setComment(txtMessage: LocalizedTextLike, options?: IConditionVariableTypeSetterOptions): void;
+    /**
+     *
+     */
+    setMessage(txtMessage: LocalizedTextLike | LocalizedText): void;
+
+    /**
+     */
+    setClientUserId(userIdentity: string): void;
+    /*
+     *
+     *
+     * as per spec 1.0.3 - Part 9
+     *
+     * Quality reveals the status of process values or other resources that this Condition instance is
+     * based upon. If, for example, a process value is “Uncertain”, the associated “LevelAlarm”
+     * Condition is also questionable. Values for the Quality can be any of the OPC StatusCodes
+     * defined in Part 8 as well as Good, Uncertain and Bad as defined in Part 4. These
+     * StatusCodes are similar to but slightly more generic than the description of data quality in the
+     * various field bus specifications. It is the responsibility of the Server to map internal status
+     * information to these codes. A Server which supports no quality information shall return Good.
+     * This quality can also reflect the communication status associated with the system that this
+     * value or resource is based on and from which this Alarm was received. For communication
+     * errors to the underlying system, especially those that result in some unavailable Event fields,
+     * the quality shall be BadNoCommunication error.
+     *
+     * Quality refers to the quality of the data value(s) upon which this Condition is based. Since a
+     * Condition is usually based on one or more Variables, the Condition inherits the quality of
+     * these Variables. E.g., if the process value is “Uncertain”, the “LevelAlarm” Condition is also
+     * questionable. If more than one variable is represented by a given condition or if the condition
+     * is from an underlining system and no direct mapping to a variable is available, it is up to the
+     * application to determine what quality is displayed as part of the condition.
+     */
+
+    /**
+     * set the condition quality
+     */
+    setQuality(quality: StatusCode, options?: IConditionVariableTypeSetterOptions): void;
+    /**
+     *
+     */
+    getQuality(): StatusCode;
+    /*
+     * as per spec 1.0.3 - Part 9
+     * The Severity of a Condition is inherited from the base Event model defined in Part 5. It
+     * indicates the urgency of the Condition and is also commonly called ‘priority’, especially in
+     * relation to Alarms in the ProcessConditionClass.
+     *
+     * as per spec 1.0.3 - PArt 5
+     * Severity is an indication of the urgency of the Event. This is also commonly called “priority”.
+     * Values will range from 1 to 1 000, with 1 being the lowest severity and 1 000 being the highest.
+     * Typically, a severity of 1 would indicate an Event which is informational in nature, while a value
+     * of 1 000 would indicate an Event of catastrophic nature, which could potentially result in severe
+     * financial loss or loss of life.
+     * It is expected that very few Server implementations will support 1 000 distinct severity levels.
+     * Therefore, Server developers are responsible for distributing their severity levels across the
+     * 1 to 1 000 range in such a manner that clients can assume a linear distribution. For example, a
+     * client wishing to present five severity levels to a user should be able to do the following
+     * mapping:
+     *            Client Severity OPC Severity
+     *                HIGH        801 – 1 000
+     *                MEDIUM HIGH 601 – 800
+     *                MEDIUM      401 – 600
+     *                MEDIUM LOW  201 – 400
+     *                LOW           1 – 200
+     * In many cases a strict linear mapping of underlying source severities to the OPC Severity range
+     * is not appropriate. The Server developer will instead intelligently map the underlying source
+     * severities to the 1 to 1 000 OPC Severity range in some other fashion. In particular, it is
+     * recommended that Server developers map Events of high urgency into the OPC severity range
+     * of 667 to 1 000, Events of medium urgency into the OPC severity range of 334 to 666 and
+     * Events of low urgency into OPC severities of 1 to 333.
+     */
+    setSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
+
+    /**
+     */
+    getSeverity(): UInt16;
+
+    /*
+     * as per spec 1.0.3 - part 9:
+     *  LastSeverity provides the previous severity of the ConditionBranch. Initially this Variable
+     *  contains a zero value; it will return a value only after a severity change. The new severity is
+     *  supplied via the Severity Property which is inherited from the BaseEventType.
+     *
+     */
+    setLastSeverity(severity: UInt16, options?: IConditionVariableTypeSetterOptions): void;
+    /**
+     */
+    getLastSeverity(): UInt16;
+
+    /**
+     * setReceiveTime
+     *
+     * (as per OPCUA 1.0.3 part 5)
+     *
+     * ReceiveTime provides the time the OPC UA Server received the Event from the underlying
+     * device of another Server.
+     *
+     * ReceiveTime is analogous to ServerTimestamp defined in Part 4, i.e.
+     * in the case where the OPC UA Server gets an Event from another OPC UA Server, each Server
+     * applies its own ReceiveTime. That implies that a Client may get the same Event, having the
+     * same EventId, from different Servers having different values of the ReceiveTime.
+     *
+     * The ReceiveTime shall always be returned as value and the Server is not allowed to return a
+     * StatusCode for the ReceiveTime indicating an error.
+     *
+     */
+    setReceiveTime(time: UtcTime): void;
+    /**
+     * (as per OPCUA 1.0.3 part 5)
+     * Time provides the time the Event occurred. This value is set as close to the event generator as
+     * possible. It often comes from the underlying system or device. Once set, intermediate OPC UA
+     * Servers shall not alter the value.
+     *
+     */
+    setTime(time: Date): void;
+    /**
+     * LocalTime is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset
+     * specifies the time difference (in minutes) between the Time Property and the time at the location
+     * in which the event was issued. If DaylightSavingInOffset is TRUE, then Standard/Daylight
+     * savings time (DST) at the originating location is in effect and Offset includes the DST correction.
+     * If FALSE then the Offset does not include DST correction and DST may or may not have been
+     * in effect.
+     */
+    setLocalTime(localTime: TimeZoneDataType): void;
+
+    // read only !
+    getSourceName(): LocalizedText;
+    /**
+     *
+     */
+    getSourceNode(): NodeId;
+
+    /**
+     *
+     */
+    getEventType(): NodeId;
+    getMessage(): LocalizedText;
+    isCurrentBranch(): boolean;
+    // -- ACKNOWLEDGEABLE -------------------------------------------------------------------
+
+    getAckedState(): boolean;
+    setAckedState(ackedState: boolean): StatusCode;
+    getConfirmedState(): boolean;
+
+    setConfirmedStateIfExists(confirmedState: boolean): void;
+    setConfirmedState(confirmedState: boolean): void;
+
+    // ---- Shelving
+    getSuppressedState(): boolean;
+    setSuppressedState(suppressed: boolean): void;
+
+    getActiveState(): boolean;
+
+    setActiveState(newActiveState: boolean): StatusCode;
+
+    setShelvingState(): void;
+    toString(): string;
+
+    /**
+     * @private
+     */
+    _constructEventData(): IEventData;
+}

package/api/interfaces/alarms_and_conditions/deviation_stuff.ts

@@ -0,0 +1,16 @@
+import type { IAddressSpace, UAVariableT } from "node-opcua-address-space-base";
+import type { DataType } from "node-opcua-basic-types";
+import type { DataValue } from "node-opcua-data-value";
+import type { SetPointSupport } from "./install_setpoint_options.js";
+
+export interface DeviationStuff extends SetPointSupport {
+    _onSetpointDataValueChange(dataValue: DataValue): void;
+    _setStateBasedOnInputValue(value: unknown): void;
+
+    getSetpointNodeNode(): UAVariableT<number, DataType.Double> | UAVariableT<number, DataType.Float> | undefined;
+
+    getInputNodeValue(): number | null;
+    getSetpointValue(): number | null;
+
+    readonly addressSpace: IAddressSpace;
+}

package/api/interfaces/alarms_and_conditions/instantiate_alarm_condition_options.ts

@@ -0,0 +1,8 @@
+import type { UAVariable } from "node-opcua-address-space-base";
+import type { NodeId } from "node-opcua-nodeid";
+import type { InstantiateConditionOptions } from "./instantiate_condition_options.js";
+
+export interface InstantiateAlarmConditionOptions extends InstantiateConditionOptions {
+    maxTimeShelved?: number;
+    inputNode: UAVariable | NodeId;
+}

package/api/interfaces/alarms_and_conditions/instantiate_exclusive_deviation_alarm_options.ts

@@ -0,0 +1,6 @@
+import type { InstallSetPointOptions } from "./install_setpoint_options.js";
+import type { InstantiateLimitAlarmOptions } from "./instantiate_limit_alarm_options.js";
+
+export interface InstantiateExclusiveDeviationAlarmOptions extends InstantiateLimitAlarmOptions, InstallSetPointOptions {
+    /** empty interface */
+}

package/api/interfaces/alarms_and_conditions/instantiate_exclusive_limit_alarm_options.ts

@@ -0,0 +1,6 @@
+import type { InstallSetPointOptions } from "./install_setpoint_options.js";
+import type { InstantiateLimitAlarmOptions } from "./instantiate_limit_alarm_options.js";
+
+export interface InstantiateExclusiveLimitAlarmOptions extends InstantiateLimitAlarmOptions, InstallSetPointOptions {
+    /** empty interface */
+}

package/api/interfaces/alarms_and_conditions/instantiate_limit_alarm_options.ts

@@ -0,0 +1,13 @@
+// import type { UAVariable } from "node-opcua-address-space-base";
+import type { NodeId } from "node-opcua-nodeid";
+import type { UAVariable } from "../../index.js";
+import type { InstantiateAlarmConditionOptions } from "./instantiate_alarm_condition_options.js";
+
+export interface InstantiateLimitAlarmOptions extends InstantiateAlarmConditionOptions {
+    highHighLimit?: number;
+    highLimit: number;
+    lowLimit: number;
+    lowLowLimit?: number;
+
+    inputNode: UAVariable | NodeId;
+}

package/api/interfaces/alarms_and_conditions/instantiate_non_exclusive_deviation_alarm_options.ts

@@ -0,0 +1,6 @@
+import type { InstallSetPointOptions } from "./install_setpoint_options.js";
+import type { InstantiateLimitAlarmOptions } from "./instantiate_limit_alarm_options.js";
+
+export interface InstantiateNonExclusiveDeviationAlarmOptions extends InstantiateLimitAlarmOptions, InstallSetPointOptions {
+    /** empty interface */
+}

package/api/interfaces/alarms_and_conditions/instantiate_non_exclusive_limit_alarm_options.ts

@@ -0,0 +1,6 @@
+import type { InstallSetPointOptions } from "./install_setpoint_options.js";
+import type { InstantiateLimitAlarmOptions } from "./instantiate_limit_alarm_options.js";
+
+export interface InstantiateNonExclusiveLimitAlarmOptions extends InstantiateLimitAlarmOptions, InstallSetPointOptions {
+    /** empty interface */
+}

package/api/interfaces/alarms_and_conditions/instantiate_off_normal_alarm_options.ts

@@ -0,0 +1,21 @@
+import type { UAVariable } from "node-opcua-address-space-base";
+import type { NodeIdLike } from "node-opcua-nodeid";
+import type { InstantiateAlarmConditionOptions } from "./instantiate_alarm_condition_options.js";
+
+export interface InstantiateOffNormalAlarmOptions extends InstantiateAlarmConditionOptions {
+    /**
+     *
+     * https://reference.opcfoundation.org/v105/Core/docs/Part9/5.8.23/#5.8.23.2
+     *
+     * The NormalState Property is a Property that points to a Variable which has a value that corresponds
+     * to one of the possible values of the Variable pointed to by the InputNode Property where the NormalState
+     * Property Variable value is the value that is considered to be the normal state of the Variable
+     * pointed to by the InputNode Property.
+     *
+     * When the value of the Variable referenced by the InputNode Property is not equal to the value of
+     * the NormalState Property the Alarm is Active. If this Variable is not in the AddressSpace,
+     * a NULL NodeId shall be provided.
+     *
+     */
+    normalState?: NodeIdLike | UAVariable | null;
+}

package/api/interfaces/alarms_and_conditions/ua_acknowledgeable_condition_ex.ts

@@ -0,0 +1,28 @@
+import type { ListenerSignature, UAMethod } from "node-opcua-address-space-base";
+import type { LocalizedText, LocalizedTextLike } from "node-opcua-data-model";
+import type { UAAcknowledgeableCondition_Base } from "node-opcua-nodeset-ua";
+import type { UATwoStateVariableEx } from "../../ua_two_state_variable_ex.js";
+import type { ConditionSnapshot } from "./condition_snapshot.js";
+import type { UAConditionEvents, UAConditionEx } from "./ua_condition_ex.js";
+
+export interface UAAcknowledgeableConditionHelper {
+    autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void;
+    acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: string | LocalizedTextLike | LocalizedText): void;
+}
+
+export interface UAAcknowledgeableConditionEvents extends UAConditionEvents {
+    acknowledged: (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot) => void;
+    confirmed: (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot) => void;
+}
+
+export interface UAAcknowledgeableConditionEx<
+    T extends UAAcknowledgeableConditionEvents & ListenerSignature<T> = UAAcknowledgeableConditionEvents
+> extends UAAcknowledgeableCondition_Base,
+        UAAcknowledgeableConditionHelper,
+        UAConditionEx<T> {
+    enabledState: UATwoStateVariableEx;
+    ackedState: UATwoStateVariableEx;
+    confirmedState?: UATwoStateVariableEx;
+    acknowledge: UAMethod;
+    confirm?: UAMethod;
+}