node-opcua-nodeset-machinery-process-values 2.99.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-2023  Sterfive SAS - 833264583 RCS ORLEANS - France (https://www.sterfive.com)
+
+Copyright (c) 2014-2022 Etienne Rossignon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "node-opcua-nodeset-machinery-process-values",
+    "version": "2.99.0",
+    "description": "pure nodejs OPCUA SDK - module node-opcua-nodeset-machinery-process-values",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc -b"
+    },
+    "author": "Etienne Rossignon <etienne.rossignon@sterfive.com>",
+    "license": "MIT",
+    "dependencies": {
+        "node-opcua-address-space-base": "2.99.0",
+        "node-opcua-basic-types": "2.99.0",
+        "node-opcua-data-access": "2.99.0",
+        "node-opcua-data-model": "2.99.0",
+        "node-opcua-nodeid": "2.99.0",
+        "node-opcua-nodeset-padim": "2.99.0",
+        "node-opcua-nodeset-ua": "2.99.0",
+        "node-opcua-status-code": "2.98.1",
+        "node-opcua-variant": "2.99.0"
+    },
+    "files": [
+        "dist",
+        "source"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/node-opcua/node-opcua.git"
+    },
+    "keywords": [
+        "OPCUA",
+        "opcua",
+        "m2m",
+        "iot",
+        "opc ua",
+        "internet of things"
+    ],
+    "homepage": "http://node-opcua.github.io/",
+    "gitHead": "90ce9f5b44d74198d84a384de622dfa94fd05c0c"
+}

package/source/index.ts

@@ -0,0 +1,4 @@
+export * from "./ua_process_value";
+export * from "./ua_process_value_setpoint_variable";
+export * from "./ua_process_value_variable";
+export * from "./ua_zero_point_adjustment_event";

package/source/ua_process_value.ts

@@ -0,0 +1,96 @@
+// ----- this file has been automatically generated - do not edit
+import { UAMethod, UAProperty } from "node-opcua-address-space-base"
+import { DataType, Variant, VariantOptions } from "node-opcua-variant"
+import { LocalizedText, QualifiedName } from "node-opcua-data-model"
+import { EUInformation } from "node-opcua-data-access"
+import { NodeId } from "node-opcua-nodeid"
+import { StatusCode } from "node-opcua-status-code"
+import { UInt32, UInt16, Int16, UAString } from "node-opcua-basic-types"
+import { DTRange } from "node-opcua-nodeset-ua/source/dt_range"
+import { DTEnumValue } from "node-opcua-nodeset-ua/source/dt_enum_value"
+import { DTArgument } from "node-opcua-nodeset-ua/source/dt_argument"
+import { UAAnalogUnit } from "node-opcua-nodeset-ua/source/ua_analog_unit"
+import { UAAnalogUnitRange } from "node-opcua-nodeset-ua/source/ua_analog_unit_range"
+import { UAMultiStateValueDiscrete } from "node-opcua-nodeset-ua/source/ua_multi_state_value_discrete"
+import { UAExclusiveDeviationAlarm } from "node-opcua-nodeset-ua/source/ua_exclusive_deviation_alarm"
+import { UAExclusiveLimitAlarm } from "node-opcua-nodeset-ua/source/ua_exclusive_limit_alarm"
+import { UAAnalogSignalVariable } from "node-opcua-nodeset-padim/source/ua_analog_signal_variable"
+import { UAAnalogSignal, UAAnalogSignal_Base } from "node-opcua-nodeset-padim/source/ua_analog_signal"
+import { UAProcessValueSetpointVariable } from "./ua_process_value_setpoint_variable"
+export interface UAProcessValue_analogSignal<T, DT extends DataType> extends Omit<UAAnalogSignalVariable<T, DT>, "engineeringUnits"|"euRange"> { // Variable
+      engineeringUnits: UAProperty<EUInformation, DataType.ExtensionObject>;
+      euRange: UAProperty<DTRange, DataType.ExtensionObject>;
+      /**
+       * highHighLimit
+       * Defines the absolute high high limit
+       */
+      highHighLimit?: UAAnalogUnit<any, any>;
+      /**
+       * highLimit
+       * Defines the absolute high limit
+       */
+      highLimit?: UAAnalogUnit<any, any>;
+      /**
+       * lowLimit
+       * Defines the absolute low limit
+       */
+      lowLimit?: UAAnalogUnit<any, any>;
+      /**
+       * lowLowLimit
+       * Defines the absolute low low limit
+       */
+      lowLowLimit?: UAAnalogUnit<any, any>;
+      /**
+       * percentageValue
+       * Provides the process value in percentage.
+       */
+      percentageValue?: UAAnalogUnitRange<number, DataType.Double>;
+}
+/**
+ * Represents a process value
+ *
+ * |                |                                                  |
+ * |----------------|--------------------------------------------------|
+ * |namespace       |http://opcfoundation.org/UA/Machinery/ProcessValues/|
+ * |nodeClass       |ObjectType                                        |
+ * |typedDefinition |21:ProcessValueType ns=21;i=1003                  |
+ * |isAbstract      |false                                             |
+ */
+export interface UAProcessValue_Base extends UAAnalogSignal_Base {
+    /**
+     * alarmSuppression
+     * Indicates if alarms based on the Status shall be
+     * suppressed.
+     */
+    alarmSuppression?: UAMultiStateValueDiscrete<UInt16, DataType.UInt16>;
+    /**
+     * analogSignal
+     * The process value.
+     */
+    analogSignal: UAProcessValue_analogSignal<any, any>;
+    /**
+     * deviationAlarm
+     * Becomes active, when the process values derivates
+     * from the ProcessValueSetpoint.
+     */
+    deviationAlarm?: UAExclusiveDeviationAlarm;
+    /**
+     * limitAlarm
+     * Becomes active, when absolute limits are reached.
+     */
+    limitAlarm?: UAExclusiveLimitAlarm;
+    /**
+     * processValueSetpoint
+     * The desired value, may or may not be controlled
+     * by the server.
+     */
+    processValueSetpoint?: UAProcessValueSetpointVariable<any, any>;
+    /**
+     * status
+     * Indicates if a limit has been reached.
+     */
+    status?: UAMultiStateValueDiscrete<UInt16, DataType.UInt16>;
+    zeroPointAdjustment?: UAMethod;
+}
+export interface UAProcessValue extends Omit<UAAnalogSignal, "analogSignal"|"zeroPointAdjustment">, UAProcessValue_Base {
+}

