node-opcua-aggregates 2.51.0

package/.mocharc.yml

@@ -0,0 +1,7 @@
+require:
+  - ts-node/register
+extension:
+  - ts
+  - js
+recursive: true
+timeout: 10000

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2021 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/bin/sample_aggregate_server.js

@@ -0,0 +1,15 @@
+const opcua = require("node-opcua");
+const path = require("path");
+
+const server = new opcua.OPCUAServer({
+});
+
+const { addAggregateSupport } = require("..");
+
+server.start(function(err){
+
+    addAggregateSupport(server.engine.addressSpace);
+
+    console.log("err= ",err);
+
+});

package/dist/aggregates.d.ts

@@ -0,0 +1,7 @@
+import { AddressSpace, BaseNode, UAObject, UAServerCapabilities, UAVariable } from "node-opcua-address-space";
+import { AggregateConfigurationOptionsEx } from "./interval";
+export declare function createHistoryServerCapabilities(addressSpace: AddressSpace, serverCapabilities: UAServerCapabilities): UAObject;
+export declare type AggregateFunctionName = "AnnotationCount" | "Average" | "Count" | "Delta" | "DeltaBounds" | "DurationBad" | "DurationGood" | "DurationInStateNonZero" | "DurationInStateZero" | "EndBound" | "Interpolative" | "Maximum" | "Maximum2" | "MaximumActualTime" | "MaximumActualTime2" | "Minimum" | "Minimum2" | "MinimumActualTime" | "MinimumActualTime2" | "NumberOfTransitions" | "PercentBad" | "PercentGood" | "Range" | "Range2" | "StandardDeviationPopulation" | "StandardDeviationSample" | "Start" | "StartBound" | "TimeAverage" | "TimeAverage2" | "Total" | "Total2" | "VariancePopulation" | "VarianceSample" | "WorstQuality" | "WorstQuality2";
+export declare function addAggregateSupport(addressSpace: AddressSpace): void;
+export declare function installAggregateConfigurationOptions(node: UAVariable, options: AggregateConfigurationOptionsEx): void;
+export declare function getAggregateConfiguration(node: BaseNode): AggregateConfigurationOptionsEx;

