keyboards/crkbd/readme.md

   1 # Corne Keyboard (CRKBD)
   2
   3 Also known (incorrectly) as the `HeliDox`.
   4
   5 ![Crkbd](https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg)
   6
   7 ![Crkbd](https://user-images.githubusercontent.com/736191/40887871-0eead5dc-678a-11e8-9518-e3ad9e5d2bac.png)
   8
   9 A split keyboard with 3x6 vertically staggered keys and 3 thumb keys.
  10
  11 Keyboard Maintainer: [foostan](https://github.com/foostan/) [@foostan](https://twitter.com/foostan)
  12 Hardware Supported: Crkbd PCB, Pro Micro
  13 Hardware Availability: [PCB & Case Data](https://github.com/foostan/crkbd)
  14
  15 Make example for this keyboard (after setting up your build environment):
  16
  17 ```sh
  18 make crkbd:default
  19 ```
  20
  21 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
  22
  23 ## RGB Matrix
  24 The Corne Keyboard also supports using the RGB Matrix feature, in place of RGB Light.  This provids a better experience when using the keyboard, as it supports a number of per key effects properly.  If you're not using the in switch LEDs, then you may want to pass on doing this.
  25
  26 In your keymap's `rules.mk` file, add the following:
  27
  28 ```make
  29 RGBLIGHT_ENABLE = no
  30 RGB_MATRIX_ENABLE = WS2812
  31 ```
  32
  33 And in your `config.h` file, add the following:
  34
  35 ```c
  36
  37 #ifdef RGB_MATRIX_ENABLE
  38 #   define RGB_MATRIX_KEYPRESSES // reacts to keypresses
  39 // #   define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
  40 // #   define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
  41 #   define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
  42 #   define RGB_MATRIX_FRAMEBUFFER_EFFECTS
  43 // #   define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
  44 // #   define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
  45 #    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
  46 #    define RGB_MATRIX_HUE_STEP 8
  47 #    define RGB_MATRIX_SAT_STEP 8
  48 #    define RGB_MATRIX_VAL_STEP 8
  49 #    define RGB_MATRIX_SPD_STEP 10
  50
  51 /* Disable the animations you don't want/need.  You will need to disable a good number of these    *
  52  * because they take up a lot of space.  Disable until you can successfully compile your firmware. */
  53 // #   define DISABLE_RGB_MATRIX_ALPHAS_MODS
  54 // #   define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
  55 // #   define DISABLE_RGB_MATRIX_BREATHING
  56 // #   define DISABLE_RGB_MATRIX_CYCLE_ALL
  57 // #   define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
  58 // #   define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
  59 // #   define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
  60 // #   define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
  61 // #   define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
  62 // #   define DISABLE_RGB_MATRIX_DUAL_BEACON
  63 // #   define DISABLE_RGB_MATRIX_RAINBOW_BEACON
  64 // #   define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
  65 // #   define DISABLE_RGB_MATRIX_RAINDROPS
  66 // #   define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
  67 // #   define DISABLE_RGB_MATRIX_TYPING_HEATMAP
  68 // #   define DISABLE_RGB_MATRIX_DIGITAL_RAIN
  69 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE
  70 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
  71 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
  72 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
  73 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
  74 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
  75 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
  76 // #   define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
  77 // #   define DISABLE_RGB_MATRIX_SPLASH
  78 // #   define DISABLE_RGB_MATRIX_MULTISPLASH
  79 // #   define DISABLE_RGB_MATRIX_SOLID_SPLASH
  80 // #   define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
  81 #endif
  82 ```
  83
  84 However, to properly handle the LED matrix, two LED maps had to be used. One for the left half, and one for the right half.  For the left, you don't need to do anything. That's the default setup.  But for the right side, you need to add `RGB_MATRIX_SPLIT_RIGHT=yes` needs to be added to the command.
  85
  86 First, compile and flash the left half.  Then when that's done, recompile with the setting above.  It should look something like:
  87
  88 ```sh
  89 make crkbd:default RGB_MATRIX_SPLIT_RIGHT=yes
  90 ```
  91 And then flash this new firmware image.
  92
  93 After this is done, you should be able to use the normal RGB keycodes, but you'll see the RGB Matrix effects in use, giving a much better experience.