This repository has been archived by the owner on Feb 2, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
398 lines (360 loc) · 12.6 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
"use strict";
var WebSocketClient = require('websocket').client;
class HyperionNg {
constructor(host, port, wsTan, priority) {
this.host = host;
this.port = port;
this.wsTan = wsTan;
this.priority = priority;
this.origin = 'Hyperion-Ng-Api';
}
/**
* disableHyperion: Disables all activated components. The Ng-Way to switch off.
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
disableHyperion(callback) {
this.setComponentState('ALL', false, function(err, data) {
callback(err, data);
});
}
/**
* enableHyperion: Enables all previous activated components. The Ng-Way to switch on.
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
enableHyperion(callback) {
this.setComponentState('ALL', true, function(err, data) {
callback(err, data);
});
}
/**
* disableLedDevice: Disables the LED Device. You can see this as "send color black"
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
disableLedDevice(callback) {
this.setComponentState('LEDDEVICE', false, function(err, data) {
callback(err, data);
});
}
/**
* enableLedDevice: Activates the LED Device.
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
enableLedDevice(callback) {
this.setComponentState('LEDDEVICE', true, function(err, data) {
callback(err, data);
});
}
/**
* getServerInfo: Get the server info JSON. All information you need from hyperion. There are more functions available to wrap this. Eg: getAllEffects
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getServerInfo(callback) {
this.sendToHyperion("serverinfo", "", "", this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* getAllComponents: Get all components. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getAllComponents(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.components);
});
}
/**
* getAllEffects: Get all effects. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getAllEffects(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.effects);
});
}
/**
* getStartupEffect: Gets the effect which is used for startup
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getStartupEffect(callback) {
this.getServerConfig(function(err, data) {
callback(err, data.result.foregroundEffect);
});
}
/**
* getAllGrabbers: Get all Grabbers. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getAllGrabbers(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.grabbers);
});
}
/**
* getAllLedDevices: Get all led devices. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getAllLedDevices(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.ledDevices);
});
}
/**
* getLedMappingType: Get the current led mapping type. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getLedMappingType(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.ledMAppingType);
});
}
/**
* getAllPriorities: Get all priorities. Wrap function for getServerInfo
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getAllPriorities(callback) {
this.getServerInfo(function(err, data) {
callback(err, data.info.priorities);
});
}
/**
* getSysInfo: Get system information about the operating system of hyperion.ng instance
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getSysInfo(callback) {
this.sendToHyperion("sysinfo", "", "", this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* getServerConfig: Gets the current config file
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getServerConfig(callback) {
this.sendToHyperion("config", "getconfig", "", this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* getServerConfigSchema: Gets the current config schema
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
getServerConfigSchema(callback) {
this.sendToHyperion("config", "getschema", "", this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setMappingTypeMulticolor: Set the Led Mapping Type to multicolor (classic atmolight)
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setMappingTypeMulticolor(callback) {
this.setMappingType('multicolor_mean', function(err, data) {
callback(err, data);
});
}
/**
* setMappingTypeMulticolor: Set the Led Mapping Type to unicolor (one color calculated and send to ALL leds)
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setMappingTypeUnicolor(callback) {
this.setMappingType('unicolor_mean', function(err, data) {
callback(err, data);
});
}
/**
* setMappingType: Set the Led Mapping type. Currently 'unicolor_mean' and 'multicolor_mean' is supported. Inserting something other will likely result in an error
* @param {string} type for now only use 'unicolor_mean' or 'multicolor_mean'
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setMappingType(type, callback) {
this.sendToHyperion("processing", "", '"mappingType": "' + type + '"', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setComponentState: Sets a component to true or false
* @param {string} comp The component. You can use getAllComponents to get the names.
* @param {boolean} state true or false
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setComponentState(comp, state, callback) {
var state_str = state ? "true" : "false";
this.sendToHyperion("componentstate", "", '"componentstate":{"component":"' + comp + '","state":' + state_str + '}', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setColor: Sets the color for a given priority and duration
* @param {number} r
* @param {number} g
* @param {number} b
* @param {number} duration in seconds. Use 0 for infinite
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setColor(r, g, b, duration, callback) {
this.sendToHyperion("color", "", '"color":[' + r + ',' + g + ',' + b + '], "priority":' + this.priority + ',"duration":' + duration * 1000 + ',"origin":"' + this.origin + '"', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setColorToBlackPermanently: Sets the color to black with duration 0
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setColorToBlackPermanently(callback) {
this.sendToHyperion("color", "", '"color":[0,0,0], "priority":' + this.priority + ',"duration":0,"origin":"' + this.origin + '"', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setEffect: Sets an effect.
* @param {string} effectName You can use getAllEffects to get the name
* @param {number} duration in seconds. Use 0 for infinite
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setEffect(effectName, duration, callback) {
this.sendToHyperion("effect", "", '"effect":{"name":"' + effectName + '"},"priority":' + this.priority + ',"duration":' + duration * 1000 + ',"origin":"' + this.origin + '"', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setBrightness: Set the led brightness
* @param {number} value 0 to 100
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setBrightness(value, callback) {
this.sendToHyperion("adjustment", "", '"adjustment": {"brightness": ' + value + '}', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setSourceToAutoSelection: Activates autoselection
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setSourceToAutoSelection(callback) {
this.sendToHyperion("sourceselect", "", '"auto":true', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* setSource: set a source (priority) to active
* @param {number} priority You can use getAllPriorities to get the id
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
setSource(priority, callback) {
this.sendToHyperion("sourceselect", "", '"priority":' + priority, this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* clearPriority: clears the given priority
* @param {number} priority You can use getAllPriorities to get the id
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
clearPriority(priority, callback) {
this.sendToHyperion("clear", "", '"priority":' + priority + '', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* clearApiPriority: clears the priority which is used by this api
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
clearApiPriority(callback) {
this.sendToHyperion("clear", "", '"priority":' + this.priority + '', this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* clearAllPriority: clears all priority
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
clearAllPriority(callback) {
this.sendToHyperion("clearall", "", "", this.wsTan, function(err, data) {
callback(err, data);
});
}
/**
* playStatupEffect: plays the startup effect with configured time
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
playStatupEffect(callback) {
var obj = this;
obj.getStartupEffect(function(err, data) {
obj.setEffect(data.effect, data.duration_ms/1000, function(err, data) {
callback(err, data);
});
});
}
/**
* sendToHyperion: Main function to communicate with hyperion.ng. This function is calles by the other functions. If you know the commands you want to call on hyperion side you can call this function directly.
* @param {string} command
* @param {string} subcommand
* @param {string} msg
* @param {number} wsTan
* @param {Function} callback
* @return {Function} callback return string from hyperion.ng
*/
sendToHyperion(command, subcommand, msg, wsTan, callback) {
const client = new WebSocketClient();
client.connect('ws://' + this.host + ':' + this.port + '/');
let response = "";
client.on('connectFailed', function(error) {
callback(error, null);
});
client.on('connect', function(connection) {
connection.on('error', function(error) {
callback(error, null);
});
connection.on('message', function(message) {
if (message.type === 'utf8') {
response = JSON.parse(message.utf8Data);
connection.close();
(callback && response.success === true) ? callback(null, response): callback(response, null);
}
});
if (connection.connected) {
if (typeof subcommand != 'undefined' && subcommand.length > 0) {
subcommand = ',"subcommand":"' + subcommand + '"';
} else {
subcommand = "";
}
if (typeof msg != 'undefined' && msg.length > 0) {
msg = "," + msg;
} else {
msg = "";
}
connection.send('{"command":"' + command + '", "tan":' + wsTan + subcommand + msg + '}');
}
});
}
}
module.exports = HyperionNg;