package/source/ua_process_value_setpoint_variable.ts

@@ -0,0 +1,67 @@
+// ----- this file has been automatically generated - do not edit
+import { UAProperty } from "node-opcua-address-space-base"
+import { DataType, Variant } from "node-opcua-variant"
+import { UInt16 } from "node-opcua-basic-types"
+import { UAAnalogUnitRange, UAAnalogUnitRange_Base } from "node-opcua-nodeset-ua/source/ua_analog_unit_range"
+import { UAMultiStateValueDiscrete } from "node-opcua-nodeset-ua/source/ua_multi_state_value_discrete"
+import { UAAnalogUnit } from "node-opcua-nodeset-ua/source/ua_analog_unit"
+import { UABaseDataVariable } from "node-opcua-nodeset-ua/source/ua_base_data_variable"
+/**
+ * Define the desired value of the Variable it
+ * belongs to.
+ *
+ * |                |                                                  |
+ * |----------------|--------------------------------------------------|
+ * |namespace       |http://opcfoundation.org/UA/Machinery/ProcessValues/|
+ * |nodeClass       |VariableType                                      |
+ * |typedDefinition |21:ProcessValueSetpointVariableType ns=21;i=2003  |
+ * |dataType        |Variant                                           |
+ * |dataType Name   |Variant ns=0;i=26                                 |
+ * |isAbstract      |false                                             |
+ */
+export interface UAProcessValueSetpointVariable_Base<T, DT extends DataType>  extends UAAnalogUnitRange_Base<T, DT> {
+    /**
+     * autoDeviationAdjustment
+     * Defines if the deviation variables are
+     * automatically adjusted.
+     */
+    autoDeviationAdjustment?: UAProperty<boolean, DataType.Boolean>;
+    /**
+     * deviationSensitivity
+     * Indicates the sensitivity of the deviation
+     * variables when automatically set.
+     */
+    deviationSensitivity?: UAMultiStateValueDiscrete<UInt16, DataType.UInt16>;
+    /**
+     * highDeviation
+     * Defines the high limit for deviation, relative to
+     * the process value setpoint.
+     */
+    highDeviation?: UAAnalogUnit<any, any>;
+    /**
+     * highHighDeviation
+     * Defines the high high limit for deviation,
+     * relative to the process value setpoint.
+     */
+    highHighDeviation?: UAAnalogUnit<any, any>;
+    /**
+     * lowDeviation
+     * Defines the low limit for deviation, relative to
+     * the process value setpoint.
+     */
+    lowDeviation?: UAAnalogUnit<any, any>;
+    /**
+     * lowLowDeviation
+     * Defines the low low limit for deviation, relative
+     * to the process value setpoint.
+     */
+    lowLowDeviation?: UAAnalogUnit<any, any>;
+    /**
+     * substituteValue
+     * Value that should be used when the process value
+     * setpoint cannot be controlled anymore.
+     */
+    substituteValue?: UABaseDataVariable<any, any>;
+}
+export interface UAProcessValueSetpointVariable<T, DT extends DataType> extends UAAnalogUnitRange<T, DT>, UAProcessValueSetpointVariable_Base<T, DT> {
+}

