Skip to main content

overwolf.logitech.led API

Provides API for Logitech Arx Control.

Methods Reference

Events Reference

Types Reference

init(callback)

Version added: 0.93

Initializes the LED API.

ParameterTypeDescription
callbackfunctionCallback with the result of the request

setTargetDevice(targetDevices, callback)

Version added: 0.93

Sets the target devices to use.

ParameterTypeDescription
targetDevicesLogitechDeviceLightingType array
callbackfunctionCallback with the result of the request

saveCurrentLighting(callback)

Version added: 0.93

Saves the current lighting scheme.

ParameterTypeDescription
callbackfunctionCallback with the result of the request

setLighting(redPercentage, greenPercentage, bluePercentage, callback)

Version added: 0.93

Sets the lighting for the entire device.

ParameterTypeDescription
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
callbackfunctionA callback with the result of the request

restoreLighting(callback)

Version added: 0.93

Restores the lightning to the last previously saved state.

ParameterTypeDescription
callbackfunctionCallback with the result of the request

flashLighting(redPercentage, greenPercentage, bluePercentage, milliSecondsDuration, milliSecondsInterval, callback)

Version added: 0.93

Flashes lighting sources on the device.

ParameterTypeDescription
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
milliSecondsDurationintDuration to flash in milliseconds
milliSecondsIntervalintInterval for flashes in milliseconds
callbackfunctionCallback with the result of the request

pulseLighting(redPercentage, greenPercentage, bluePercentage, milliSecondsDuration, milliSecondsInterval, callback)

Version added: 0.93

Pulses the lighting on the device.

ParameterTypeDescription
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
milliSecondsDurationintDuration to flash in milliseconds
milliSecondsIntervalintInterval for flashes in milliseconds
callbackfunctionCallback with the result of the request

stopEffects(callback)

Version added: 0.93

Stops ongoing pulse/flash effects.

ParameterTypeDescription
callbackfunctionCallback with the result of the request

setLightingFromBitmap(bitmapUrl, callback)

Version added: 0.93

Sets the lighting from an overwolf-extension:// or overwolf-media:// url. The file must be 21×6.

ParameterTypeDescription
bitmapUrlstringOverwolf url to add
callbackfunctionCallback with the result of the request

setLightingFromBitmap(bitmap, callback)

Version added: 0.93

Sets the lighting from a bitmap byte array.

ParameterTypeDescription
bitmapByte[]A byte array representing a 21×6 bitmap
callbackfunctionCallback with the result of the request

setLightingForKeyWithScanCode(keyCode, redPercentage, greenPercentage, bluePercentage, callback)

Version added: 0.93

Sets the lighting for a specific key by scan code.

ParameterTypeDescription
keyCodeintKey scan code
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
callbackfunctionCallback with the result of the request

setLightingForKeyWithHidCode(keyCode, redPercentage, greenPercentage, bluePercentage , callback)

Version added: 0.93

Sets the lighting for a specific key by HID code.

ParameterTypeDescription
keyCodeintKey HID code
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
callbackfunctionCallback with the result of the request

setLightingForKeyWithQuartzCode(keyCode, redPercentage, greenPercentage, bluePercentage, callback)

Version added: 0.93

Sets the lighting for a specific key by HID code.

ParameterTypeDescription
keyCodeintKey quartz code
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
callbackfunctionCallback with the result of the request

setLightingForKeyWithKeyName(keyName, redPercentage, greenPercentage, bluePercentage, callback)

Version added: 0.93

Sets the lighting for a specific key by key name.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
callbackfunctionCallback with the result of the request

saveLightingForKey(keyName, callback)

Version added: 0.93

Saves the current lighting of a specific key.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
callbackfunctionCallback with the result of the request

restoreLightingForKey(keyName, callback)

Version added: 0.93

Restores a previously saved lighting for a specific key.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
callbackfunctionCallback with the result of the request

flashSingleKey(keyName, redPercentage, greenPercentage, bluePercentage, milliSecondsDuration, milliSecondsInterval, callback)

