-
-
Notifications
You must be signed in to change notification settings - Fork 479
/
aggregates.ts
324 lines (278 loc) · 12.9 KB
/
aggregates.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/**
* @module node-opca-aggregates
*/
import { ObjectIds } from "node-opcua-constants";
import { makeNodeId } from "node-opcua-nodeid";
import * as utils from "node-opcua-utils";
import { DataType } from "node-opcua-variant";
import { AddressSpace, BaseNode, UAObject, UAServerCapabilities, UAVariable } from "node-opcua-address-space";
import { AggregateConfigurationOptionsEx } from "./interval";
import { AddressSpacePrivate } from "node-opcua-address-space/src/address_space_private";
import { readProcessedDetails } from "./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, // Boolean PropertyType Mandatory
accessHistoryEventsCapability: true, // Boolean PropertyType Mandatory
deleteAtTimeCapability: false, // Boolean PropertyType Mandatory
deleteEventCapability: false, // Boolean PropertyType Mandatory
deleteRawCapability: false, // Boolean PropertyType Mandatory
insertAnnotationCapability: false, // Boolean PropertyType Mandatory
insertDataCapability: false, // Boolean PropertyType Mandatory
insertEventCapability: false, // Boolean PropertyType Mandatory
maxReturnDataValues: 0,
maxReturnEventValues: 0, // UInt32 PropertyType Mandatory
replaceDataCapability: false, // Boolean PropertyType Mandatory
replaceEventCapability: false, // Boolean PropertyType Mandatory
updateDataCapability: false, // Boolean PropertyType Mandatory
updateEventCapability: false // Boolean PropertyType Mandatory
};
export function createHistoryServerCapabilities(
addressSpace: AddressSpace,
serverCapabilities: UAServerCapabilities
): UAObject {
/* 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
});
}
function setHistoricalServerCapabilities(
historyServerCapabilities: any,
defaultProperties: any
) {
function setBoolean(propName: string) {
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: DataType.Boolean, value });
}
function setUInt32(propName: string) {
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: 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 dnodeset2 says InsertAnnotationCapability ( without s )
// xx setBoolean("InsertAnnotationsCapability");
}
export 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";
function addAggregateFunctionSupport(
addressSpace: AddressSpace, functionName: number): void {
/* 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 = 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"
});
}
export enum AggregateFunction {
AnnotationCount = ObjectIds.AggregateFunction_AnnotationCount,
Average = ObjectIds.AggregateFunction_Average,
Count = ObjectIds.AggregateFunction_Count,
Delta = ObjectIds.AggregateFunction_Delta,
DeltaBounds = ObjectIds.AggregateFunction_DeltaBounds,
DurationBad = ObjectIds.AggregateFunction_DurationBad,
DurationGood = ObjectIds.AggregateFunction_DurationGood,
DurationInStateNonZero = ObjectIds.AggregateFunction_DurationInStateNonZero,
DurationInStateZero = ObjectIds.AggregateFunction_End,
EndBound = ObjectIds.AggregateFunction_EndBound,
Interpolative = ObjectIds.AggregateFunction_Interpolative,
Maximum = ObjectIds.AggregateFunction_Maximum,
Maximum2 = ObjectIds.AggregateFunction_Maximum2,
MaximumActualTime = ObjectIds.AggregateFunction_MaximumActualTime,
MaximumActualTime2 = ObjectIds.AggregateFunction_MaximumActualTime2,
Minimum = ObjectIds.AggregateFunction_Minimum,
Minimum2 = ObjectIds.AggregateFunction_Minimum2,
MinimumActualTime = ObjectIds.AggregateFunction_MinimumActualTime,
MinimumActualTime2 = ObjectIds.AggregateFunction_MinimumActualTime2,
NumberOfTransitions = ObjectIds.AggregateFunction_NumberOfTransitions,
PercentBad = ObjectIds.AggregateFunction_PercentBad,
PercentGood = ObjectIds.AggregateFunction_PercentGood,
Range = ObjectIds.AggregateFunction_Range,
Range2 = ObjectIds.AggregateFunction_Range2,
StandardDeviationPopulation = ObjectIds.AggregateFunction_StandardDeviationPopulation,
StandardDeviationSample = ObjectIds.AggregateFunction_StandardDeviationSample,
Start = ObjectIds.AggregateFunction_Start,
StartBound = ObjectIds.AggregateFunction_StartBound,
TimeAverage = ObjectIds.AggregateFunction_TimeAverage,
TimeAverage2 = ObjectIds.AggregateFunction_TimeAverage2,
Total = ObjectIds.AggregateFunction_Total,
Total2 = ObjectIds.AggregateFunction_Total2,
VariancePopulation = ObjectIds.AggregateFunction_VariancePopulation,
VarianceSample = ObjectIds.AggregateFunction_VarianceSample,
WorstQuality = ObjectIds.AggregateFunction_WorstQuality,
WorstQuality2 = ObjectIds.AggregateFunction_WorstQuality2
}
export function addAggregateSupport(addressSpace: 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")! as UAServerCapabilities;
// 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, AggregateFunction.Interpolative);
addAggregateFunctionSupport(addressSpace, AggregateFunction.Minimum);
addAggregateFunctionSupport(addressSpace, AggregateFunction.Maximum);
const addressSpaceInternal = addressSpace as AddressSpacePrivate;
addressSpaceInternal._readProcessedDetails = readProcessedDetails;
}
export function installAggregateConfigurationOptions(
node: UAVariable,
options: AggregateConfigurationOptionsEx
) {
const nodePriv = node as any;
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
});
}
export function getAggregateConfiguration(node: BaseNode): AggregateConfigurationOptionsEx {
const nodePriv = node as any;
/* 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
};
}