Global

Members

(constant) devices :Device

Type:
Properties:
Name Type Description
MASTERKEYS_PRO_L Device
MASTERKEYS_PRO_S Device
MASTERKEYS_PRO_L_White Device
MASTERKEYS_PRO_M_White Device
MASTERMOUSE_L Device
MASTERMOUSE_S Device
MASTERKEYS_PRO_M Device
MASTERKEYS_PRO_S_WHITE Device
Source:

(constant) effects :Effect

Type:
Properties:
Name Type Description
FULL_ON Effect
BREATH Effect
BREATH_CYCLE Effect
SINGLE Effect
WAVE Effect
RIPPLE Effect
CROSS Effect
RAIN Effect
STAR Effect
SNAKE Effect
REC Effect
SPECTRUM Effect
RAPID_FIRE Effect
INDICATOR Effect
MULTI_1 Effect
MULTI_2 Effect
MULTI_3 Effect
MULTI_4 Effect
OFF Effect
Source:

(constant) layouts :Layout

Type:
Properties:
Name Type Description
UNINIT Layout
US Layout
EU Layout
Source:

Methods

enableLEDControl(enabled) → {boolean}

Enables/disables LED control
Parameters:
Name Type Description
enabled boolean
Source:
Returns:
success
Type
boolean

getCPUUsage() → {number}

Gets the current CPU usgae
Source:
Returns:
usgae
Type
number

getLayout() → {Layout}

Gets the keyboard layout
Source:
Returns:
layout
Type
Layout

getRAMUsage() → {number}

Gets the current RAM usgae
Source:
Returns:
usgae
Type
number

getVolume() → {number}

Gets the current volume
Source:
Returns:
volume
Type
number

isDevicePluggedIn() → {boolean}

Verifies that the device is plugged in
Source:
Returns:
plugged
Type
boolean

setDevice(device)

Sets the device to control
Parameters:
Name Type Description
device Device
Source:

setEffect(effect) → {boolean}

Sets the current keyboard effect
Parameters:
Name Type Description
effect Effect
Source:
Returns:
success
Type
boolean

setFullLEDColor(r, g, b) → {boolean}

Changes the color of every key
Parameters:
Name Type Description
r number
g number
b number
Source:
Returns:
success
Type
boolean

setLEDColor(row, column, r, g, b) → {boolean}

Changes the color of a specific key
Parameters:
Name Type Description
row number
column number
r number
g number
b number
Source:
Returns:
success
Type
boolean

Type Definitions

Device

Type:
  • number
Source:

Effect

Type:
  • number
Source:

Layout

Type:
  • number
Source: