Merge pull request #785 from Skaronator/CCT_Support

Implement CCT warm white and cold white LEDs for devices with 5 channels.

code/espurna/config/general.h

@@ -772,11 +772,8 @@
 #define LIGHT_MAX_BRIGHTNESS    255         // Maximun brightness value
 #endif
 
-//#define LIGHT_MIN_MIREDS        153       // NOT USED (yet)! // Default to the Philips Hue value that HA has always assumed
-//#define LIGHT_MAX_MIREDS        500       // NOT USED (yet)! // https://developers.meethue.com/documentation/core-concepts
-#ifndef LIGHT_DEFAULT_MIREDS
-#define LIGHT_DEFAULT_MIREDS    153         // Default value used by MQTT. This value is __NEVRER__ applied!
-#endif
+#define LIGHT_MIN_MIREDS        153      // Default to the Philips Hue value that HA also use.
+#define LIGHT_MAX_MIREDS        500      // https://developers.meethue.com/documentation/core-concepts
 
 #ifndef LIGHT_STEP
 #define LIGHT_STEP              32          // Step size
@@ -787,9 +784,18 @@
 #endif
 
 #ifndef LIGHT_USE_WHITE
-#define LIGHT_USE_WHITE         0           // Use white channel whenever RGB have the same value
+#define LIGHT_USE_WHITE         0           // Use the 4th channel as (Warm-)White LEDs
+#endif
+
+#ifndef LIGHT_USE_CCT
+#define LIGHT_USE_CCT           0           // Use the 5th channel as Coldwhite LEDs, LIGHT_USE_WHITE must be 1.
 #endif
 
+// Used when LIGHT_USE_WHITE AND LIGHT_USE_CCT is 1 - (1000000/Kelvin = MiReds)
+// Warning! Don't change this yet, NOT FULLY IMPLEMENTED!
+#define LIGHT_COLDWHITE_MIRED   153         // Coldwhite Strip, Value must be __BELOW__ W2!! (Default: 6535 Kelvin/153 MiRed)
+#define LIGHT_WARMWHITE_MIRED   500         // Warmwhite Strip, Value must be __ABOVE__ W1!! (Default: 2000 Kelvin/500 MiRed)
+
 #ifndef LIGHT_USE_GAMMA
 #define LIGHT_USE_GAMMA         0           // Use gamma correction for color channels
 #endif

code/espurna/light.ino

@@ -40,10 +40,11 @@ bool _light_use_transitions = false;
 unsigned int _light_transition_time = LIGHT_TRANSITION_TIME;
 bool _light_has_color = false;
 bool _light_use_white = false;
+bool _light_use_cct = false;
 bool _light_use_gamma = false;
 unsigned long _light_steps_left = 1;
 unsigned char _light_brightness = LIGHT_MAX_BRIGHTNESS;
-unsigned int _light_mireds = LIGHT_DEFAULT_MIREDS;
+unsigned int _light_mireds = round((LIGHT_COLDWHITE_MIRED+LIGHT_WARMWHITE_MIRED)/2);
 
 #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX
 #include <my92xx.h>