package/dist/aggregates.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAggregateConfiguration = exports.installAggregateConfigurationOptions = exports.addAggregateSupport = exports.createHistoryServerCapabilities = void 0;
+/**
+ * @module node-opcua-aggregates
+ */
+const node_opcua_constants_1 = require("node-opcua-constants");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const utils = require("node-opcua-utils");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const read_processed_details_1 = require("./read_processed_details");
+// import { HistoryServerCapabilities } from "node-opcua-server";
+/*
+HasProperty Variable AccessHistoryDataCapability Boolean PropertyType Mandatory
+HasProperty Variable AccessHistoryEventsCapability Boolean PropertyType Mandatory
+HasProperty Variable MaxReturnDataValues UInt32 PropertyType Mandatory
+HasProperty Variable MaxReturnEventValues UInt32 PropertyType Mandatory
+HasProperty Variable InsertDataCapability Boolean PropertyType Mandatory
+HasProperty Variable ReplaceDataCapability Boolean PropertyType Mandatory
+HasProperty Variable UpdateDataCapability Boolean PropertyType Mandatory
+HasProperty Variable DeleteRawCapability Boolean PropertyType Mandatory
+HasProperty Variable DeleteAtTimeCapability Boolean PropertyType Mandatory
+HasProperty Variable InsertEventCapability Boolean PropertyType Mandatory
+HasProperty Variable ReplaceEventCapability Boolean PropertyType Mandatory
+HasProperty Variable UpdateEventCapability Boolean PropertyType Mandatory
+HasProperty Variable DeleteEventCapability Boolean PropertyType Mandatory
+HasProperty Variable InsertAnnotationsCapability Boolean PropertyType Mandatory
+ */
+const historicalCapabilitiesDefaultProperties /*: HistoryServerCapabilities */ = {
+    accessHistoryDataCapability: true,
+    accessHistoryEventsCapability: true,
+    deleteAtTimeCapability: false,
+    deleteEventCapability: false,
+    deleteRawCapability: false,
+    insertAnnotationCapability: false,
+    insertDataCapability: false,
+    insertEventCapability: false,
+    maxReturnDataValues: 0,
+    maxReturnEventValues: 0,
+    replaceDataCapability: false,
+    replaceEventCapability: false,
+    updateDataCapability: false,
+    updateEventCapability: false // Boolean PropertyType Mandatory
+};
+function createHistoryServerCapabilities(addressSpace, serverCapabilities) {
+    /* istanbul ignore next */
+    if (serverCapabilities.browseName.toString() !== "ServerCapabilities") {
+        throw new Error("Expecting server Capabilities");
+    }
+    const historyServerCapabilitiesType = addressSpace.getNamespace(0).findObjectType("HistoryServerCapabilitiesType");
+    /* istanbul ignore next */
+    if (!historyServerCapabilitiesType) {
+        throw new Error("Cannot find HistoryServerCapabilitiesType");
+    }
+    return historyServerCapabilitiesType.instantiate({
+        browseName: "HistoryServerCapabilities",
+        componentOf: serverCapabilities
+    });
+}
+exports.createHistoryServerCapabilities = createHistoryServerCapabilities;
+function setHistoricalServerCapabilities(historyServerCapabilities, defaultProperties) {
+    function setBoolean(propName) {
+        const lowerCase = utils.lowerFirstLetter(propName);
+        /* istanbul ignore next */
+        if (!defaultProperties.hasOwnProperty(lowerCase)) {
+            throw new Error("cannot find " + lowerCase);
+        }
+        const value = defaultProperties[lowerCase];
+        const prop = historyServerCapabilities.getChildByName(propName);
+        /* istanbul ignore next */
+        if (!prop) {
+            throw new Error(" Cannot find property " + propName);
+        }
+        prop.setValueFromSource({ dataType: node_opcua_variant_1.DataType.Boolean, value });
+    }
+    function setUInt32(propName) {
+        const lowerCase = utils.lowerFirstLetter(propName);
+        /* istanbul ignore next */
+        if (!historyServerCapabilities.hasOwnProperty(lowerCase)) {
+            throw new Error("cannot find " + lowerCase);
+        }
+        const value = defaultProperties[lowerCase];
+        const prop = historyServerCapabilities.getChildByName(propName);
+        prop.setValueFromSource({ dataType: node_opcua_variant_1.DataType.UInt32, value });
+    }
+    setBoolean("AccessHistoryDataCapability");
+    setBoolean("AccessHistoryEventsCapability");
+    setUInt32("MaxReturnDataValues");
+    setUInt32("MaxReturnEventValues");
+    setBoolean("InsertDataCapability");
+    setBoolean("ReplaceDataCapability");
+    setBoolean("UpdateDataCapability");
+    setBoolean("DeleteRawCapability");
+    setBoolean("DeleteAtTimeCapability");
+    setBoolean("InsertEventCapability");
+    setBoolean("ReplaceEventCapability");
+    setBoolean("UpdateEventCapability");
+    setBoolean("DeleteEventCapability");
+    /// FOUND A BUG HERE spec says InsertAnnotationsCapability
+    /// Standard nodeset2 says InsertAnnotationCapability ( without s )
+    // xx setBoolean("InsertAnnotationsCapability");
+}
+function addAggregateFunctionSupport(addressSpace, functionName) {
+    /* istanbul ignore next */
+    if (!functionName) {
+        throw new Error("Invalid function name");
+    }
+    const serverCapabilities = addressSpace.rootFolder.objects.server.serverCapabilities;
+    /* istanbul ignore next */
+    if (!serverCapabilities.historyServerCapabilities) {
+        throw new Error("missing serverCapabilities.historyServerCapabilities");
+    }
+    const aggregateFunctions = serverCapabilities.aggregateFunctions;
+    const aggregateFunctionsInHist = serverCapabilities.historyServerCapabilities.aggregateFunctions;
+    const functionNodeId = (0, node_opcua_nodeid_1.makeNodeId)(functionName);
+    const functionNode = addressSpace.getNamespace(0).findNode(functionNodeId);
+    /* istanbul ignore next */
+    if (!functionNode) {
+        throw new Error("Cannot find node " + functionName + " in addressSpace");
+    }
+    aggregateFunctions.addReference({
+        nodeId: functionNode.nodeId,
+        referenceType: "Organizes"
+    });
+    aggregateFunctionsInHist.addReference({
+        nodeId: functionNode.nodeId,
+        referenceType: "Organizes"
+    });
+}
+function addAggregateSupport(addressSpace) {
+    const aggregateConfigurationType = addressSpace.getNamespace(0).findObjectType("AggregateConfigurationType");
+    /* istanbul ignore next */
+    if (!aggregateConfigurationType) {
+        throw new Error("addressSpace do not expose AggregateConfigurationType");
+    }
+    const aggregateFunctionType = addressSpace.getNamespace(0).findObjectType("AggregateFunctionType");
+    /* istanbul ignore next */
+    if (!aggregateFunctionType) {
+        throw new Error("addressSpace do not expose AggregateFunctionType");
+    }
+    const serverObject = addressSpace.rootFolder.objects.getFolderElementByName("Server");
+    /* istanbul ignore next */
+    if (!serverObject) {
+        throw new Error("addressSpace do not expose a ServerObject");
+    }
+    // xx serverObject.
+    const serverCapabilities = serverObject.getChildByName("ServerCapabilities");
+    // Let see if HistoryServer Capabilities object exists
+    let historyServerCapabilities = serverCapabilities.getChildByName("HistoryServerCapabilities");
+    /* istanbul ignore next */
+    if (!historyServerCapabilities) {
+        historyServerCapabilities = createHistoryServerCapabilities(addressSpace, serverCapabilities);
+    }
+    setHistoricalServerCapabilities(historyServerCapabilities, historicalCapabilitiesDefaultProperties);
+    addAggregateFunctionSupport(addressSpace, node_opcua_constants_1.AggregateFunction.Interpolative);
+    addAggregateFunctionSupport(addressSpace, node_opcua_constants_1.AggregateFunction.Minimum);
+    addAggregateFunctionSupport(addressSpace, node_opcua_constants_1.AggregateFunction.Maximum);
+    addAggregateFunctionSupport(addressSpace, node_opcua_constants_1.AggregateFunction.Average);
+    const addressSpaceInternal = addressSpace;
+    addressSpaceInternal._readProcessedDetails = read_processed_details_1.readProcessedDetails;
+}
+exports.addAggregateSupport = addAggregateSupport;
+function installAggregateConfigurationOptions(node, options) {
+    const nodePriv = node;
+    const aggregateConfiguration = nodePriv.$historicalDataConfiguration.aggregateConfiguration;
+    aggregateConfiguration.percentDataBad.setValueFromSource({ dataType: "Byte", value: options.percentDataBad });
+    aggregateConfiguration.percentDataGood.setValueFromSource({ dataType: "Byte", value: options.percentDataGood });
+    aggregateConfiguration.treatUncertainAsBad.setValueFromSource({
+        dataType: "Boolean",
+        value: options.treatUncertainAsBad
+    });
+    aggregateConfiguration.useSlopedExtrapolation.setValueFromSource({
+        dataType: "Boolean",
+        value: options.useSlopedExtrapolation
+    });
+    nodePriv.$historicalDataConfiguration.stepped.setValueFromSource({
+        dataType: "Boolean",
+        value: options.stepped
+    });
+}
+exports.installAggregateConfigurationOptions = installAggregateConfigurationOptions;
+function getAggregateConfiguration(node) {
+    const nodePriv = node;
+    /* istanbul ignore next */
+    if (!nodePriv.$historicalDataConfiguration) {
+        throw new Error("internal error");
+    }
+    const aggregateConfiguration = nodePriv.$historicalDataConfiguration.aggregateConfiguration;
+    // Beware ! Stepped value comes from Historical Configuration !
+    const stepped = nodePriv.$historicalDataConfiguration.stepped.readValue().value.value;
+    return {
+        percentDataBad: aggregateConfiguration.percentDataBad.readValue().value.value,
+        percentDataGood: aggregateConfiguration.percentDataGood.readValue().value.value,
+        stepped,
+        treatUncertainAsBad: aggregateConfiguration.treatUncertainAsBad.readValue().value.value,
+        // xx stepped:                aggregateConfiguration.stepped.readValue().value,
+        useSlopedExtrapolation: aggregateConfiguration.useSlopedExtrapolation.readValue().value.value
+    };
+}
+exports.getAggregateConfiguration = getAggregateConfiguration;
+//# sourceMappingURL=aggregates.js.map

