< 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

  1. gh_asus_aura.get_num_mb_light_ctrl (Lua - Python)
  2. gh_asus_aura.get_mb_light_ctrl_num_leds (Lua - Python)
  3. gh_asus_aura.set_mb_mode (Lua - Python)
  4. gh_asus_aura.set_mb_led_color (Lua - Python)
  5. gh_asus_aura.get_num_gpu_light_ctrl (Lua - Python)
  6. gh_asus_aura.get_gpu_light_ctrl_num_leds (Lua - Python)
  7. gh_asus_aura.set_gpu_mode (Lua - Python)
  8. gh_asus_aura.set_gpu_led_color (Lua - Python)



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

Lua - Python


Parameters

This function has no input parameter(s).


Return Values


Code sample

    
num_light_ctrl = gh_asus_aura.get_num_mb_light_ctrl()
            


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

Lua - Python


Parameters


Return Values


Code sample

    
light_ctrl_index = 0                
num_leds = gh_asus_aura.get_mb_light_ctrl_num_leds(light_ctrl_index)
            


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

Lua - Python


Parameters


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)
            


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

Lua - Python


Parameters


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)
            


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

Lua - Python


Parameters

This function has no input parameter(s).


Return Values


Code sample

    
num_light_ctrl = gh_asus_aura.get_num_gpu_light_ctrl()
            


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

Lua - Python


Parameters


Return Values


Code sample

    
light_ctrl_index = 0                
num_leds = gh_asus_aura.get_gpu_light_ctrl_num_leds(light_ctrl_index)
            


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

Lua - Python


Parameters


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_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

Lua - Python


Parameters


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)
            






GeeXLab Rootard Guide | Downloads | Contact | Newsletter