@@ -77,39 +78,64 @@ const unsigned char _light_gamma_table[] = {
 // -----------------------------------------------------------------------------
 
 void _setRGBInputValue(unsigned char red, unsigned char green, unsigned char blue) {
-    _light_channel[0].inputValue = red;
-    _light_channel[1].inputValue = green;
-    _light_channel[2].inputValue = blue;
+    _light_channel[0].inputValue = constrain(red, 0, LIGHT_MAX_VALUE);
+    _light_channel[1].inputValue = constrain(green, 0, LIGHT_MAX_VALUE);;
+    _light_channel[2].inputValue = constrain(blue, 0, LIGHT_MAX_VALUE);;
 }
 
 void _generateBrightness() {
 
     double brightness = (double) _light_brightness / LIGHT_MAX_BRIGHTNESS;
 
-    // Convert RGB to RGBW
+    // Convert RGB to RGBW(W)
     if (_light_has_color && _light_use_white) {
 
-        // Substract the common part from RGB channels and add it to white channel. So [250,150,50] -> [200,100,0,50
+        // Substract the common part from RGB channels and add it to white channel. So [250,150,50] -> [200,100,0,50]
         unsigned char white = std::min(_light_channel[0].inputValue, std::min(_light_channel[1].inputValue, _light_channel[2].inputValue));
         for (unsigned int i=0; i < 3; i++) {
             _light_channel[i].value = _light_channel[i].inputValue - white;
         }
-        _light_channel[3].value = white;
-        _light_channel[3].inputValue = 0;
+
+        // Split the White Value across 2 White LED Strips.
+        if (_light_use_cct) {
+
+          // This change the range from 153-500 to 0-347 so we get a value between 0 and 1 in the end.
+          double miredFactor = ((double) _light_mireds - (double) LIGHT_COLDWHITE_MIRED)/((double) LIGHT_WARMWHITE_MIRED - (double) LIGHT_COLDWHITE_MIRED);
+
+          // set cold white
+          _light_channel[3].inputValue = 0;
+          _light_channel[3].value = round(((double) 1.0 - miredFactor) * white);
+
+          // set warm white
+          _light_channel[4].inputValue = 0;
+          _light_channel[4].value = round(miredFactor * white);
+        } else {
+          _light_channel[3].inputValue = 0;
+          _light_channel[3].value = white;
+        }
 
         // Scale up to equal input values. So [250,150,50] -> [200,100,0,50] -> [250, 125, 0, 63]
         unsigned char max_in = std::max(_light_channel[0].inputValue, std::max(_light_channel[1].inputValue, _light_channel[2].inputValue));
         unsigned char max_out = std::max(std::max(_light_channel[0].value, _light_channel[1].value), std::max(_light_channel[2].value, _light_channel[3].value));
+        unsigned char channelSize = _light_use_cct ? 5 : 4;
+
+        if (_light_use_cct) {
+          max_out = std::max(max_out, _light_channel[4].value);
+        }
+
         double factor = (max_out > 0) ? (double) (max_in / max_out) : 0;
-        for (unsigned int i=0; i < 4; i++) {
+        for (unsigned char i=0; i < channelSize; i++) {
             _light_channel[i].value = round((double) _light_channel[i].value * factor * brightness);
         }
 
         // Scale white channel to match brightness
-        _light_channel[3].value = constrain(_light_channel[3].value * LIGHT_WHITE_FACTOR, 0, 255);
+        for (unsigned char i=3; i < channelSize; i++) {
+            _light_channel[i].value = constrain(_light_channel[i].value * LIGHT_WHITE_FACTOR, 0, LIGHT_MAX_BRIGHTNESS);
+        }
 
-        // For the rest of channels, don't apply brightness, it is already in the target:
-        for (unsigned char i=4; i < _light_channel.size(); i++) {
+        // For the rest of channels, don't apply brightness, it is already in the inputValue
+        // i should be 4 when RGBW and 5 when RGBWW
+        for (unsigned char i=channelSize; i < _light_channel.size(); i++) {
             _light_channel[i].value = _light_channel[i].inputValue;
         }
 
@@ -155,16 +181,10 @@ void _fromRGB(const char * rgb) {
         }
         break;
       case 'M': // Mired Value
-        if (_light_has_color) {
-            unsigned long mireds = atol(p + 1);
-            _fromMireds(mireds);
-        }
+          _fromMireds(atol(p + 1));
         break;
       case 'K': // Kelvin Value
-        if (_light_has_color) {
-            unsigned long kelvin = atol(p + 1);
-            _fromKelvin(kelvin);
-        }
+          _fromKelvin(atol(p + 1));
         break;
       default: // assume decimal values separated by commas
         char * tok;
@@ -257,13 +277,18 @@ void _fromHSV(const char * hsv) {
 // https://github.com/stelgenhof/AiLight
 void _fromKelvin(unsigned long kelvin, bool setMireds) {
 
-    // Check we have RGB channels
     if (!_light_has_color) return;
 
     if (setMireds) {
-      _light_mireds = round(1000000UL / kelvin);
+      _light_mireds = constrain(round(1000000UL / kelvin), LIGHT_MIN_MIREDS, LIGHT_MAX_MIREDS);
     }
 
+    if (_light_use_cct) {
+      _setRGBInputValue(LIGHT_MAX_VALUE, LIGHT_MAX_VALUE, LIGHT_MAX_VALUE);
+      return;
+    }
+
+
     // Calculate colors
     unsigned int red = (kelvin <= 66)
         ? LIGHT_MAX_VALUE
@@ -277,11 +302,7 @@ void _fromKelvin(unsigned long kelvin, bool setMireds) {
             ? 0
             : 138.5177312231 * log(kelvin - 10) - 305.0447927307);
 
-    _setRGBInputValue(
-        constrain(red, 0, LIGHT_MAX_VALUE),
-        constrain(green, 0, LIGHT_MAX_VALUE),
-        constrain(blue, 0, LIGHT_MAX_VALUE)
-    );
+    _setRGBInputValue(red, green, blue);
 }
 
 void _fromKelvin(unsigned long kelvin) {
@@ -290,8 +311,15 @@ void _fromKelvin(unsigned long kelvin) {
 
 // Color temperature is measured in mireds (kelvin = 1e6/mired)
 void _fromMireds(unsigned long mireds) {
-    if (mireds == 0) mireds = 1;
-    _light_mireds = mireds;
+    if (!_light_has_color) return;
+
+    _light_mireds = mireds = constrain(mireds, LIGHT_MIN_MIREDS, LIGHT_MAX_MIREDS);
+
+    if (_light_use_cct) {
+      _setRGBInputValue(LIGHT_MAX_VALUE, LIGHT_MAX_VALUE, LIGHT_MAX_VALUE);
+      return;
+    }
+
     unsigned long kelvin = constrain(1000000UL / mireds, 1000, 40000) / 100;
     _fromKelvin(kelvin, false);
 }
@@ -313,15 +341,15 @@ void _toRGB(char * rgb, size_t len) {
 }
 
 void _toHSV(char * hsv, size_t len) {
-    double min, max, h, s, v;
+    double h, s, v;
     double brightness = (double) _light_brightness / LIGHT_MAX_BRIGHTNESS;
 
     double r = (double) (_light_channel[0].inputValue * brightness) / 255.0;
     double g = (double) (_light_channel[1].inputValue * brightness) / 255.0;
     double b = (double) (_light_channel[2].inputValue * brightness) / 255.0;
 
-    min = std::min(r, std::min(g, b));
-    max = std::max(r, std::max(g, b));
+    double min = std::min(r, std::min(g, b));
+    double max = std::max(r, std::max(g, b));
 
     v = 100.0 * max;
     if (v == 0) {
@@ -447,6 +475,7 @@ void _lightColorSave() {
         setSetting("ch", i, _light_channel[i].inputValue);
     }
     setSetting("brightness", _light_brightness);
+    setSetting("mireds", _light_mireds);
     saveSettings();
 }
 
@@ -455,6 +484,7 @@ void _lightColorRestore() {
         _light_channel[i].inputValue = getSetting("ch", i, i==0 ? 255 : 0).toInt();
     }
     _light_brightness = getSetting("brightness", LIGHT_MAX_BRIGHTNESS).toInt();
+    _light_mireds = getSetting("mireds", _light_mireds).toInt();
     lightUpdate(false, false);
 }
 
@@ -757,6 +787,10 @@ void _lightWebSocketOnSend(JsonObject& root) {
     bool useRGB = getSetting("useRGB", LIGHT_USE_RGB).toInt() == 1;
     root["useRGB"] = useRGB;
     if (_light_has_color) {
+        if (_light_use_cct) {
+            root["useCCT"] = _light_use_cct;
+            root["mireds"] = _light_mireds;
+        }
         if (useRGB) {
             root["rgb"] = lightColor(true);
             root["brightness"] = lightBrightness();
@@ -786,6 +820,12 @@ void _lightWebSocketOnAction(uint32_t client_id, const char * action, JsonObject
                 lightUpdate(true, true);
             }
         }
+        if (_light_use_cct) {
+          if (strcmp(action, "mireds") == 0) {
+              _fromMireds(data["mireds"]);
+              lightUpdate(true, true);
+          }
+        }
     }
 
     if (strcmp(action, "channel") == 0) {
@@ -967,6 +1007,12 @@ void _lightConfigure() {
         setSetting("useWhite", _light_use_white);
     }
 
+    _light_use_cct = getSetting("useCCT", LIGHT_USE_CCT).toInt() == 1;
+    if (_light_use_cct && ((_light_channel.size() < 5) || !_light_use_white)) {
+        _light_use_cct = false;
+        setSetting("useCCT", _light_use_cct);
+    }
+
     _light_use_gamma = getSetting("useGamma", LIGHT_USE_GAMMA).toInt() == 1;
     _light_use_transitions = getSetting("useTransitions", LIGHT_USE_TRANSITIONS).toInt() == 1;
     _light_transition_time = getSetting("lightTime", LIGHT_TRANSITION_TIME).toInt();

code/html/custom.js

@@ -13,6 +13,7 @@ var numReconnect = 0;
 var numReload = 0;
 
 var useWhite = false;
+var useCCT = false;
 
 var now = 0;
 var ago = 0;
@@ -804,6 +805,22 @@ function initColorRGB() {
 
 }
 
+function initCCT() {
+
+  // check if already initialized
+  var done = $("#cct > div").length;
+  if (done > 0) { return; }
+
+  $("#miredsTemplate").children().clone().appendTo("#cct");
+
+  $("#mireds").on("change", function() {
+    var value = $(this).val();
+    var parent = $(this).parents(".pure-g");
+    $("span", parent).html(value);
+    sendAction("mireds", {mireds: value});
+  });
+}
+
 function initColorHSV() {
 
     // check if already initialized
@@ -841,6 +858,9 @@ function initChannels(num) {
         max = num % 3;
         if ((max > 0) & useWhite) {
             max--;
+            if (useCCT) {
+              max--;
+            }
         }
     }
     var start = num - max;
@@ -1021,10 +1041,21 @@ function processData(data) {
             return;
         }
 
+        if ("mireds" === key) {
+            $("#mireds").val(value);
+            $("span.mireds").html(value);
+            return;
+        }
+
         if ("useWhite" === key) {
             useWhite = value;
         }
 
+        if ("useCCT" === key) {
+            initCCT();
+            useCCT = value;
+        }
+
         // ---------------------------------------------------------------------
         // Sensors & Magnitudes
         // ---------------------------------------------------------------------

code/html/index.html

@@ -179,6 +179,8 @@
 
                                 <div id="colors"></div>
 
+                                <div id="cct"></div>
+
                                 <div id="channels"></div>
 
                                 <div id="magnitudes"></div>
@@ -410,12 +412,20 @@
                                     <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useWhite" action="reload" tabindex="9" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
-                                    <div class="pure-u-1 pure-u-lg-3-4 hint">Use forth dimmable channel as white when first 3 have the same RGB value.<br />Will only work if the device has at least 4 dimmable channels.<br />Enabling this will render useless the "Channel 4" slider in the status page.<br />Reload the page to update the web interface.</div>
+                                    <div class="pure-u-1 pure-u-lg-3-4 hint">Use forth dimmable channel as (cold) white light calculated out of the RGB values.<br />Will only work if the device has at least 4 dimmable channels.<br />Enabling this will render useless the "Channel 4" slider in the status page.<br />Reload the page to update the web interface.</div>
+                                </div>
+
+                                <div class="pure-g">
+                                    <label class="pure-u-1 pure-u-lg-1-4">Use white color temperature</label>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useCCT" action="reload" tabindex="10" /></div>
+                                    <div class="pure-u-0 pure-u-lg-1-2"></div>
+                                    <div class="pure-u-0 pure-u-lg-1-4"></div>
+                                    <div class="pure-u-1 pure-u-lg-3-4 hint">Use fifth dimmable channel as warm white light and the forth dimmable channel as cold white.<br />Will only work if the device has at least 5 dimmable channels and "white channel" above is also ON.<br />Enabling this will render useless the "Channel 5" slider in the status page.<br />Reload the page to update the web interface.</div>
                                 </div>
 
                                 <div class="pure-g">
                                     <label class="pure-u-1 pure-u-lg-1-4">Use gamma correction</label>
-                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useGamma" tabindex="10" /></div>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useGamma" tabindex="11" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">Use gamma correction for RGB channels.<br />Will only work if "use colorpicker" above is also ON.</div>
@@ -423,7 +433,7 @@
 
                                 <div class="pure-g">
                                     <label class="pure-u-1 pure-u-lg-1-4">Use CSS style</label>
-                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useCSS" tabindex="11" /></div>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useCSS" tabindex="12" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">Use CSS style to report colors to MQTT and REST API. <br />Red will be reported as "#FF0000" if ON, otherwise "255,0,0"</div>
@@ -431,7 +441,7 @@
 
                                 <div class="pure-g">
                                     <label class="pure-u-1 pure-u-lg-1-4">Color transitions</label>
-                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useTransitions" tabindex="12" /></div>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="useTransitions" tabindex="13" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">If enabled color changes will be smoothed.</div>
@@ -439,7 +449,7 @@
 
                                 <div class="pure-g">
                                     <label class="pure-u-1 pure-u-lg-1-4">Transition time</label>
-                                    <div class="pure-u-1 pure-u-lg-1-4"><input class="pure-u-1" type="number" name="lightTime" min="10" max="5000" tabindex="13" /></div>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input class="pure-u-1" type="number" name="lightTime" min="10" max="5000" tabindex="14" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-2"></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">Time in millisecons to transition from one color to another.</div>
@@ -447,7 +457,7 @@
 
                                 <div class="pure-g">
                                     <div class="pure-u-1 pure-u-lg-1-4"><label>MQTT group</label></div>
-                                    <div class="pure-u-1 pure-u-lg-3-4"><input name="mqttGroupColor" class="pure-u-1" tabindex="14" action="reconnect" /></div>
+                                    <div class="pure-u-1 pure-u-lg-3-4"><input name="mqttGroupColor" class="pure-u-1" tabindex="15" action="reconnect" /></div>
                                     <div class="pure-u-0 pure-u-lg-1-4"></div>
                                     <div class="pure-u-1 pure-u-lg-3-4 hint">Sync color between different lights.</div>
                                 </div>
@@ -1405,6 +1415,14 @@
             </div>
         </div>
 
+        <div id="miredsTemplate" class="template">
+            <div class="pure-g">
+                <label class="pure-u-1 pure-u-lg-1-4">Mireds (Cold &harr; Warm)</label>
+                <input type="range" min="153" max="500" class="slider pure-u-lg-1-4" id="mireds">
+                <span class="slider mireds pure-u-lg-1-4"></span>
+            </div>
+        </div>
+
         <div id="magnitudeTemplate" class="template">
             <div class="pure-g">
                 <label class="pure-u-1 pure-u-lg-1-4"></label>