package/dist/aggregates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregates.js","sourceRoot":"","sources":["../source/aggregates.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,+DAAyD;AACzD,yDAA+C;AAC/C,0CAA0C;AAC1C,2DAA8C;AAK9C,qEAAgE;AAEhE,iEAAiE;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,uCAAuC,CAAC,gCAAgC,GAAG;IAC7E,2BAA2B,EAAE,IAAI;IACjC,6BAA6B,EAAE,IAAI;IACnC,sBAAsB,EAAE,KAAK;IAC7B,qBAAqB,EAAE,KAAK;IAC5B,mBAAmB,EAAE,KAAK;IAC1B,0BAA0B,EAAE,KAAK;IACjC,oBAAoB,EAAE,KAAK;IAC3B,qBAAqB,EAAE,KAAK;IAC5B,mBAAmB,EAAE,CAAC;IACtB,oBAAoB,EAAE,CAAC;IACvB,qBAAqB,EAAE,KAAK;IAC5B,sBAAsB,EAAE,KAAK;IAC7B,oBAAoB,EAAE,KAAK;IAC3B,qBAAqB,EAAE,KAAK,CAAC,iCAAiC;CACjE,CAAC;AAEF,SAAgB,+BAA+B,CAAC,YAA0B,EAAE,kBAAwC;IAChH,0BAA0B;IAC1B,IAAI,kBAAkB,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,oBAAoB,EAAE;QACnE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;KACpD;IAED,MAAM,6BAA6B,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,+BAA+B,CAAE,CAAC;IAEpH,0BAA0B;IAC1B,IAAI,CAAC,6BAA6B,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAChE;IACD,OAAO,6BAA6B,CAAC,WAAW,CAAC;QAC7C,UAAU,EAAE,2BAA2B;QACvC,WAAW,EAAE,kBAAkB;KAClC,CAAC,CAAC;AACP,CAAC;AAhBD,0EAgBC;AAED,SAAS,+BAA+B,CAAC,yBAA8B,EAAE,iBAAsB;IAC3F,SAAS,UAAU,CAAC,QAAgB;QAChC,MAAM,SAAS,GAAG,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEnD,0BAA0B;QAC1B,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;YAC9C,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;SAC/C;QACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,yBAAyB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEhE,0BAA0B;QAC1B,IAAI,CAAC,IAAI,EAAE;YACP,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,QAAQ,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,SAAS,SAAS,CAAC,QAAgB;QAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnD,0BAA0B;QAC1B,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;YACtD,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;SAC/C;QACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,yBAAyB,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,UAAU,CAAC,6BAA6B,CAAC,CAAC;IAC1C,UAAU,CAAC,+BAA+B,CAAC,CAAC;IAE5C,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACjC,SAAS,CAAC,sBAAsB,CAAC,CAAC;IAElC,UAAU,CAAC,sBAAsB,CAAC,CAAC;IACnC,UAAU,CAAC,uBAAuB,CAAC,CAAC;IACpC,UAAU,CAAC,sBAAsB,CAAC,CAAC;IACnC,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAClC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACrC,UAAU,CAAC,uBAAuB,CAAC,CAAC;IACpC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IACrC,UAAU,CAAC,uBAAuB,CAAC,CAAC;IACpC,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAEpC,0DAA0D;IAC1D,mEAAmE;IACnE,gDAAgD;AACpD,CAAC;AA2CD,SAAS,2BAA2B,CAAC,YAA0B,EAAE,YAAoB;IACjF,0BAA0B;IAC1B,IAAI,CAAC,YAAY,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC5C;IAED,MAAM,kBAAkB,GAAG,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAsD,CAAC;IAEzH,0BAA0B;IAC1B,IAAI,CAAC,kBAAkB,CAAC,yBAAyB,EAAE;QAC/C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KAC3E;IAED,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,kBAAkB,CAAC;IAEjE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,yBAAyB,CAAC,kBAAkB,CAAC;IAEjG,MAAM,cAAc,GAAG,IAAA,8BAAU,EAAC,YAAY,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAE3E,0BAA0B;IAC1B,IAAI,CAAC,YAAY,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,YAAY,GAAG,kBAAkB,CAAC,CAAC;KAC5E;IAED,kBAAkB,CAAC,YAAY,CAAC;QAC5B,MAAM,EAAE,YAAY,CAAC,MAAM;QAC3B,aAAa,EAAE,WAAW;KAC7B,CAAC,CAAC;IACH,wBAAwB,CAAC,YAAY,CAAC;QAClC,MAAM,EAAE,YAAY,CAAC,MAAM;QAC3B,aAAa,EAAE,WAAW;KAC7B,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,mBAAmB,CAAC,YAA0B;IAC1D,MAAM,0BAA0B,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC;IAE7G,0BAA0B;IAC1B,IAAI,CAAC,0BAA0B,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;KAC5E;IAED,MAAM,qBAAqB,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAEnG,0BAA0B;IAC1B,IAAI,CAAC,qBAAqB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACvE;IAED,MAAM,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAEtF,0BAA0B;IAC1B,IAAI,CAAC,YAAY,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAChE;IACD,mBAAmB;IAEnB,MAAM,kBAAkB,GAAG,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAA0B,CAAC;IAEtG,sDAAsD;IACtD,IAAI,yBAAyB,GAAG,kBAAkB,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;IAE/F,0BAA0B;IAC1B,IAAI,CAAC,yBAAyB,EAAE;QAC5B,yBAAyB,GAAG,+BAA+B,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;KACjG;IAED,+BAA+B,CAAC,yBAAyB,EAAE,uCAAuC,CAAC,CAAC;IAEpG,2BAA2B,CAAC,YAAY,EAAE,wCAAiB,CAAC,aAAa,CAAC,CAAC;IAC3E,2BAA2B,CAAC,YAAY,EAAE,wCAAiB,CAAC,OAAO,CAAC,CAAC;IACrE,2BAA2B,CAAC,YAAY,EAAE,wCAAiB,CAAC,OAAO,CAAC,CAAC;IACrE,2BAA2B,CAAC,YAAY,EAAE,wCAAiB,CAAC,OAAO,CAAC,CAAC;IAErE,MAAM,oBAAoB,GAAI,YAA+C,CAAC;IAC9E,oBAAoB,CAAC,qBAAqB,GAAG,6CAAoB,CAAC;AACtE,CAAC;AA1CD,kDA0CC;AAED,SAAgB,oCAAoC,CAAC,IAAgB,EAAE,OAAwC;IAC3G,MAAM,QAAQ,GAAG,IAAW,CAAC;IAC7B,MAAM,sBAAsB,GAAG,QAAQ,CAAC,4BAA4B,CAAC,sBAAsB,CAAC;IAC5F,sBAAsB,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC9G,sBAAsB,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChH,sBAAsB,CAAC,mBAAmB,CAAC,kBAAkB,CAAC;QAC1D,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,OAAO,CAAC,mBAAmB;KACrC,CAAC,CAAC;IACH,sBAAsB,CAAC,sBAAsB,CAAC,kBAAkB,CAAC;QAC7D,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,OAAO,CAAC,sBAAsB;KACxC,CAAC,CAAC;IAEH,QAAQ,CAAC,4BAA4B,CAAC,OAAO,CAAC,kBAAkB,CAAC;QAC7D,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CAAC;AACP,CAAC;AAlBD,oFAkBC;AAED,SAAgB,yBAAyB,CAAC,IAAc;IACpD,MAAM,QAAQ,GAAG,IAAW,CAAC;IAE7B,0BAA0B;IAC1B,IAAI,CAAC,QAAQ,CAAC,4BAA4B,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IACD,MAAM,sBAAsB,GAAG,QAAQ,CAAC,4BAA4B,CAAC,sBAAsB,CAAC;IAE5F,+DAA+D;IAC/D,MAAM,OAAO,GAAG,QAAQ,CAAC,4BAA4B,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;IAEtF,OAAO;QACH,cAAc,EAAE,sBAAsB,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK;QAC7E,eAAe,EAAE,sBAAsB,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK;QAC/E,OAAO;QACP,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK;QACvF,+EAA+E;QAC/E,sBAAsB,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK;KAChG,CAAC;AACN,CAAC;AApBD,8DAoBC"}

