< GeeXLab Reference Guide />
> Back to Reference Guide Index
gh_asus_aura library
Description
gh_asus_aura is ASUS Aura LED illumination module. It provides functions to manage the illumination on various ASUS products: motherboards, graphics cards, RAM, keyboards and mice (RAM, keyboards and mice are not yet supported by gh_asus_aura). Only for Windows 32-bit.
Number of functions: 8
- gh_asus_aura.get_gpu_light_ctrl_num_leds ()
- gh_asus_aura.get_mb_light_ctrl_num_leds ()
- gh_asus_aura.get_num_gpu_light_ctrl ()
- gh_asus_aura.get_num_mb_light_ctrl ()
- gh_asus_aura.set_gpu_led_color ()
- gh_asus_aura.set_gpu_mode ()
- gh_asus_aura.set_mb_led_color ()
- gh_asus_aura.set_mb_mode ()
get_gpu_light_ctrl_num_leds
Description
Returns the number of LEDs for a particular graphics card light controller.
Syntax
num_leds = gh_asus_aura.get_gpu_light_ctrl_num_leds(
light_ctrl_index
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
Return Values
- num_leds [INTEGER]: number of LEDs
Code sample
light_ctrl_index = 0
num_leds = gh_asus_aura.get_gpu_light_ctrl_num_leds(light_ctrl_index)
get_mb_light_ctrl_num_leds
Description
Returns the number of LEDs for a particular motherboard light controller.
Syntax
num_leds = gh_asus_aura.get_mb_light_ctrl_num_leds(
light_ctrl_index
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
Return Values
- num_leds [INTEGER]: number of LEDs
Code sample
light_ctrl_index = 0
num_leds = gh_asus_aura.get_mb_light_ctrl_num_leds(light_ctrl_index)
get_num_gpu_light_ctrl
Description
Returns the number of light controllers of the graphics card.
Syntax
num_light_ctrl = gh_asus_aura.get_num_gpu_light_ctrl()
Languages
Parameters
This function has no input parameter(s).
Return Values
- num_light_ctrl [INTEGER]: number of light controllers
Code sample
num_light_ctrl = gh_asus_aura.get_num_gpu_light_ctrl()
get_num_mb_light_ctrl
Description
Returns the number of light controllers of the motherboard.
Syntax
num_light_ctrl = gh_asus_aura.get_num_mb_light_ctrl()
Languages
Parameters
This function has no input parameter(s).
Return Values
- num_light_ctrl [INTEGER]: number of light controllers
Code sample
num_light_ctrl = gh_asus_aura.get_num_mb_light_ctrl()
set_gpu_led_color
Description
Sets the RGB color of a particular LED of the graphics card.
Syntax
gh_asus_aura.set_gpu_led_color(
light_ctrl_index,
led_index,
r, g, b
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
- led_index [INTEGER]: LED index in the range (0 … num_leds - 1)
- r, g, b [INTEGER]: RGB color in the range (0 … 255) per channel
Return Values
This function has no return value(s).
Code sample
light_ctrl_index = 0
led_index = 0
r = 255
g = 0
b = 0
gh_asus_aura.set_gpu_led_color(light_ctrl_index, led_index, r, g, b)
set_gpu_mode
Description
Sets the mode of a particular graphics card light controller. To program the LEDs, the software programming mode (mode=1) must be used.
Syntax
gh_asus_aura.set_gpu_mode(
light_ctrl_index,
mode
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
- mode [BOOLEAN]: 1 (software programming) or 0 (default)
Return Values
This function has no return value(s).
Code sample
light_ctrl_index = 0
mode = 1
gh_asus_aura.set_gpu_mode(light_ctrl_index, mode)
set_mb_led_color
Description
Sets the RGB color of a particular LED of the motherboard.
Syntax
gh_asus_aura.set_mb_led_color(
light_ctrl_index,
led_index,
r, g, b
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
- led_index [INTEGER]: LED index in the range (0 … num_leds - 1)
- r, g, b [INTEGER]: RGB color in the range (0 … 255) per channel
Return Values
This function has no return value(s).
Code sample
light_ctrl_index = 0
led_index = 0
r = 255
g = 0
b = 0
gh_asus_aura.set_mb_led_color(light_ctrl_index, led_index, r, g, b)
set_mb_mode
Description
Sets the mode of a particular motherboard light controller. To program the LEDs, the software programming mode (mode=1) must be used.
Syntax
gh_asus_aura.set_mb_mode(
light_ctrl_index,
mode
)
Languages
Parameters
- light_ctrl_index [INTEGER]: light controller index in the range (0 … num_light_ctrl - 1)
- mode [BOOLEAN]: 1 (software programming) or 0 (default)
Return Values
This function has no return value(s).
Code sample
light_ctrl_index = 0
mode = 1
gh_asus_aura.set_mb_mode(light_ctrl_index, mode)
| |