7 /* Key Action(16bit code)
12 0000|0000|000000|00 No action
13 0000|mods|000000|00 Left mods Momentary
14 0000|mods|000000|01 Left mods OneShot
15 0000|mods|000000|10 (reserved)
16 0000|mods|000000|11 (reserved)
17 0000|0000| keycode Key
18 0000|mods| keycode Key+Left mods
21 0001|0000|000000|00 No action
22 0001|mods|000000|00 Right mods Momentary
23 0001|mods|000000|01 Right mods OneShot
24 0001|mods|000000|10 (reserved)
25 0001|mods|000000|11 (reserved)
26 0001|0000| keycode Key
27 0001|mods| keycode Key+Right mods
30 0010|mods| keycode Left mods+tap Key
33 0011|mods| keycode Right mods+tap Key
38 This action handles other usages than keyboard.
40 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
41 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
42 0100|10| usage(10) (reserved)
43 0100|11| usage(10) (reserved)
49 0101|XXXX| keycode Mouse key
54 ACT_LAYER_PRESSED(1000): Set layer on key pressed
55 ACT_LAYER_RELEASED(1001): Set layer on key released
56 ACT_LAYER_BIT(1010): On/Off layer bit
57 ACT_LAYER_EXT(1011): Extentions
59 1000|LLLL|0000 0000 set layer L when pressed
60 1001|LLLL|0000 0000 set layer L when released
61 1010|BBBB|0000 0000 on/off bit B when pressed/released
62 1011|0000|0000 0000 set default layer when pressed
63 1011|0001|0000 0000 set default layer when released
65 1000|LLLL|1111 0000 set layer L when pressed + tap toggle
66 1001|LLLL|1111 0000 set layer L when released[tap is ignored/not used]
67 1010|BBBB|1111 0000 on/off bit B when pressed/released + tap toggle
68 1011|0000|1111 0000 set default layer when pressed + tap toggle
69 1011|0001|1111 0000 set default layer when released[tap is ignored/not used]
71 1000|LLLL|1111 1111 set L to default layer when pressed
72 1001|LLLL|1111 1111 set L to default layer when released
73 1010|BBBB|1111 1111 on/off bit B of default layer when pressed/released
74 1011|0000|1111 1111 set current to default layer when pressed
75 1011|0001|1111 1111 set current to default layer when released
77 1000|LLLL| keycode set layer L when pressed + tap key
78 1001|LLLL| keyocde set layer L when released[tap is ignored/not used]
79 1010|BBBB| keyocde on/off bit B when pressed/released + tap key
80 1011|0000| keyocde set default layer when pressed + tap key
81 1011|0001| keyocde set default layer when released[tap is ignored/not used]
89 1100|opt | id(8) Macro play
90 1100|1111| id(8) Macro record
93 1110|opt | id(8) Built-in Command exec
96 1111| address(12) Function
97 Macro record(dynamicly)
99 TODO: modifier + [tap key /w mod]
100 : layerkey + [tap key /w mod]
101 for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
102 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
108 ACT_LMODS_TAP = 0b0010,
109 ACT_RMODS_TAP = 0b0011,
112 ACT_MOUSEKEY = 0b0101,
114 ACT_LAYER_PRESSED = 0b1000,
115 ACT_LAYER_RELEASED = 0b1001,
116 ACT_LAYER_BIT = 0b1010,
117 ACT_LAYER_EXT = 0b1011,
120 ACT_COMMAND = 0b1110,
121 ACT_FUNCTION = 0b1111
124 // TODO: not portable across compiler/endianness?
126 In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15).
127 AVR looks like a little endian in avr-gcc.
129 Byte order and bit order of 0x1234:
130 Big endian: 15 ... 8 7 ... 210
133 Little endian: 012 ... 7 8 ... 15
148 struct action_layer {
153 struct action_usage {
158 struct action_command {
169 STROKE_ALLUP, /* release all keys in reverse order */
179 void action_exec(keyevent_t event);
182 // TODO: proper names
183 /* action_t utility */
185 #define ACTION(kind, param) ((kind)<<12 | (param))
186 #define MOD_BITS(mods) (((mods)>>4 | (mods)) & 0x0F)
189 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
190 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x00)
191 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, (mods)<<8 | (key))
192 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x01)
193 #define ACTION_LMODS_SWITCH(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF0 | (tap))
194 #define ACTION_LMODS_TOGGLE(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF1 | (tap))
195 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x00)
196 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, (mods)<<8 | (key))
197 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x01)
198 #define ACTION_RMODS_SWITCH(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF0 | (tap))
199 #define ACTION_RMODS_TOGGLE(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF1 | (tap))
201 #define ACTION_LMODS_TAP(mods, key) ACTION(ACT_LMODS_TAP, MOD_BITS(mods)<<8 | (key))
202 #define ACTION_RMODS_TAP(mods, key) ACTION(ACT_RMODS_TAP, MOD_BITS(mods)<<8 | (key))
205 #define ACTION_LAYER_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
206 #define ACTION_LAYER_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
207 #define ACTION_LAYER_BIT(bits) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0x00)
208 #define ACTION_LAYER_TO_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
209 #define ACTION_LAYER_TO_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
211 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
212 #define ACTION_LAYER_BIT_TAP_TOGGLE(layer) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0xF0)
213 #define ACTION_LAYER_DEFAULT_TAP_TOGGLE ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xF0)
215 #define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
216 #define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
217 #define ACTION_LAYER_DEFAULT_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
218 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xFF)
219 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0xFF)
221 #define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
222 #define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (layer)<<8 | (key))
223 #define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
226 #define ACTION_USAGE_PAGE_SYSTEM 0
227 #define ACTION_USAGE_PAGE_CONSUMER 1
228 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
229 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
231 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
233 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
235 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
237 #define ACTION_FUNCTION(addr) ACTION(ACT_FUNCTION, addr)
240 /* helpers for readability */
241 #define LAYER(layer) (layer)
242 #define TAP(tap) (tap)
245 #define QUADRUPLE_TAP 4
246 #define QUINTUPLE_TAP 5
247 #define DOWN(key) (key)
248 #define UP(key) STROKE_UP, (key)
250 #endif /* ACTION_H */