forked from k3erg/marantz-denon-telnet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
466 lines (396 loc) · 15.9 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
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
/**
@fileoverview Control marantz and Denon AVR's by telnet.
@author Mike Kronenberg <[email protected]> (http://www.kronenberg.org)
@license MIT
*/
/**
Function called when a command is run and data is returned.
@callback defaultCallback
@param {Error} error NULL or Error object, if command failed
@param {null|Object|Array|boolean} data Array with returned data or NULL if command failed
*/
var telnet = require('telnet-client');
/**
Returns an instance of MarantzDenonTelnet that can handle telnet commands to the given IP.
@constructor
@param {string} ip Address of the AVR.
*/
var MarantzDenonTelnet = function(ip) {
this.connectionparams = {
host: ip,
port: 23,
timeout: 1000, // The RESPONSE should be sent within 200ms of receiving the request COMMAND. (plus network delay)
sendTimeout: 1200,
negotiationMandatory: false,
ors: '\r', // Set outbound record separator
irs: '\r'
};
this.cmdCue = [];
this.connection = null;
};
/**
Extract information from returned data arrays.
@param {Array} zoneInfo for Example ['Z240', 'SVOFF', 'Z2ON', 'Z2NET', 'Z240']
@return {Object} {PW: string, SI: string, SV: string, VL: string}
*/
MarantzDenonTelnet.prototype.parseZoneInfo = function(zoneInfo) {
var i;
var ret = {};
for (i = 0; i < zoneInfo.length; i++) {
var item = zoneInfo[i];
var id = item.substr(0, 2);
var payLoad = item.substr(2);
if (item.substr(0, 1) === 'Z') {
if (payLoad.match(/^[0-9]*$/)) {
ret['VL'] = payLoad;
} else if (item.substr(2).match(/(ON|OFF)/)) {
ret['PW'] = payLoad;
} else {
ret['SI'] = payLoad;
}
} else if (id === 'MV' && payLoad.substr(0, 3) != 'MAX') {
ret['VL'] = payLoad;
} else if (id === 'SI') {
ret['SI'] = payLoad;
} else if (id === 'SV') {
ret['SV'] = payLoad;
}
}
return ret;
};
/**
Works thru Telnet cue.
*/
MarantzDenonTelnet.prototype.sendNextTelnetCueItem = function() {
var mdt = this;
if (this.cmdCue.length) {
if (!this.connection) {
this.connection = new telnet();
this.connection.on('connect', function() {
mdt.sendNextTelnetCueItem();
});
this.connection.on('error', function() {
// There must be an item on the cmdCue, else we wouldn't be here...
// and node.js barfs if we don't catch this error. So lets catch it
// and use the first item in the cmdCue's error handler.
// Only quetion is, should we remove it from the queue or not?
mdt.cmdCue[0].callback('Failed to connect', null);
mdt.connection.end();
mdt.connection = null;
});
this.connection.connect(this.connectionparams);
} else {
var item = this.cmdCue.shift();
var isRequestCommand = (item.cmd.substr(-1) === '?');
var send_options = {timeout: (isRequestCommand ? this.connectionparams.timeout : 10)};
if (typeof item.waitfor !== 'undefined') {
send_options.waitfor = item.waitfor;
}
this.connection.send(item.cmd, send_options, function(error, data) {
if (typeof data === 'string') {
data = data.trim().split('\r');
for (var i = 0; i < data.length; i++) { // sanitize data
data[i] = data[i].trim();
}
} else if (error && !isRequestCommand && error.message === 'response not received') { // if it is no 'request COMMAND' the AVR will not respond
data = [];
error = null;
}
item.callback(error, data);
setTimeout(function() { // Send the COMMAND in 50ms or more intervals.
mdt.sendNextTelnetCueItem();
}, 50);
});
}
} else {
this.connection.end();
this.connection = null;
}
};
/**
Low level method to add a command to the Telnet cue.
@param {string} cmd Telnet command
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?RegExp} waitfor Wait for this regexp to fulfill instead of a timeout.
*/
MarantzDenonTelnet.prototype.telnet = function(cmd, callback, waitfor) {
this.cmdCue.push({'cmd': cmd, 'callback': callback, 'waitfor': waitfor});
if (!this.connection) {
this.sendNextTelnetCueItem();
}
};
/**
Send raw Telnet codes to the AVR.
@see marantz Telnet Reference {@link http://www.us.marantz.com/DocumentMaster/US/Marantz_FY16_AV_SR_NR_PROTOCOL_V01(2).xls}
@param {string} cmd Telnet command
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.cmd('PW?', function(error, data) {console.log('Power is: ' + data);});
// Power is: [PWON,Z2ON,Z3ON|PWSTANDBY]
*/
MarantzDenonTelnet.prototype.cmd = function(cmd, callback) {
this.telnet(cmd, function(error, data) {
if (!error) {
callback(null, data);
} else {
callback(error);
}
});
};
/**
Get the currently selected input of a zone.
Telnet Command examples: SI?, Z2SOURCE
@param {defaultCallback} callback Function to be called when the command is run and data is returned. Will return one or more of: 'CD', 'SPOTIFY', 'CBL/SAT', 'DVD', 'BD', 'GAME', 'GAME2', 'AUX1',
'MPLAY', 'USB/IPOD', 'TUNER', 'NETWORK', 'TV', 'IRADIO', 'SAT/CBL', 'DOCK',
'IPOD', 'NET/USB', 'RHAPSODY', 'PANDORA', 'LASTFM', 'IRP', 'FAVORITES', 'SERVER'
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getInput(function(error, data) {console.log('INPUT of MAIN ZONE is: ' + JSON.stringify(data));}, 'ZM');
// INPUT of MAIN ZONE is: {"SI":"MPLAY","SV":"OFF"}
*/
MarantzDenonTelnet.prototype.getInput = function(callback, zone) {
var mdt = this;
var commandPrefix = (!zone || (zone == 'ZM')) ? 'SI' : zone;
this.telnet(commandPrefix + '?', function(error, data) {
if (!error) {
var parsedData = mdt.parseZoneInfo(data);
callback(null, {SI: parsedData['SI'], SV: parsedData['SV']});
} else {
callback(error);
}
});
};
/**
Select the input of a zone.
Telnet Command examples: SIMPLAY, Z2MPLAY, Z3CD
@param {string} input Supported values: 'CD', 'SPOTIFY', 'CBL/SAT', 'DVD', 'BD', 'GAME', 'GAME2', 'AUX1',
'MPLAY', 'USB/IPOD', 'TUNER', 'NETWORK', 'TV', 'IRADIO', 'SAT/CBL', 'DOCK',
'IPOD', 'NET/USB', 'RHAPSODY', 'PANDORA', 'LASTFM', 'IRP', 'FAVORITES', 'SERVER'
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.setInput('MPLAY', function(error, data) {console.log('Set INPUT of MAIN ZONE to MPLAY.');});
// Set INPUT of MAIN ZONE to MPLAY.
*/
MarantzDenonTelnet.prototype.setInput = function(input, callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? 'SI' : zone;
this.telnet(commandPrefix + input, function(error, data) {
if (!error) {
callback(null, data);
} else {
callback(error);
}
});
};
/**
Get the current mute state of a zone.
Defaults MAIN ZONE, if no zone set.
Telnet Command examples: SIMPLAY, Z2MPLAY, Z3CD
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getMuteState(function(error, data) {console.log('MUTE state of ZONE2 is: ' + (data ? 'ON' : 'OFF'));}, 'Z2');
// MUTE state of ZONE2 is: [ON|OFF]
*/
MarantzDenonTelnet.prototype.getMuteState = function(callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? '' : zone;
this.telnet(commandPrefix + 'MU?', function(error, data) {
if (!error) {
callback(null, (data[0] == commandPrefix + 'MUON'));
} else {
callback(error);
}
});
};
/**
Set the mute state of a zone.
Defaults MAIN ZONE, if no zone set.
Telnet Command examples: MUON, MUOFF, Z2MUON, Z3MUOFF
@param {boolean} muteState TRUE for muted
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.setMuteState(true, function(error, data) {console.log('Set MUTE state of ZONE2 to ON.');}, 'Z2');
// Set MUTE state of ZONE2 to ON.
*/
MarantzDenonTelnet.prototype.setMuteState = function(muteState, callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? '' : zone;
this.telnet(commandPrefix + 'MU' + (muteState ? 'ON' : 'OFF'), function(error, data) {
if (!error) {
callback(null, muteState);
} else {
callback(error);
}
});
};
/**
Get the current power state of the AVR.
Telnet Command examples: PW?
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getPowerState(function(error, data) {console.log('POWER state of AVR is: ' + (data ? 'ON' : 'OFF'))});
// POWER state of AVR is: [ON|OFF]
*/
MarantzDenonTelnet.prototype.getPowerState = function(callback) {
this.telnet('PW?', function(error, data) {
if (!error) {
callback(null, (data[0] == 'PWON'));
} else {
callback("Can't connect to device: " + error, false);
}
});
};
/**
Sets the power state of the AVR.
Telnet Command examples: PWON, PWSTANDBY (threr is no PWOFF!)
@param {boolean} powerState - TRUE to power the AVR on
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.setPowerState(false, function(error, data) {console.log('Sent power off command to AVR.');});
// Set POWER state of AVR to ON.
*/
MarantzDenonTelnet.prototype.setPowerState = function(powerState, callback) {
this.telnet('PW' + (powerState ? 'ON' : 'STANDBY'), function(error, data) {
if (!error) {
callback(null, powerState);
} else {
callback(error);
}
});
};
/**
Get the current volume of a zone.
There is no MAIN ZONE Volue, its handled by the Mastervolume (MV)
Telnet Command examples: MV10, Z215
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getVolume(function(error, data) {console.log('VOLUME of MAIN ZONE is: ' + data);}, 'ZM');
// VOLUME of MAIN ZONE is: [0-100]
*/
MarantzDenonTelnet.prototype.getVolume = function(callback, zone) {
var mdt = this;
var commandPrefix = (!zone || (zone == 'ZM')) ? 'MV' : zone;
this.telnet(commandPrefix + '?', function(error, data) {
if (!error) {
callback(null, parseInt((mdt.parseZoneInfo(data)['VL'] + '0').substring(0, 3), 10) * 0.1);
} else {
callback(error);
}
});
};
/**
Set the playback volume of a zone.
There is no MAIN ZONE Volue, its handled by the Mastervolume (MV)
Telnet Command examples: MV20, Z230, Z340
@param {number} volume 0-100
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {?string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.setVolume(30, function(error, data) {console.log('Set VOLUME of MAIN ZONE to 30.');}, 'ZM');
// Set VOLUME of MAIN ZONE to 30.
*/
MarantzDenonTelnet.prototype.setVolume = function(volume, callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? 'MV' : zone;
var vol = (volume * 10).toFixed(0); //volume fix
if (vol < 100) {
vol = '0' + vol;
} else {
vol = '' + vol;
}
this.telnet(commandPrefix + vol, function(error, data) {
if (!error) {
callback(null, volume);
} else {
callback(error);
}
});
};
/**
Get all supported zones of the AVR.
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getZones(function(error, data) {console.log('Available Zones: ' + JSON.stringify(data));});
// Available Zones: {"ZM":"MAIN ZONE","Z2":"ZONE2","Z3":"ZONE3"}
*/
MarantzDenonTelnet.prototype.getZones = function(callback) {
var mdt = this;
var zoneIds = ['ZM', 'Z2', 'Z3', 'Z4', 'Z5', 'Z6', 'Z7', 'Z8', 'Z9'];
var zones = {};
// get number of zones (PW? -> ["PWON","Z2ON","Z3ON"])
var handleZoneIds = function(err, data) {
if (data) {
for (i = 0; i < data.length; i++) {
zones[zoneIds[i]] = zoneIds[i];
}
}
mdt.telnet('RR?', handleZoneNames);
};
// Try to get zone names supported by recent AVR (RR? -> ["R1MAIN ZONE ","R2ZONE2 ","R3ZONE3"])
var handleZoneNames = function(err, data) {
var zoneName;
if (data) {
for (i = 0; i < data.length; i++) {
zoneName = data[i].trim().substr(2);
zones[zoneIds[i]] = zoneName;
}
}
callback(null, zones); // whatever happens, we finally go on
};
this.telnet('PW?', handleZoneIds);
};
/**
Returns the current power state of a zone.
Telnet Command examples: PW?, Z2?, Z3?
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.getZonePowerState(function(error, data) {console.log('POWER state of ZONE3 is: ' + (data ? 'ON' : 'OFF'));}, 'Z3');
// POWER state of ZONE3 is: [ON|OFF]
*/
MarantzDenonTelnet.prototype.getZonePowerState = function(callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? 'ZM' : zone;
this.telnet(commandPrefix + '?', function(error, data) {
if (!error) {
callback(null, (data[0] == commandPrefix + 'ON'));
} else {
callback(error);
}
});
};
/**
Sets the power state of a zone.
Telnet Command examples: PWON, PWSTANDBY, Z2ON, Z3OFF
@param {boolean} powerState TRUE to power on
@param {defaultCallback} callback Function to be called when the command is run and data is returned
@param {string} zone NULL or ZM for MAIN ZONE, Z1 ... Zn for all others
@example
var mdt = new MarantzDenonTelnet('127.0.0.1');
mdt.setZonePowerState(false, function(error, data) {console.log('Set POWER state of ZONE3 to OFF.');}, 'Z3');
// Set POWER state of ZONE3 to OFF.
*/
MarantzDenonTelnet.prototype.setZonePowerState = function(powerState, callback, zone) {
var commandPrefix = (!zone || (zone == 'ZM')) ? 'MV' : zone;
this.telnet(commandPrefix + (powerState ? 'ON' : 'OFF'), function(error, data) {
if (!error) {
callback(null, powerState);
} else {
callback(error);
}
});
};
/**
Export.
*/
module.exports = MarantzDenonTelnet;