package/source/ua_process_value_variable.ts

@@ -0,0 +1,48 @@
+// ----- this file has been automatically generated - do not edit
+import { DataType, Variant } from "node-opcua-variant"
+import { EUInformation } from "node-opcua-data-access"
+import { DTRange } from "node-opcua-nodeset-ua/source/dt_range"
+import { UAAnalogUnit } from "node-opcua-nodeset-ua/source/ua_analog_unit"
+import { UAAnalogUnitRange } from "node-opcua-nodeset-ua/source/ua_analog_unit_range"
+import { UAAnalogSignalVariable, UAAnalogSignalVariable_Base } from "node-opcua-nodeset-padim/source/ua_analog_signal_variable"
+/**
+ * Provides a process value and additional meta data
+ *
+ * |                |                                                  |
+ * |----------------|--------------------------------------------------|
+ * |namespace       |http://opcfoundation.org/UA/Machinery/ProcessValues/|
+ * |nodeClass       |VariableType                                      |
+ * |typedDefinition |21:ProcessValueVariableType ns=21;i=2002          |
+ * |dataType        |Variant                                           |
+ * |dataType Name   |Variant ns=0;i=26                                 |
+ * |isAbstract      |false                                             |
+ */
+export interface UAProcessValueVariable_Base<T, DT extends DataType>  extends UAAnalogSignalVariable_Base<T, DT> {
+    /**
+     * highHighLimit
+     * Defines the absolute high high limit
+     */
+    highHighLimit?: UAAnalogUnit<any, any>;
+    /**
+     * highLimit
+     * Defines the absolute high limit
+     */
+    highLimit?: UAAnalogUnit<any, any>;
+    /**
+     * lowLimit
+     * Defines the absolute low limit
+     */
+    lowLimit?: UAAnalogUnit<any, any>;
+    /**
+     * lowLowLimit
+     * Defines the absolute low low limit
+     */
+    lowLowLimit?: UAAnalogUnit<any, any>;
+    /**
+     * percentageValue
+     * Provides the process value in percentage.
+     */
+    percentageValue?: UAAnalogUnitRange<number, DataType.Double>;
+}
+export interface UAProcessValueVariable<T, DT extends DataType> extends UAAnalogSignalVariable<T, DT>, UAProcessValueVariable_Base<T, DT> {
+}

package/source/ua_zero_point_adjustment_event.ts

@@ -0,0 +1,25 @@
+// ----- this file has been automatically generated - do not edit
+import { UAProperty } from "node-opcua-address-space-base"
+import { DataType, VariantOptions } from "node-opcua-variant"
+import { LocalizedText } from "node-opcua-data-model"
+import { NodeId } from "node-opcua-nodeid"
+import { StatusCode } from "node-opcua-status-code"
+import { UInt16, UAString } from "node-opcua-basic-types"
+import { DTTimeZone } from "node-opcua-nodeset-ua/source/dt_time_zone"
+import { UABaseEvent, UABaseEvent_Base } from "node-opcua-nodeset-ua/source/ua_base_event"
+/**
+ * Provides information, that a zero-point
+ * adjustment took place
+ *
+ * |                |                                                  |
+ * |----------------|--------------------------------------------------|
+ * |namespace       |http://opcfoundation.org/UA/Machinery/ProcessValues/|
+ * |nodeClass       |ObjectType                                        |
+ * |typedDefinition |21:ZeroPointAdjustmentEventType ns=21;i=1002      |
+ * |isAbstract      |true                                              |
+ */
+export interface UAZeroPointAdjustmentEvent_Base extends UABaseEvent_Base {
+    zeroPointAdjustmentResult: UAProperty<StatusCode, DataType.StatusCode>;
+}
+export interface UAZeroPointAdjustmentEvent extends UABaseEvent, UAZeroPointAdjustmentEvent_Base {
+}