Skip to content

Device Commands

Commands for listing and inspecting connected Razer devices.

list

List all connected Razer Chroma devices.

Synopsis

uchroma list [options]
uchroma ls [options]
uchroma devices [options]

Options

OptionShortDescription
--all-aShow all details (serial, firmware, brightness)
--quiet-qOnly show device keys (for scripting)

Examples

Basic listing:

bash
$ uchroma list

Devices (2)

[0] Razer BlackWidow V3  keyboard  blackwidow_v3
[1] Razer DeathAdder V2  mouse     deathadder_v2

Detailed listing:

bash
$ uchroma list --all

Devices (2)

[0] Razer BlackWidow V3  keyboard  blackwidow_v3
     serial: XX1234567890
     firmware: v1.03
     brightness: 100%

[1] Razer DeathAdder V2  mouse     deathadder_v2
     serial: PM2034567890
     firmware: v1.00
     brightness: 80%

Script-friendly output:

bash
$ uchroma list --quiet
blackwidow_v3
deathadder_v2

Output Fields

FieldDescription
IndexNumeric index for device selection (e.g., [0])
NameFull device name
TypeDevice type (keyboard, mouse, mousepad, headset, keypad, laptop)
KeyShort identifier for device selection

dump

Display detailed debug information about devices and the system.

Synopsis

uchroma dump [what] [options]
uchroma debug [what] [options]
uchroma info [what] [options]

Arguments

ArgumentDescriptionDefault
whatWhat to dump: device, hardware, version, or allall

Options

OptionDescription
--jsonOutput as JSON for programmatic consumption

Examples

Full debug dump:

bash
$ uchroma dump

Version

  uchroma: 0.10.0
  python: 3.11.4
  traitlets: 5.14.0
  coloraide: 3.2.0

Device

  Razer BlackWidow V3

    type: keyboard
    key: blackwidow_v3
    serial: XX1234567890
    firmware: v1.03
    manufacturer: Razer
    usb: 1532:024e
    matrix: 6x22
    brightness: 100%
    leds: backlight, logo
    effects: breath_dual, breath_random, breath_single, reactive, ...
    renderers: aurora, comets, copper_bars, embers, kaleidoscope, ...
    current_fx: spectrum

Hardware Database

  keyboard: 45
  mouse: 32
  mousepad: 8
  headset: 12
  keypad: 4
  laptop: 6

Version info only:

bash
$ uchroma dump version

Version

  uchroma: 0.10.0
  python: 3.11.4
  traitlets: 5.14.0
  coloraide: 3.2.0

Specific device info:

bash
$ uchroma -d blackwidow_v3 dump device

Device

  Razer BlackWidow V3

    type: keyboard
    key: blackwidow_v3
    serial: XX1234567890
    ...

JSON output:

bash
$ uchroma dump --json
{
  "version": {
    "uchroma": "0.10.0",
    "python": "3.11.4"
  }
}

Device Information Fields

FieldDescription
typeDevice type (keyboard, mouse, etc.)
keyShort device identifier
serialDevice serial number
firmwareFirmware version
manufacturerDevice manufacturer
usbUSB vendor:product ID
matrixLED matrix dimensions (rows x columns)
brightnessCurrent brightness percentage
ledsSupported standalone LEDs
effectsAvailable hardware effects
renderersAvailable animation renderers
current_fxCurrently active effect
wirelessWhether device is wireless
batteryBattery level and charging status (wireless only)
system_controlWhether system control is available (laptops)
power_modeCurrent power mode (laptops)
fan_rpmFan speeds (laptops)
cpu_boost / gpu_boostBoost levels (laptops)

Hardware Database

The hardware database section shows the count of supported devices by type. This reflects the device configurations bundled with uchroma, not currently connected devices.

Released under the LGPL-3.0 License.