hid-mapper-sample

This is a proof of concept (POC) project with code to override the default hid functionality of human interface devices (HID) on Linux.

It enables keyboard macros via configuration as code. Currently yaml configuration are supported but other format parsers can be added.

Process

1. Create yaml map configuration file <device>.map.yaml
2. Create Generic Driver Profile configuration file <device>.profile.yaml (not implemented yet)
3. Start Driver with configuration(s) ./generic-linux-driver <device>.profile.yaml <device>.map.yaml (not implemented yet)

Currently only the non generic g600-linux-driver is implemented. The name generic-linux-driver is bad... Will change later...

It Grabs the HID input device (Other devices wont be able to use the grabbed device) and remaps the keys to any key macro defined in linux/input-event-codes.h.

flowchart LR
  driver   --o hid-information
  driver   --o mapper 
  driver   --x grab-input 
  mapper   --o emitter
  mapper --o config  
  mapper   --o macro
  emitter  --o keys
  macro    --o keys

See diagrams for more information.

Note:

• This software is still in a pre-alpha state and should be treated as unstable. The use of said software is for non mission critical applications.

• This software has not been tested against anti cheat software. As such you might get booted or banned for cheating as this creating virtual input.

Table of contents

• Local Development
  • Setup (Aptitude)
  • Source
  • Compiling
    • G600
    • Generic
• Usage
  • G600
• Configuration
  • map

Development Docs

• Diagrams
• HID
• Input Grabbing

↥ TOP ↥

Local Development

For local development configuration for vscode with the c/c++ extension is provided for debugging.

Setup (Aptitude)

• build-essential gcc compiler and make tools (llvm might work but have not tested)
• git to pull source code to local computer
• libyaml-dev is needed to read from yaml files

sudo apt-get update
sudo apt-get install build-essential git libyaml-dev

Source

Cloning repository syntax into folder

git clone --recurse-submodules https://github.com/bluemner/hid-mapper-sample

Compiling

G600

To compile code unique to g600 run the command

make g600

Generic

Generic is not yet implemented

↥ TOP ↥

Usage

Logitech G600 sample that the generic code will be based off of.

You will need the following libs that are compiled with the application

Make sure you do git clone recursive to pull the libhid-descriptor source!

• lib.hid.descriptor.so
• lib.hid.rawlinux.so

g600-linux-driver

Not sure about calling this a "driver" but for now it will do...

To run compile the code then run the binary file g600-linux-driver. The program will need sudo permissions to grab the device. You could also setup an input group that has permissions to grab a device.

sudo ./g600-linux-driver configs/g600.map.yaml

Press control + c to quit.

The code also has necessary signal captures for:

signal(SIGINT, stop);
signal(SIGTERM, stop);
signal(SIGQUIT, stop);
signal(SIGABRT, stop); 

So systemd scripts should work.

↥ TOP ↥

Configuration

G600 example config: configs/g600.map.yaml

Map

Version: 1.0.0.alpha

This format may be subject to change

---
#
# Configuration will map to the linux name of each button
# Example G7 is KEY_MACRO7 in input-event
#
bagpipe:
  name: "Logitech Gaming Mouse G600"
  description: "Sample profile"
  vendor:  "Logitech"
  product: "G600"
  #
  # ID Section can be found on linux at
  # /sys/class/input/input*/id
  # replace * with number 
  #
  bustype_id: 0x0003 # hex
  product_id: 0x1025 # hex
  vendor_id:  0x046d # hex
  version_id: 0x0111 # hex

  buttons:
    - key: "BTN_LEFT" # Key you want to watch
      press: "+BTN_LEFT" # On key press action
      release: "-BTN_LEFT" # On key press release
      modifier: false # if set to true all other fields but key will be ignored
      modifier_press: # if modifier is held and key pressed
      modifier_release: # if modifier is held and key released

↥ TOP ↥