keyboard/ergodox/Ergodox-FAQ.md

   1 # TMK Generic
   2
   3 * I'm not sure what the Magic + H does.
   4  Is this a menu that will pop up regardless of what platform and program is open?
   5
   6  Yes, this is sort of debugging.
   7  Use PJRC's [hid_listen](https://www.pjrc.com/teensy/hid_listen.html) to see debug messages.
   8
   9 # TMK/Ergodox specific
  10
  11 * I would like to configure my leds to indicate the active layer.
  12  I read that can be done, but I haven't seen an example for this firmware.
  13  Can someone please post an example or a link?
  14
  15  TMK for Ergodox have support for seven (!) led's:
  16  - three on right
  17  - three on left (see http://geekhack.org/index.php?topic=22780.msg873819#msg873819 for more details)
  18  - Teensy onboard led as well
  19
  20  Any of these leds can be used as layer indicator or NumLock/CapsLock/ScrollLock led.
  21
  22  [Here is example](https://github.com/cub-uanic/tmk_keyboard/blob/cub_layout/keyboard/ergodox/matrix.c#L121-167)
  23  how you can assign some meaning to each led.
  24  In this code only left leds are used to show layers, but you can
  25  [change `led_set()`](https://github.com/cub-uanic/tmk_keyboard/blob/cub_layout/keyboard/ergodox/led.c)
  26  and do anything you want with all leds.
  27
  28 # Firmware
  29
  30 #### Where to get binaries?
  31 https://github.com/cub-uanic/tmk_keyboard/releases
  32
  33 #### Where to get sources?
  34 https://github.com/cub-uanic/tmk_keyboard/tree/master
  35
  36 #### How to compile?
  37
  38     cd tmk_keyboard/keyboard/ergodox
  39
  40     # just to be safe
  41     make -f Makefile.lufa clean
  42
  43     # use one of these
  44     make -f Makefile.lufa
  45     make -f Makefile.lufa dvorak
  46     make -f Makefile.lufa colemak
  47     make -f Makefile.lufa workman
  48     make -f Makefile.lufa micro
  49     make -f Makefile.lufa cub
  50
  51
  52 # Layouts
  53
  54 TODO description of layouts in base firmware binaries
  55
  56
  57 # Things TO-DO
  58
  59 - [ ] Flash NumLock led only when "numpad" layer is active
  60 - [ ] Command (in terms of IS_COMMAND) to switch to no-leds mode
  61 - [ ] Increase count of ACTION keys
  62 - [ ] Fix command_state() onboard led: it should flash only when kbd in some specific mode (CONSOLE || MOUSE)
  63 - [ ] ergodox_blink_all_leds() should save current state of leds, and restore after blink. initial state of all leds == off
  64 - [ ] add support for pseudo-backlight (reversed LEDs) + docs/photo
  65 - [ ] command to debug all LEDs (on/off/blink)
  66 - [ ] proper (in-core) implementation of DEBUG_MATRIX_SCAN_RATE (non-Ergodox specific)
  67 - [ ] proper (in-core) support for per-layer fn_actions[]
  68 - [ ] create one-handed layouts, see
  69         http://half-qwerty.com/
  70         https://geekhack.org/index.php?topic=60165.0
  71         https://www.massdrop.com/ext/ergodox/?hash=e097c3b9932179055023d47e48b25f1d
  72