yoctolib-esm

/********************************************************************* * * $Id: svn_id $ * * Implements the high-level API for ColorLedCluster functions * * - - - - - - - - - License information: - - - - - - - - - * * Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland. * * Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual * non-exclusive license to use, modify, copy and integrate this * file into your software for the sole purpose of interfacing * with Yoctopuce products. * * You may reproduce and distribute copies of this file in * source or object form, as long as the sole purpose of this * code is to interface with Yoctopuce products. You must retain * this notice in the distributed source file. * * You should refer to Yoctopuce General Terms and Conditions * for additional information regarding your rights and * obligations. * * THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT * WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING * WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO * EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL, * INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, * COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR * SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT * LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR * CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE * BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF * WARRANTY, OR OTHERWISE. * *********************************************************************/ import { YAPIContext, YFunction } from './yocto_api.js'; /** * YColorLedCluster Class: RGB LED cluster control interface, available for instance in the * Yocto-Color-V2, the Yocto-MaxiBuzzer or the Yocto-MaxiKnob * * The YColorLedCluster class allows you to drive a * color LED cluster. Unlike the ColorLed class, the YColorLedCluster * class allows to handle several LEDs at once. Color changes can be done using RGB * coordinates as well as HSL coordinates. * The module performs all conversions form RGB to HSL automatically. It is then * self-evident to turn on a LED with a given hue and to progressively vary its * saturation or lightness. If needed, you can find more information on the * difference between RGB and HSL in the section following this one. */ export declare class YColorLedCluster extends YFunction { _className: string; _activeLedCount: number; _ledType: YColorLedCluster.LEDTYPE; _maxLedCount: number; _dynamicLedCount: number; _blinkSeqMaxCount: number; _blinkSeqMaxSize: number; _command: string; _valueCallbackColorLedCluster: YColorLedCluster.ValueCallback | null; readonly ACTIVELEDCOUNT_INVALID: number; readonly LEDTYPE_RGB: YColorLedCluster.LEDTYPE; readonly LEDTYPE_RGBW: YColorLedCluster.LEDTYPE; readonly LEDTYPE_WS2811: YColorLedCluster.LEDTYPE; readonly LEDTYPE_INVALID: YColorLedCluster.LEDTYPE; readonly MAXLEDCOUNT_INVALID: number; readonly DYNAMICLEDCOUNT_INVALID: number; readonly BLINKSEQMAXCOUNT_INVALID: number; readonly BLINKSEQMAXSIZE_INVALID: number; readonly COMMAND_INVALID: string; static readonly ACTIVELEDCOUNT_INVALID: number; static readonly LEDTYPE_RGB: YColorLedCluster.LEDTYPE; static readonly LEDTYPE_RGBW: YColorLedCluster.LEDTYPE; static readonly LEDTYPE_WS2811: YColorLedCluster.LEDTYPE; static readonly LEDTYPE_INVALID: YColorLedCluster.LEDTYPE; static readonly MAXLEDCOUNT_INVALID: number; static readonly DYNAMICLEDCOUNT_INVALID: number; static readonly BLINKSEQMAXCOUNT_INVALID: number; static readonly BLINKSEQMAXSIZE_INVALID: number; static readonly COMMAND_INVALID: string; constructor(yapi: YAPIContext, func: string); imm_parseAttr(name: string, val: any): number; /** * Returns the number of LEDs currently handled by the device. * * @return an integer corresponding to the number of LEDs currently handled by the device * * On failure, throws an exception or returns YColorLedCluster.ACTIVELEDCOUNT_INVALID. */ get_activeLedCount(): Promise<number>; /** * Changes the number of LEDs currently handled by the device. * Remember to call the matching module * saveToFlash() method to save the setting permanently. * * @param newval : an integer corresponding to the number of LEDs currently handled by the device * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_activeLedCount(newval: number): Promise<number>; /** * Returns the RGB LED type currently handled by the device. * * @return a value among YColorLedCluster.LEDTYPE_RGB, YColorLedCluster.LEDTYPE_RGBW and * YColorLedCluster.LEDTYPE_WS2811 corresponding to the RGB LED type currently handled by the device * * On failure, throws an exception or returns YColorLedCluster.LEDTYPE_INVALID. */ get_ledType(): Promise<YColorLedCluster.LEDTYPE>; /** * Changes the RGB LED type currently handled by the device. * Remember to call the matching module * saveToFlash() method to save the setting permanently. * * @param newval : a value among YColorLedCluster.LEDTYPE_RGB, YColorLedCluster.LEDTYPE_RGBW and * YColorLedCluster.LEDTYPE_WS2811 corresponding to the RGB LED type currently handled by the device * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_ledType(newval: YColorLedCluster.LEDTYPE): Promise<number>; /** * Returns the maximum number of LEDs that the device can handle. * * @return an integer corresponding to the maximum number of LEDs that the device can handle * * On failure, throws an exception or returns YColorLedCluster.MAXLEDCOUNT_INVALID. */ get_maxLedCount(): Promise<number>; /** * Returns the maximum number of LEDs that can perform autonomous transitions and sequences. * * @return an integer corresponding to the maximum number of LEDs that can perform autonomous * transitions and sequences * * On failure, throws an exception or returns YColorLedCluster.DYNAMICLEDCOUNT_INVALID. */ get_dynamicLedCount(): Promise<number>; /** * Returns the maximum number of sequences that the device can handle. * * @return an integer corresponding to the maximum number of sequences that the device can handle * * On failure, throws an exception or returns YColorLedCluster.BLINKSEQMAXCOUNT_INVALID. */ get_blinkSeqMaxCount(): Promise<number>; /** * Returns the maximum length of sequences. * * @return an integer corresponding to the maximum length of sequences * * On failure, throws an exception or returns YColorLedCluster.BLINKSEQMAXSIZE_INVALID. */ get_blinkSeqMaxSize(): Promise<number>; get_command(): Promise<string>; set_command(newval: string): Promise<number>; /** * Retrieves a RGB LED cluster for a given identifier. * The identifier can be specified using several formats: * * - FunctionLogicalName * - ModuleSerialNumber.FunctionIdentifier * - ModuleSerialNumber.FunctionLogicalName * - ModuleLogicalName.FunctionIdentifier * - ModuleLogicalName.FunctionLogicalName * * * This function does not require that the RGB LED cluster is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YColorLedCluster.isOnline() to test if the RGB LED cluster is * indeed online at a given time. In case of ambiguity when looking for * a RGB LED cluster by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * * @param func : a string that uniquely characterizes the RGB LED cluster, for instance * YRGBLED2.colorLedCluster. * * @return a YColorLedCluster object allowing you to drive the RGB LED cluster. */ static FindColorLedCluster(func: string): YColorLedCluster; /** * Retrieves a RGB LED cluster for a given identifier in a YAPI context. * The identifier can be specified using several formats: * * - FunctionLogicalName * - ModuleSerialNumber.FunctionIdentifier * - ModuleSerialNumber.FunctionLogicalName * - ModuleLogicalName.FunctionIdentifier * - ModuleLogicalName.FunctionLogicalName * * * This function does not require that the RGB LED cluster is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method YColorLedCluster.isOnline() to test if the RGB LED cluster is * indeed online at a given time. In case of ambiguity when looking for * a RGB LED cluster by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * * @param yctx : a YAPI context * @param func : a string that uniquely characterizes the RGB LED cluster, for instance * YRGBLED2.colorLedCluster. * * @return a YColorLedCluster object allowing you to drive the RGB LED cluster. */ static FindColorLedClusterInContext(yctx: YAPIContext, func: string): YColorLedCluster; /** * Registers the callback function that is invoked on every change of advertised value. * The callback is invoked only during the execution of ySleep or yHandleEvents. * This provides control over the time when the callback is triggered. For good responsiveness, remember to call * one of these two functions periodically. To unregister a callback, pass a null pointer as argument. * * @param callback : the callback function to call, or a null pointer. The callback function should take two * arguments: the function object of which the value has changed, and the character string describing * the new advertised value. * @noreturn */ registerValueCallback(callback: YColorLedCluster.ValueCallback | null): Promise<number>; _invokeValueCallback(value: string): Promise<number>; sendCommand(command: string): Promise<number>; /** * Changes the current color of consecutive LEDs in the cluster, using a RGB color. Encoding is done * as follows: 0xRRGGBB. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param rgbValue : new color. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_rgbColor(ledIndex: number, count: number, rgbValue: number): Promise<number>; /** * Changes the color at device startup of consecutive LEDs in the cluster, using a RGB color. * Encoding is done as follows: 0xRRGGBB. Don't forget to call saveLedsConfigAtPowerOn() * to make sure the modification is saved in the device flash memory. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param rgbValue : new color. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_rgbColorAtPowerOn(ledIndex: number, count: number, rgbValue: number): Promise<number>; /** * Changes the color at device startup of consecutive LEDs in the cluster, using a HSL color. * Encoding is done as follows: 0xHHSSLL. Don't forget to call saveLedsConfigAtPowerOn() * to make sure the modification is saved in the device flash memory. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param hslValue : new color. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_hslColorAtPowerOn(ledIndex: number, count: number, hslValue: number): Promise<number>; /** * Changes the current color of consecutive LEDs in the cluster, using a HSL color. Encoding is done * as follows: 0xHHSSLL. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param hslValue : new color. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_hslColor(ledIndex: number, count: number, hslValue: number): Promise<number>; /** * Allows you to modify the current color of a group of adjacent LEDs to another color, in a seamless and * autonomous manner. The transition is performed in the RGB space. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param rgbValue : new color (0xRRGGBB). * @param delay : transition duration in ms * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ rgb_move(ledIndex: number, count: number, rgbValue: number, delay: number): Promise<number>; /** * Allows you to modify the current color of a group of adjacent LEDs to another color, in a seamless and * autonomous manner. The transition is performed in the HSL space. In HSL, hue is a circular * value (0..360 deg). There are always two paths to perform the transition: by increasing * or by decreasing the hue. The module selects the shortest transition. * If the difference is exactly 180 deg, the module selects the transition which increases * the hue. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param hslValue : new color (0xHHSSLL). * @param delay : transition duration in ms * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ hsl_move(ledIndex: number, count: number, hslValue: number, delay: number): Promise<number>; /** * Adds an RGB transition to a sequence. A sequence is a transition list, which can * be executed in loop by a group of LEDs. Sequences are persistent and are saved * in the device flash memory as soon as the saveBlinkSeq() method is called. * * @param seqIndex : sequence index. * @param rgbValue : target color (0xRRGGBB) * @param delay : transition duration in ms * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ addRgbMoveToBlinkSeq(seqIndex: number, rgbValue: number, delay: number): Promise<number>; /** * Adds an HSL transition to a sequence. A sequence is a transition list, which can * be executed in loop by an group of LEDs. Sequences are persistent and are saved * in the device flash memory as soon as the saveBlinkSeq() method is called. * * @param seqIndex : sequence index. * @param hslValue : target color (0xHHSSLL) * @param delay : transition duration in ms * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ addHslMoveToBlinkSeq(seqIndex: number, hslValue: number, delay: number): Promise<number>; /** * Adds a mirror ending to a sequence. When the sequence will reach the end of the last * transition, its running speed will automatically be reversed so that the sequence plays * in the reverse direction, like in a mirror. After the first transition of the sequence * is played at the end of the reverse execution, the sequence starts again in * the initial direction. * * @param seqIndex : sequence index. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ addMirrorToBlinkSeq(seqIndex: number): Promise<number>; /** * Adds to a sequence a jump to another sequence. When a pixel will reach this jump, * it will be automatically relinked to the new sequence, and will run it starting * from the beginning. * * @param seqIndex : sequence index. * @param linkSeqIndex : index of the sequence to chain. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ addJumpToBlinkSeq(seqIndex: number, linkSeqIndex: number): Promise<number>; /** * Adds a to a sequence a hard stop code. When a pixel will reach this stop code, * instead of restarting the sequence in a loop it will automatically be unlinked * from the sequence. * * @param seqIndex : sequence index. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ addUnlinkToBlinkSeq(seqIndex: number): Promise<number>; /** * Links adjacent LEDs to a specific sequence. These LEDs start to execute * the sequence as soon as startBlinkSeq is called. It is possible to add an offset * in the execution: that way we can have several groups of LED executing the same * sequence, with a temporal offset. A LED cannot be linked to more than one sequence. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param seqIndex : sequence index. * @param offset : execution offset in ms. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ linkLedToBlinkSeq(ledIndex: number, count: number, seqIndex: number, offset: number): Promise<number>; /** * Links adjacent LEDs to a specific sequence at device power-on. Don't forget to configure * the sequence auto start flag as well and call saveLedsConfigAtPowerOn(). It is possible to add an offset * in the execution: that way we can have several groups of LEDs executing the same * sequence, with a temporal offset. A LED cannot be linked to more than one sequence. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param seqIndex : sequence index. * @param offset : execution offset in ms. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ linkLedToBlinkSeqAtPowerOn(ledIndex: number, count: number, seqIndex: number, offset: number): Promise<number>; /** * Links adjacent LEDs to a specific sequence. These LED start to execute * the sequence as soon as startBlinkSeq is called. This function automatically * introduces a shift between LEDs so that the specified number of sequence periods * appears on the group of LEDs (wave effect). * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * @param seqIndex : sequence index. * @param periods : number of periods to show on LEDs. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ linkLedToPeriodicBlinkSeq(ledIndex: number, count: number, seqIndex: number, periods: number): Promise<number>; /** * Unlinks adjacent LEDs from a sequence. * * @param ledIndex : index of the first affected LED. * @param count : affected LED count. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ unlinkLedFromBlinkSeq(ledIndex: number, count: number): Promise<number>; /** * Starts a sequence execution: every LED linked to that sequence starts to * run it in a loop. Note that a sequence with a zero duration can't be started. * * @param seqIndex : index of the sequence to start. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ startBlinkSeq(seqIndex: number): Promise<number>; /** * Stops a sequence execution. If started again, the execution * restarts from the beginning. * * @param seqIndex : index of the sequence to stop. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ stopBlinkSeq(seqIndex: number): Promise<number>; /** * Stops a sequence execution and resets its contents. LEDs linked to this * sequence are not automatically updated anymore. * * @param seqIndex : index of the sequence to reset * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ resetBlinkSeq(seqIndex: number): Promise<number>; /** * Configures a sequence to make it start automatically at device * startup. Note that a sequence with a zero duration can't be started. * Don't forget to call saveBlinkSeq() to make sure the * modification is saved in the device flash memory. * * @param seqIndex : index of the sequence to reset. * @param autostart : 0 to keep the sequence turned off and 1 to start it automatically. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_blinkSeqStateAtPowerOn(seqIndex: number, autostart: number): Promise<number>; /** * Changes the execution speed of a sequence. The natural execution speed is 1000 per * thousand. If you configure a slower speed, you can play the sequence in slow-motion. * If you set a negative speed, you can play the sequence in reverse direction. * * @param seqIndex : index of the sequence to start. * @param speed : sequence running speed (-1000...1000). * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_blinkSeqSpeed(seqIndex: number, speed: number): Promise<number>; /** * Saves the LEDs power-on configuration. This includes the start-up color or * sequence binding for all LEDs. Warning: if some LEDs are linked to a sequence, the * method saveBlinkSeq() must also be called to save the sequence definition. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ saveLedsConfigAtPowerOn(): Promise<number>; saveLedsState(): Promise<number>; /** * Saves the definition of a sequence. Warning: only sequence steps and flags are saved. * to save the LEDs startup bindings, the method saveLedsConfigAtPowerOn() * must be called. * * @param seqIndex : index of the sequence to start. * * @return YAPI.SUCCESS when the call succeeds. * * On failure, throws an exception or returns a negative error code. */ saveBlinkSeq(seqIndex: number): Promise<number>; /** * Sends a binary buffer to the LED RGB buffer, as is. * First three bytes are RGB components for LED specified as parameter, the * next three bytes for the next LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param buff : the binary buffer to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_rgbColorBuffer(ledIndex: number, buff: Uint8Array): Promise<number>; /** * Sends 24bit RGB colors (provided as a list of integers) to the LED RGB buffer, as is. * The first number represents the RGB value of the LED specified as parameter, the second * number represents the RGB value of the next LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param rgbList : a list of 24bit RGB codes, in the form 0xRRGGBB * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_rgbColorArray(ledIndex: number, rgbList: number[]): Promise<number>; /** * Sets up a smooth RGB color transition to the specified pixel-by-pixel list of RGB * color codes. The first color code represents the target RGB value of the first LED, * the next color code represents the target value of the next LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param rgbList : a list of target 24bit RGB codes, in the form 0xRRGGBB * @param delay : transition duration in ms * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ rgbArrayOfs_move(ledIndex: number, rgbList: number[], delay: number): Promise<number>; /** * Sets up a smooth RGB color transition to the specified pixel-by-pixel list of RGB * color codes. The first color code represents the target RGB value of the first LED, * the next color code represents the target value of the next LED, etc. * * @param rgbList : a list of target 24bit RGB codes, in the form 0xRRGGBB * @param delay : transition duration in ms * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ rgbArray_move(rgbList: number[], delay: number): Promise<number>; /** * Sends a binary buffer to the LED HSL buffer, as is. * First three bytes are HSL components for the LED specified as parameter, the * next three bytes for the second LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param buff : the binary buffer to send * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_hslColorBuffer(ledIndex: number, buff: Uint8Array): Promise<number>; /** * Sends 24bit HSL colors (provided as a list of integers) to the LED HSL buffer, as is. * The first number represents the HSL value of the LED specified as parameter, the second number represents * the HSL value of the second LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param hslList : a list of 24bit HSL codes, in the form 0xHHSSLL * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ set_hslColorArray(ledIndex: number, hslList: number[]): Promise<number>; /** * Sets up a smooth HSL color transition to the specified pixel-by-pixel list of HSL * color codes. The first color code represents the target HSL value of the first LED, * the second color code represents the target value of the second LED, etc. * * @param hslList : a list of target 24bit HSL codes, in the form 0xHHSSLL * @param delay : transition duration in ms * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ hslArray_move(hslList: number[], delay: number): Promise<number>; /** * Sets up a smooth HSL color transition to the specified pixel-by-pixel list of HSL * color codes. The first color code represents the target HSL value of the first LED, * the second color code represents the target value of the second LED, etc. * * @param ledIndex : index of the first LED which should be updated * @param hslList : a list of target 24bit HSL codes, in the form 0xHHSSLL * @param delay : transition duration in ms * * @return YAPI.SUCCESS if the call succeeds. * * On failure, throws an exception or returns a negative error code. */ hslArrayOfs_move(ledIndex: number, hslList: number[], delay: number): Promise<number>; /** * Returns a binary buffer with content from the LED RGB buffer, as is. * First three bytes are RGB components for the first LED in the interval, * the next three bytes for the second LED in the interval, etc. * * @param ledIndex : index of the first LED which should be returned * @param count : number of LEDs which should be returned * * @return a binary buffer with RGB components of selected LEDs. * * On failure, throws an exception or returns an empty binary buffer. */ get_rgbColorBuffer(ledIndex: number, count: number): Promise<Uint8Array>; /** * Returns a list on 24bit RGB color values with the current colors displayed on * the RGB LEDs. The first number represents the RGB value of the first LED, * the second number represents the RGB value of the second LED, etc. * * @param ledIndex : index of the first LED which should be returned * @param count : number of LEDs which should be returned * * @return a list of 24bit color codes with RGB components of selected LEDs, as 0xRRGGBB. * * On failure, throws an exception or returns an empty array. */ get_rgbColorArray(ledIndex: number, count: number): Promise<number[]>; /** * Returns a list on 24bit RGB color values with the RGB LEDs startup colors. * The first number represents the startup RGB value of the first LED, * the second number represents the RGB value of the second LED, etc. * * @param ledIndex : index of the first LED which should be returned * @param count : number of LEDs which should be returned * * @return a list of 24bit color codes with RGB components of selected LEDs, as 0xRRGGBB. * * On failure, throws an exception or returns an empty array. */ get_rgbColorArrayAtPowerOn(ledIndex: number, count: number): Promise<number[]>; /** * Returns a list on sequence index for each RGB LED. The first number represents the * sequence index for the the first LED, the second number represents the sequence * index for the second LED, etc. * * @param ledIndex : index of the first LED which should be returned * @param count : number of LEDs which should be returned * * @return a list of integers with sequence index * * On failure, throws an exception or returns an empty array. */ get_linkedSeqArray(ledIndex: number, count: number): Promise<number[]>; /** * Returns a list on 32 bit signatures for specified blinking sequences. * Since blinking sequences cannot be read from the device, this can be used * to detect if a specific blinking sequence is already programmed. * * @param seqIndex : index of the first blinking sequence which should be returned * @param count : number of blinking sequences which should be returned * * @return a list of 32 bit integer signatures * * On failure, throws an exception or returns an empty array. */ get_blinkSeqSignatures(seqIndex: number, count: number): Promise<number[]>; /** * Returns a list of integers with the current speed for specified blinking sequences. * * @param seqIndex : index of the first sequence speed which should be returned * @param count : number of sequence speeds which should be returned * * @return a list of integers, 0 for sequences turned off and 1 for sequences running * * On failure, throws an exception or returns an empty array. */ get_blinkSeqStateSpeed(seqIndex: number, count: number): Promise<number[]>; /** * Returns a list of integers with the "auto-start at power on" flag state for specified blinking sequences. * * @param seqIndex : index of the first blinking sequence which should be returned * @param count : number of blinking sequences which should be returned * * @return a list of integers, 0 for sequences turned off and 1 for sequences running * * On failure, throws an exception or returns an empty array. */ get_blinkSeqStateAtPowerOn(seqIndex: number, count: number): Promise<number[]>; /** * Returns a list of integers with the started state for specified blinking sequences. * * @param seqIndex : index of the first blinking sequence which should be returned * @param count : number of blinking sequences which should be returned * * @return a list of integers, 0 for sequences turned off and 1 for sequences running * * On failure, throws an exception or returns an empty array. */ get_blinkSeqState(seqIndex: number, count: number): Promise<number[]>; hsl2rgbInt(temp1: number, temp2: number, temp3: number): Promise<number>; hsl2rgb(hslValue: number): Promise<number>; /** * Continues the enumeration of RGB LED clusters started using yFirstColorLedCluster(). * Caution: You can't make any assumption about the returned RGB LED clusters order. * If you want to find a specific a RGB LED cluster, use ColorLedCluster.findColorLedCluster() * and a hardwareID or a logical name. * * @return a pointer to a YColorLedCluster object, corresponding to * a RGB LED cluster currently online, or a null pointer * if there are no more RGB LED clusters to enumerate. */ nextColorLedCluster(): YColorLedCluster | null; /** * Starts the enumeration of RGB LED clusters currently accessible. * Use the method YColorLedCluster.nextColorLedCluster() to iterate on * next RGB LED clusters. * * @return a pointer to a YColorLedCluster object, corresponding to * the first RGB LED cluster currently online, or a null pointer * if there are none. */ static FirstColorLedCluster(): YColorLedCluster | null; /** * Starts the enumeration of RGB LED clusters currently accessible. * Use the method YColorLedCluster.nextColorLedCluster() to iterate on * next RGB LED clusters. * * @param yctx : a YAPI context. * * @return a pointer to a YColorLedCluster object, corresponding to * the first RGB LED cluster currently online, or a null pointer * if there are none. */ static FirstColorLedClusterInContext(yctx: YAPIContext): YColorLedCluster | null; } export declare namespace YColorLedCluster { const enum LEDTYPE { RGB = 0, RGBW = 1, WS2811 = 2, INVALID = -1 } interface ValueCallback { (func: YColorLedCluster, value: string): void; } }