This is layer notification for QMK Keyboard / firmware.
Notification pop-up will show each time layer changes.
iam really expecting you and community to improve this repo since i think this is the the first and only solution for qmk layer notification (instead using screen / lcd) by now.
- Made using node and other supporting library
- Notification pop-up will show each time layer changes.
- Plug / un-Plug detection
split in 3 step (qmk code, QMK Layer Notification, node application management)
prerequisite QMK debuging
Your keyboard will output debug information if you have CONSOLE_ENABLE = yes in your rules.mk. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the DEBUG keycode in your keymap, use the Command feature to enable debug mode, or add the following code to your keymap.
- put
#include "print.h"
on top yourkeymap.c
- put
uprintf("SOME DYNAMIC LAYER CHANGES\n");
inkeymap.c
, somewhere in your layer shift code - my example :
#include "print.h"
...
bool process_record_user(uint16_t keycode, keyrecord_t* record) {
switch (keycode) {
case KC_CYCLE_LAYERS: // custom macro
if (record->event.pressed) {
// SEND_STRING("I love QMK with VIA!");
selected_layer++;
if (selected_layer > 3) {
selected_layer = 0;
}
layer_clear();
layer_on(selected_layer);
uprintf("layer%u\n", selected_layer);
}
break;
}
return true;
}
- Check if the debug already running :
Debugging With hid_listen Something stand-alone? hid_listed, provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available.
prerequisite. Node and NPM. google it how to have in your computer. there is ton of resources out there.
- clone this repo
- install depedency
npm i
- check the result of your HID list on your device
node list
- find your device, and edit config.js accordingly. example somewhere in result
[
...{
vendorId: 28263,
productId: 8499,
path: "\\\\?\\hid#vid_6e67&pid_2133&mi_02&col01#7&2e040053&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030}",
manufacturer: "nguyedt",
product: "Bento",
release: 256,
interface: 2,
usagePage: 1,
usage: 128,
},
...{
vendorId: 28263,
productId: 8499,
path: "\\\\?\\hid#vid_6e67&pid_2133&mi_01#7&1ad3e415&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030}",
manufacturer: "nguyedt",
product: "Bento",
release: 256,
interface: 1,
usagePage: 65376,
usage: 97,
},
];
GLITCH1. somehow, sometimes, this resulting multiple (array) device with same vendorId & productId. index in config.device
use to manually select which device that will monitor using it index (start from 0). StUpiDly try which index to use/monitor, one by one (at least for now).
then i put that information into config.js
.
export const device = {
vid: 28263, //vendorId
pid: 8499, //productId
index: 1, // 0 - ~
};
- Test the aplication
node index
this will make the aplication run at startup, auto restart on crash, etc. read more pm2
- install pm2
npm i pm2 -g
- register the application
pm2 start index.js --name qmk_layer_notification
- save confif
pm2 save
- This is barely functional notification pop-up
- Iam still found glitch / bug there and there
- Only tested in windows for now (teorytically applicatible in other OS)
- GLITCH1. how efficiently selected which device to monitor
- put the code inside installer (ie. electoron) and make other people use easier.
- improve notification UI message & mapping. like, "Layer - Default" , "Layer - OBS", etc
- dynamic config reference for different user/config thru args or other method
- resource optimization ?