-
Notifications
You must be signed in to change notification settings - Fork 5
/
rgb.html
477 lines (410 loc) · 21.8 KB
/
rgb.html
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
467
468
469
470
471
472
473
474
475
476
477
<script type="text/javascript">
RED.nodes.registerType('rgb-output',{
category: 'hapcan',
color: '#C1C1C1',
defaults: {
gateway: {type:"hapcan-gateway", required: true},
name: {value:""},
group: {value: 1, required: true, validate: function(val){return (val > 0 && val < 256);} },
node: {value: 1, required: true, validate: function(val){return (val > 0 && val < 256);}},
channel: {value: 1, required: true,validate: function(val){return (val > 0 && val <= 4);}},
state: {value: 0xFF, required: true, validate: function(val) {return (val>=0 && val < 256)}},
speed: {value: 0x00, required: true, validate: function(val) {return (val>=-1 && val <= 256)}},
UNIV : {value: 3, required: true, validate: function(val) {return (val==1 || val == 3 || val==undefined)}}
},
inputs:1,
outputs:0,
icon: "relay-output.png",
align: 'right',
label: function() {
return (this.name||"rgb output") + ' ('+this.node+','+this.group+') ['+this.channel+']';
},
labelStyle: function() { return this.name?"node_label_italic":""; } ,
inputLabels: "rgb control message",
oneditprepare: async function() {
let config = this
var nodeOptions = '';
var groupOptions = '';
var devicesOptions = null
var gatewaySelect = $('#node-input-gateway')
var devicesSelect = $("#node-input-devices")
var nodeSelect = $("#node-input-node")
var groupSelect = $("#node-input-group")
var currentDevice = null
var deviceList = []
gatewaySelect.change(function()
{
devicesOptions = ''
var selectedGatewayId = gatewaySelect.children('option[selected]').first().val()
if(selectedGatewayId == null)
selectedGatewayId = gatewaySelect.children("option").first().val()
var gateway = RED.nodes.node(selectedGatewayId)
if(gateway != null )
{
deviceList = gateway.devices.filter((d) => d.applicationType === 8)
deviceList.forEach( (device) => {
var selected = '';
if(Number(config.node) === device.node && Number(config.group) === device.group)
{
selected = 'selected="selected"'
currentDevice = device
}
devicesOptions += `<option ${selected} value="${device.id}">${device.description} (${device.node},${device.group})</option>`
})
}
devicesOptions += `<option ${currentDevice === null ? 'selected="selected"' : ''} value="0">(set node, group manually)</option>`
devicesSelect.empty().append(devicesOptions).trigger('change')
})
devicesSelect.on('change', function() {
if(Number(this.value) === 0)
{
nodeSelect.removeAttr('disabled')
groupSelect.removeAttr('disabled')
}
currentDevice = deviceList.find(v=>v.id === this.value)
if(currentDevice !== undefined) {
nodeSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.node}]`).prop('selected', true).trigger('change')
groupSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.group}]`).prop('selected', true).trigger('change')
nodeSelect.attr('disabled', 'disabled')
groupSelect.attr('disabled', 'disabled')
}
})
var stateOptions = '';
var speedOptions = '';
for(var i = -1; i < 256; i++)
{
if(i>0)
{
var selectedNode = '';
if((Number(this.node) === i))
selectedNode = 'selected="selected"';
nodeOptions += '<option '+ selectedNode +' value="'+i+'">'+i+'</option>';
var selectedGroup = '';
if((Number(this.group) === i))
selectedGroup = 'selected="selected"';
groupOptions += '<option '+ selectedGroup +' value="'+i+'">'+i+'</option>';
}
if(i >= 0)
{
var selectedState = '';
if((Number(this.state) === i))
selectedState = 'selected="selected"';
stateOptions += '<option '+ selectedState +' value="'+i+'">'+i+'</option>';
}
var selectedSpeed = '';
if((Number(this.speed) === i))
selectedSpeed = 'selected="selected"';
var value = i;
if( value === -1 )
value = "leave unchanged";
else if( value === 0 )
value = "0 - instant switch";
speedOptions += '<option '+ selectedSpeed +' value="'+i+'">'+value+'</option>';
}
nodeSelect.append(nodeOptions);
groupSelect.append(groupOptions);
$("#node-input-state").append(stateOptions);
$("#node-input-speed").append(speedOptions);
if(this.UNIV == undefined )
{
this.UNIV = 3;
$('#node-input-UNIV').val(3);
}
}
});
</script>
<script type="text/x-red" data-template-name="rgb-output">
<div class="form-row">
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Device name">
</div>
<div class="form-row">
<label for="node-input-gateway"><i class="fa fa-globe"></i> Gateway</label>
<input type="text" id="node-input-gateway" placeholder="Gateway">
</div>
<div class="form-row">
<label for="node-input-devices"><i class="fa fa-microchip"></i> Device</label>
<select id="node-input-devices"></select>
</div>
<div class="form-row">
<label for="node-input-node"><i class="fa fa-cube"></i> Node</label>
<select id="node-input-node"></select>
</div>
<div class="form-row">
<label for="node-input-group"><i class="fa fa-cubes"></i> Group</label>
<select id="node-input-group"></select>
</div>
<div class="form-row">
<label for="node-input-channel"><i class="fa fa-sign-out"></i> Channel</label>
<select id="node-input-channel">
<option selected="selected" value="1">Red</option>
<option value="2">Green</option>
<option value="3">Blue</option>
<option value="4">Master</option>
</select>
</div>
<div class="form-row">
<label for="node-input-state"><i class="fa fa-dot-circle-o"></i> Default state</label>
<select id="node-input-state"></select>
</div>
<div class="form-row">
<label for="node-input-speed"><i class="fa fa-clock-o"></i> Speed</label>
<select id="node-input-speed"></select>
</div>
<hr>
<div class="form-row">
<label for="node-input-UNIV"><i class="fa fa-cubes"></i> UNIV</label>
<select id="node-input-UNIV">
<option value="1">UNIV 1.0.8.X module</option>
<option selected="selected" value="3">UNIV 3.8.X module</option>
</select>
</div>
</script>
<script type="text/x-red" data-help-name="rgb-output">
<p>Allows controlling of the Hapcan RGB LED Controller UNIV-3.8.X and UNIV-1.0.8 modules.</p>
<p>The node allows you to control single rgb channel or whole rgb module. It uses the Ethernet gateway to communicate with Hapcan bus.</p>
<h3>Inputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">string | number | bool | any | object</span></dt>
<dd>Any input message will perform default action. If topic is set to <i>control</i> the payload will control the RGB module.</dd>
<dt class="optional">topic <span class="property-type">string</span></dt>
<dd>Topic is optional. When a <i>control</i> value is provided it will overrides default settings and allows controlling of the node directly.</dd>
</dl>
<h3>Details</h3>
<p>The default node behaviour on any input message is to set state to the value with speed specified in properties.
When <code>msg.topic</code> is set to <i>control</i> then input value will control node in several ways. In control mode the <code>msg.payload</code>
can be one of the following types:
</p>
<dl class="message-properties">
<dt>string</dt>
<dd>Value of <i>ON</i>, <i>OFF</i>, <i>TOGGLE</i>, <i>STOP</i> will control the default channel. Case insensitive.
</dd>
<dt>number</dt>
<dd>Output channel will be set to the specified value (0-255).</dd>
<dt>boolean</dt>
<dd>Output channel will be turn ON when value is true, otherwise it will turn OFF.</dd>
<dt>object</dt>
<dd>Gives an ability to control whole RGB module by providing values. See details below.</dd>
</dl>
<p>
<b>Note</b>. Node will send different instructions to Hapcan module based on current parameter values.
For example, if speed = 0 then channel will switch to desired state instantly. Speed > 0 cause the node will send two frames, set speed for channel and set softly
to state value. If string TOGGLE is passed, the node will send toggle or start command to the Hapcan module, based on speed value.
</p>
<h3>Full control object definition</h3>
<p>
Passing the <i>object</i> (JSON) in <code>msg.payload</code> allows to control whole RGB module. Below are the possible properties list that can be specified.
If no property is specified the default node settings values will be used. Node will throw an error in case of invalid values.
</p>
<dl class="message-properties">
<dt>channel <span class="property-type">number | string </span></dt>
<dd>Single number value (1-4) or channel string name (RED, GREEN, BLUE, MASTER) of selected channel to perform the action.</dd>
<dt>state <span class="property-type">string | number | bool</span></dt></dt>
<dd>String, number or bool state value. See <code>msg.payload</code> description above for details.</dd>
<dt>speed <span class="property-type">number</span></dt></dt>
<dd>Animation time in seconds (0-255s). The speed value affect final instruction that node will send to the Hapcan module.
If speed = 0 the state will change instantly. Other values will change state softly. In UNIV 1.0.8 modules the speed can be set in
predefined times from 1, 5, 10, 15...60s. The current speed value will be rounded to available speed values.
</dd>
</dl>
<h3>References</h3>
<ul>
<li><a href="http://hapcan.com/devices/universal/univ_3/univ_3-8-0-x/index.htm">Hapcan RGB UNIV-3.8.X Controller</a> - module firmware notes.</li>
<li><a href="http://hapcan.com/devices/universal/univ_v1-0/univ_v1-0-8-1/index.htm">Hapcan RGB UNIV-1.0.8 Controller</a> - module firmware notes.</li>
</ul>
</script>
<script type="text/javascript">
RED.nodes.registerType('rgb-input',{
category: 'hapcan',
color: '#D3D3D3',
defaults: {
gateway: {type:"hapcan-gateway", required: true},
name: {value:""},
group: {value: 1, required: true, validate: function(val){return (val >= 0 && val < 256);} },
node: {value: 1, required: true, validate: function(val){return (val >= 0 && val < 256);}},
channelFilter: {value: 1, required: true,validate: function(val){return (val > 0 && val <= 256);}},
userFieldStateON: {value: ""},
userFieldStateOFF: {value: ""}
},
inputs:0,
outputs:1,
icon: "relay-output.png",
align: 'left',
label: function() {
return `${this.name||"rgb input"} (${Number(this.node) === 0 ? 'any' : this.node}, ${Number(this.group) === 0 ? 'any' : this.group})`;
},
labelStyle: function() { return this.name?"node_label_italic":""; } ,
oneditprepare: async function() {
let config = this
var nodeOptions = '';
var groupOptions = '';
var devicesOptions = null
var gatewaySelect = $('#node-input-gateway')
var devicesSelect = $("#node-input-devices")
var nodeSelect = $("#node-input-node")
var groupSelect = $("#node-input-group")
var currentDevice = null
var deviceList = []
gatewaySelect.change(function()
{
devicesOptions = ''
currentDevice = null
var selectedGatewayId = gatewaySelect.children('option[selected]').first().val()
if(selectedGatewayId == null)
selectedGatewayId = gatewaySelect.children("option").first().val()
var gateway = RED.nodes.node(selectedGatewayId)
if(gateway != null )
{
deviceList = gateway.devices.filter((d) => d.applicationType === 8)
deviceList.forEach( (device) => {
var selected = '';
if(Number(config.node) === device.node && Number(config.group) === device.group)
{
selected = 'selected="selected"'
currentDevice = device
}
devicesOptions += `<option ${selected} value="${device.id}">${device.description} (${device.node},${device.group})</option>`
})
}
devicesOptions += `<option ${currentDevice === null ? 'selected="selected"' : ''} value="0">(set node, group manually)</option>`
devicesSelect.empty().append(devicesOptions).trigger('change')
})
devicesSelect.on('change', function() {
if(Number(this.value) === 0)
{
nodeSelect.removeAttr('disabled')
groupSelect.removeAttr('disabled')
}
currentDevice = deviceList.find(v=>v.id === this.value)
if(currentDevice !== undefined) {
nodeSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.node}]`).prop('selected', true).trigger('change')
groupSelect.find('option').removeProp('selected').filter(`[value=${currentDevice.group}]`).prop('selected', true).trigger('change')
nodeSelect.attr('disabled', 'disabled')
groupSelect.attr('disabled', 'disabled')
}
})
for(var i = 0; i < 256; i++)
{
var selectedNode = '';
if((Number(this.node) === i))
selectedNode = 'selected="selected"';
let text = i === 0? 'any' : i
nodeOptions += `<option ${selectedNode} value="${i}">${text}</option>`
var selectedGroup = '';
if((Number(this.group) === i))
selectedGroup = 'selected="selected"';
groupOptions += `<option ${selectedGroup} value="${i}">${text}</option>`
}
nodeSelect.append(nodeOptions);
groupSelect.append(groupOptions);
if( this.channelFilter & 1 !== 0 )
$("#channel1").prop('checked', true);
if( (this.channelFilter & 2) !== 0 )
$("#channel2").prop('checked', true);
if( (this.channelFilter & 4) !== 0 )
$("#channel3").prop('checked', true);
if( (this.channelFilter & 8) !== 0 )
$("#channel4").prop('checked', true);
},
oneditsave: function(){
this.channelFilter = 0;
this.channelFilter |= $("#channel1").is(":checked") ? 1 : 0;
this.channelFilter |= $("#channel2").is(":checked") ? 2 : 0;
this.channelFilter |= $("#channel3").is(":checked") ? 4 : 0;
this.channelFilter |= $("#channel4").is(":checked") ? 8 : 0;
}
});
</script>
<script type="text/x-red" data-template-name="rgb-input">
<div class="form-row">
<label for="node-input-name"><i class="icon-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Device name">
</div>
<div class="form-row">
<label for="node-input-gateway"><i class="fa fa-globe"></i> Gateway</label>
<input type="text" id="node-input-gateway" placeholder="Gateway">
</div>
<div class="form-row">
<label for="node-input-devices"><i class="fa fa-microchip"></i> Device</label>
<select id="node-input-devices"></select>
</div>
<div class="form-row">
<label for="node-input-node"><i class="fa fa-cube"></i> Node</label>
<select id="node-input-node"></select>
</div>
<div class="form-row">
<label for="node-input-group"><i class="fa fa-cubes"></i> Group</label>
<select id="node-input-group"></select>
</div>
<div class="form-row">
<label for="node-input-channel" style="width: 150px;"><i class="fa fa-sign-out"></i> Channel filter</label><br>
<input style="width: 10%;" id="channel1" type="checkbox" value="1">Red
<input style="width: 10%;" id="channel2" type="checkbox" value="2">Green
<input style="width: 10%;" id="channel3" type="checkbox" value="4">Blue
<input style="width: 10%;" id="channel4" type="checkbox" value="8">Master
</div>
<hr>
<div class="form-row">
<label style="width: auto;"><i class="fa fa-envelope-o"></i> Set <b>userField</b> value for states:</label>
</div>
<div class="form-row">
<label style="padding-left: 25px; margin-right: -25px;" for="node-input-userFieldStateON"><i class="fa fa-circle"></i> ON</label>
<input type="text" id="node-input-userFieldStateON" >
</div>
<div class="form-row">
<label style="padding-left: 25px; margin-right: -25px;" for="node-input-userFieldStateOFF"><i class="fa fa-circle"></i> OFF</label>
<input type="text" id="node-input-userFieldStateOFF" >
</div>
</script>
<script type="text/x-red" data-help-name="rgb-input">
<p>Receives Hapcan RGB LED Controller UNIV-3.8.X status messages.</p>
<p>The node emit RGB status messages. It uses the Ethernet gateway to receive messages from Hapcan bus.</p>
<h3>Output</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">object</span></dt>
<dd>Hapcan message object with RGB module's state data.</dd>
<dt>topic <span class="property-type">string</span></dt>
<dd>Contains <i>RGB message</i> string.</dd>
</dl>
<h3>Details</h3>
<p>The <code>msg.payload</code> contains:
</p>
<dl class="message-properties">
<dt>frame <span class="property-type">Buffer[15]</span></dt>
<dd>15 bytes buffer containing raw Hapcan's CAN frame.</dd>
<dt>frameType <span class="property-type">number</span></dt>
<dd>Hapcan frame type number (decimal).</dd>
<dt>isAnswer <span class="property-type">bool</span></dt>
<dd><i>True</i> if message is an answer for request.</dd>
<dt>node <span class="property-type">number</span></dt>
<dd>Sender module node number.</dd>
<dt>group <span class="property-type">number</span></dt>
<dd>Sender module group number.</dd>
<dt>status <span class="property-type">number</span></dt>
<dd>Current channel output value 0x00-0xFF.</dd>
<dt>relay <span class="property-type">string</span></dt>
<dd>Current status of all channels. <i>OFF</i> if all channels are turned off, <i>ON</i> if
master channel and any other channel is turned on. The value is available only for
master channel message. In other cases the value is <i>undefined</i>.</dd>
<dt>enabled <span class="property-type">bool</span></dt>
<dd><i>True</i> if current channel is turned on.</dd>
<dt>channel <span class="property-type">number</span></dt>
<dd>Current channel number 0x01-0x04.</dd>
<dt>channelName <span class="property-type">string</span></dt>
<dd>String value of current channel. Can be <i>RED</i>, <i>GREEN</i>, <i>BLUE</i> or <i>MASTER</i>.</dd>
<dt>channelName <span class="property-type">string</span></dt>
<dd>Device's channel name that has changed.</dd>
<dt>deviceName <span class="property-type">string</span></dt>
<dd>Device's name that emits the message.</dd>
<dt>userField <span class="property-type">string</span></dt>
<dd>User defined value for each state.</dd>
</dl>
<p>
This node receives RGB LED Controller status messages of the selected module in group. The output is fired when channel filter matches the status message.
</p>
<h3>References</h3>
<ul>
<li><a href="http://hapcan.com/devices/universal/univ_3/univ_3-8-0-x/index.htm">Hapcan RGB UNIV-3.8.X Controller</a> - module firmware notes.</li>
<li><a href="http://hapcan.com/devices/universal/univ_v1-0/univ_v1-0-8-1/index.htm">Hapcan RGB UNIV-1.0.8 Controller</a> - module firmware notes.</li>
</ul>
</script>