Version added: 0.93

Flashes a single key.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
redPercentageintRed percentage (0 – 100)
greenPercentageintGreen percentage (0 – 100)
bluePercentageintBlue percentage (0 – 100)
milliSecondsDurationintDuration to flash in milliseconds
milliSecondsIntervalintInterval for flashes in milliseconds
callbackfunctionCallback with the result of the request

pulseSingleKey(keyName, startRedPercentage, startGreenPercentage, startBluePercentage, finishRedPercentage, finishGreenPercentage, finishBluePercentage, milliSecondsDuration, isInfinite, callback)

Version added: 0.93

Pulses a single key.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
startRedPercentageintRed start percentage (0 – 100)
startGreenPercentageintGreen start percentage (0 – 100)
startBluePercentageintBlue start percentage (0 – 100)
finishRedPercentageintRed finish percentage (0 – 100)
finishGreenPercentageintGreen finish percentage (0 – 100)
finishBluePercentageintBlue finish percentage (0 – 100)
milliSecondsDurationintDuration to flash in milliseconds
milliSecondsIntervalintInterval for flashes in milliseconds
callbackfunctionCallback with the result of the request

stopEffectsOnKey(keyName, callback)

Version added: 0.93

Stops ongoing pulse/flash effects on a specific key.

ParameterTypeDescription
keyNameKeyboardNames enumKey name
callbackfunctionCallback with the result of the request

shutdown()

Version added: 0.93

Shuts down the API.

onError

Version added: 0.93

Triggered when an error occurs, sent with an error code.

overwolf.logitech.led.LogitechLedData Object

Version added: 0.93

Describes an Arx event.

ParameterTypeDescription
required_devicesLogitechDevice ObjetList of required devices
required_devices_detailsstringRead only. List of required devices with additional details
required_lighting_typesLogitechDeviceLightingType enumList of required lighting types
required_lighting_detailsstringValue string on the event

overwolf.logitech.led.LogitechArxData Object

Version added: 0.93

Describes the Arx API data.

ParameterTypeDescription
app_folderstringOptional folder to use when publishing a website

overwolf.logitech.led.enums.LogitechDeviceLightingType enum

Version added: 0.93

A list of Logitech devices lighting types.

ParameterDescription
Mono
RGB
PerkeyRGB
All

overwolf.logitech.led.enums.KeyboardNames enum

Version added: 0.93

The names of the keys.

ParameterDescription
ESC
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
PRINT_SCREEN
SCROLL_LOCK
PAUSE_BREAK
TILDE
ONE
TWO
THREE
FOUR
FIVE
SIX
SEVEN
EIGHT
NINE
ZERO
MINUS
EQUALS
BACKSPACE
INSERT
HOME
SPAGE_UPEVEN
NUM_LOCK
NUM_SLASH
NUM_ASTERISK
NUM_MINUS
NINE
ZERO
MINUS
TAB
Q
W
HOME
E
R
T
Y
U
I
O
P
OPEN_BRACKET
CLOSE_BRACKET
BACKSLASH
KEYBOARD_DELETE
END
PAGE_DOWN
NUM_SEVEN
NUM_EIGHT
NUM_NINE
NUM_PLUS
CAPS_LOCK
I
O
P
A
S
D
F
G
H
J
K
L
SEMICOLON
APOSTROPHE
ENTER
NUM_FOUR
NUM_FIVE
NUM_SIX
LEFT_SHIFT
Z
X
C
V
B
N
M
COMMA
PERIOD
FORWARD_SLASH
RIGHT_SHIFT
ARROW_UP
NUM_ONE
NUM_TWO
NUM_THREE
NUM_ENTER
LEFT_CONTROL
LEFT_WINDOWS
LEFT_ALT
SPACE
RIGHT_ALT
RIGHT_WINDOWS
APPLICATION_SELECT
RIGHT_CONTROL
ARROW_LEFT
ARROW_DOWN
ARROW_RIGHT
NUM_ZERO
NUM_PERIOD