forked from fh1ch/node-bacstack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbacnet-client.js
More file actions
291 lines (268 loc) · 15.1 KB
/
Copy pathbacnet-client.js
File metadata and controls
291 lines (268 loc) · 15.1 KB
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
// Util Modules
var debug = require('debug')('bacstack');
// Local Modules
var baTransport = require('./bacnet-transport');
var baServices = require('./bacnet-services');
var baAsn1 = require('./bacnet-asn1');
var baAdpu = require('./bacnet-adpu');
var baNpdu = require('./bacnet-npdu');
var baBvlc = require('./bacnet-bvlc');
var baEnum = require('./bacnet-enum');
module.exports = function(settings) {
var self = this;
var DEFAULT_HOP_COUNT = 0xFF;
var BVLC_HEADER_LENGTH = 4;
var invokeCounter = 0;
var lastSequenceNumber = 0;
var invokeStore = {};
var segmentStore = [];
var transport = settings.transport || baTransport({
port: settings.port,
interface: settings.interface,
broadcastAddress: settings.broadcastAddress
});
// Local Handlers
var whoIsHandler;
// Helper utils
var invokeCallback = function(result) {
var callback = invokeStore[result.result.invokeId];
if (callback) return callback(null, result);
debug('InvokeId ', result.result.invokeId, ' not found -> drop package');
};
var addCallback = function(id, callback) {
var timeout = setTimeout(function() {
delete invokeStore[id];
callback(new Error('ERR_TIMEOUT'));
}, settings.adpuTimeout);
invokeStore[id] = function(err, data) {
clearTimeout(timeout);
delete invokeStore[id];
callback(err, data);
};
};
var getBuffer = function() {
return {
buffer: Buffer.alloc(transport.getMaxPayload()),
offset: BVLC_HEADER_LENGTH,
max_offset: 0,
serialize_counter: 0,
min_limit: 0,
result: false
};
};
// Service Handlers
var ProcessError = function(adr, type, service, invokeId, buffer, offset, length) {
debug('Handle Error');
var result = baServices.DecodeError(buffer, offset, length);
if (!result) return debug('Couldn`t decode Error');
};
var segmentAckResponse = function(receiver, negative, server, originalInvokeId, sequencenumber, actualWindowSize) {
var buffer = getBuffer();
baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE, receiver, null, DEFAULT_HOP_COUNT, baEnum.BacnetNetworkMessageTypes.NETWORK_MESSAGE_WHO_IS_ROUTER_TO_NETWORK, 0);
baAdpu.encodeSegmentAck(buffer, baEnum.BacnetPduTypes.PDU_TYPE_SEGMENT_ACK | (negative ? baEnum.BacnetPduTypes.NEGATIVE_ACK : 0) | (server ? baEnum.BacnetPduTypes.SERVER : 0), originalInvokeId, sequencenumber, actualWindowSize);
baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU, buffer.offset);
transport.send(buffer.buffer, buffer.offset, receiver);
};
var performDefaultSegmentHandling = function(sender, adr, type, service, invokeId, maxSegments, maxAdpu, sequencenumber, first, moreFollows, buffer, offset, length) {
if (first) {
segmentStore = [];
type &= ~baEnum.BacnetPduTypes.SEGMENTED_MESSAGE;
var adpuHeaderLen = 3;
if ((type & baEnum.BacnetPduTypes.PDU_TYPE_MASK) === baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST) {
adpuHeaderLen = 4;
}
var adpubuffer = getBuffer();
adpubuffer.offset = 0;
buffer.copy(adpubuffer.buffer, adpuHeaderLen, offset, offset + length);
if ((type & baEnum.BacnetPduTypes.PDU_TYPE_MASK) === baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST) {
baAdpu.encodeConfirmedServiceRequest(adpubuffer, type, service, maxSegments, maxAdpu, invokeId, 0, 0);
} else {
baAdpu.encodeComplexAck(adpubuffer, type, service, invokeId, 0, 0);
}
segmentStore.push(adpubuffer.buffer.slice(0, length + adpuHeaderLen));
} else {
segmentStore.push(buffer.slice(offset, offset + length));
}
if (!moreFollows) {
var apduBuffer = Buffer.concat(segmentStore);
segmentStore = [];
type &= ~baEnum.BacnetPduTypes.SEGMENTED_MESSAGE;
handlePdu(adr, type, apduBuffer, 0, apduBuffer.length);
}
};
var processSegment = function(receiver, type, service, invokeId, maxSegments, maxAdpu, server, sequencenumber, proposedWindowNumber, buffer, offset, length) {
var first = false;
if (sequencenumber === 0 && lastSequenceNumber === 0) {
first = true;
} else {
if (sequencenumber !== lastSequenceNumber + 1) {
return segmentAckResponse(receiver, true, server, invokeId, lastSequenceNumber, proposedWindowNumber);
}
}
lastSequenceNumber = sequencenumber;
var moreFollows = ((type & baEnum.BacnetPduTypes.MORE_FOLLOWS) === baEnum.BacnetPduTypes.MORE_FOLLOWS);
if (!moreFollows) {
lastSequenceNumber = 0;
}
if ((sequencenumber % proposedWindowNumber) === 0 || !moreFollows) {
segmentAckResponse(receiver, false, server, invokeId, sequencenumber, proposedWindowNumber);
}
performDefaultSegmentHandling(this, receiver, type, service, invokeId, maxSegments, maxAdpu, sequencenumber, first, moreFollows, buffer, offset, length);
};
var processUnconfirmedServiceRequest = function(address, type, service, buffer, offset, length) {
debug('Handle processUnconfirmedServiceRequest');
if (service === baEnum.BacnetUnconfirmedServices.SERVICE_UNCONFIRMED_I_AM) {
var result = baServices.decodeIamBroadcast(buffer, offset);
if (!result) return debug('Received invalid iAm message');
whoIsHandler(address, result.deviceId, result.maxApdu, result.segmentation, result.vendorId);
} else if (service === baEnum.BacnetUnconfirmedServices.SERVICE_UNCONFIRMED_WHO_IS) {
return debug('TODO: Implement');
// TODO: Implement
/*var result = baServices.decodeWhoIsBroadcast(buffer, offset, length);
if (!result) return debug('Received invalid whoIs message');
OnWhoIs(this, address, result.lowLimit, result.highLimit);
*/
} else {
debug('Received unsupported unconfirmed service request');
}
};
var handlePdu = function(address, type, buffer, offset, length) {
var result;
// Handle different PDU types
switch (type & baEnum.BacnetPduTypes.PDU_TYPE_MASK) {
case baEnum.BacnetPduTypes.PDU_TYPE_UNCONFIRMED_SERVICE_REQUEST:
result = baAdpu.decodeUnconfirmedServiceRequest(buffer, offset);
processUnconfirmedServiceRequest(address, result.type, result.service, buffer, offset + result.len, length - result.len);
break;
case baEnum.BacnetPduTypes.PDU_TYPE_SIMPLE_ACK:
result = baAdpu.decodeSimpleAck(buffer, offset);
offset += result.len;
length -= result.len;
invokeCallback({result: result, buffer: buffer, offset: offset + result.len, length: length - result.len});
break;
case baEnum.BacnetPduTypes.PDU_TYPE_COMPLEX_ACK:
result = baAdpu.decodeComplexAck(buffer, offset);
if ((type & baEnum.BacnetPduTypes.SEGMENTED_MESSAGE) === 0) {
invokeCallback({result: result, buffer: buffer, offset: offset + result.len, length: length - result.len});
} else {
processSegment(address, result.type, result.service, result.invokeId, baEnum.BacnetMaxSegments.MAX_SEG0, baEnum.BacnetMaxAdpu.MAX_baAdpu50, false, result.sequencenumber, result.proposedWindowNumber, buffer, offset + result.len, length - result.len);
}
break;
case baEnum.BacnetPduTypes.PDU_TYPE_SEGMENT_ACK:
result = baAdpu.decodeSegmentAck(buffer, offset);
//m_last_segment_ack.Set(address, result.originalInvokeId, result.sequencenumber, result.actualWindowSize);
//processSegmentAck(address, result.type, result.originalInvokeId, result.sequencenumber, result.actualWindowSize, buffer, offset + result.len, length - result.len);
break;
case baEnum.BacnetPduTypes.PDU_TYPE_ERROR:
result = baAdpu.decodeError(buffer, offset);
//processError(address, result.type, result.service, result.invokeId, buffer, offset + result.len, length - result.len);
break;
case baEnum.BacnetPduTypes.PDU_TYPE_REJECT:
case baEnum.BacnetPduTypes.PDU_TYPE_ABORT:
result = baAdpu.decodeAbort(buffer, offset);
//processAbort(address, result.type, result.invokeId, result.reason, buffer, offset + result.len, length - result.len);
break;
case baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST:
result = baAdpu.decodeConfirmedServiceRequest(buffer, offset);
if ((type & baEnum.BacnetPduTypes.SEGMENTED_MESSAGE) === 0) {
//processConfirmedServiceRequest(address, result.type, result.service, result.maxSegments, result.maxAdpu, result.invokeId, buffer, offset + result.len, length - result.len);
} else {
processSegment(address, result.type, result.service, result.invokeId, result.maxSegments, result.maxAdpu, true, result.sequencenumber, result.proposedWindowNumber, buffer, offset + result.len, length - result.len);
}
break;
default:
debug('Received unknown PDU type -> Drop package');
break;
}
};
var handleNpdu = function(buffer, offset, msgLength, remoteAddress) {
// Check data length
if (msgLength <= 0) return debug('No NPDU data -> Drop package');
// Parse baNpdu header
var result = baNpdu.Decode(buffer, offset);
if (!result) return debug('Received invalid NPDU header -> Drop package');
if ((result.npdu_function & baEnum.BacnetNpduControls.NETWORK_LAYER_MESSAGE) === baEnum.BacnetNpduControls.NETWORK_LAYER_MESSAGE) {
return debug('Received network layer message -> Drop package');
}
offset += result.len;
msgLength -= result.len;
if (msgLength <= 0) return debug('No APDU data -> Drop package');
var apduType = baAdpu.getDecodedType(buffer, offset);
handlePdu(remoteAddress, apduType, buffer, offset, msgLength);
};
var receiveData = self.receiveData = function(buffer, remoteAddress) {
// Check data length
if (buffer.length < baBvlc.BVLC_HEADER_LENGTH) return debug('Received invalid data -> Drop package');
// Parse BVLC header
var result = baBvlc.decode(buffer, 0);
if (!result) return debug('Received invalid BVLC header -> Drop package');
// Check BVLC function
if (result.func === baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU || result.func === baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_BROADCAST_NPDU || result.func === baEnum.BacnetBvlcFunctions.BVLC_FORWARDED_NPDU) {
handleNpdu(buffer, result.len, buffer.length - result.len, remoteAddress);
} else {
debug('Received unknown BVLC function -> Drop package');
}
};
// Public Functions
self.whoIs = function(lowLimit, highLimit, address, handler) {
whoIsHandler = handler;
var buffer = getBuffer();
address = address || transport.getBroadcastAddress();
baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE, address, null, DEFAULT_HOP_COUNT, baEnum.BacnetNetworkMessageTypes.NETWORK_MESSAGE_WHO_IS_ROUTER_TO_NETWORK, 0);
baAdpu.encodeUnconfirmedServiceRequest(buffer, baEnum.BacnetPduTypes.PDU_TYPE_UNCONFIRMED_SERVICE_REQUEST, baEnum.BacnetUnconfirmedServices.SERVICE_UNCONFIRMED_WHO_IS);
baServices.EncodeWhoIsBroadcast(buffer, lowLimit, highLimit);
// TODO: Differentiate between uni & broadcast
baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_BROADCAST_NPDU, buffer.offset);
transport.send(buffer.buffer, buffer.offset, address);
};
self.readProperty = function(address, objectType, objectInstance, propertyId, arrayIndex, next) {
arrayIndex = arrayIndex || baAsn1.BACNET_ARRAY_ALL;
var maxSegments = baEnum.BacnetMaxSegments.MAX_SEG65;
var buffer = getBuffer();
baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE | baEnum.BacnetNpduControls.EXPECTING_REPLY, address, null, DEFAULT_HOP_COUNT, baEnum.BacnetNetworkMessageTypes.NETWORK_MESSAGE_WHO_IS_ROUTER_TO_NETWORK, 0);
var type = baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST | (maxSegments !== baEnum.BacnetMaxSegments.MAX_SEG0 ? baEnum.BacnetPduTypes.SEGMENTED_RESPONSE_ACCEPTED : 0);
baAdpu.encodeConfirmedServiceRequest(buffer, type, baEnum.BacnetConfirmedServices.SERVICE_CONFIRMED_READ_PROPERTY, maxSegments, baEnum.BacnetMaxAdpu.MAX_APDU1476, invokeCounter, 0, 0);
baServices.EncodeReadProperty(buffer, objectType, objectInstance, propertyId, arrayIndex);
baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU, buffer.offset);
transport.send(buffer.buffer, buffer.offset, address);
addCallback(invokeCounter++, function(err, data) {
if (err) return next(err);
var result = baServices.DecodeReadPropertyAcknowledge(data.buffer, data.offset, data.length);
if (!result) return next(new Error('INVALID_DECODING'));
next(null, result);
});
};
self.writeProperty = function(address, objectType, objectInstance, propertyId, priority, valueList, next) {
var maxSegments = baEnum.BacnetMaxSegments.MAX_SEG65;
var buffer = getBuffer();
baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE | baEnum.BacnetNpduControls.EXPECTING_REPLY, address, null, DEFAULT_HOP_COUNT, baEnum.BacnetNetworkMessageTypes.NETWORK_MESSAGE_WHO_IS_ROUTER_TO_NETWORK, 0);
baAdpu.encodeConfirmedServiceRequest(buffer, baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST, baEnum.BacnetConfirmedServices.SERVICE_CONFIRMED_WRITE_PROPERTY, maxSegments, baEnum.BacnetMaxAdpu.MAX_APDU1476, invokeCounter, 0, 0);
baServices.EncodeWriteProperty(buffer, objectType, objectInstance, propertyId, baAsn1.BACNET_ARRAY_ALL, priority, valueList);
baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU, buffer.offset);
transport.send(buffer.buffer, buffer.offset, address);
addCallback(invokeCounter++, function(err, data) {
if (err) return next(err);
// FIXME: Implement DecodeWritePropertyAcknowledge function
//var result = baServices.DecodeReadPropertyMultipleAcknowledge(data.buffer, data.offset, data.length);
next(null, data);
});
};
self.readPropertyMultiple = function(address, propertiesArray, next) {
var maxSegments = baEnum.BacnetMaxSegments.MAX_SEG65;
var buffer = getBuffer();
baNpdu.Encode(buffer, baEnum.BacnetNpduControls.PRIORITY_NORMAL_MESSAGE | baEnum.BacnetNpduControls.EXPECTING_REPLY, address, null, DEFAULT_HOP_COUNT, baEnum.BacnetNetworkMessageTypes.NETWORK_MESSAGE_WHO_IS_ROUTER_TO_NETWORK, 0);
var type = baEnum.BacnetPduTypes.PDU_TYPE_CONFIRMED_SERVICE_REQUEST | (baEnum.maxSegments !== baEnum.BacnetMaxSegments.MAX_SEG0 ? baEnum.BacnetPduTypes.SEGMENTED_RESPONSE_ACCEPTED : 0);
baAdpu.encodeConfirmedServiceRequest(buffer, type, baEnum.BacnetConfirmedServices.SERVICE_CONFIRMED_READ_PROP_MULTIPLE, maxSegments, baEnum.BacnetMaxAdpu.MAX_APDU1476, invokeCounter, 0, 0);
baServices.EncodeReadPropertyMultiple(buffer, propertiesArray);
baBvlc.encode(buffer.buffer, baEnum.BacnetBvlcFunctions.BVLC_ORIGINAL_UNICAST_NPDU, buffer.offset);
transport.send(buffer.buffer, buffer.offset, address);
addCallback(invokeCounter++, function(err, data) {
if (err) return next(err);
var result = baServices.DecodeReadPropertyMultipleAcknowledge(data.buffer, data.offset, data.length);
if (!result) return next(new Error('INVALID_DECODING'));
next(null, result);
});
};
transport.setHandler(receiveData);
return self;
};