Skip to content

Conversation

@carlosedp
Copy link
Contributor

Description

This PR adds a LED index map to the qmk info command under the -L option which is useful if one wants to customize any keyboard config for RGB LEDs (like battery indicators, connection, etc).

The output is similar to:

❯ qmk info -kb monsgeek/m1_v5/m1_v5_us -m -L
⚠ monsgeek/m1_v5/m1_v5_us: Layout "LAYOUT" is offset on Y axis by 0.25
Keyboard Name: M1 V5
Manufacturer: AKKO
Website:
Maintainer: yangzheng20003
Layouts: LAYOUT
Processor: WB32FQ95
Bootloader: wb32-dfu
Matrix for "LAYOUT":
┌──┐  ┌──┐┌──┐┌──┐┌──┐ ┌──┐┌──┐┌──┐┌──┐ ┌──┐┌──┐┌──┐┌──┐ ┌──┐  ┌──┐
│0A│  │0B││0C││0D││0E│ │0F││0G││0H││0I│ │0J││0K││0L││0M│ │0N│  │0O│
└──┘  └──┘└──┘└──┘└──┘ └──┘└──┘└──┘└──┘ └──┘└──┘└──┘└──┘ └──┘  └──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌───────┐  ┌──┐
│1A││1B││1C││1D││1E││1F││1G││1H││1I││1J││1K││1L││1M││1N     │  │1O│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└───────┘  └──┘
┌────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌─────┐  ┌──┐
│2A  ││2B││2C││2D││2E││2F││2G││2H││2I││2J││2K││2L││2M││2N   │  │2O│
└────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└─────┘  └──┘
┌─────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌────────┐  ┌──┐
│3A   ││3B││3C││3D││3E││3F││3G││3H││3I││3J││3K││3L││3N      │  │3O│
└─────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└────────┘  └──┘
┌───────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──────┐      ┌──┐
│4A     ││4C││4D││4E││4F││4G││4H││4I││4J││4K││4L││4M    │ ┌──┐ │4N│
└───────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──────┘ │4O│ └──┘
┌───┐┌───┐┌───┐┌────────────────────────┐┌──┐┌──┐┌──┐     └──┘
│5A ││5B ││5C ││5G                      ││5J││5K││5L│ ┌──┐┌──┐┌──┐
└───┘└───┘└───┘└────────────────────────┘└──┘└──┘└──┘ │5M││5N││5O│
                                                      └──┘└──┘└──┘
LED indices for "LAYOUT":
┌──┐  ┌──┐┌──┐┌──┐┌──┐ ┌──┐┌──┐┌──┐┌──┐ ┌──┐┌──┐┌──┐┌──┐ ┌──┐  ┌──┐
│23│  │22││21││20││19│ │18││17││16││15│ │14││13││12││11│ │10│  │  │
└──┘  └──┘└──┘└──┘└──┘ └──┘└──┘└──┘└──┘ └──┘└──┘└──┘└──┘ └──┘  └──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌───────┐  ┌──┐
│24││25││26││27││28││29││30││31││32││33││34││35││36││37     │  │9 │
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└───────┘  └──┘
┌────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌─────┐  ┌──┐
│51  ││50││49││48││47││46││45││44││43││42││41││40││39││38   │  │8 │
└────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└─────┘  └──┘
┌─────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌────────┐  ┌──┐
│52   ││53││54││55││56││57││58││59││60││61││62││63││64      │  │7 │
└─────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└────────┘  └──┘
┌───────┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──────┐      ┌──┐
│77     ││76││75││74││73││72││71││70││69││68││67││66    │ ┌──┐ │65│
└───────┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──────┘ │6 │ └──┘
┌───┐┌───┐┌───┐┌────────────────────────┐┌──┐┌──┐┌──┐     └──┘
│78 ││79 ││80 ││81                      ││0 ││1 ││2 │ ┌──┐┌──┐┌──┐
└───┘└───┘└───┘└────────────────────────┘└──┘└──┘└──┘ │3 ││4 ││5 │
                                                      └──┘└──┘└──┘

Which was combined with the -m option to show the key indexes too.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@github-actions github-actions bot added python cli qmk cli command labels Oct 22, 2025
@drashna drashna requested a review from a team October 23, 2025 06:48
@carlosedp
Copy link
Contributor Author

Sorry about the delay. Cleaned-up code on latest commit.

@carlosedp
Copy link
Contributor Author

Done.

@zvecr zvecr merged commit 22b213e into qmk:master Nov 8, 2025
5 checks passed
coldwateryu pushed a commit to coldwateryu/qmk_firmware that referenced this pull request Nov 24, 2025
cadusk pushed a commit to cadusk/qmk_firmware that referenced this pull request Nov 29, 2025
* upstream/master: (24 commits)
  Bump actions/checkout from 4 to 6 (qmk#25829)
  QMK CLI Environment bootstrapper (qmk#25038)
  Add Demod LM Rev. 1 (qmk#25793)
  Add support for Coffee Break Keyboards' Coffeevan (qmk#25805)
  [Keyboard] Add Keenome Keys' "The Grid v2" (qmk#25813)
  Bump actions/checkout from 5 to 6 (qmk#25807)
  [Keyboard] Add Coffee Break Keyboards Acai (qmk#25796)
  Short term fix for skip_converter KeyError in 'qmk userspace-add' (qmk#25798)
  Hyper7 v4 (qmk#25728)
  Add imi60-HS (qmk#25773)
  Fix detection of hid bootloader flashing tool (qmk#25790)
  VIA Keylog Change (qmk#25504)
  [Bugfix] QP error handling (qmk#25591)
  [Keyboard] Add Rubrehaku (qmk#24907)
  Fix pmw33xx sensor initialisation (qmk#25777)
  Add LED index map to `qmk info` cli command (qmk#25743)
  Bump actions/download-artifact from 5 to 6 (qmk#25746)
  Bump actions/upload-artifact from 4 to 5 (qmk#25745)
  Bump JamesIves/github-pages-deploy-action from 4.7.3 to 4.7.4 (qmk#25771)
  Deprecate LAYOUT() macro in favor of JSON matrix definitions
  ...
eth4nH pushed a commit to eth4nH/yunzii_firmware that referenced this pull request Dec 4, 2025
versality pushed a commit to versality/qmk_firmware that referenced this pull request Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli qmk cli command python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants