VEIKK Linux Driver V3 Configuration tool

The configuration tool for the VEIKK driver (v3).

For the old version of the VEIKK driver (v2), see this configuration tool. These are not compatible.

Description

TODO lorem ipsum

This includes two command-line scripts:

• veikk: a daemon that services requests and performs the button mappings -- must be run as root
• veikkctl: a CLI to configure the veikk daemon

Install

Install the package globally, so that the root user can access the scripts (necessary for running the daemon).

TODO: notes about prerequisites...

$ sudo python3 -m pip install --prefix=/usr/local veikk-config

(If you have a venv set up, make sure it is not active -- you want to be using the global Python environment.)

Uninstall

$ sudo python3 -m pip uninstall veikk-config

Build

Prerequisites: Python 3 (tested on 3.8.2), pip 3

Initial setup

It's recommended to build this in a venv.

Create, activate, and set up the venv.

$ python3 -m venv venv
$ . venv/bin/activate
(venv) $ pip install -r requirements.txt

You only have to create the venv and install the requirements once (unless the dependencies change). To deactivate the venv:

(venv) $ deactivate
$ # out of the venv now

Testing

To test the programs without pip install-ing them every time, you can use the helper scripts:

(venv) $ python 

Install the package (locally)

The veikk and veikkctl packages will be installed using distutils. These will expose the command line scripts of the same name.

(venv) $ pip install .
(venv) $ veikk         # run veikk config daemon
(venv) $ veikkctl      # run veikk config interface