0.3.0 Kelvin2RGB

Author: RobTillaart

libraries/Kelvin2RGB/CHANGELOG.md

@@ -6,7 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.2.0] - 2023-02-19
+## [0.3.0] - 2025-02-01
+- remove **reset()**
+- update readme.md + comments
+- minor edits
+
+----
+
+## [0.2.0] - 2024-02-19
 - fix in Tanner Helland (very minor).
 - remove dead link from readme.md.
 - removed experimental from code.

libraries/Kelvin2RGB/Kelvin2RGB.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: Kelvin2RGB.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 //    DATE: 2018-01-31
 // PURPOSE: Arduino library for converting temperature to RGB values
 //     URL: https://github.com/RobTillaart/Kelvin2RGB
@@ -22,7 +22,7 @@ Kelvin2RGB::Kelvin2RGB()
 void Kelvin2RGB::begin()
 {
   _temperature = 0;
-  _brightness  = 0;          //  default = darkness
+  _brightness  = 0;          //  default == darkness
   _red   = 0;
   _green = 0;
   _blue  = 0;

libraries/Kelvin2RGB/Kelvin2RGB.h

@@ -2,13 +2,13 @@
 //
 //    FILE: Kelvin2RGB.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 //    DATE: 2018-01-31
 // PURPOSE: Arduino library for converting temperature to RGB values
 //     URL: https://github.com/RobTillaart/Kelvin2RGB
 
 
-#define KELVIN2RGB_LIB_VERSION            (F("0.2.0"))
+#define KELVIN2RGB_LIB_VERSION            (F("0.3.0"))
 
 #include "Arduino.h"
 
@@ -19,7 +19,7 @@
 
 
 
-//  Values in table below based on 
+//  Values in table below based on
 //  https://en.wikipedia.org/wiki/Color_temperature#Categorizing_different_lighting
 //
 //             DAY LIGHT SETTING   = TEMPERATURE
@@ -57,12 +57,11 @@ class Kelvin2RGB
 
   //  resets all variables to zero.
   void begin();
-  [[deprecated("Use begin() instead")]]
-  void reset() { begin(); };  //  obsolete 0.3.0
+
 
   //  temperature = 0..65500   brightness = 0.0 .. 100.0%
-  void convert_TH(float temperature, float brightness = 100.0);
-  void convert_NB(float temperature, float brightness = 100.0);
+  void convert_TH(float temperature, float brightness = 100.0);  //  Tanner-Helland algorithm
+  void convert_NB(float temperature, float brightness = 100.0);  //  Neil Bartlett algorithm
 
   float    temperature();
   float    brightness();
@@ -77,10 +76,11 @@ class Kelvin2RGB
   //  returns RGB.
   uint32_t setRGB(float red, float green, float blue, float brightness = 100.0);
 
-  uint32_t RGB();       //  32 bit colour  (only 3 bytes used)
-  uint16_t RGB565();    //  16 bit colour  (2 bytes)
-  uint32_t BGR();
-  uint32_t CMYK();
+  //  other color schemes, more space efficient as 3 floats.
+  uint32_t RGB();       //  32 bit colour  (3 bytes used)
+  uint16_t RGB565();    //  16 bit colour  (2 bytes, compact)
+  uint32_t BGR();       //  32 bit colour  (3 bytes used)
+  uint32_t CMYK();      //  32 bit colour  (4 bytes used)
 
 
 private:

libraries/Kelvin2RGB/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2024 Rob Tillaart
+Copyright (c) 2018-2025 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

libraries/Kelvin2RGB/README.md

@@ -11,7 +11,7 @@
 
 # Kelvin2RGB
 
-Arduino library for converting temperature and brightness to RGB values.
+Arduino library for converting Kelvin temperature and brightness to RGB values.
 
 
 ## Credentials
@@ -62,20 +62,20 @@ Especially with images with more than 8 bits per channel this is preferred.
 That said it is also possible to use this on a 565 image or to adjust colour lookup tables.
 
 
-#### Celsius and Fahrenheit
+### Celsius and Fahrenheit
 
 To use Celsius or Fahrenheit with the **Kelvin2RGB** library, 
 one need to convert that temperature to Kelvin.
 
 ```cpp
 Kelvin = Celsius + 273.15;
-Kelvin = (Fahrenheit - 32) * 5 / 9 - 273.15;
+Kelvin = (Fahrenheit - 32) * 5.0 / 9.0 - 273.15;
 // or shorter
 Kelvin = (Fahrenheit - 523.67) * 0.5555555555;
 ```
 
 
-#### Related
+### Related
 
 - https://github.com/RobTillaart/Kelvin2RGB
 - https://github.com/RobTillaart/map2colour   map float onto a colour(gradient).
@@ -90,14 +90,14 @@ Kelvin = (Fahrenheit - 523.67) * 0.5555555555;
 
 The interface is straightforward:
 
-#### Constructor
+### Constructor
 
 - **Kelvin2RGB()** constructor.
 - **void begin()** resets all internal values to 0. 
     All colours, brightness and temperature.
 
 
-#### Convertors
+### Convertors
 
 - **void convert_TH(float temperature, float brightness = 100)**
     temperature = 0..65500   temperature below 1000 is not well defined.
@@ -114,7 +114,7 @@ The interface is straightforward:
 - **float blue()** returns blue channel weight 0.0 .. 1.0
 
 
-#### Color types
+### Color types
 
 - **uint32_t setRGB(float red, float green, float blue, float brightness = 100)** sets RGB values
     red, green, blue should be in 0 .. 1.0 range. brightness should be in 0..100%, Default = 100%.
@@ -126,14 +126,41 @@ The interface is straightforward:
 - **uint32_t CMYK()** returns a 32 bit = 4 byte CMYK value,
 
 
-#### Obsolete
+### Obsolete
 
 - **void reset()** => replaced by **begin()**
 
 
 ## Predefined colors
 
 
+```cpp
+const uint16_t DLS_dark            =     0;
+const uint16_t DLS_match           =  1700;
+const uint16_t DLS_sodiumLamp      =  1700;
+const uint16_t DLS_candleFlame     =  1850;
+const uint16_t DLS_sunrise         =  1850;
+const uint16_t DLS_sunset          =  1850;
+const uint16_t DLS_bulb            =  2400;
+const uint16_t DLS_bulbSoftWhite   =  2550;
+const uint16_t DLS_LEDlamp         =  2700;
+const uint16_t DLS_warmWhite       =  3000;
+const uint16_t DLS_studioLight     =  3200;
+const uint16_t DLS_studioCPlight   =  3350;
+const uint16_t DLS_daylightHorizon =  5000;
+const uint16_t DLS_flashLight      =  5700;
+const uint16_t DLS_xenonLight      =  6200;
+const uint16_t DLS_dayLightBright  =  6500;
+const uint16_t DLS_normal          =  6500;
+const uint16_t DLS_screenLow       =  6500;
+const uint16_t DLS_screenMed       =  8000;
+const uint16_t DLS_screenHigh      =  9500;
+const uint16_t DLS_polewardSky0    = 15000;
+const uint16_t DLS_polewardSky1    = 19000;
+const uint16_t DLS_polewardSky2    = 23000;
+const uint16_t DLS_polewardSky3    = 27000;
+```
+
 
 ## Future
 
@@ -149,7 +176,6 @@ The interface is straightforward:
 - investigate other formulas.
 - investigate usability for RGB led strip.
 - separate brightness per colour channel to mimic "artificial illumination"
-- remove begin() or reset()?
 - add examples
   - ledstrip
 - use a "dirty flag" to minimize math operations.

libraries/Kelvin2RGB/keywords.txt

@@ -4,6 +4,8 @@
 Kelvin2RGB	KEYWORD1
 
 # Methods and Functions (KEYWORD2)
+begin	KEYWORD2
+
 convert_TH	KEYWORD2
 convert_NB	KEYWORD2
 temperature	KEYWORD2

libraries/Kelvin2RGB/library.json

@@ -1,7 +1,7 @@
 {
   "name": "Kelvin2RGB",
   "keywords": "RGB,BGR,RGB565,CMYK,temperature",
-  "description": "Arduino library for converting temperature to RGB values",
+  "description": "Arduino library for converting Kelvin temperature to RGB values. Tanner Helland Bartlett",
   "authors":
   [
     {
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/Kelvin2RGB.git"
   },
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/Kelvin2RGB/library.properties

@@ -1,9 +1,9 @@
 name=Kelvin2RGB
-version=0.2.0
+version=0.3.0
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
-sentence=Arduino library for converting temperature to RGB values
-paragraph=
+sentence=Arduino library for converting Kelvin temperature to RGB values
+paragraph=Tanner Helland Bartlett
 category=Sensors
 url=https://github.com/RobTillaart/Kelvin2RGB
 architectures=*