package/dist/average.d.ts

@@ -0,0 +1,3 @@
+import { UAVariable } from "node-opcua-address-space";
+import { DataValue } from "node-opcua-data-value";
+export declare function getAverageData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void;

package/dist/average.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAverageData = void 0;
+const node_opcua_data_value_1 = require("node-opcua-data-value");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const common_1 = require("./common");
+const interval_1 = require("./interval");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+function calculateIntervalAverageValue(interval, options) {
+    const indexStart = interval.index;
+    let statusCode;
+    let isPartial = interval.isPartial;
+    let isRaw = false;
+    let hasBad = false;
+    const values = [];
+    for (let i = indexStart; i < indexStart + interval.count; i++) {
+        const dataValue = interval.dataValues[i];
+        if (dataValue.statusCode === node_opcua_status_code_1.StatusCodes.BadNoData) {
+            isPartial = true;
+            continue;
+        }
+        if (!(0, interval_1.isGood)(dataValue.statusCode)) {
+            hasBad = true;
+            continue;
+        }
+        values.push(dataValue.value.value);
+    }
+    if (isRaw) {
+        if (hasBad) {
+            statusCode = node_opcua_status_code_1.StatusCodes.UncertainDataSubNormal;
+        }
+        else {
+            statusCode = node_opcua_status_code_1.StatusCodes.Good;
+        }
+    }
+    else if (hasBad) {
+        statusCode = node_opcua_status_code_1.StatusCode.makeStatusCode(node_opcua_status_code_1.StatusCodes.UncertainDataSubNormal, "HistorianCalculated");
+    }
+    else {
+        statusCode = node_opcua_status_code_1.StatusCode.makeStatusCode(node_opcua_status_code_1.StatusCodes.Good, "HistorianCalculated");
+    }
+    if (values.length === 0) {
+        return new node_opcua_data_value_1.DataValue({
+            sourceTimestamp: interval.startTime,
+            statusCode: node_opcua_status_code_1.StatusCodes.BadNoData,
+        });
+    }
+    const mean = values.reduce((p, c) => p + c, 0) / values.length;
+    return new node_opcua_data_value_1.DataValue({
+        sourceTimestamp: interval.startTime,
+        statusCode: statusCode,
+        value: {
+            dataType: node_opcua_variant_1.DataType.Double, value: mean
+        }
+    });
+}
+function getAverageData(node, processingInterval, startDate, endDate, callback) {
+    return (0, common_1.getAggregateData)(node, processingInterval, startDate, endDate, calculateIntervalAverageValue, callback);
+}
+exports.getAverageData = getAverageData;
+//# sourceMappingURL=average.js.map

