zigbee-herdsman-converters 21.9.0 → 21.9.2

package/lib/color.d.ts

@@ -0,0 +1,272 @@
+import { KeyValue, KeyValueAny, Tz, Zh } from './types';
+/**
+ * Class representing color in RGB space
+ */
+export declare class ColorRGB {
+    /**
+     * red component (0..1)
+     */
+    red: number;
+    /**
+     * green component (0..1)
+     */
+    green: number;
+    /**
+     * blue component (0..1)
+     */
+    blue: number;
+    /**
+     * Create RGB color
+     */
+    constructor(red: number, green: number, blue: number);
+    /**
+     * Create RGB color from object
+     * @param rgb - object with properties red, green and blue
+     * @returns new ColoRGB object
+     */
+    static fromObject(rgb: {
+        red: number;
+        green: number;
+        blue: number;
+    }): ColorRGB;
+    /**
+     * Create RGB color from hex string
+     * @param hex -hex encoded RGB color
+     * @returns new ColoRGB object
+     */
+    static fromHex(hex: string): ColorRGB;
+    /**
+     * Return this color with values rounded to given precision
+     * @param precision - decimal places to round to
+     */
+    rounded(precision: number): ColorRGB;
+    /**
+     * Convert to Object
+     * @returns object with properties red, green and blue
+     */
+    toObject(): {
+        red: number;
+        green: number;
+        blue: number;
+    };
+    /**
+     * Convert to HSV
+     *
+     * @returns color in HSV space
+     */
+    toHSV(): ColorHSV;
+    /**
+     * Convert to CIE
+     * @returns color in CIE space
+     */
+    toXY(): ColorXY;
+    /**
+     * Returns color after sRGB gamma correction
+     * @returns corrected RGB
+     */
+    gammaCorrected(): ColorRGB;
+    /**
+     * Returns color after reverse sRGB gamma correction
+     * @returns raw RGB
+     */
+    gammaUncorrected(): ColorRGB;
+    /**
+     * Create hex string from RGB color
+     * @returns hex hex encoded RGB color
+     */
+    toHEX(): string;
+}
+/**
+ *  Class representing color in CIE space
+ */
+export declare class ColorXY {
+    /** X component (0..1) */
+    x: number;
+    /** Y component (0..1) */
+    y: number;
+    /**
+     * Create CIE color
+     */
+    constructor(x: number, y: number);
+    /**
+     * Create CIE color from object
+     * @param xy - object with properties x and y
+     * @returns new ColorXY object
+     */
+    static fromObject(xy: {
+        x: number;
+        y: number;
+    }): ColorXY;
+    /**
+     * Create XY object from color temp in mireds
+     * @param mireds - color temp in mireds
+     * @returns color in XY space
+     */
+    static fromMireds(mireds: number): ColorXY;
+    /**
+     * Converts color in XY space to temperature in mireds
+     * @returns color temp in mireds
+     */
+    toMireds(): number;
+    /**
+     * Converts CIE color space to RGB color space
+     * From: https://github.com/usolved/cie-rgb-converter/blob/master/cie_rgb_converter.js
+     */
+    toRGB(): ColorRGB;
+    /**
+     * Convert to HSV
+     * @returns color in HSV space
+     */
+    toHSV(): ColorHSV;
+    /**
+     * Return this color with value rounded to given precision
+     * @param precision - decimal places to round to
+     */
+    rounded(precision: number): ColorXY;
+    /**
+     * Convert to object
+     * @returns object with properties x and y
+     */
+    toObject(): {
+        x: number;
+        y: number;
+    };
+}
+/**
+ * Class representing color in HSV space
+ */
+declare class ColorHSV {
+    /** hue component (0..360) */
+    hue: number;
+    /** saturation component (0..100) */
+    saturation: number;
+    /** value component (0..100) */
+    value: number;
+    /**
+     * Create color in HSV space
+     */
+    constructor(hue: number, saturation?: number, value?: number);
+    /**
+     * Create HSV color from object
+     */
+    static fromObject(hsv: {
+        hue?: number;
+        saturation?: number;
+        value: number;
+    }): ColorHSV;
+    /**
+     * Create HSV color from HSL
+     * @param hsl - color in HSL space
+     * @returns color in HSV space
+     */
+    static fromHSL(hsl: {
+        hue: number;
+        saturation: number;
+        lightness: number;
+    }): ColorHSV;
+    /**
+     * Return this color with value rounded to given precision
+     * @param precision - decimal places to round to
+     */
+    rounded(precision: number): ColorHSV;
+    /**
+     * Convert to object
+     * @param short - return h, s, v instead of hue, saturation, value
+     * @param includeValue - omit v(alue) from return
+     */
+    toObject(short?: boolean, includeValue?: boolean): {
+        h?: number;
+        hue?: number;
+        s?: number;
+        saturation?: number;
+        v?: number;
+        value?: number;
+    };
+    /**
+     * Convert RGB color
+     * @returns
+     */
+    toRGB(): ColorRGB;
+    /**
+     * Create CIE color from HSV
+     */
+    toXY(): ColorXY;
+    /**
+     * Create Mireds from HSV
+     * @returns color temp in mireds
+     */
+    toMireds(): number;
+    /**
+     * Returns color with missing properties set to defaults
+     * @returns HSV color
+     */
+    complete(): ColorHSV;
+    /**
+     * Interpolates hue value based on correction map through ranged linear interpolation
+     * @param hue - hue to be corrected
+     * @param correctionMap -  array of hueIn -\> hueOut mappings; example: `[ {"in": 20, "out": 25}, {"in": 109, "out": 104}]`
+     * @returns corrected hue value
+     */
+    static interpolateHue(hue: number, correctionMap: KeyValueAny[]): number;
+    /**
+     * Applies hue interpolation if entity has hue correction data
+     * @param hue - hue component of HSV color
+     * @returns corrected hue component of HSV color
+     */
+    static correctHue(hue: number, meta: Tz.Meta): number;
+    /**
+     * Returns HSV color after hue correction
+     * @param meta - entity meta object
+     * @returns hue corrected color
+     */
+    hueCorrected(meta: Tz.Meta): ColorHSV;
+    /**
+     * Returns HSV color after gamma and hue corrections
+     * @param meta - entity meta object
+     * @returns corrected color in HSV space
+     */
+    colorCorrected(meta: Tz.Meta): ColorHSV;
+}
+export declare class Color {
+    hsv: ColorHSV;
+    xy: ColorXY;
+    rgb: ColorRGB;
+    /**
+     * Create Color object
+     * @param hsv - ColorHSV instance
+     * @param rgb - ColorRGB instance
+     * @param xy - ColorXY instance
+     */
+    constructor(hsv: ColorHSV, rgb: ColorRGB, xy: ColorXY);
+    /**
+     * Create Color object from converter's value argument
+     * @param value - converter value argument
+     * @returns Color object
+     */
+    static fromConverterArg(value: any): Color;
+    /**
+     * Returns true if color is HSV
+     */
+    isHSV(): boolean;
+    /**
+     * Returns true if color is RGB
+     */
+    isRGB(): boolean;
+    /**
+     * Returns true if color is XY
+     */
+    isXY(): boolean;
+}
+/**
+ * Sync all color attributes
+ * NOTE: behavior can be disable by setting the 'color_sync' device/group option
+ * @param newState - state with only the changed attributes set
+ * @param oldState - state from the cache with all the old attributes set
+ * @param endpoint - with lightingColorCtrl cluster
+ * @param options - meta.options for the device or group
+ * @returns state with color, color_temp, and color_mode set and synchronized from newState's attributes
+ *          (other attributes are not included make sure to merge yourself)
+ */
+export declare function syncColorState(newState: KeyValueAny, oldState: KeyValueAny, endpoint: Zh.Endpoint | Zh.Group, options: KeyValue): KeyValueAny;
+export {};
+//# sourceMappingURL=color.d.ts.map

