/
USBKeyboard2.js
389 lines (372 loc) · 13.4 KB
/
USBKeyboard2.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/* following right below is the Espruino code */
/*
Original code ( USBKeyboard.js )
Copyright (c) 2015 Gordon Williams, Pur3 Ltd. See the file LICENSE for copying permission.
Below code ( modified* version of USBKeyboard.js )
Copyright (c) 2018 Stephane Adam Garnier, SeedsDesign. MIT license. ( or whatever is the best in regards to Gordon Williams' ;p )
*Nb: both versions of the module could be merged if we can use the modified version of .type() ;)
*/
```
var wskb = require("USBKeyboard2");
// use as the original USBKeyboard module
setWatch(function() {
wskb.setModifiers(wskb.MODIFY.SHIFT, function() {
wskb.type("HELLO WORLD", function() {
wskb.setModifiers(0, function() {
wskb.tap(wskb.KEY.ENTER);
});
});
});
}, BTN, {debounce:100,repeat:true, edge:"rising"});
// enjoy niceties
exports.htype('abcdefghijklmnopqrstuvwxyz');
exports.htype('abcdefghijklmnopqrstuvwxyz'.toUpperCase());
exports.htype('aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ');
exports.htype('1234567890');
// combine with .tap() .. and do inception ? ^^
exports.htype('exports.htype("lol");', function(){ exports.tap(KEY.ENTER); });
// combine any char & it will auto handle applying the right modifier flag(s)
exports.htype('rgb(0, 255, 128)');
exports.htype('#0FAC3A');
exports.htype('hsl(360, 100%, 50%)');
// not all characters are supported this way, but adding them is quite easy ( ex: for "©" )
exports.htype('Hello World Espruino© USBKeyboard2.js module !');
```
E.setUSBHID({
reportDescriptor : [
0x05, 0x01, // Usage Page (Generic Desktop),
0x09, 0x06, // Usage (Keyboard),
0xA1, 0x01, // Collection (Application),
0x75, 0x01, // Report Size (1),
0x95, 0x08, // Report Count (8),
0x05, 0x07, // Usage Page (Key Codes),
0x19, 0xE0, // Usage Minimum (224),
0x29, 0xE7, // Usage Maximum (231),
0x15, 0x00, // Logical Minimum (0),
0x25, 0x01, // Logical Maximum (1),
0x81, 0x02, // Input (Data, Variable, Absolute), ;Modifier byte
0x95, 0x01, // Report Count (1),
0x75, 0x08, // Report Size (8),
0x81, 0x03, // Input (Constant), ;Reserved byte
0x95, 0x05, // Report Count (5),
0x75, 0x01, // Report Size (1),
0x05, 0x08, // Usage Page (LEDs),
0x19, 0x01, // Usage Minimum (1),
0x29, 0x05, // Usage Maximum (5),
0x91, 0x02, // Output (Data, Variable, Absolute), ;LED report
0x95, 0x01, // Report Count (1),
0x75, 0x03, // Report Size (3),
0x91, 0x03, // Output (Constant), ;LED report padding
0x95, 0x06, // Report Count (6),
0x75, 0x08, // Report Size (8),
0x15, 0x00, // Logical Minimum (0),
0x25, 0x68, // Logical Maximum(104),
0x05, 0x07, // Usage Page (Key Codes),
0x19, 0x00, // Usage Minimum (0),
0x29, 0x68, // Usage Maximum (104),
0x81, 0x00, // Input (Data, Array),
0xc0 // End Collection
]
});
/*
R: even if some characters are NOT printed onto some keyboard keys,
it doesn't mean that pressing a modifier then a key wouldn't produce another character
in other words, only the OS keymap layout is important, NOT what's printed on one's keyboard
*/
// R: Hut1_12v2.pdf p.53
var MODIFY = {
CTRL : 0x01,
SHIFT : 0x02,
ALT : 0x04,
GUI : 0x08,
LEFT_CTRL : 0x01,
LEFT_SHIFT : 0x02,
LEFT_ALT : 0x04,
LEFT_GUI : 0x08,
RIGHT_CTRL : 0x10,
RIGHT_SHIFT : 0x20,
RIGHT_ALT : 0x40,
RIGHT_GUI : 0x80
};
/* followinf layout is for the keyboard mapping on a zenbook prime ( FR ) */
var KEY = {
//a : 4,
//A :[4, MODIFY.SHIFT],
a : 20, // MAPPED FROM US/EN "q"
A :[20, MODIFY.SHIFT], // MAPPED FROM US/EN "Q"
b : 5,
B :[5, MODIFY.SHIFT],
c : 6,
C :[6, MODIFY.SHIFT],
"©" :[6, MODIFY.SHIFT | MODIFY.RIGHT_ALT], // BONUS/EXAMPLE FOR HOW TO SET MULTIPLE MODIFIER FLAGS
d : 7,
D :[7, MODIFY.SHIFT],
e : 8,
E :[8, MODIFY.SHIFT],
f : 9,
F :[9, MODIFY.SHIFT],
g : 10,
G :[10, MODIFY.SHIFT],
h : 11,
H :[11, MODIFY.SHIFT],
i : 12,
I :[12, MODIFY.SHIFT],
j : 13,
J :[13, MODIFY.SHIFT],
k : 14,
K :[14, MODIFY.SHIFT],
l : 15,
L :[15, MODIFY.SHIFT],
//m : 16, // WILL BECOME ","
m : 51, // MAPPED FROM US/EN ";"
//M :[16, MODIFY.SHIFT], // WILL BECOME ""
M :[51, MODIFY.SHIFT],
n : 17,
N :[17, MODIFY.SHIFT],
o : 18,
O :[18, MODIFY.SHIFT],
p : 19,
P :[19, MODIFY.SHIFT],
//q : 20, // MAPPED FROM US/EN "a"
//Q :[20, MODIFY.SHIFT], // MAPPED FROM US/EN "A"
q : 4,
Q :[4, MODIFY.SHIFT],
r : 21,
R :[21, MODIFY.SHIFT],
s : 22,
S :[22, MODIFY.SHIFT],
t : 23,
T :[23, MODIFY.SHIFT],
u : 24,
U :[24, MODIFY.SHIFT],
v : 25,
V :[25, MODIFY.SHIFT],
//w : 26,
//W :[26, MODIFY.SHIFT],
w : 29, // MAPPED FROM US/EN "z"
W :[29, MODIFY.SHIFT], // MAPPED FROM US/EN "Z"
x : 27,
X :[27, MODIFY.SHIFT],
y : 28,
Y :[28, MODIFY.SHIFT],
//z : 29,
//Z :[29, MODIFY.SHIFT],
z : 26, // MAPPED FROM US/EN "w"
Z :[26, MODIFY.SHIFT], // MAPPED FROM US/EN "W"
"²" : 53, // MAPPED FROM US/EN "~"
"&" : 30,
1 :[30, MODIFY.SHIFT],
"é" : 31,
2 :[31, MODIFY.SHIFT],
"~" :[31, MODIFY.RIGHT_ALT],
'"' : 32,
3 :[32, MODIFY.SHIFT],
"#" :[32, MODIFY.RIGHT_ALT],
"'" : 33,
4 :[33, MODIFY.SHIFT],
"{" :[33, MODIFY.RIGHT_ALT],
"(" : 34,
5 :[34, MODIFY.SHIFT],
"[" :[34, MODIFY.RIGHT_ALT],
"-" : 35,
6 :[35, MODIFY.SHIFT],
"|" :[35, MODIFY.RIGHT_ALT],
"è" : 36,
7 :[36, MODIFY.SHIFT],
"`" :[36, MODIFY.RIGHT_ALT],
"_" : 37,
8 :[37, MODIFY.SHIFT],
"\\" :[37, MODIFY.RIGHT_ALT],
"ç" : 38,
9 :[38, MODIFY.SHIFT],
"^" :[38, MODIFY.RIGHT_ALT], // HAS A COMMENTED-OUT DUPLICATE "^"
"à" : 39,
0 :[39, MODIFY.SHIFT],
"@" :[39, MODIFY.RIGHT_ALT],
")" : 45, // MAPPED FROM US/EN "-"
"°" :[45, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
"]" :[45, MODIFY.RIGHT_ALT], // DEDUCE FROM THE ABOVE
"=" : 46, // SAME AS FOR US/EN "="
"+" :[46, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
"}" :[46, MODIFY.RIGHT_ALT], // DEDUCED FROM THE ABOVE
// WIP P..
//"^" : 47, // MAPPED FROM US/EN "[" // DUPLICATE "^"
"¨" :[47, MODIFY.SHIFT], // MAPPED FROM US/EN "{"
"$" : 48, // MAPPED FROM US/EN "]"
"£" :[48, MODIFY.SHIFT], // MAPPED FROM US/EN "}"
"¤" :[48, MODIFY.RIGHT_ALT], // DEDUCED FROM THE ABOVE
// WIP M..
"ù" : 52, // MAPPED FROM US/EN "'"
"%" :[52, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
"*" : 49, // MAPPED FROM US/EN "\\"
"µ" :[49, MODIFY.SHIFT],
"<" :[54, MODIFY.SHIFT], // MAPPED FROM US/EN ","
">" :[55, MODIFY.SHIFT], // MAPPED FROM US/EN "."
// WIP N..
"," : 16, // MAPPED FROM US/EN "m"
"?" :[16, MODIFY.SHIFT], // MAPPED FROM US/EN "M"
";" : 54, // MAPPED FROM US/EN ","
"." :[54, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
":" : 55, // MAPPED FROM US/EN "."
"/" :[55, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
"!" : 56, // MAPPED FROM US/EN "/"
"§" :[56, MODIFY.SHIFT], // DEDUCED FROM THE ABOVE
ENTER : 40,
"\n" : 40,
ESC : 41,
BACKSPACE : 42,
"\t" : 43,
" " : 44,
//"-" : 45, // - & _ // REMAPPED
//"=" : 46, // = & + // REMAPPED
//"[" : 47, // [ & { // REMAPPED
//"]" : 48, // ] & } // REMAPPED
//"\\" : 49, // \ & | // REMAPPED
NUMBER : 50, // # & ²
//";" : 51, // ; & : // REMAPPED
//"'" : 52, // ' & " // REMAPPED
//"~" : 53, // grave accent & ~ // REMAPPED
//"," : 54, // , & < // REMAPPED
//"." : 55, // . & > // REMAPPED
//"/" : 56, // / & ? // REMAPPED
CAPS_LOCK : 57,
F1 : 58,
F2 : 59,
F3 : 60,
F4 : 61,
F5 : 62,
F6 : 63,
F7 : 64,
F8 : 65,
F9 : 66,
F10 : 67,
F11 : 68,
F12 : 69,
PRINTSCREEN : 70,
SCROLL_LOCK : 71,
PAUSE : 72,
INSERT : 73,
HOME : 74,
PAGE_UP : 75,
DELETE : 76,
END : 77,
PAGE_DOWN : 78,
RIGHT : 79,
LEFT : 80,
DOWN : 81,
UP : 82,
NUM_LOCK : 83,
PAD_SLASH : 84,
PAD_ASTERIX : 85,
PAD_MINUS : 86,
PAD_PLUS : 87,
PAD_ENTER : 88,
PAD_1 : 89,
PAD_2 : 90,
PAD_3 : 91,
PAD_4 : 92,
PAD_5 : 93,
PAD_6 : 94,
PAD_7 : 95,
PAD_8 : 96,
PAD_9 : 97,
PAD_0 : 98,
PAD_PERIOD : 99
};
var exports = {}; // when using a module from the right hand side of the Espruino IDE
exports.KEY = KEY;
exports.MODIFY = MODIFY;
var modifiers = 0;
exports.setModifiers = function(m, callback) {
modifiers = m;
E.sendUSBHID([modifiers,0,0,0,0,0,0,0]);
if (callback) setTimeout(callback, 10);
}
exports.tap = function(key, callback) {
E.sendUSBHID([modifiers,0,key,0,0,0,0,0]);
setTimeout(function() {
E.sendUSBHID([modifiers,0,0,0,0,0,0,0]);
if (callback) setTimeout(callback, 10);
}, 10);
}
/*
// original typing fcn
exports.type = function(txt, callback) {
var intr = setInterval(function() {
if (!txt.length) {
clearInterval(intr);
if (callback) callback();
} else {
if (txt[0] in KEY) exports.tap(KEY[txt[0]]);
txt = txt.substr(1);
}
}, 20);
}
*/
// original typing fcn - modified to work with the adjusted "KEY" obj
exports.type = function(txt, callback) {
var intr = setInterval(function() {
if (!txt.length) {
clearInterval(intr);
if (callback) callback();
} else {
if (txt[0] in KEY) {
// to ease using the adjusted "mixed values type" KEY obj
if( typeof KEY[txt[0]] === 'number'){ exports.tap(KEY[txt[0]]); }
else { exports.tap(KEY[txt[0]][0]); }
}
//exports.tap(KEY[txt[0]]); // originally
txt = txt.substr(1);
}
}, 20);
}
/*
// wip debug code
var htype = function(txt, callback){
var intr = setInterval(function(){
if (!txt.length){
clearInterval(intr);
if(callback) callback();
} else {
if(txt[0] in KEY){
console.log('key idx exist in layout keys:', KEY[txt[0]]);
if( typeof KEY[txt[0]] === 'number'){ console.log('char keycode: ' + KEY[txt[0]] ); }
else { console.log('modifier(s): ' + KEY[txt[0]][1] + ' char keycode: ' + KEY[txt[0]][0] ); }
}
txt = txt.substr(1);
}
}, 20);
}
*/
// wip debug code -- TO TEST ON ESPRUINO DEVICE :D
//var htype = function(txt, callback){
exports.htype = function(txt, callback){
var intr = setInterval(function(){
if (!txt.length){
clearInterval(intr);
if(callback) callback();
} else {
if(txt[0] in KEY){
//console.log('key idx exist in layout keys:', KEY[txt[0]]);
if( typeof KEY[txt[0]] === 'number'){
//console.log('char keycode: ' + KEY[txt[0]]);
var keyCode = KEY[txt[0]];
exports.setModifiers(0, function(){
exports.tap( keyCode );
});
}
else {
//console.log('modifier(s): ' + KEY[txt[0]][1] + ' char keycode: ' + KEY[txt[0]][0] );
var modifiersFlag = KEY[txt[0]][1];
var keyCode = KEY[txt[0]][0];
exports.setModifiers(modifiersFlag, function(){
exports.tap( keyCode, function(){
exports.setModifiers(0); // TODO: try moving this to be called only on end of txt processing
});
});
}
}
txt = txt.substr(1);
}
}, 50); // 20ms seems not enough for reliable typing ..
}