forked from SignalK/signalk-js-client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
408 lines (370 loc) · 11.1 KB
/
index.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
/* global Primus */
var EventEmitter = require('eventemitter3'),
debug = require('debug')('signalk:client'),
url = require('url'),
Promise = require('bluebird'),
agent = require('superagent-promise')(require('superagent'), Promise);
var BrowserWebSocket = global.WebSocket || global.MozWebSocket;
var WebSocket = BrowserWebSocket;
/**
* @summary Create a new Signal K Client
*
* The constructor takes three optional parameters: hostname, port, and a flag indicating whether or not to use SSL. If
* no parameters are passed, {@linkcode Client#connect} will attempt to discover a Signal K server on the network via
* mDNS. Naturally, this doesn't work in the browser.
* It inherits from EventEmitter, so EventEmitter conventions apply.
*
* @param {string} hostname Host to connect to, e.g. localhost
* @param {number} port Pass undefined to use standard ports: 80/443
* @param {boolean} useSSL Does what it says on the tin
*
* @class
* This library makes it a little easier to interface with Signal K servers via the REST API and WebSockets. To use it,
* create a new Client object.
*
* @example
* var client = new Client('localhost');
* client.connect();
*
*/
function Client(hostname, port, useSSL) {
EventEmitter.call(this);
this.hostname = hostname;
if (useSSL) {
this.protocol = 'https';
this.wsProtocol = 'wss';
this.port = port || 443;
} else {
this.protocol = 'http';
this.wsProtocol = 'ws';
this.port = port || 80;
}
}
require('util').inherits(Client, EventEmitter);
/**
* @param {Object} options
* @param {string} options.hostname Deprecated
* @param {number} options.port Use 80 unless you have a reason not to
* @param {function} options.onData
* @param {function} options.onConnect
* @param {function} options.onDisconnect
* @param {function} options.onError
* @param {function} options.onClose
* @param {string} options.subscribe
*
* @returns Calls {@linkcode Client#connectDelta} or {@linkcode Client#discoverAndConnect} and returns the result of
* that function
*/
Client.prototype.connect = function(options) {
debug('connect');
var hostname = this.hostname;
var port = this.port;
if (options) {
hostname = options.hostname || hostname;
port = options.port || port;
}
if (hostname && port) {
return this.connectDelta(
hostname + ':' + port,
options.onData,
options.onConnect,
options.onDisconnect,
options.onError,
options.onClose,
options.subscribe
);
}
return Promise.resolve(options)
};
/**
* @returns a Promise
*/
Client.prototype.connectP = function(options) {
console.log(options);
debug('connect');
debug(options);
var hostname = this.hostname;
var port = this.port;
if (options) {
hostname = options.hostname || hostname;
port = options.port || port;
}
return new Promise(function(resolve, reject) {
var connectDeltaByUrl = this.connectDeltaByUrl.bind(this);
this.get('/signalk', hostname, port)
.then(function(response) {
debug('Got ' + JSON.stringify(response.body.endpoints, null, 2));
var onConnect = function(connection) {
if (options.onConnect) {
options.onConnect(connection);
}
resolve(connection);
};
var onError = function(error) {
if (options.onError) {
options.onError(error);
}
reject(error);
};
connectDeltaByUrl(
response.body.endpoints.v1['signalk-ws'],
options.onData,
onConnect,
options.onDisconnect,
onError,
options.onClose,
options.subscribe
);
})
.catch(function(error) {
reject(error);
});
});
};
Client.prototype.apiGet = function(path) {
return this.get('/signalk/v1/api' + path);
};
Client.prototype.get = function(path, hostname, port) {
var apiUrl = {
protocol: this.protocol,
hostname: hostname || this.hostname,
port: port || this.port,
path: path
};
return agent('GET', url.format(apiUrl));
};
Client.prototype.discoveryAvailable = function() {
return false
};
Client.prototype.startDiscovery = function() {
return Promise.resolve([])
};
/**
* Stops mDNS discovery. Called by {@codelink discoverAndConnect} after it has found an mDNS endpoint.
*/
Client.prototype.stopDiscovery = function() {
debug('Stopping discovery');
if (this.browser) {
this.browser.stop();
debug('Discovery stopping');
}
};
/**
* @returns A Promise
*/
Client.prototype.discoverAndConnect = function() {
return Promise.reject(new Error('Not supported'))
};
/**
* Wrapper for {@linkcode Client#connectDeltaByUrl}
*
* The hostname parameter here is not related to the hostname that may have been passed to the constructor. However,
* the constructor's useSSL parameter determines whether or not to use SSL here.
*
* @param {string} hostname - The host to connect to, may include the port
* @param {messageCb} callback - Called whenever a new delta message arrives
* @param {connetCb} onConnect - Called when the WebSocket connection is established
* @param {function} onDisconnect - Not implemented
* @param {function} onError - Called if the WebSocket connection raises an error
* @param {function} onClose - Called when the WebSocket connection is closed
* @param {string} [subscribe] - Optional path to subscribe to
* @returns result of {@linkcode Client#connectDeltaByUrl}
*/
Client.prototype.connectDelta = function(hostname, callback, onConnect, onDisconnect, onError, onClose, subscribe) {
var wsUrl = {
protocol: this.wsProtocol,
slashes: true,
hostname: hostname.split(':')[0],
port: hostname.split(':')[1],
pathname: '/signalk/v1/stream'
};
if(subscribe) {
wsUrl.query = {'subscribe': subscribe};
}
return this.connectDeltaByUrl(url.format(wsUrl), callback, onConnect, onDisconnect, onError, onClose);
};
/**
*
* If the application includes the Primus library, connectDeltaByUrl will use it and Primus will handle reconnecting to
* the server automatically. If the client application does not include Primus, then this will fall back to using the
* native WebSockets interface and the client application is responsible for restarting the connection if it is lost.
*
* @param {string} wsUrl - WebSocket url to connect to, e.g. ws://localhost/signalk/v1/stream
* @param {messageCb} callback - Called whenever a new delta message arrives
* @param {connectCb} onConnect - Called when the WebSocket connection is established
* @param {function} onDisconnect - Not implemented
* @param {function} onError - Called if the WebSocket connection raises an error
* @param {function} onClose - Called when the WebSocket connection is closed
* @param {string} [subscribe] - Optional path to subscribe to
*/
Client.prototype.connectDeltaByUrl = function(wsUrl, callback, onConnect, onDisconnect, onError, onClose) {
var theUrl = url.parse(wsUrl);
this.hostname = theUrl.hostname;
this.port = theUrl.port;
var sub = {
context: 'vessels.self',
subscribe: [
{
path: '*',
},
],
};
debug('Connecting ws to ' + theUrl.href);
var skConnection = {
hostname: this.hostname,
};
if (typeof Primus != 'undefined') {
debug('Using Primus');
var primus = Primus.connect(wsUrl, {
reconnect: {
maxDelay: 15000,
minDelay: 500,
retries: Infinity,
},
});
primus.on('data', callback);
skConnection.send = primus.write.bind(primus);
skConnection.disconnect = function() {
primus.end();
debug('Disconnected');
};
if (onConnect) {
primus.on('open', onConnect.bind(this, skConnection));
} else {
primus.on('open', function() {
skConnection.send(sub);
});
}
} else {
debug('Using ws');
var connection = new WebSocket(wsUrl);
skConnection.send = function(data) {
connection.send(typeof data != 'string' ? JSON.stringify(data) : data);
};
skConnection.disconnect = function() {
connection.close();
debug('Disconnected');
};
connection.onopen = function() {
debug('open');
if (onConnect) {
onConnect(skConnection);
} else {
skConnection.send(sub);
}
};
connection.onerror = function(error) {
debug('error:' + error);
if (onError) {
onError(error);
}
};
connection.onmessage = function(msg) {
try {
callback(JSON.parse(msg.data));
} catch (e) {
console.error(e);
}
};
connection.onclose = function(event) {
debug('close:' + event);
if (onClose) {
onClose(event);
}
};
}
skConnection.subscribeAll = function() {
skConnection.send(sub);
};
return skConnection;
};
/**
* getSelf
*
* Returns the current contents of the Signal K tree for your vessel (or at least the contents of the Signal K tree
* pointed to by self).
*
* @returns {Promise}
*/
Client.prototype.getSelf = function() {
var skUrl = {
protocol: this.protocol,
hostname: this.hostname,
port: this.port,
pathname: '/signalk/v1/api/vessels/self',
};
return agent('GET', url.format(skUrl));
};
/**
* getSelfId
*
* Returns the self identity
*
* @returns {Promise}
*/
Client.prototype.getSelfId = function() {
var skUrl = {
protocol: this.protocol,
hostname: this.hostname,
port: this.port,
pathname: '/signalk/v1/api/self'
};
return agent('GET', url.format(skUrl));
}
/**
*
* getSelfMatcher
*
* @returns {function} A function that can be passed to a filter function to select delta messages just for your vessel.
*/
Client.prototype.getSelfMatcher = function() {
return this.getSelfId().then(function(result) {
var selfData = result.body;
var selfId = selfData.mmsi || selfData.uuid;
if (selfId) {
var selfContext = 'vessels.' + selfId;
return function(delta) {
return delta.context === 'self' || delta.context === 'vessels.self' || delta.context === selfContext;
};
} else {
return function() {
return true;
};
}
});
};
/**
* Fetch meta data from the server for a Signal K path specified by prefix and path.
*
* @param {string} prefix
* @param {string} path - Path to get metadata for
* @returns A Signal K metadata object
*
* @example
* var metadata = client.getMeta('self', 'navigation.speedOverGround');
*/
Client.prototype.getMeta = function(prefix, path) {
return this.get(prefix + '/' + path.split('.').join('/') + '/meta');
};
function isDelta(msg) {
return typeof msg.context != 'undefined';
}
function isHello(msg) {
return typeof msg.version != 'undefined';
}
module.exports = {
Client: Client,
isDelta: isDelta,
isHello: isHello,
};
/**
* @callback messageCb
* @param {Object} msg - Signal K Delta
*/
/**
* @callback connectCb
* @param {Object} skConnection
* @param {string} skConnection.hostname - hostname of the currently connected server
* @param {function} skConnection.send - a function taking a single parameter, use to send data to the server
* @param {string} skConnection.disconnect - call to close the connection to the Signal K server
*/