qmk/qmk_firmware

[Bug] Documentation suggests using pyhidapi

Geschlossen

#26.047 geöffnet am 03.03.2026

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (43.867 Forks)batch import
bughelp wanted

Repository-Metriken

Stars
 (20.368 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Describe the Bug

Some documentation page shows how to use Python to communicate with a QMK device. It suggests using pyhidapi, which is a bit confusing for those who don't know the naming mess of pyhidapi. In fact, if you follow along and run pip install pyhidapi, you'll end up with some abandoned package version 0.0.2 which for better or worse does not import as import hid.

Contributor Guide

Research-Richtung
Aktualisieren Sie die Dokumentation, indem Sie Verweise auf 'pyhidapi' durch das richtige Python Paket 'hidapi' (oder 'pyhidapi' als Import 'hid') ersetzen und die Import Anweisung klären.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85