-
Notifications
You must be signed in to change notification settings - Fork 1
/
daylight-rgbw.html
184 lines (170 loc) · 8.3 KB
/
daylight-rgbw.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
<!--
Daylight RGBW Color control Node for Node-RED
-------------------------------------------------------------------------------------------------------------------
Copyright (c) 2018 Raimond Brookman
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-->
<script type="text/x-red" data-template-name="daylight-rgbw">
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name">
</div>
<div class="form-row">
<label for="node-input-topic"><i class="fa fa-tasks"></i> Topic</label>
<input type="text" id="node-input-topic" placeholder="Topic">
</div>
<div class="form-row">
<label for="node-input-latitude"><i class="fa fa-map-marker"></i> Latitude</label>
<input type="text" id="node-input-latitude" placeholder="Latitude">
</div>
<div class="form-row">
<label for="node-input-longitude"><i class="fa fa-map-marker"></i> Longitude</label>
<input type="text" id="node-input-longitude" placeholder="Longitude">
</div>
<div class="form-row">
<label for="node-input-colorTempUnit"><i class="fa fa-tasks"></i>Output Color Temp. Unit</label>
<select style="width:26% !important" type="text" id="node-input-colorTempUnit" >
<option value="K">Kelvin</option>
<option value="M">Mired</option>
</select>
</div>
<div class="form-row">
<label for="node-input-minColorTemp"><i class="fa fa-tasks"></i> Min. Color Temp.(K)</label>
<input type="text" id="node-input-minColorTemp" placeholder="Min. Color Temp.">
</div>
<div class="form-row">
<label for="node-input-maxColorTemp"><i class="fa fa-tasks"></i> Max. Color Temp.(K)</label>
<input type="text" id="node-input-maxColorTemp" placeholder="Max. Color Temp.">
</div>
<div class="form-row">
<label for="node-input-whiteLevel"><i class="fa fa-tasks"></i> White Level</label>
<input type="text" id="node-input-whiteLevel" placeholder="White Level">
</div>
</script>
<script type="text/x-red" data-help-name="daylight-rgbw">
<h3>Inputs</h3>
Several types of input messages are handled, depending on their topic.
<ol class="node-ports">
<li>
<dl class="message-properties">
<dt>payload (topic:date-time)
<span class="property-type">Date</span>
</dt>
<dd> Date object, for instance as provided by the Inject node.</dd>
</dl>
</li>
<li>
<dl class="message-properties">
<dt>payload (topic:item-switch)
<span class="property-type">string</span>
</dt>
<dd> ON or OFF, to either enable sending output messages or not</dd>
</dl>
</li>
<li>
<dl class="message-properties">
<dt>payload (topic:color-temp)
<span class="property-type">number</span>
</dt>
<dd> Number to set a desired color tempurature in Kelvin directly.</dd>
</dl>
</li>
<li>
<dl class="message-properties">
<dt>payload (topic:white-level)
<span class="property-type">number</span>
</dt>
<dd> Number to set a desired brightness (white level).</dd>
</dl>
</li>
</ol>
<h3>Outputs</h3>
<ol class="node-ports">
<li> Red dim value
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>From 0 to 100 (precentage) brightness</dd>
</dl>
</li>
<li> Green dim value
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>From 0 to 100 (precentage) brightness</dd>
</dl>
</li>
<li> Blue dim value
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>From 0 to 100 (precentage) brightness</dd>
</dl>
</li>
<li> White dim value
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>From 0 to 100 (precentage) brightness</dd>
</dl>
</li>
<li> Color Temperature value
<dl class="message-properties">
<dt>payload <span class="property-type">number</span></dt>
<dd>Color temperature in configured unit (Kelvin or Mired)</dd>
</dl>
</li>
<h3>Details</h3>
<p>
This node offers the possibility to control the color of a RGBW ledstrip according to time of day.
This is done by calculating the angle of the sun with the horizon and project that on a color temperature scale.
Therefore it is important to correctly configure your longitude and lattitude.
</p>
<p>
Typically you choose a color tempurature of around 1000K for sunrise/sunset (sun at horizon) and a color temperature around 5500K for the highest point of the sun
But to tune it for your specific RGBW source you can tune these settings in the configuration.
The white level is kept constant and can be configured too.
When the item is switched off, it will still update the RGBW colors, so that when the light source is switched on it will drectly be set to the correct colors.
</p>
<p>
The typical setup is to:
<p>
<b> Have an external node to provide the current timestamp.</b>
For instance the Inject Node offers this.
Choose to provide the timestamp by interval to determine how often the colors will be updated.
</p>
<p>
<b> Have your RGB(W) node status attached to the input to provide ON or OFF</b>
<p>
This way you prevent the light source to come on each time when the color are updated.
This node is optimized to work directly with OpenHab2 nodes, but will work with any node as long as the topic is set to item-switch.
</p>
<p>
<b> Have your RGB(W) dimmer controls for the color channels connected to the outputs.</b>
</p>
</script>
<script type="text/javascript">
RED.nodes.registerType('daylight-rgbw',{
category: 'RGBW',
color:"#999999",
defaults: {
name: {value:""},
topic: {value:"daylight-rgbw", required:true},
latitude: {required:true, validate:RED.validators.number() },
longitude: {required:true, validate:RED.validators.number() },
minColorTemp: {value:1000, required:true, validate:RED.validators.number() },
maxColorTemp: {value:6000, required:true, validate:RED.validators.number()},
whiteLevel: {value:50, required:true, validate:RED.validators.number()},
colorTempUnit : {value:"K", required:true}
},
inputs:1,
outputs:5,
icon: "light.png", // saved in icons/myicon.png
label: function() { // sets the default label contents
return this.name||this.topic||"Daylight RGBW";
},
paletteLabel: "Daylight RGBW",
outputLabels: ["red","green","blue", "white", "colorTemp"],
labelStyle: function() { // sets the class to apply to the label
return this.name?"node_label_italic":"";
}
});
</script>