Global

Members

(constant) devices :Device

Type:

Device

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:

index.js, line 39

(constant) effects :Effect

Type:

Effect

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:

index.js, line 10

(constant) layouts :Layout

Type:

Layout

Properties:

Name	Type	Description
`UNINIT`	Layout
`US`	Layout
`EU`	Layout

Source:

index.js, line 58

Methods

enableLEDControl(enabled) → {boolean}

Enables/disables LED control

Parameters:

Name	Type	Description
`enabled`	boolean

Source:

index.js, line 117

Returns:

success

Type: boolean

getCPUUsage() → {number}

Gets the current CPU usgae

Source:

index.js, line 68

Returns:

usgae

Type: number

getLayout() → {Layout}

Gets the keyboard layout

Source:

index.js, line 108

Returns:

layout

Type: Layout

getRAMUsage() → {number}

Gets the current RAM usgae

Source:

index.js, line 76

Returns:

usgae

Type: number

getVolume() → {number}

Gets the current volume

Source:

index.js, line 84

Returns:

volume

Type: number

isDevicePluggedIn() → {boolean}

Verifies that the device is plugged in

Source:

index.js, line 100

Returns:

plugged

Type: boolean

setDevice(device)

Sets the device to control

Parameters:

Name	Type	Description
`device`	Device

Source:

index.js, line 92

setEffect(effect) → {boolean}

Sets the current keyboard effect

Parameters:

Name	Type	Description
`effect`	Effect

Source:

index.js, line 126

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:

index.js, line 137

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:

index.js, line 150

Returns:

success

Type: boolean

Type Definitions

Device

Type:

number

Source:

index.js, line 32

Effect

Type:

number

Source:

index.js, line 3

Layout

Type:

number

Source:

index.js, line 51