Add OpenRGB device discovery report command #88

Open
opened 2026-05-23 01:00:41 -04:00 by JackFrostbyte · 0 comments

Objective

Add a command that discovers OpenRGB devices and produces a structured report that can be used during portable setup.

Scope

The command should connect to OpenRGB and report:

  • Device names.
  • Device indexes.
  • Zone names.
  • Zone indexes.
  • LED counts.
  • Available modes if useful.
  • Raw information useful for profile creation.

Requirements

The command should:

  • Avoid writing RGB data.
  • Be safe to run as a discovery step.
  • Produce human-readable output.
  • Optionally produce machine-readable JSON output.
  • Help users identify which zones should be used, ignored, or reserved.

Acceptance criteria

  • Discovery command exists.
  • Discovery command does not modify RGB state.
  • Output is useful for creating a device profile.
  • Documentation explains how to run the command.
# Objective Add a command that discovers OpenRGB devices and produces a structured report that can be used during portable setup. # Scope The command should connect to OpenRGB and report: - Device names. - Device indexes. - Zone names. - Zone indexes. - LED counts. - Available modes if useful. - Raw information useful for profile creation. # Requirements The command should: - Avoid writing RGB data. - Be safe to run as a discovery step. - Produce human-readable output. - Optionally produce machine-readable JSON output. - Help users identify which zones should be used, ignored, or reserved. # Acceptance criteria - Discovery command exists. - Discovery command does not modify RGB state. - Output is useful for creating a device profile. - Documentation explains how to run the command.
JackFrostbyte added reference develop 2026-05-23 01:00:44 -04:00
Sign in to join this conversation.
No labels
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
JackFrostbyte/rgb-aura#88
No description provided.