https://github.com/mte90/pydal

Remap your specific keyboard to execute custom scripts!
https://github.com/mte90/pydal

footswitch hacktoberfest hid linux pedal usb

Last synced: 2 months ago
JSON representation

Remap your specific keyboard to execute custom scripts!

• Host: GitHub
• URL: https://github.com/mte90/pydal
• Owner: Mte90
• License: gpl-3.0
• Created: 2018-05-11T15:04:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-23T16:14:58.000Z (about 1 year ago)
• Last Synced: 2024-10-04T13:26:09.613Z (3 months ago)
• Topics: footswitch, hacktoberfest, hid, linux, pedal, usb
• Language: Python
• Homepage: https://daniele.tech/2018/05/pydal-or-how-to-remap-your-keyboard-to-scripting-in-linux-easily/
• Size: 25.4 KB
• Stars: 20
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pydal

[![License](https://img.shields.io/badge/License-BSD%20v3-blue.svg)](https://spdx.org/licenses/BSD-3-Clause)

A simple way to create your macros, with a config file to execute cusom script/program and target a specific keyboard.

![](https://daniele.tech/wp-content/uploads/2018/05/footswitch-300x300.jpg)

As you can see in photo, in my case I have a foot switch and in this way I am able to use it to run scripts that move my mouse cursor in one of the 3 monitor I have.

This tiny Python script, parse the config file and map to the specific keyboard configured a script to execute on the various buttons.

# Commands

```

mte90:~/pydal $ ./pydal.py 

usage: pydal.py [-h] [-devices [DEVICES]] [-run [RUN]] [--config [CONFIG]]

                [--version]

Pydal is a tiny script to assign a script to a button of a specific keyboard

optional arguments:

  -h, --help          show this help message and exit

  -devices [DEVICES]  The devices list

  -run [RUN]          Launch Pydal

  --config [CONFIG]   Config file for Pydal

  --version           show program's version number and exit

```

# How to use it

## First step

Run `pydal.py -devices` to get a list of all the HID devices connected to your computer.  

Save the name of the keyboard that you need to for your config file.

## Second step

Copy `config-sample.ini` where you want (also with a different name) and add the keyboard name in the config file.  

Configure the settings as you wish for every key, on the keydown/keyup status and a absolute path to the script that you want to execute.

## Third step

Run with `pydal.py --config /your/path/config.ini -run` and get fun!

# Installation

Requirements:

* pyevdev - Debian has a package `python3-evdev` 

Permission to the user to access to all the input devices:

```

useradd plugdev [your-user]

usermod -a -G plugdev [your-user]

```

Add the udev rules to your system `99-pydal.rules` on `/etc/udev/rules.d/`.