Skip to content

macro.md

Latest commit

 

History

History
71 lines (51 loc) · 3.87 KB

macro.md

File metadata and controls

71 lines (51 loc) · 3.87 KB

Macro Configuration

Hub16 can also be used with software on your computer to enable powerful, context aware macros to be run.

This works by sending uniquely identifiable keys to your computer which are picked up by software, which can then map those keys as required. As such, this requires the correct firmware to be loaded onto Hub16, and software to be installed on your computer.

Firmware

Hub16 does not ship with the macro firmware preinstalled, but is easily flashed onto your board.

MechMerlin has a great video on the process, so I will highlight the Hub16 specific configurations / settings.

  • When selecting the file to flash, use firmware/binaries/hub16_macro.bin.
  • Ensure you select the microcontroller as "ATMEGA32U4" before flashing the board.
  • The reset button can be found between the USB connectors on the back of the board, or by holding the bottom left key down whilst pressing the second from the right key on the bottom row (see below).

The default configuration for macro mode is shown below:

------------------  ENC1:Clockwise: q
|  ENC1   ENC2   |  ENC1:Anticlockwise: r
| a   b   c   d  |  ENC1:Button: s
| e   f   g   h  |  ENC2:Clockwise: t
| i   j   k   l  |  ENC2:Anticlockwise: u
| m   n   o   p* |  ENC2:Button: v
------------------

* Once flashing the macro layout you may notice that holding or tapping the bottom right key quickly may not result in a key being sent. This because if you double tap that key, it will bring you to a configuration layer on the keyboard which allows you to control the LEDs and reset the keyboard. Double tapping the same key will return you to the base layer. The keymap for this configuration is shown below:

         _______,   _______,
_______, RGB_MOD, RGB_RMOD,  RGB_TOG,
RGB_VAD, RGB_VAI,  RGB_HUD,  RGB_HUI,
RGB_SAD, RGB_SAI,  _______,  _______,
_______, _______,  RESET,       HOME,

Software

Windows

  • Download and install AutoHotKey.
  • Copy the example script from software/hub16-template.ahk into a folder of your choice.
  • For the script to run at startup, I strongly suggest placing a shortcut to the above file in %APPDATA%/Roaming/Microsoft/Windows/Start Menu/Programs/Start-up.
  • Configure the script to suit your use case, ensuring to restart the AHK script after each change, otherwise it will not use the latest changes.

macOS

  • Install Karabiner-Elements.
  • Copy the example script from software/hub16-karabiner.json to your local ~.config/karabiner folder.
  • Configure keybindings as required.

Linux

  • Whilst it's slightly more painful and buggy to configure and use on Linux, the below is the best configuration I've got to work. PRs are very much welcome for improvements to this.
  • Install AutoKey from here, as the apt-get version is broken.
  • Create a file in your home directory with the name .Xmodmap and the following contents
keycode 202 = Hyper_R
add mod3 = Hyper_R
  • Update xmodmap with xmodmap ~/.Xmodmap and then confirm that mod3 has been updated by entering xmodmap in your shell and looking for mod3 Hyper_R (0xca).
  • Then add it to your ~./bashrc, as this will allow the keyboard to work only after a shell is opened by the user. A PR to resolve this would be very welcomed.
  • Load the AutoKey files found in software/hub16 and it should work.
    • Note: you may need to make a new folder from within Autokey, then copy your files in as it is particular about locating new files.
  • You will also need to configure AutoKey to start at boot, which can be done from Edit -> Preferences.
  • For volume and media control as configured in my example code, playerctl and alsa-utils must be installed.