BSD Ports

sysutils/py-qmk 1.2.0 DragonFly

CLI program for working with QMK firmware

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
MIT
Categories
python, sysutils
Package size
30.5 KiB, 128.4 KiB installed

Description

A program to help users work with QMK keyboard firmware.

Features:

  • Interact with your qmk_firmware tree from any location
  • Use qmk clone to pull down anyone's qmk_firmware fork
  • Setup your build environment with qmk setup
  • Check that your environment is correctly setup with qmk doctor

In the other systems

The newest version among them is 1.2.0, as upstream numbers it.

SystemPortVersionVulnerabilitiesStatusMaintainerLast update
DragonFlysysutils/py-qmk1.2.0 newestnone known-[email protected]-
FreeBSDsysutils/py-qmk1.2.0 newestnone known-[email protected]-
HardenedBSDsysutils/py-qmk1.2.0 newestno data-[email protected]-
GhostBSDsysutils/py-qmk1.2.0 newestno data-[email protected]-

Version history 1

  1. 1.2.0

Upstream's version as each commit to the port's Makefile set it, or as this site first saw it in the system's packages; the tree's own revisions are not versions here.

Install

Binary package:

pkg install py312-qmk

From DPorts:

cd /usr/dports/sysutils/py-qmk && make install clean

Dependency graph

Ports that need it on the left, what it needs to run on the right; at most 8 of each. "Dependencies" below lists them all.

Dependencies

Run dependencies 19

No port depends on this one.

Configuration

No options to configure.

Service scripts
none

Message after installing

Setup
=====

Before finishing the setup of QMK by running `qmk setup`, it is advised to
install the python3 package first:

    # pkg install python3

The reason for this is that the qmk_firmware scripts which are downloaded
during the setup expect python3 to be installed (instead of /usr/local/bin/python3.12).

Granting Write Permissions to USB Controllers
=============================================

Flashing images to controllers as a non-root user requires
some additional setup:

1. Add the user to the "operator" group:

        # pw groupmod operator -m piotr

2. Add the following ruleset to /etc/devfs.rules:

        [qmk=10]
        add path 'ttyU*' mode 0660 group operator

3. Enable "qmk" ruleset:

        # sysrc devfs_set_rulesets+="/dev=qmk"

4. Restart the devfs service to load the new rules:

        # service devfs restart