An extended version of the hotkeys application using action classes.
In adafruit's Hotkeys code, a macro is using a series of integers, assumed to be Keycodes. While it's great to make it simple and minimal, it doesn't allow for other types of actions, and mixing them. Consumer Controls for example are also encoded as integers.
Action classes let you encapsulate actions with a class instance, serving as markups in the code. I tend to prefer short names, but more explicit longer names are available. A macro can be a single item or a list (that reduces the number of parenthesis when there's only one).
Press or release one or more keys with a keycode name as strings. It presses the key and only releases it at the end of the macro, unless you specify to release in two ways: a negative shortcut, or 0. Keycodes can also be represented with the Keycode.THING int. If the key code is not found, it defaults to layout.keycodes().
# long version, with key names
(0x004000, 'Redo', [ Shortcut("COMMAND", "SHIFT", "Z") ]),
# short version:
(0x004000, 'Undo', [ S("COMMAND", "Z") ]),
# importing Keycode
(0x004000, 'Undo Win', [ Shortcut(Keycode.CONTROL, Keycode.Z) ]),
# releasing all (prefered)
(0x004000, 'Things', [ S("ALT", "A"), 0, S("ALT", "B") ]),
# releasing one (holding ALT)
(0x004000, 'Other', [ S("ALT", "A"), -S("A"), S("B") ]),# long version
(0x004000, 'Hello', [ Type("Hello world") ]),
# short version
(0x004000, 'Taco', [ T(" :taco:") ]),The consumer_control_extended module can be found in the Layout Repository and contains a bunch of names for consumer control functions, basically dumped from the USB HID specifications. Some might even do something !
# as strings
(0x202000, 'Volume-', Control("VOLUME_DECREMENT")),
(0x202000, 'Volume+', Control("VOLUME_INCREMENT")),
# as int (start calculator)
(0x202000, 'Calc', Control(0x192)),
# with ConsumerControlExtended
from consumer_control_extended.ConsumerControlExtended import *
...
(0x202000, 'Calc', Control(AL_CALCULATOR)),Note that mouse movements are relative, and depend on the computer's setup. They are only done once on press and not repeated in this implementation. Mouse buttons are held until the macro key is released.
# click 1 = left, 2 = right, 3 = middle
(0x202000, 'Click', Mouse(1)),
# mouse move
(0x202000, 'Zipzap', Mouse(x=100, y=100)),
# mouse wheel
(0x202000, 'Wheel+', Mouse(wheel=10)),# midi notes as strings, with or without velocity (127 by default)
(0x004000, 'Hello', [ Midi( "A-1#", ("C1", 64) ) ]),
# midi notes as numbers
(0x004000, 'Taco', [ M( 10 ), M( (11, 100) ) ]),# arpeggio
(0x202000, 'Arpeggio',
Tone(
("C6", 0.2), ("E6", 0.2), ("G6", 0.2), ("C7", 0.2),
("G6", 0.2), ("E6", 0.2), ("C6", 0.5),
)
),Instead of an action, you can put a function, expecting 3 parameters, the Macropad Instance, the number of the key being pressed, the index of the action in the current macro's list.
# turn off the lights when pressing the encoder, and hide the interface
def onoff(pad, key, idx):
# pad.display.brightness = 0
pad.group.hidden = not pad.group.hidden
pad.display.refresh()
if pad.group.hidden:
pad.pixels.fill(0)
pad.pixels.show()
app = {
...
'macros' : [
...
# Encoder button ---
(0x000000, '', onoff)
]
}You can specify a function to be called when switching apps (macro pages), one when you enter, one when you leave. They take the MacroPad instance, the previous app and the current app (instances of App).
# beep when we start this page
# restore the lights and screen when we leave it
# or we won't know where we are when switching pages
beep = Tone(("C6", 0.08), 0.05, ("E6", 0.10))
def entering(pad, prev_app, next_app):
beep.action()
def leaving(pad, prev_app, next_app):
pad.group.hidden = False
pad.display.refresh()
app = {
'name' : 'Test Macros', # Application name
'enter' : entering,
'leave' : leaving,
'macros' : [
# ...
]
}# type a blod string in some text editor, possibly, and beep
(0x004000, 'Bold String',
[
Shortcut("CONTROL", "B"), # shortcut
0, # release
Type("Is this bold ?", # type
0.5, # wait
Tone( ("C6", 0.08) ), # beep
]
),The keyboard layout and keycode can be configured in the macros_config.py file, with modules from the Layout Repository.
from keyboard_layout_mac_fr import KeyboardLayout
default_layout = KeyboardLayout
from keycode_mac_fr import Keycode
default_keycode = Keycode