forked from biemster/3keys_1knob
-
Notifications
You must be signed in to change notification settings - Fork 0
/
3keys_1knob.c
481 lines (429 loc) · 14.7 KB
/
3keys_1knob.c
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
// ===================================================================================
// Project: MacroPad Mini for CH551, CH552 and CH554
// Version: v1.1
// Year: 2023
// Author: Stefan Wagner
// Github: https://github.com/wagiminator
// EasyEDA: https://easyeda.com/wagiminator
// License: http://creativecommons.org/licenses/by-sa/3.0/
// ===================================================================================
//
// Description:
// ------------
// Firmware example implementation for the MacroPad Mini.
//
// References:
// -----------
// - Blinkinlabs: https://github.com/Blinkinlabs/ch554_sdcc
// - Deqing Sun: https://github.com/DeqingSun/ch55xduino
// - Ralph Doncaster: https://github.com/nerdralph/ch554_sdcc
// - WCH Nanjing Qinheng Microelectronics: http://wch.cn
//
// Compilation Instructions:
// -------------------------
// - Chip: CH551, CH552 or CH554
// - Clock: min. 12 MHz internal
// - Adjust the firmware parameters in include/config.h if necessary.
// - Make sure SDCC toolchain and Python3 with PyUSB is installed.
// - Press BOOT button on the board and keep it pressed while connecting it via USB
// with your PC.
// - Run 'make flash'.
//
// Operating Instructions:
// -----------------------
// - Connect the board via USB to your PC. It should be detected as a HID keyboard.
// - Press a macro key and see what happens.
// - To enter bootloader hold down key 1 while connecting the MacroPad to USB. All
// NeoPixels will light up white as long as the device is in bootloader mode
// (about 10 seconds).
// ===================================================================================
// Libraries, Definitions and Macros
// ===================================================================================
// Libraries
#include <config.h> // user configurations
#include <system.h> // system functions
#include <delay.h> // delay functions
#include <neo.h> // NeoPixel functions
#include <usb_conkbd.h> // USB HID consumer keyboard functions
// Prototypes for used interrupts
void USB_interrupt(void);
void USB_ISR(void) __interrupt(INT_NO_USB) {
USB_interrupt();
}
// ===================================================================================
// NeoPixel Functions
// ===================================================================================
enum Event {
NONE,
KEY1,
KEY2,
KEY3,
ENC_SW,
ENC_CW,
ENC_CCW,
KEY12,
KEY23,
KEY13,
ENC_SW_CW,
ENC_SW_CCW
};
struct RGB {
uint8_t r;
uint8_t g;
uint8_t b;
};
struct Chars {
char mod1;
char char1;
char mod2;
char char2;
char mod3;
char char3;
char modSW;
char charSW;
char modCW;
char charCW;
char modCCW;
char charCCW;
char mod12;
char char12;
char mod23;
char char23;
char mod13;
char char13;
char swcharCW;
char swcharCCW;
char swmodCW;
char swmodCCW;
};
__idata struct RGB neo[4];
__idata struct RGB neobg[4];
__idata struct RGB neofg[4];
__idata struct RGB neofade[4];
__idata uint8_t layer = 0;
__idata uint8_t max_layer = 0;
__idata uint8_t show_mode = 0;
__idata uint8_t option[4] = { 0 };
__idata struct Chars chars[4];
__idata const int8_t encoder_factor[] = { 0, 1, -1, 2, -1, 0, -2, 1, 1, -2, 0, -1, 2, -1, 1, 0 };
__idata int8_t encoder_value = 0;
// Update NeoPixels
void NEO_update(void) {
EA = 0; // disable interrupts
NEO_writeColor(neo[1].r, neo[1].g, neo[1].b);
NEO_writeColor(neo[2].r, neo[2].g, neo[2].b);
NEO_writeColor(neo[3].r, neo[3].g, neo[3].b);
EA = 1; // enable interrupts
}
void set_neo_rgb(uint8_t n, uint8_t r, uint8_t g, uint8_t b);
void set_neo_rgb(uint8_t n, uint8_t r, uint8_t g, uint8_t b) {
if (n == 0) {
set_neo_rgb(1, r, g, b);
set_neo_rgb(2, r, g, b);
set_neo_rgb(3, r, g, b);
} else { neo[n].r = r; neo[n].g = g; neo[n].b = b; }
}
void set_neo_fg(uint8_t n);
void set_neo_fg(uint8_t n) {
if (n == 0) { set_neo_fg(1); set_neo_fg(2); set_neo_fg(3); }
else { set_neo_rgb(n, neofg[layer].r, neofg[layer].g, neofg[layer].b); }
}
void set_neo_bg(uint8_t n);
void set_neo_bg(uint8_t n) {
if (n == 0) { set_neo_bg(1); set_neo_bg(2); set_neo_bg(3); }
else { set_neo_rgb(n, neobg[layer].r, neobg[layer].g, neobg[layer].b); }
}
uint8_t safe_fade(uint8_t from, uint8_t by, uint8_t min) {
if (from <= min) { return min; }
if (from < by) { return min; }
from -= by;
if (by < min) { return min; }
return from;
}
void fade_out(uint8_t n);
void fade_out(uint8_t n) {
if (n == 0) { fade_out(1); fade_out(2); fade_out(3); }
else {
neo[n].r = safe_fade(neo[n].r, neofade[layer].r, neobg[layer].r);
neo[n].g = safe_fade(neo[n].g, neofade[layer].g, neobg[layer].g);
neo[n].b = safe_fade(neo[n].b, neofade[layer].b, neobg[layer].b);
}
}
void type_uint(uint8_t n) {
KBD_type('0' + (n / 100));
KBD_type('0' + ((n % 100) / 10));
KBD_type('0' + ((n % 10) / 1));
}
void type_delimit() { KBD_type(','); KBD_type(' '); }
void parse_layer(int8_t dir) {
if (max_layer > 3) { max_layer = 3; }
if (dir == 0) { layer = 0; return; }
switch (max_layer) {
case 0:
layer = 0;
break;
case 1:
layer = 3;
break;
case 2:
if (dir > 0) { layer = 2; return; }
if (dir < 0) { layer = 3; return; }
break;
case 3:
layer += dir;
if (layer > 3) { layer = 1; }
if (layer < 1) { layer = 3; }
break;
}
}
void seq_delay(uint8_t n) {
__idata uint8_t i;
if (n < 1) { return; }
if (n > 3) { return; }
for (i = 0; i < option[n]; i++) { DLY_ms(100); }
}
void mod_type(char c, uint8_t mod);
void get_type(enum Event ev, uint8_t n);
void parse_type(enum Event ev) {
get_type(ev, layer);
if (layer == 0) {
if (max_layer <= 2) { seq_delay(1); get_type(ev, 1); }
if (max_layer <= 1) { seq_delay(2); get_type(ev, 2); }
if (max_layer <= 0) { seq_delay(3); get_type(ev, 3); }
}
}
void get_type(enum Event ev, uint8_t n) {
char c = 0;
uint8_t mod = 0;
switch (ev) {
case KEY1:
c = chars[n].char1; mod = chars[n].mod1; break;
case KEY2:
c = chars[n].char2; mod = chars[n].mod2; break;
case KEY3:
c = chars[n].char3; mod = chars[n].mod3; break;
case ENC_SW:
c = chars[n].charSW; mod = chars[n].modSW; break;
case ENC_CW:
c = chars[n].charCW; mod = chars[n].modCW; break;
case ENC_CCW:
c = chars[n].charCCW; mod = chars[n].modCCW; break;
case KEY12:
c = chars[n].char12; mod = chars[n].mod12; break;
case KEY23:
c = chars[n].char23; mod = chars[n].mod23; break;
case KEY13:
c = chars[n].char13; mod = chars[n].mod13; break;
case ENC_SW_CW:
c = chars[n].swcharCW; mod = chars[n].swmodCW; break;
case ENC_SW_CCW:
c = chars[n].swcharCCW; mod = chars[n].swmodCCW; break;
}
if (c == 0) { return; }
if (mod == 0xFF) {
if (c >= 0xF0) {
switch (c) {
case 0xF0: parse_layer(0); break;
case 0xF1: layer = 1; break;
case 0xF2: layer = 2; break;
case 0xF3: layer = 3; break;
case 0xF5: max_layer = 0; break;
case 0xF6: max_layer = 1; break;
case 0xF7: max_layer = 2; break;
case 0xF8: max_layer = 3; break;
case 0xFA: parse_layer(-1); break;
case 0xFB: parse_layer(1); break;
case 0xFD: KBD_type('0' + (layer % 10)); break;
}
if (c != 0xFF) { show_mode = 60; }
} else {
CON_type(c);
}
return;
}
mod_type(c, mod);
}
void mod_type(char c, uint8_t mod) {
if (mod & 1) { KBD_press(KBD_KEY_LEFT_CTRL); }
if (mod & 2) { KBD_press(KBD_KEY_LEFT_SHIFT); }
if (mod & 4) { KBD_press(KBD_KEY_LEFT_ALT); }
if (mod & 8) { KBD_press(KBD_KEY_LEFT_GUI); }
if (mod & 16) { KBD_press(KBD_KEY_RIGHT_CTRL); }
if (mod & 32) { KBD_press(KBD_KEY_RIGHT_SHIFT); }
if (mod & 64) { KBD_press(KBD_KEY_RIGHT_ALT); }
if (mod & 128) { KBD_press(KBD_KEY_RIGHT_GUI); }
KBD_type(c);
if (mod & 128) { KBD_release(KBD_KEY_RIGHT_GUI); }
if (mod & 64) { KBD_release(KBD_KEY_RIGHT_ALT); }
if (mod & 32) { KBD_release(KBD_KEY_RIGHT_SHIFT); }
if (mod & 16) { KBD_release(KBD_KEY_RIGHT_CTRL); }
if (mod & 8) { KBD_release(KBD_KEY_LEFT_GUI); }
if (mod & 4) { KBD_release(KBD_KEY_LEFT_ALT); }
if (mod & 2) { KBD_release(KBD_KEY_LEFT_SHIFT); }
if (mod & 1) { KBD_release(KBD_KEY_LEFT_CTRL); }
}
// Read EEPROM (stolen from https://github.com/DeqingSun/ch55xduino/blob/ch55xduino/ch55xduino/ch55x/cores/ch55xduino/eeprom.c)
uint8_t eeprom_read_byte (uint8_t addr){
ROM_ADDR_H = DATA_FLASH_ADDR >> 8;
ROM_ADDR_L = addr << 1; //Addr must be even
ROM_CTRL = ROM_CMD_READ;
return ROM_DATA_L;
}
void enter_bootloader(void);
void parse_keys() {
static __bit key1 = 0;
static __bit key2 = 0;
static __bit key3 = 0;
static __idata uint8_t press = 0;
static __idata uint8_t hold = 0;
static __idata uint8_t all = 0; // three keys held
if (!PIN_read(PIN_KEY1) != key1) { key1 = !key1; }
if (!PIN_read(PIN_KEY2) != key2) { key2 = !key2; }
if (!PIN_read(PIN_KEY3) != key3) { key3 = !key3; }
hold = 0;
if (key1) { hold |= 1; press |= 1; set_neo_fg(1); }
if (key2) { hold |= 2; press |= 2; set_neo_fg(2); }
if (key3) { hold |= 4; press |= 4; set_neo_fg(3); }
if (hold == 0) {
switch (press) {
case 1: parse_type(KEY1); break;
case 2: parse_type(KEY2); break;
case 4: parse_type(KEY3); break;
case 3: parse_type(KEY12); break;
case 5: parse_type(KEY13); break;
case 6: parse_type(KEY23); break;
}
press = 0;
all = 0;
} else {
if (hold == 7) { all++; if (all > 200) { enter_bootloader(); } }
}
}
void parse_encoder() {
static __bit keyenc = 0;
static __idata uint8_t knob = 0; // knob held down
static __bit mode_changed = 0;
__idata int8_t encoder_dir = 0;
if (!PIN_read(PIN_ENC_SW) != keyenc) {
keyenc = !keyenc;
if (keyenc) { mode_changed = 0; }
if (!keyenc && !mode_changed) { parse_type(ENC_SW); }
}
if (encoder_value >= 4) { encoder_dir = -1; encoder_value -= 4; }
if (encoder_value <= -4) { encoder_dir = 1; encoder_value += 4; }
if (keyenc) { // encoder pressed
if (encoder_dir) {
mode_changed = 1;
if (encoder_dir > 0) { parse_type(ENC_SW_CCW); }
if (encoder_dir < 0) { parse_type(ENC_SW_CW); }
}
if (max_layer > 0) {
if (knob > 200) { parse_layer(0); mode_changed = 1; }
if (mode_changed) { show_mode = 60; knob = 0; } else { knob++; }
}
} else {
if (encoder_dir > 0) { parse_type(ENC_CCW); }
if (encoder_dir < 0) { parse_type(ENC_CW); }
knob = 0;
}
}
// ===================================================================================
// Main Function
// ===================================================================================
void enter_bootloader(void) {
__idata uint8_t i; // temp variable
NEO_latch(); // make sure pixels are ready
for(i=9; i; i--) NEO_sendByte(127); // light up all pixels
BOOT_now(); // enter bootloader
}
void main(void) {
// Variables
__idata uint8_t i = 0;
__idata uint8_t n = 0;
__bit warning = 0;
__idata uint8_t encoder_state = 0;
__idata uint8_t dt = 0;
// __idata struct RGB neomode;
NEO_init();
if (!PIN_read(PIN_KEY1)) { enter_bootloader(); }
CLK_config(); DLY_ms(5); KBD_init(); WDT_start();
for (i = 0; i <= 3; i++) {
n = i * 32;
chars[i].mod1 = (char)eeprom_read_byte(n++);
chars[i].char1 = (char)eeprom_read_byte(n++);
chars[i].mod2 = (char)eeprom_read_byte(n++);
chars[i].char2 = (char)eeprom_read_byte(n++);
chars[i].mod3 = (char)eeprom_read_byte(n++);
chars[i].char3 = (char)eeprom_read_byte(n++);
chars[i].modSW = (char)eeprom_read_byte(n++);
chars[i].charSW = (char)eeprom_read_byte(n++);
chars[i].modCW = (char)eeprom_read_byte(n++);
chars[i].charCW = (char)eeprom_read_byte(n++);
chars[i].modCCW = (char)eeprom_read_byte(n++);
chars[i].charCCW = (char)eeprom_read_byte(n++);
neofg[i].r = eeprom_read_byte(n++);
neofg[i].g = eeprom_read_byte(n++);
neofg[i].b = eeprom_read_byte(n++);
option[i] = eeprom_read_byte(n++);
chars[i].mod12 = (char)eeprom_read_byte(n++);
chars[i].char12 = (char)eeprom_read_byte(n++);
chars[i].mod23 = (char)eeprom_read_byte(n++);
chars[i].char23 = (char)eeprom_read_byte(n++);
chars[i].mod13 = (char)eeprom_read_byte(n++);
chars[i].char13 = (char)eeprom_read_byte(n++);
chars[i].swcharCW = (char)eeprom_read_byte(n++);
chars[i].swcharCCW = (char)eeprom_read_byte(n++);
neofade[i].r = eeprom_read_byte(n++);
neofade[i].g = eeprom_read_byte(n++);
neofade[i].b = eeprom_read_byte(n++);
chars[i].swmodCW = (char)eeprom_read_byte(n++);
neobg[i].r = eeprom_read_byte(n++);
neobg[i].g = eeprom_read_byte(n++);
neobg[i].b = eeprom_read_byte(n++);
chars[i].swmodCCW = (char)eeprom_read_byte(n++);
if ((neofg[i].r | neofg[i].g | neofg[i].b) == 0) {
neofg[i].r = 0xFF; neofg[i].g = 0x16;
}
if ((neobg[i].r | neobg[i].g | neobg[i].b) == 0) {
neobg[i].r = 0xC; neobg[i].g = 0x1;
}
if (neofade[i].r == 0) { neofade[i].r = 1; }
if (neofade[i].g == 0) { neofade[i].g = 1; }
if (neofade[i].b == 0) { neofade[i].b = 1; }
}
max_layer = option[0];
if ((chars[0].char1 | chars[0].char2 | chars[0].char3) == 0) {
neo[1].r = 255; neo[1].g = 0; neo[1].b = 0; NEO_update();
DLY_ms(200); neo[1].r = 0; NEO_update();
DLY_ms(200); neo[1].r = 255; NEO_update();
DLY_ms(200); neo[1].r = 0; NEO_update();
DLY_ms(200); neo[1].r = 255; NEO_update();
DLY_ms(200);
}
set_neo_bg(1); set_neo_bg(2); set_neo_bg(3);
for (i = 1; i <= 3; i++) {
if (max_layer >= i) { set_neo_fg(i); }
}
DLY_ms(200);
set_neo_fg(1); set_neo_fg(2); set_neo_fg(3);
while (1) {
if (max_layer == 0) { layer = 0; }
i = (encoder_state & 3) | ((!PIN_read(PIN_ENC_A)) << 2) | ((!PIN_read(PIN_ENC_B)) << 3);
encoder_state = i >> 2;
encoder_value += encoder_factor[i];
dt++;
if (dt >= 5) {
parse_keys();
parse_encoder();
NEO_update();
fade_out(0);
if (show_mode) {
show_mode--;
set_neo_rgb(0, neofg[layer].r, neofg[layer].g, neofg[layer].b);
}
WDT_reset();
dt -= 5;
}
DLY_ms(1);
}
}