package/dist/average.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"average.js","sourceRoot":"","sources":["../source/average.ts"],"names":[],"mappings":";;;AACA,iEAAkD;AAClD,2DAAuD;AACvD,qCAA4C;AAC5C,yCAA6E;AAC7E,mEAAiE;AAEjE,SAAS,6BAA6B,CAClC,QAAkB,EAClB,OAAsC;IAGtC,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC;IAClC,IAAI,UAAsB,CAAC;IAC3B,IAAI,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;IAEnC,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,UAAU,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAE3D,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAEzC,IAAI,SAAS,CAAC,UAAU,KAAK,oCAAW,CAAC,SAAS,EAAE;YAChD,SAAS,GAAG,IAAI,CAAC;YACjB,SAAS;SACZ;QAED,IAAI,CAAC,IAAA,iBAAM,EAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YAC/B,MAAM,GAAG,IAAI,CAAC;YACd,SAAS;SACZ;QACD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtC;IAED,IAAI,KAAK,EAAE;QACP,IAAI,MAAM,EAAE;YACR,UAAU,GAAG,oCAAW,CAAC,sBAAsB,CAAC;SACnD;aAAM;YACH,UAAU,GAAG,oCAAW,CAAC,IAAI,CAAC;SACjC;KACJ;SAAM,IAAI,MAAM,EAAE;QACf,UAAU,GAAG,mCAAU,CAAC,cAAc,CAAC,oCAAW,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAAC;KACrG;SAAM;QACH,UAAU,GAAG,mCAAU,CAAC,cAAc,CAAC,oCAAW,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;KACnF;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,iCAAS,CAAC;YACjB,eAAe,EAAE,QAAQ,CAAC,SAAS;YACnC,UAAU,EAAE,oCAAW,CAAC,SAAS;SACpC,CAAC,CAAC;KACN;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;IAE/D,OAAO,IAAI,iCAAS,CAAC;QACjB,eAAe,EAAE,QAAQ,CAAC,SAAS;QACnC,UAAU,EAAE,UAAwB;QACpC,KAAK,EAAE;YACH,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI;SACzC;KACJ,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,cAAc,CAC1B,IAAgB,EAChB,kBAA0B,EAC1B,SAAe,EACf,OAAa,EACb,QAA+D;IAE/D,OAAO,IAAA,yBAAgB,EAAC,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,OAAO,EAAE,6BAA6B,EAAE,QAAQ,CAAC,CAAC;AACnH,CAAC;AARD,wCAQC"}

package/dist/common.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @module node-opca-aggregates
+ */
+import { UAVariable } from "node-opcua-address-space";
+import { DataValue } from "node-opcua-data-value";
+import { Interval, AggregateConfigurationOptionsEx } from "./interval";
+export declare function getAggregateData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, lambda: (interval: Interval, aggregateConfiguration: AggregateConfigurationOptionsEx) => DataValue, callback: (err: Error | null, dataValues?: DataValue[]) => void): void;
+export declare function interpolateValue(dataValue1: DataValue, dataValue2: DataValue, date: Date): DataValue;

