AutoHotInterception/README.md
2018-03-08 00:11:38 +00:00

3.0 KiB

AutoHotInterception

AutoHotInterception(AHI) allows you to execute AutoHotkey code in response to keys on a specific keyboard, whilst (optionally) blocking the native functionality of that key.
In other words, you can use a key on a second (or third, or fourth..) keyboard to trigger AHK code, and that key will not be seen by applications. You can use the same key on multiple keyboards for individual actions.

AHI uses the Interception driver by Francisco Lopez

Setup

  1. Download and install the Interception Driver
  2. Download a zip from the releases page and extract it to a folder
  3. Copy the interception.dll from the folder where you ran the interecption install into the lib folder
    (You can optionally place the contents of the lib folder in My Documents\AutoHotkey\lib
  4. Edit the example script, enter the VID and PID of your keyboard
  5. Run the example script

Usage

Initializing the Library

Include the library

#Persistent ; (Interception hotkeys do not stop AHK from exiting, so use this)
#include Lib\AutoHotInterception.ahk

Initialize the library

Interception := AutoHotInterception_Init()

Modes

There are two modes of operation for AHI, currently each script can only use one of them.

Context mode

Context mode is so named as it takes advantage of AutoHotkey's Context Sensitive Hotkeys.
In AHK, you can wrap your hotkeys in a block like so:

#if myVariable == 1
F1::Msgbox You Pressed F1
#if

This hotkey would only fire if the myVariable was 1.
In context mode, you subscribe to a keyboard, and any time events for that keyboard are just about to happen, then AHI fires your callback, and you set this variable to 1 the hotkey is enabled. After your hotkey fires, AHI fires the callback again and the variable gets set back to 0.

Step 1

Register your callback with AHI

VID := 0x04F2, PID := 0x0112
Interception.SetContextCallback(VID, PID, Func("SetKb1Context"))

Step 2

Create your callback function, and set the context variable to the value of state

SetKb1Context(state){
	global isKeyboard1Active
	Sleep 0		; We seem to need this for hotstrings to work, not sure why
	isKeyboard1Active := state
}

Step 3

Create your hotkeys, wrapped in an #if block for that context variable

#if isKeyboard1Active
::aaa::JACKPOT
1:: 
	ToolTip % "KEY DOWN EVENT @ " A_TickCount
	return
	
1 up::
	ToolTip % "KEY UP EVENT @ " A_TickCount
	return
#if

Subscription mode

In Subscription mode, you bypass AHK's hotkey system completely, and Interception notifies you of key events via callbacks.

Subscribe to a key on a specific keyboard SubscribeKey(<scanCode>, <block>, <callback>, <VID>, <PID>

VID := 0x04F2, PID := 0x0112
Interception.SubscribeKey(GetKeySC("1"), true, Func("KeyEvent"), VID, PID)
return

Callback function is passed state 0 (released) or 1 (pressed)

KeyEvent(state){
	ToolTip % "State: " state
}