ethanmassie / deskcycle_kb

Python script for creating keyboard inputs from a DeskCycle

DeskCycle KB

Create keyboard inputs based on speed of DeskCycle. Requires Arduino mod for DeskCycle to output to usb.

Requires

• python3
• pyserial
• pyautogui
• marshmallow_dataclass
• marshmallow_enum
• tkinter

Getting Started

Install dependencies
pip install -r requirements.txt

(Linux Only) Install tkinter with your package manager
Arch Based: pacman -S tk
Debian Based: apt install python3-tk

(Linux/BSD/Mac? Only) Add yourself to the dialout group
sudo usermod -a -G dialout $(whoami) Then logout and log back in and verify you are in the dialout group by running:
groups

Run the example config to verify everything works.
Unix Like: ./deskcycle_kb.py -f example_configs/descenders.json
Windows: python deskcycle_kb.py -f example_configs\descenders.json

Write A Custom Config

By default the script will look in ~/.config/deskcycle_kb/ or %APPDATA%\Local\deskcycle_kb\ for config files. You can also provide full paths to config files.

Config files must be written in JSON format. See example_configs for usable examples.

{
    "keys": [
        {
            "key_name": "String Representation of key to press",
            "min_speed": "Float minimum speed for trigger speed range",
            "max_speed": "Float maximum speed for trigger speed range. Default infinity",
            "key_type":  "String either HOLD_KEY, TOGGLE_KEY, or TYPEWRITE_KEY. Default HOLD_KEY"
        }
    ]
}

Original DeskCycle Mod by Kneave
Source Code
Blog Post