package/dist/common.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interpolateValue = exports.getAggregateData = void 0;
+/**
+ * @module node-opca-aggregates
+ */
+const node_opcua_address_space_1 = require("node-opcua-address-space");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_data_value_1 = require("node-opcua-data-value");
+const node_opcua_service_history_1 = require("node-opcua-service-history");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const aggregates_1 = require("./aggregates");
+const interval_1 = require("./interval");
+/**
+ * @internal
+ * @param node
+ * @param processingInterval
+ * @param startDate
+ * @param endDate
+ * @param dataValues
+ * @param lambda
+ * @param callback
+ */
+function processAggregateData(node, processingInterval, startDate, endDate, dataValues, lambda, callback) {
+    const aggregateConfiguration = (0, aggregates_1.getAggregateConfiguration)(node);
+    const results = [];
+    const tstart = startDate.getTime();
+    const tend = endDate.getTime();
+    const indexHint = 0;
+    for (let t = tstart; t < tend; t += processingInterval) {
+        const sourceTimestamp = new Date();
+        sourceTimestamp.setTime(t);
+        const interval = (0, interval_1.getInterval)(sourceTimestamp, processingInterval, indexHint, dataValues);
+        const dataValue = lambda(interval, aggregateConfiguration);
+        /* istanbul ignore next */
+        if (!dataValue || !dataValue.sourceTimestamp) {
+            // const dataValue = interval.interpolatedValue(aggregateConfiguration);
+            throw Error("invalid DataValue");
+        }
+        results.push(dataValue);
+    }
+    setImmediate(() => {
+        callback(null, results);
+    });
+}
+function getAggregateData(node, processingInterval, startDate, endDate, lambda, callback) {
+    /* istanbul ignore next */
+    if (node.nodeClass !== node_opcua_data_model_1.NodeClass.Variable) {
+        throw new Error("node must be UAVariable");
+    }
+    /* istanbul ignore next */
+    if (processingInterval <= 0) {
+        throw new Error("Invalid processing interval, shall be greater than 0");
+    }
+    const context = new node_opcua_address_space_1.SessionContext();
+    const historyReadDetails = new node_opcua_service_history_1.ReadRawModifiedDetails({
+        endTime: endDate,
+        startTime: startDate,
+    });
+    const indexRange = null;
+    const dataEncoding = null;
+    const continuationPoint = null;
+    node.historyRead(context, historyReadDetails, indexRange, dataEncoding, continuationPoint, (err, result) => {
+        /* istanbul ignore next */
+        if (err) {
+            return callback(err);
+        }
+        const historyData = result.historyData;
+        const dataValues = historyData.dataValues || [];
+        processAggregateData(node, processingInterval, startDate, endDate, dataValues, lambda, callback);
+    });
+}
+exports.getAggregateData = getAggregateData;
+function interpolateValue(dataValue1, dataValue2, date) {
+    const t0 = dataValue1.sourceTimestamp.getTime();
+    const t = date.getTime();
+    const t1 = dataValue2.sourceTimestamp.getTime();
+    const coef1 = (t - t0) / (t1 - t0);
+    const coef2 = (t1 - t) / (t1 - t0);
+    const value = dataValue1.value.clone();
+    value.value = coef2 * dataValue1.value.value + coef1 * dataValue2.value.value;
+    const statusCode = node_opcua_status_code_1.StatusCode.makeStatusCode(dataValue1.statusCode, "HistorianInterpolated");
+    return new node_opcua_data_value_1.DataValue({
+        sourceTimestamp: date,
+        statusCode,
+        value
+    });
+}
+exports.interpolateValue = interpolateValue;
+//# sourceMappingURL=common.js.map

