feat: Improves handling of color temperature.

This features allows more granular control over how this plugin perceives the color temperature that it gets reported from Tuya.

Author: milo526

config.schema.json

@@ -161,6 +161,20 @@
               "description": "The brightness value that Tuya returns when your light is at its brightest.",
               "required": false
             },
+            "min_kelvin": {
+              "title": "Minimal Kelvin",
+              "type": "string",
+              "pattern": "^-?\\d+$",
+              "description": "The kelvin value that Tuya returns when your light is at its warmest (most red).",
+              "required": false
+            },
+            "max_kelvin": {
+              "title": "Maximal Brightness",
+              "type": "string",
+              "pattern": "^-?\\d+$",
+              "description": "The kelvin value that Tuya returns when your light is at its coolest (most blue).",
+              "required": false
+            },
             "current_temperature_factor": {
               "title": "Temperature Factor",
               "type": "string",
@@ -316,13 +330,25 @@
             {
               "key": "defaults[].min_brightness",
               "condition": {
-                "functionBody": "return (model.defaults[arrayIndices].device_type == 'light')"
+                "functionBody": "return (model.defaults[arrayIndices].light_characteristics?.includes('Brightness'))"
               }
             },
             {
               "key": "defaults[].max_brightness",
               "condition": {
-                "functionBody": "return (model.defaults[arrayIndices].device_type == 'light')"
+                "functionBody": "return (model.defaults[arrayIndices].light_characteristics?.includes('Brightness'))"
+              }
+            },
+            {
+              "key": "defaults[].min_kelvin",
+              "condition": {
+                "functionBody": "return (model.defaults[arrayIndices].light_characteristics?.includes('Color Temperature'))"
+              }
+            },
+            {
+              "key": "defaults[].max_kelvin",
+              "condition": {
+                "functionBody": "return (model.defaults[arrayIndices].light_characteristics?.includes('Color Temperature'))"
               }
             },
             {

src/accessories/characteristics/active.ts

@@ -55,7 +55,8 @@ export class ActiveCharacteristic extends TuyaWebCharacteristic {
       );
       callback && callback(null, stateValue);
     } else {
-      callback && callback(new Error("Could not get state from data"));
+      callback &&
+        callback(new Error("Could not find required property 'state'"));
     }
   }
 }

src/accessories/characteristics/colorTemperature.ts

@@ -1,7 +1,9 @@
 import {
+  Characteristic,
   CharacteristicGetCallback,
   CharacteristicSetCallback,
   CharacteristicValue,
+  Formats,
 } from "homebridge";
 import { TuyaWebCharacteristic } from "./base";
 import { MapRange } from "../../helpers/MapRange";
@@ -22,7 +24,36 @@ export class ColorTemperatureCharacteristic extends TuyaWebCharacteristic {
     return accessory.deviceConfig.data.color_temp !== undefined;
   }
 
-  private rangeMapper = MapRange.tuya(140, 500).homeKit(10000, 1000);
+  public setProps(char?: Characteristic): Characteristic | undefined {
+    return char?.setProps({
+      format: Formats.INT,
+      minValue: this.minHomekit,
+      maxValue: this.maxHomekit,
+    });
+  }
+
+  public get minKelvin(): number {
+    const data = this.accessory.deviceConfig.config;
+    return Number(data?.min_kelvin) || 1000000 / 500;
+  }
+
+  public get maxKelvin(): number {
+    const data = this.accessory.deviceConfig.config;
+    return Number(data?.max_kelvin) || 1000000 / 140;
+  }
+
+  public get minHomekit(): number {
+    return 1000000 / this.maxKelvin;
+  }
+
+  public get maxHomekit(): number {
+    return 1000000 / this.minKelvin;
+  }
+
+  public rangeMapper = MapRange.tuya(this.maxKelvin, this.minKelvin).homeKit(
+    this.minHomekit,
+    this.maxHomekit
+  );
 
   public getRemoteValue(callback: CharacteristicGetCallback): void {
     this.accessory
@@ -46,7 +77,7 @@ export class ColorTemperatureCharacteristic extends TuyaWebCharacteristic {
     }
 
     // Set device state in Tuya Web API
-    const value = Math.round(this.rangeMapper.tuyaToHomekit(homekitValue));
+    const value = Math.round(this.rangeMapper.homekitToTuya(homekitValue));
 
     this.accessory
       .setDeviceState("colorTemperatureSet", { value }, { color_temp: value })
@@ -59,15 +90,38 @@ export class ColorTemperatureCharacteristic extends TuyaWebCharacteristic {
 
   updateValue(data: DeviceState, callback?: CharacteristicGetCallback): void {
     if (data?.color_temp !== undefined) {
+      const tuyaValue = data.color_temp;
       const homekitColorTemp = Math.round(
-        this.rangeMapper.homekitToTuya(Number(data.color_temp))
+        this.rangeMapper.tuyaToHomekit(Number(data.color_temp))
       );
+
+      if (homekitColorTemp > this.maxHomekit) {
+        this.warn(
+          "Characteristic 'ColorTemperature' will receive value higher than allowed mired (%s) since provided Tuya kelvin value (%s) " +
+            "is lower then configured minimum Tuya kelvin value (%s). Please update your configuration!",
+          homekitColorTemp,
+          tuyaValue,
+          this.rangeMapper.tuyaStart
+        );
+      } else if (homekitColorTemp < this.minHomekit) {
+        this.warn(
+          "Characteristic 'ColorTemperature' will receive value lower than allowed mired (%s) since provided Tuya kelvin value (%s) " +
+            "exceeds configured maximum Tuya kelvin value (%s). Please update your configuration!",
+          homekitColorTemp,
+          tuyaValue,
+          this.rangeMapper.tuyaEnd
+        );
+      }
+
       this.accessory.setCharacteristic(
         this.homekitCharacteristic,
         homekitColorTemp,
         !callback
       );
       callback && callback(null, homekitColorTemp);
+    } else {
+      callback &&
+        callback(new Error("Could not find required property 'color_temp'"));
     }
   }
 }

src/accessories/characteristics/on.ts

@@ -55,7 +55,8 @@ export class OnCharacteristic extends TuyaWebCharacteristic {
       );
       callback && callback(null, stateValue);
     } else {
-      callback && callback(new Error("Could not get state from data"));
+      callback &&
+        callback(new Error("Could not find required property 'state'"));
     }
   }
 }

src/config.ts

@@ -15,6 +15,8 @@ export type TuyaDeviceDefaults = {
   cover_characteristics: "Stop"[];
   min_brightness: string | number;
   max_brightness: string | number;
+  min_kelvin: string | number;
+  max_kelvin: string | number;
 };
 
 type Config = {