com.asus.robotframework.API

Class WheelLights

java.lang.Object

com.asus.robotframework.API.WheelLights

public class WheelLights
extends java.lang.Object

Control wheel lights.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WheelLights.Direction Wheel lights direction.
static class	WheelLights.Lights Wheel lights ID
static class	WheelLights.Pattern Wheel lights pattern.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHARGING_TYPE_BIDIRECTIONAL
static int	CHARGING_TYPE_UNIDIRECTIONAL

Method Summary

Modifier and Type	Method and Description
int	setBrightness(WheelLights.Lights id, int active, int bright) Set the brightness of wheel LEDs.
int	setBrightness(WheelLights.Lights id, int active, int bright, boolean immediately) Set the brightness of wheel LEDs.
int	setColor(WheelLights.Lights id, int active, int color) Set the color of wheel LEDs.
int	startBlinking(WheelLights.Lights id, int active, int brightTime, int darkTime, int cycleNumber) Start the blinking pattern.
int	startBreathing(WheelLights.Lights id, int active, int darkToBrightTime, int brightToDarkTime, int cycleNumber) Start the breathing pattern action.
int	startMarquee(WheelLights.Lights id, WheelLights.Direction direction, int colorShiftTime, int brightTime, int cycleNumber) Start the marquee pattern action.
int	turnOff(WheelLights.Lights id, int active) Stop the pattern set by startPattern.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHARGING_TYPE_BIDIRECTIONAL

public static final int CHARGING_TYPE_BIDIRECTIONAL

See Also:

Constant Field Values

CHARGING_TYPE_UNIDIRECTIONAL

public static final int CHARGING_TYPE_UNIDIRECTIONAL

See Also:

Constant Field Values

Method Detail

setBrightness

public int setBrightness(WheelLights.Lights id,
                         int active,
                         int bright)

Set the brightness of wheel LEDs.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponds to LED7~LED0, set the corresponding bit to specify the selected LEDs

bright - bright value in the range from 0 to 55, 0 means turning off the light

Returns:

serial number of the command

setBrightness

public int setBrightness(WheelLights.Lights id,
                         int active,
                         int bright,
                         boolean immediately)

Set the brightness of wheel LEDs.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponding LED7~LED0. Set the corresponded bit to specify the selected LEDs.

bright - bright value in the range from 0 to 55, 0 means turning off the light.

immediately - true change brightness immediately, false will change with next pattern start or setColor

Returns:

serial number of the command

setColor

public int setColor(WheelLights.Lights id,
                    int active,
                    int color)

Set the color of wheel LEDs.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponding LED7~LED0. Set the cooresponed bit to specify the selected LEDs.

color - color value in ARGB format (e.g. RED is 0x00ff0000, GREEN is 0x0000ff00, BLUE is 0x000000ff)

Returns:

serial number of the command

startBlinking

public int startBlinking(WheelLights.Lights id,
                         int active,
                         int brightTime,
                         int darkTime,
                         int cycleNumber)

Start the blinking pattern.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponding LED7~LED0. Set the cooresponed bit to specify the selected LEDs.

brightTime - parameter for on time, value in the range from (1~255)*10ms

darkTime - parameter for off time, value in the range from (1~255)*10ms

cycleNumber - number of cycles, value in the range from 0~255, 0 means that the pattern will run forever until stop_pattern is called (When the cycleNumber expired, although the light will be turned off, you will still need to call the stop_pattern to disable the pattern.)

Returns:

serial cycleNumber of the command

See Also:

WheelLights.turnOff(Lights, int)

startBreathing

public int startBreathing(WheelLights.Lights id,
                          int active,
                          int darkToBrightTime,
                          int brightToDarkTime,
                          int cycleNumber)

Start the breathing pattern action.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponding LED7~LED0. Set the cooresponed bit to specify the selected LEDs.

darkToBrightTime - parameter for the time between darkest to brightest, value in the range from (1~20)*0.5s

brightToDarkTime - for the time between brightest to darkest, value in the range from (1~20)*0.5s

cycleNumber - number of cycles, value in the range from 0~255, 0 means that the pattern will run forever until stop_pattern is called (When the cycleNumber expired, although the light will be turned off, you will still need to call the stop_pattern to disable the pattern.)

Returns:

serial cycle number of the command

See Also:

WheelLights.turnOff(Lights, int)

startMarquee

public int startMarquee(WheelLights.Lights id,
                        WheelLights.Direction direction,
                        int colorShiftTime,
                        int brightTime,
                        int cycleNumber)

Start the marquee pattern action.

Parameters:

id - wheel lights ID

direction - forward or backward

colorShiftTime - parameter for color shift time, value in the range from (1~255)*10ms

brightTime - parameter for active time between each LED, value in the range from (1~255)*10ms Note: For Marquee, (t1 x 2) < (t2 x 9)

cycleNumber - then cycleNumber of run 0~255
0 means that the pattern will run forever until stopping pattern.
When the cycleNumber expired, although the light will be turn off, you could need to call stop_pattern to disable pattern.

Returns:

Serial cycleNumber of the command

See Also:

WheelLights.turnOff(Lights, int)

turnOff

public int turnOff(WheelLights.Lights id,
                   int active)

Stop the pattern set by startPattern.

Parameters:

id - wheel lights ID

active - bitmap array of selected LED. bit7~bit0 corresponding LED7~LED0. Set the cooresponed bit to specify the selected LEDs.

Returns:

serial number of the command