pimk

command module
v0.0.0-...-dbacb9a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2022 License: GPL-3.0 Imports: 13 Imported by: 0

README

PiMK

PiMK allows you to turn a Raspberry Pi 4 Model B into a keyboard remapping device. By plugging your keyboard(s) into the Pi, and plugging the Pi into your computer it can act as a keyboard device and translate keystrokes allowing you to remap keys.

If you plan to plug in multiple keyboards or your keyboard(s) require higher amounts of power I reccommend using either a deciated Pi power supply such as Waveshare's UPS or plugging your Pi into a powered USB hub.

Completed Features

  • Key remapping
  • Custom hotkeys
  • Layer support
  • Multiple keyboards with separate config support
  • Macros

Security

While running the Pi has the ability to see all keystrokes entered. This can become a security concern when entering sensitive information such as passwords.

As a result I do NOT recommend having your Pi connected to your network as this could provide an entry point for attackers. If you must ensure you are hardening the OS and installing the latest security updates.

Installation

git clone https://github.com/basharkey/pimk.git
sudo apt install -y ansible
cd pimk/
ansible-playbook main.yml

Configuration

Start/Stop Service
sudo systemctl start pimk
sudo systemctl stop pimk

Config Files

Default
/etc/pimk/default.conf
Custom
/etc/pimk/usb-04d9_USB_Keyboard-event-kbd.conf

For more information on creating config files see the Wiki

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL