## Backlight **Kind**: global class * [Backlight](#Backlight) * [new Backlight(displayOTron)](#new_Backlight_new) * [.turnOff()](#Backlight+turnOff) * [.setBrightnessOfLed(ledIndex, brightness)](#Backlight+setBrightnessOfLed) * [.setToHue(hue)](#Backlight+setToHue) * [.setLeftToHue(hue)](#Backlight+setLeftToHue) * [.setMiddleToHue(hue)](#Backlight+setMiddleToHue) * [.setRightToHue(hue)](#Backlight+setRightToHue) * [.setToRGB(red, green, blue)](#Backlight+setToRGB) * [.setZoneToRGB(zoneIndex, red, green, blue)](#Backlight+setZoneToRGB) * [.setLeftToRGB(red, green, blue)](#Backlight+setLeftToRGB) * [.setMiddleToRGB(red, green, blue)](#Backlight+setMiddleToRGB) * [.setRightToRGB(red, green, blue)](#Backlight+setRightToRGB) ### new Backlight(displayOTron) Creates a new `Backlight` object. Note: you should not instantiate this class directly. Instead, use the `backlight` property of an initialized `DOTHAT` object. | Param | Type | Description | | --- | --- | --- | | displayOTron | DisplayOTron | The `DisplayOTron` instance. | ### backlight.turnOff() Turns off the backlight. **Kind**: instance method of [Backlight](#Backlight) ### backlight.setBrightnessOfLed(ledIndex, brightness) Sets the brightness of a specific LED. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | ledIndex | Number | The index of the LED (should be between 0 and 17). | | brightness | Number | The brightness value (should be between 0 and 255). | ### backlight.setToHue(hue) Sets all backlight zones to a specific hue. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | hue | Number | The hue value (should be between 0.0 and 1.0). | ### backlight.setLeftToHue(hue) Sets the left backlight zone to a specific hue. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | hue | Number | The hue value (should be between 0.0 and 1.0). | ### backlight.setMiddleToHue(hue) Sets the middle backlight zone to a specific hue. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | hue | Number | The hue value (should be between 0.0 and 1.0). | ### backlight.setRightToHue(hue) Sets the right backlight zone to a specific hue. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | hue | Number | The hue value (should be between 0.0 and 1.0). | ### backlight.setToRGB(red, green, blue) Sets all backlight zones to a specific RGB color. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | red | Number | The red value (should be between 0 and 255). | | green | Number | The green value (should be between 0 and 255). | | blue | Number | The blue value (should be between 0 and 255). | ### backlight.setZoneToRGB(zoneIndex, red, green, blue) Sets a specific backlight zone to a specific RGB color. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | zoneIndex | Number | The index of the zone (should be between 0 and 5). | | red | Number | The red value (should be between 0 and 255). | | green | Number | The green value (should be between 0 and 255). | | blue | Number | The blue value (should be between 0 and 255). | ### backlight.setLeftToRGB(red, green, blue) Sets the left backlight zone to a specific RGB color. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | red | Number | The red value (should be between 0 and 255). | | green | Number | The green value (should be between 0 and 255). | | blue | Number | The blue value (should be between 0 and 255). | ### backlight.setMiddleToRGB(red, green, blue) Sets the middle backlight zone to a specific RGB color. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | red | Number | The red value (should be between 0 and 255). | | green | Number | The green value (should be between 0 and 255). | | blue | Number | The blue value (should be between 0 and 255). | ### backlight.setRightToRGB(red, green, blue) Sets the right backlight zone to a specific RGB color. **Kind**: instance method of [Backlight](#Backlight) | Param | Type | Description | | --- | --- | --- | | red | Number | The red value (should be between 0 and 255). | | green | Number | The green value (should be between 0 and 255). | | blue | Number | The blue value (should be between 0 and 255). |