SteelSeries Aerox 3 Wireless
Supported Models
SteelSeries Aerox 3 Wireless (wired mode) |
1038:183a |
SteelSeries Aerox 3 Wireless (2.4 GHz wireless mode) |
1038:1838 |
Missing Features
The following feature are currently not supported by Rivalcfg:
Smart illumination
Command-Line Usage
usage: rivalcfg [-h] [--list] [--version] [--no-save] [--update-udev]
[--print-udev] [--print-debug] [-s SENSITIVITY]
[-p POLLING_RATE] [--top-color Z1_COLOR]
[--middle-color Z2_COLOR] [--bottom-color Z3_COLOR]
[-a REACTIVE_COLOR] [-t SLEEP_TIMER] [-T DIM_TIMER]
[-b BUTTONS_MAPPING] [-e] [-d DEFAULT_LIGHTING] [-r]
[--battery-level]
options:
-h, --help show this help message and exit
--list List supported devices and exit
--version show program's version number and exit
--no-save Do not persist settings in the internal device memory
--update-udev Updates udev rules (Linux only, requires to be run as
root)
--print-udev Prints udev rules and exit
--print-debug Prints debug information and exit
SteelSeries Aerox 3 Wireless (wired mode) Options:
-s, --sensitivity SENSITIVITY
Set sensitivity preset (DPI) (up to 5 settings, from
100 dpi to 18000 dpi, default: '400, 800, 1200, 2400,
3200')
-p, --polling-rate POLLING_RATE
Set polling rate (Hz) (values: 125, 250, 500, 1000,
default: 1000)
--top-color, --z1 Z1_COLOR
Set the color of the top LED (e.g. red, #ff0000,
ff0000, #f00, f00, default: red)
--middle-color, --z2 Z2_COLOR
Set the color of the middle LED (e.g. red, #ff0000,
ff0000, #f00, f00, default: lime)
--bottom-color, --z3 Z3_COLOR
Set the color of the bottom LED (e.g. red, #ff0000,
ff0000, #f00, f00, default: blue)
-a, --reactive-color REACTIVE_COLOR
Set the color of the LEDs in reaction to a button
click (e.g. off, disable, red, #ff0000, ff0000, #f00,
f00, default: off)
-t, --sleep-timer SLEEP_TIMER
Set the IDLE time before the mouse goes to sleep mode
(minutes, 0 = disable) (from 0 to 20, default: 5)
-T, --dim-timer DIM_TIMER
Set the IDLE time before the mouse light is dimmed
(seconds, 0 = disable) (from 0 to 1200, default: 30)
-b, --buttons BUTTONS_MAPPING
Set the mapping of the buttons (default:
buttons(button1=button1; button2=button2;
button3=button3; button4=button4; button5=button5;
button6=dpi; scrollup=scrollup; scrolldown=scrolldown;
layout=qwerty))
-e, --rainbow-effect Enable the rainbow effect (can be disabled by setting
a color)
-d, --default-lighting DEFAULT_LIGHTING
Set default lighting at mouse startup (values: off,
reactive, rainbow, reactive-rainbow, default: rainbow)
-r, --reset Reset all settings to their factory default
--battery-level Print the battery level of the mouse and exit
Please report any bug on Github: https://github.com/flozz/rivalcfg/issues
Sensitivity (DPI)
This mouse supports up to 5 sensitivity presets. You can define them like this:
rivalcfg --sensitivity 800 # one preset
rivalcfg --sensitivity 800,1600 # two presets
You can switch preset using the button under the mouse wheel.
Note
When you set the sensitivity through the CLI, the selected preset always back to the first one.
Note
From Python API, you can pass an int, a tuple or a list
as parameter. You are also able to change the currently selected preset:
mouse.sensitivity(800)
mouse.sensitivity("800, 1600")
mouse.sensitivity([800, 1600])
# select the second preset (1600 dpi)
mouse.sensitivity([800, 1600, 2000, 4000], selected_preset=2)
Colors
This mouse supports colors. Various formats are supported.
Hexadecimal notation
You can use a 24 bit hexadecimal notation (like in HTML / CSS documents). Example of “red” color using hexadecimal notation:
#FF0000FF0000#F00F00
Named Colors
The folowing named colors are supported:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
RGB Tuple (Python API only)
If you are using the Python API (not the command line interface), you can
also pass colors as RGB tuple or list:
(255, 0, 0)[255, 0, 0]
Important
On newer SteelSeries mice, the color settings are not saved in the onboard memory anymore (see Default Lighting bellow).
Rainbow Effect
The Aerox 3 offers an onboard rainbow light effect. Please note that the effect is reset if you change colors.
Default Lighting
The color setting is not saved in the onboard memory on this device. You can only define if the light goes blank or rainbow at startup.
Supported values are:
off: All LEDs are off when the mouse wakes up. Clicking on mouse buttons will not trigger light reaction.reactive: All LEDs are off when the mouse wakes up. Clicking on mouse buttons will trigger a light reaction.rainbow: LEDs display an animated rainbow effect when the mouse wakes up. Clicking on mouse buttons will not trigger a light reaction.reactive-rainbow: LEDs display an animated rainbow effect when the mouse wakes up. Clicking on mouse buttons will trigger a light reacion.
Examples:
rivalcfg --default-lighting off
rivalcfg --default-lighting reactive-rainbow
Buttons
This mouse supports buttons mapping. Buttons can be mapped with:
some special actions,
mouse buttons,
multimedia keys,
and keyboard keys.
The general syntax for buttons mapping is the following:
buttons(layout=<LAYOUT>; button1=<mapping1>; buttonN=<mappingN>)
Example:
rivalcfg --buttons "buttons(layout=QWERTY; button1=button1; button2=PlayPause; button3=disabled; button5=A; button6=DPI)"
Arguments:
layout: The keyboard layout to use when papping the keys (see the “Mapping Keyboard Keys” section bellow).button1: The first button of the mouse.button2: The second button of the mouse.buttonN: The Nth button of the mouse (The number of available buttons depends of the mouse model).
Note
All parameters are optional. If you do not define a mapping for a specific button, it will be reset to its default value.
You can also reset all buttons to their factory default by passing "default" as parameter:
rivalcfg --buttons default
Warning
Be sure to map the mouse button button1 on some button, else you will not be able to click with the mouse!
Mapping Special Actions
The following special actions are available¹:
disabled: disable the button,dpi: use this button to switch between DPI presets,ScrollUp: simulate a scroll up (not available on all devices¹)ScrollDown: simulate a scroll down (not available on all devices¹)
Example:
buttons(button4=disabled; button5=disabled; button6=DPI)
Note
¹ The ScrollUp and ScrollDown actions are not available on all devices.
Rival 300 / Rival: OK
Sensei [RAW]: Not supported
Mapping Multimedia Keys
Mouse buttons can be mapped to multimedia keys. The following keys are available:
Mute: turn off the soundNext: play next mediaPlayPause: toggle play / pause on the currently playing mediaPrevious: play the previous mediaVolumeUp: increase the volumeVolumeDown: decrease the volume
Example:
buttons(button4=VolumeDown; button5=VolumeUp)
Mapping Keyboard Keys
Mouse buttons can be mapped to any keyboard key, using different layouts.
To select the desired layout, just use the layout parameter. If this
parameter is not specified, the QWERTY layout will be used by default.
Available layouts:
QWERTY(see available keys)
The available keys depend on the selected layout.
Example:
buttons(layout=QWERTY; button7=PageDown; button8=PageUp)
Note
Some characters like ; or = cannot be used as a key identifier as they
interfere with the buttons() syntax. For those keys, use one of the
available aliases, like semicolon (instead of ;) or equal
(instead of =).
Example:
buttons(button4=semicolon; button5=equal)
Python API
TODO