package/dist/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../source/common.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,uEAAsE;AACtE,iEAAkD;AAClD,iEAAkD;AAClD,2EAAoG;AACpG,mEAAoD;AAEpD,6CAAyD;AACzD,yCAAoF;AAEpF;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CACzB,IAAgB,EAChB,kBAA0B,EAC1B,SAAe,EACf,OAAa,EACb,UAAuB,EACvB,MAAkG,EAClG,QAA+D;IAE/D,MAAM,sBAAsB,GAAG,IAAA,sCAAyB,EAAC,IAAI,CAAC,CAAC;IAE/D,MAAM,OAAO,GAAgB,EAAE,CAAC;IAEhC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAE/B,MAAM,SAAS,GAAG,CAAC,CAAC;IACpB,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,kBAAkB,EAAE;QACpD,MAAM,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC;QACnC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE3B,MAAM,QAAQ,GAAG,IAAA,sBAAW,EAAC,eAAe,EAAE,kBAAkB,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAEzF,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;QAE3D,0BAA0B;QAC1B,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;YAC1C,wEAAwE;YACxE,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACpC;QACD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC3B;IAED,YAAY,CAAC,GAAG,EAAE;QACd,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AAEP,CAAC;AAED,SAAgB,gBAAgB,CAC5B,IAAgB,EAChB,kBAA0B,EAC1B,SAAe,EACf,OAAa,EACb,MAAkG,EAClG,QAA+D;IAG/D,0BAA0B;IAC1B,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,QAAQ,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC9C;IAED,0BAA0B;IAC1B,IAAI,kBAAkB,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;KAC3E;IAED,MAAM,OAAO,GAAG,IAAI,yCAAc,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAG,IAAI,mDAAsB,CAAC;QAClD,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,SAAS;KACvB,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,IAAI,CAAC;IACxB,MAAM,YAAY,GAAG,IAAI,CAAC;IAC1B,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,YAAY,EAAE,iBAAiB,EACrF,CAAC,GAAiB,EAAE,MAA0B,EAAE,EAAE;QAE9C,0BAA0B;QAC1B,IAAI,GAAG,EAAE;YACL,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;SACxB;QACD,MAAM,WAAW,GAAG,MAAO,CAAC,WAA0B,CAAC;QAEvD,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,IAAI,EAAE,CAAC;QAEhD,oBAAoB,CAAC,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrG,CAAC,CAAC,CAAC;AACX,CAAC;AAxCD,4CAwCC;AAED,SAAgB,gBAAgB,CAAC,UAAqB,EAAE,UAAqB,EAAE,IAAU;IACrF,MAAM,EAAE,GAAG,UAAU,CAAC,eAAgB,CAAC,OAAO,EAAE,CAAC;IACjD,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IACzB,MAAM,EAAE,GAAG,UAAU,CAAC,eAAgB,CAAC,OAAO,EAAE,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACvC,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;IAC9E,MAAM,UAAU,GAAG,mCAAU,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,EAAE,uBAAuB,CAAC,CAAC;IAC7F,OAAO,IAAI,iCAAS,CAAC;QACjB,eAAe,EAAE,IAAI;QACrB,UAAU;QACV,KAAK;KACR,CAAC,CAAC;AACP,CAAC;AAdD,4CAcC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module node-opca-aggregates
+ */
+export { addAggregateSupport, installAggregateConfigurationOptions, getAggregateConfiguration, } from "./aggregates";
+export * from "./interpolate";
+export * from "./minmax";
+export * from "./interval";
+export * from "./common";
+export * from "./average";
+export * from "./read_processed_details";
+export { AggregateFunction } from "node-opcua-constants";