package/lib/color.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../src/lib/color.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,EAAC,MAAM,SAAS,CAAC;AAuBtD;;GAEG;AACH,qBAAa,QAAQ;IACjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;gBACS,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IASpD;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC;IAOjE;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAMrC;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ;IAIpC;;;OAGG;IACH,QAAQ,IAAI;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC;IAQtD;;;;OAIG;IACH,KAAK,IAAI,QAAQ;IAiCjB;;;OAGG;IACH,IAAI,IAAI,OAAO;IAef;;;OAGG;IACH,cAAc,IAAI,QAAQ;IAO1B;;;OAGG;IACH,gBAAgB,IAAI,QAAQ;IAO5B;;;OAGG;IACH,KAAK,IAAI,MAAM;CAclB;AAED;;GAEG;AACH,qBAAa,OAAO;IAChB,yBAAyB;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,yBAAyB;IACzB,CAAC,EAAE,MAAM,CAAC;IAEV;;OAEG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAOhC;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO;IAOtD;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAK1C;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAMlB;;;OAGG;IACH,KAAK,IAAI,QAAQ;IAqCjB;;;OAGG;IACH,KAAK,IAAI,QAAQ;IAIjB;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAInC;;;OAGG;IACH,QAAQ,IAAI;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC;CAMrC;AAED;;GAEG;AACH,cAAM,QAAQ;IACV,6BAA6B;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;gBACS,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,MAAa,EAAE,KAAK,GAAE,MAAa;IASxE;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,QAAQ;IAOpF;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,GAAG,QAAQ;IAUnF;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ;IAQpC;;;;OAIG;IACH,QAAQ,CACJ,KAAK,GAAE,OAAe,EACtB,YAAY,GAAE,OAAc,GAC7B;QAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC;IA0B1F;;;OAGG;IACH,KAAK,IAAI,QAAQ;IAiDjB;;OAEG;IACH,IAAI,IAAI,OAAO;IAIf;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;OAGG;IACH,QAAQ,IAAI,QAAQ;IAOpB;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,MAAM;IAkBxE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM;IAUrD;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,QAAQ;IAIrC;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,QAAQ;CAG1C;AAED,qBAAa,KAAK;IACd,GAAG,EAAE,QAAQ,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,GAAG,EAAE,QAAQ,CAAC;IAEd;;;;;OAKG;gBACS,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO;IAsBrD;;;;OAIG;IAEH,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK;IAuD1C;;OAEG;IACH,KAAK,IAAI,OAAO;IAIhB;;OAEG;IACH,KAAK,IAAI,OAAO;IAIhB;;OAEG;IACH,IAAI,IAAI,OAAO;CAGlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,GAAG,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,GAAG,WAAW,CAwH7I"}