-
Notifications
You must be signed in to change notification settings - Fork 0
/
xbeepromise.js
445 lines (348 loc) · 15.5 KB
/
xbeepromise.js
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*jslint node:true, nomen:true */
/*
* lib/xbee-promise.js
* https://github.com/101100/xbee-promise
*
* Copyright (c) 2014 Jason Heard
* Licensed under the MIT license.
*/
var parambulator = require('parambulator');
var Q = require('q');
var SerialPort = require('serialport').SerialPort;
var xbee_api = require('xbee-api');
var util = require('util');
var constructorOptionsSpec = {
serialport: 'required$, string$',
required$: 'module',
module: { enum$: ["802.15.4", "ZNet", "ZigBee"] },
api_mode: { enum$: [1, 2] },
serialportOptions: 'object$',
defaultTimeoutMs: { type$: 'integer', min$: 10 }
};
var localCommandOptionsSpec = {
command: 'required$, string$',
commandParameter: { type$: ['string', 'array'] },
timeoutMs: { type$: 'integer', min$: 10 }
};
var remoteCommandOptionsSpec = {
command: 'required$, string$',
commandParameter: { type$: ['string', 'array'] },
exactlyone$: ['destinationId', 'destination64', 'destination16'],
destinationId: { type$: ['string'] },
destination64: { type$: ['string', 'array'] },
destination16: { type$: ['string', 'array'] },
timeoutMs: { type$: 'integer', min$: 10 }
};
var remoteTransmitOptionsSpec = {
data: 'required$, string$',
exactlyone$: ['destinationId', 'destination64', 'destination16'],
destinationId: { type$: ['string'] },
destination64: { type$: ['string', 'array'] },
destination16: { type$: ['string', 'array'] },
timeoutMs: { type$: 'integer', min$: 10 }
};
module.exports = function xbeePromiseLibrary(options) {
"use strict";
var xbeeAPI,
serialport,
cachedNodes = {},
debug = false,
defaultTimeoutMs,
module;
function closeSerialport() {
if (debug) {
console.log("Closing serial port");
}
serialport.drain(function closeAfterDraining() {
serialport.close();
});
}
function _createCallback(deferred, frameId, frameType) {
return function deferredResolverCallback(receivedFrame) {
if (receivedFrame.id === frameId && receivedFrame.type === frameType) {
// This is our frame's response. Resolve the promise.
deferred.resolve(receivedFrame);
}
};
}
// Returns a promise that will resolve to the response for the given
// frame that will be sent.
function _sendFramePromiseResponse(frame, timeoutMs, responseFrameType) {
var frameId = xbeeAPI.nextFrameId(),
deferred = Q.defer(),
callback;
// Set the frame ID and create the callback to check for it
frame.id = frameId;
callback = _createCallback(deferred, frameId, responseFrameType);
// Attach callback so we're waiting for the response
xbeeAPI.on("frame_object", callback);
// Write to the serialport (when open or now if open)
if (!serialport.isOpen()) {
serialport.on("open", function () {
serialport.write(xbeeAPI.buildFrame(frame));
});
} else {
serialport.write(xbeeAPI.buildFrame(frame));
}
// Return our promise with a timeout
return deferred.promise.timeout(timeoutMs).fin(function () {
// clean up: remove listener after the promise is complete (for any reason)
xbeeAPI.removeListener("frame_object", callback);
});
}
function _localCommand(command, timeoutMs, commandParameter) {
var frame = {
type: xbee_api.constants.FRAME_TYPE.AT_COMMAND,
command: command,
commandParameter: commandParameter
};
if (debug) {
console.log("Doing local command", command, "with parameter", commandParameter || []);
}
return _sendFramePromiseResponse(frame, timeoutMs, xbee_api.constants.FRAME_TYPE.AT_COMMAND_RESPONSE)
.then(function (frame) {
if (frame.commandStatus === xbee_api.constants.COMMAND_STATUS.OK) {
return frame.commandData;
}
// if not OK, throw error
throw new Error(xbee_api.constants.COMMAND_STATUS[frame.commandStatus]);
});
}
function _extractDestination64(commandData) {
// Result in commandData is 16 bit address as two bytes,
// followed by 64 bit address as 8 bytes. This function
// returns the 64 bit address.
var address64 = commandData.slice(2, 10);
if (debug) {
console.log("Extracted 64 bit address:", address64);
}
return address64;
}
// Returns a promise that will resolve to the 64 bit address of the node
// with the given node identifier.
function _lookupByNodeIdentifier(nodeIdentifier, timeoutMs) {
// if the address is cached, return that wrapped in a promise
if (cachedNodes[nodeIdentifier]) {
return new Q(cachedNodes[nodeIdentifier]);
}
if (debug) {
console.log("Looking up", nodeIdentifier);
}
return _localCommand('DN', timeoutMs, nodeIdentifier)
.then(_extractDestination64, function errorHandler() {
// any error from _sendFramePromiseResponse implies node not found
throw new Error("Node not found");
})
.then(function (address64) {
// cache result
cachedNodes[nodeIdentifier] = address64;
return address64;
});
}
// Sends a the given command and parameter to the given destination.
// A promise is returned that will resolve to the resulting command
// data on success or result in an Error with the failed status as
// the text. Only one of destination64 or destination16 should be
// given; the other should be undefined.
function _remoteCommand(command, destination64, destination16, timeoutMs, commandParameter) {
var frame = {
type: xbee_api.constants.FRAME_TYPE.REMOTE_AT_COMMAND_REQUEST,
command: command,
commandParameter: commandParameter,
destination64: destination64,
destination16: destination16
};
if (debug) {
console.log("Sending", command, "to", destination64, "with parameter", commandParameter || []);
}
return _sendFramePromiseResponse(frame, timeoutMs, xbee_api.constants.FRAME_TYPE.REMOTE_COMMAND_RESPONSE)
.then(function (frame) {
if (frame.commandStatus === xbee_api.constants.COMMAND_STATUS.OK) {
return frame.commandData;
}
// if not OK, throw error
throw new Error(xbee_api.constants.COMMAND_STATUS[frame.commandStatus]);
});
}
// Sends a the given data to the given destination. A promise is
// returned that will resolve to 'true' on success or result in an
// Error with the failed status as the text. Only one of
// destination64 or destination16 should be given; the other should
// be undefined.
function _remoteTransmit(destination64, destination16, data, timeoutMs) {
var frame = {
data: data,
type: xbee_api.constants.FRAME_TYPE.ZIGBEE_TRANSMIT_REQUEST,
destination64: destination64,
destination16: destination16
},
responseFrameType = xbee_api.constants.FRAME_TYPE.ZIGBEE_TRANSMIT_STATUS;
if (module === "802.15.4") {
responseFrameType = xbee_api.constants.FRAME_TYPE.TX_STATUS;
frame.type = destination64 ?
xbee_api.constants.FRAME_TYPE.TX_REQUEST_64 :
xbee_api.constants.FRAME_TYPE.TX_REQUEST_16;
}
if (debug) {
console.log("Sending '" + data + "' to", destination64 || destination16);
}
return _sendFramePromiseResponse(frame, timeoutMs, responseFrameType)
.then(function (frame) {
if (frame.deliveryStatus === xbee_api.constants.DELIVERY_STATUS.SUCCESS) {
return true;
}
// if not OK, throw error
throw new Error(xbee_api.constants.DELIVERY_STATUS[frame.deliveryStatus]);
});
}
// Validate the destination found within the given settings object.
// The existence of exactly one of destinationId, destination64 and
// destination16 and their types are assumed to already be verified.
// This function must ensure that destination64 is the correct
// length, if it exists, destination16 is the correct length, if it
// exists, and destinationId was used only if the module type was
// not '802.15.4'.
function _validateDestination(settings) {
var hexRegex = /^[0-9a-f]+$/;
if (settings.destinationId && module === '802.15.4') {
throw new Error("'destinationId' is not supported by 802.15.4 modules. Use 'destination16' or 'destination64' instead.");
}
if (typeof settings.destination64 === "string") {
if (settings.destination64.length !== 16) {
throw new Error("'destination64' is not the correct length. It must be a hex string of length 16 or a byte array of length 8.");
}
if (!settings.destination64.match(hexRegex)) {
throw new Error("'destination64' is not a hex string. It must be a hex string of length 16 or a byte array of length 8.");
}
} else if (util.isArray(settings.destination64)) {
if (settings.destination64.length !== 8) {
throw new Error("'destination64' is not the correct length. It must be a hex string of length 16 or a byte array of length 8.");
}
settings.destination64.forEach(function (element) {
if (typeof element !== "number" || element < 0 || element > 255) {
throw new Error("'destination64' is not a byte array. It must be a hex string of length 16 or a byte array of length 8.");
}
});
}
if (typeof settings.destination16 === "string") {
if (settings.destination16.length !== 4) {
throw new Error("'destination16' is not the correct length. It must be a hex string of length 4 or a byte array of length 2.");
}
if (!settings.destination16.match(hexRegex)) {
throw new Error("'destination16' is not a hex string. It must be a hex string of length 4 or a byte array of length 2.");
}
} else if (util.isArray(settings.destination16)) {
if (settings.destination16.length !== 2) {
throw new Error("'destination16' is not the correct length. It must be a hex string of length 4 or a byte array of length 2.");
}
settings.destination16.forEach(function (element) {
if (typeof element !== "number" || element < 0 || element > 255) {
throw new Error("'destination16' is not a byte array. It must be a hex string of length 4 or a byte array of length 2.");
}
});
}
}
// Validates that a command is the correct length (two characters).
function _validateCommand(command) {
if (command.length !== 2) {
throw new Error("'command' must be a string of length 2.");
}
}
function localCommand(settings) {
var command,
commandParameter,
timeoutMs = (settings && settings.timeoutMs) || defaultTimeoutMs;
parambulator(localCommandOptionsSpec).validate(settings || {}, function (err) {
if (err) {
throw err;
}
});
_validateCommand(settings.command);
command = settings.command;
commandParameter = settings.commandParameter || [];
return _localCommand(command, timeoutMs, commandParameter);
}
function remoteCommand(settings) {
var command,
commandParameter,
timeoutMs = (settings && settings.timeoutMs) || defaultTimeoutMs;
parambulator(remoteCommandOptionsSpec).validate(settings || {}, function (err) {
if (err) {
throw err;
}
});
_validateDestination(settings);
_validateCommand(settings.command);
command = settings.command;
commandParameter = settings.commandParameter || [];
if (settings.destination64 || settings.destination16) {
return _remoteCommand(command, settings.destination64, settings.destination16, timeoutMs, commandParameter);
}
if (settings.destinationId) {
return _lookupByNodeIdentifier(settings.destinationId, timeoutMs)
.then(function (lookupResult) {
cachedNodes[settings.destinationId] = lookupResult;
return _remoteCommand(command, lookupResult, undefined, timeoutMs, commandParameter);
});
}
}
// TODO test!
function remoteTransmit(settings) {
var data,
timeoutMs = (settings && settings.timeoutMs) || defaultTimeoutMs;
parambulator(remoteTransmitOptionsSpec).validate(settings || {}, function (err) {
if (err) {
throw err;
}
});
_validateDestination(settings);
// TODO is there a miximum length for 'data'?
data = settings.data;
if (settings.destination64 || settings.destination16) {
return _remoteTransmit(settings.destination64, settings.destination16, data, timeoutMs);
}
if (settings.destinationId) {
return _lookupByNodeIdentifier(settings.destinationId, timeoutMs)
.then(function (lookupResult) {
cachedNodes[settings.destinationId] = lookupResult;
return _remoteTransmit(lookupResult, undefined, data, timeoutMs);
});
}
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Initialization
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//console.log(options);
parambulator(constructorOptionsSpec).validate(options || {}, function (err) {
if (err) {
throw err;
}
});
//console.log('success', options || {});
module = options.module;
xbeeAPI = new xbee_api.XBeeAPI({
api_mode: options.api_mode || 1,
module: module
});
options.serialportOptions = options.serialportOptions || {};
options.serialportOptions.parser = xbeeAPI.rawParser();
if (options.debug) {
debug = true;
}
if (debug) {
console.log("Connecting to serialport", options.serialport);
}
serialport = new SerialPort(options.serialport, options.serialportOptions);
defaultTimeoutMs = options.defaultTimeoutMs || 5000;
if (debug) {
xbeeAPI.on("frame_object", function (frame) {
console.log("Debug frame:\n", frame);
});
}
return {
localCommand: localCommand,
remoteCommand: remoteCommand,
remoteTransmit: remoteTransmit,
close: closeSerialport
};
}; // end of xbeePromiseLibrary