package/dist/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+exports.AggregateFunction = exports.getAggregateConfiguration = exports.installAggregateConfigurationOptions = exports.addAggregateSupport = void 0;
+/**
+ * @module node-opca-aggregates
+ */
+var aggregates_1 = require("./aggregates");
+Object.defineProperty(exports, "addAggregateSupport", { enumerable: true, get: function () { return aggregates_1.addAggregateSupport; } });
+Object.defineProperty(exports, "installAggregateConfigurationOptions", { enumerable: true, get: function () { return aggregates_1.installAggregateConfigurationOptions; } });
+Object.defineProperty(exports, "getAggregateConfiguration", { enumerable: true, get: function () { return aggregates_1.getAggregateConfiguration; } });
+__exportStar(require("./interpolate"), exports);
+__exportStar(require("./minmax"), exports);
+__exportStar(require("./interval"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./average"), exports);
+__exportStar(require("./read_processed_details"), exports);
+var node_opcua_constants_1 = require("node-opcua-constants");
+Object.defineProperty(exports, "AggregateFunction", { enumerable: true, get: function () { return node_opcua_constants_1.AggregateFunction; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA;;GAEG;AACH,2CAIsB;AAHlB,iHAAA,mBAAmB,OAAA;AACnB,kIAAA,oCAAoC,OAAA;AACpC,uHAAA,yBAAyB,OAAA;AAE7B,gDAA8B;AAC9B,2CAAyB;AACzB,6CAA2B;AAC3B,2CAAyB;AACzB,4CAA0B;AAC1B,2DAAyC;AACzC,6DAE8B;AAD1B,yHAAA,iBAAiB,OAAA"}

package/dist/interpolate.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @module node-opca-aggregates
+ */
+import { UAVariable } from "node-opcua-address-space";
+import { DataValue } from "node-opcua-data-value";
+import { AggregateConfigurationOptionsEx, Interval } from "./interval";
+export declare function interpolatedValue(interval: Interval, options: AggregateConfigurationOptionsEx): DataValue;
+/**
+ *
+ * @param node
+ * @param processingInterval
+ * @param startDate
+ * @param endDate
+ * @param callback
+ */
+export declare function getInterpolatedData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void;

package/dist/interpolate.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInterpolatedData = exports.interpolatedValue = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_value_1 = require("node-opcua-data-value");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const common_1 = require("./common");
+const interval_1 = require("./interval");
+/*
+ For any intervals containing regions where the StatusCodes are Bad,
+ the total duration of all Bad regions is calculated and divided by the width of the interval.
+ The resulting ratio is multiplied by 100 and compared to the PercentDataBad parameter.
+ The StatusCode for the interval is Bad if the ratio is greater than or equal to the PercentDataBad parameter.
+ For any interval which is not Bad, the total duration of all Good regions is then calculated and divided by
+ the width of the interval. The resulting ratio is multiplied by 100 and compared to the PercentDataGood parameter.
+ The StatusCode for the interval is Good if the ratio is greater than or equal to the PercentDataGood parameter.
+ If for an interval neither ratio applies then that interval is Uncertain_DataSubNormal.
+  */
+function interpolatedValue(interval, options) {
+    options = (0, interval_1.adjustProcessingOptions)(options);
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "useSlopedExtrapolation"));
+    (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(options, "treatUncertainAsBad"));
+    const bTreatUncertainAsBad = options.treatUncertainAsBad;
+    const steppedValue = (previousDataValue) => {
+        if (!previousDataValue.statusCode) {
+            throw new Error("Expecting statusCode");
+        }
+        const interpValue = new node_opcua_data_value_1.DataValue({
+            sourceTimestamp: interval.startTime,
+            statusCode: node_opcua_status_code_1.StatusCodes.Bad,
+            value: previousDataValue.value,
+        });
+        interpValue.statusCode =
+            node_opcua_status_code_1.StatusCode.makeStatusCode(node_opcua_status_code_1.StatusCodes.UncertainDataSubNormal, "HistorianInterpolated");
+        return interpValue;
+    };
+    if (interval.index === -1) {
+        // the interval is beyond end Data
+        // we need to find previous good value
+        // and second previous  good value to extrapolate
+        const prev1 = (0, interval_1._findGoodDataValueBefore)(interval.dataValues, interval.dataValues.length, bTreatUncertainAsBad);
+        if (prev1.index <= 0) {
+            return new node_opcua_data_value_1.DataValue({
+                sourceTimestamp: interval.startTime,
+                statusCode: node_opcua_status_code_1.StatusCodes.BadNoData,
+                value: undefined,
+            });
+        }
+        if (!options.useSlopedExtrapolation) {
+            return steppedValue(prev1.dataValue);
+        }
+        const prev2 = (0, interval_1._findGoodDataValueBefore)(interval.dataValues, prev1.index, bTreatUncertainAsBad);
+        if (prev2.index <= 0) {
+            // use step value
+            return steppedValue(prev1.dataValue);
+        }
+        // else interpolate
+        const interpVal = (0, common_1.interpolateValue)(prev2.dataValue, prev1.dataValue, interval.startTime);
+        // tslint:disable:no-bitwise
+        if (prev2.index + 1 < prev1.index || prev1.index < interval.dataValues.length - 1) {
+            // some bad data exist in between = change status code
+            const mask = 0x0000FFFFFF;
+            const extraBits = interpVal.statusCode.value & mask;
+            interpVal.statusCode = node_opcua_status_code_1.StatusCode.makeStatusCode(node_opcua_status_code_1.StatusCodes.UncertainDataSubNormal, extraBits);
+        }
+        return interpVal;
+    }
+    /* istanbul ignore next */
+    if (interval.index < 0 && interval.count === 0) {
+        return new node_opcua_data_value_1.DataValue({
+            sourceTimestamp: interval.startTime,
+            statusCode: node_opcua_status_code_1.StatusCodes.BadNoData
+        });
+    }
+    const dataValue1 = interval.dataValues[interval.index];
+    // if a non-Bad Raw value exists at the timestamp then it is the bounding value;
+    if (!(0, interval_1.isBad)(dataValue1.statusCode) && interval.hasRawDataAsStart()) {
+        return dataValue1;
+    }
+    // find the first non-Bad Raw value before the timestamp;
+    // find previous good value
+    const before = interval.beforeStartDataValue(bTreatUncertainAsBad);
+    if ((0, interval_1.isBad)(before.dataValue.statusCode)) {
+        return new node_opcua_data_value_1.DataValue({
+            sourceTimestamp: interval.startTime,
+            statusCode: node_opcua_status_code_1.StatusCodes.BadNoData
+        });
+    }
+    if (options.stepped) {
+        if (before.index + 1 === interval.index) {
+            return new node_opcua_data_value_1.DataValue({
+                sourceTimestamp: interval.startTime,
+                statusCode: node_opcua_status_code_1.StatusCode.makeStatusCode(before.dataValue.statusCode, "HistorianInterpolated"),
+                value: before.dataValue.value
+            });
+        }
+        return steppedValue(before.dataValue);
+    }
+    // find the first non-Bad Raw value after the timestamp;
+    const next = interval.nextStartDataValue(bTreatUncertainAsBad);
+    //  draw a line between before value and after value;
+    // use point where the line crosses the timestamp as an estimate of the bounding value.
+    //   The calculation can be expressed with the following formula:
+    //    V bound = (T bound – T before)x( V after – V before)/( T after – T before) + V before
+    //    where V
+    //   x is a value at ‘x’ and Tx is the timestamp associated with Vx.
+    const interpolatedDataValue = (0, common_1.interpolateValue)(before.dataValue, next.dataValue, interval.startTime);
+    if (before.index + 1 < next.index
+        || !(0, interval_1.isGood)(next.dataValue.statusCode)
+        || !(0, interval_1.isGood)(before.dataValue.statusCode)) {
+        // tslint:disable:no-bitwise
+        // some bad data exist in between = change status code
+        const mask = 0x0000FFFFFF;
+        const extraBits = interpolatedDataValue.statusCode.value & mask;
+        interpolatedDataValue.statusCode =
+            node_opcua_status_code_1.StatusCode.makeStatusCode(node_opcua_status_code_1.StatusCodes.UncertainDataSubNormal, extraBits);
+    }
+    // check if uncertain or bad value exist between before/next
+    // todo
+    return interpolatedDataValue;
+}
+exports.interpolatedValue = interpolatedValue;
+/**
+ *
+ * @param node
+ * @param processingInterval
+ * @param startDate
+ * @param endDate
+ * @param callback
+ */
+function getInterpolatedData(node, processingInterval, startDate, endDate, callback) {
+    return (0, common_1.getAggregateData)(node, processingInterval, startDate, endDate, interpolatedValue, callback);
+}
+exports.getInterpolatedData = getInterpolatedData;
+//# sourceMappingURL=interpolate.js.map