docs/modding_your_keyboard.md

   1
   2 ## Audio output from a speaker
   3
   4 Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any keyboard that allows access to the C6 or B5 port (`#define C6_AUDIO` and `#define B5_AUDIO`), you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
   5
   6 The audio code lives in [quantum/audio/audio.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/audio.h) and in the other files in the audio directory. It's enabled by default on the Planck [stock keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/planck/keymaps/default/keymap.c). Here are the important bits:
   7
   8 ```
   9 #include "audio.h"
  10 ```
  11
  12 Then, lower down the file:
  13
  14 ```
  15 float tone_startup[][2] = {
  16     ED_NOTE(_E7 ),
  17     E__NOTE(_CS7),
  18     E__NOTE(_E6 ),
  19     E__NOTE(_A6 ),
  20     M__NOTE(_CS7, 20)
  21 };
  22 ```
  23
  24 This is how you write a song. Each of these lines is a note, so we have a little ditty composed of five notes here.
  25
  26 Then, we have this chunk:
  27
  28 ```
  29 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
  30 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
  31 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
  32 float tone_plover[][2]     = SONG(PLOVER_SOUND);
  33 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
  34
  35 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
  36 float goodbye[][2] = SONG(GOODBYE_SOUND);
  37 ```
  38
  39 Wherein we bind predefined songs (from [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h)) into named variables. This is one optimization that helps save on memory: These songs only take up memory when you reference them in your keymap, because they're essentially all preprocessor directives.
  40
  41 So now you have something called `tone_plover` for example. How do you make it play the Plover tune, then? If you look further down the keymap, you'll see this:
  42
  43 ```
  44 PLAY_NOTE_ARRAY(tone_plover, false, 0); // Signature is: Song name, repeat, rest style
  45 ```
  46
  47 This is inside one of the macros. So when that macro executes, your keyboard plays that particular chime.
  48
  49 "Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes.
  50
  51 ## Music mode
  52
  53 The music mode maps your columns to a chromatic scale, and your rows to octaves. This works best with ortholinear keyboards, but can be made to work with others. All keycodes less than `0xFF` get blocked, so you won't type while playing notes - if you have special keys/mods, those will still work. A work-around for this is to jump to a different layer with KC_NOs before (or after) enabling music mode.
  54
  55 Recording is experimental due to some memory issues - if you experience some weird behavior, unplugging/replugging your keyboard will fix things.
  56
  57 Keycodes available:
  58
  59 * `MU_ON` - Turn music mode on
  60 * `MU_OFF` - Turn music mode off
  61 * `MU_TOG` - Toggle music mode
  62
  63 In music mode, the following keycodes work differently, and don't pass through:
  64
  65 * `LCTL` - start a recording
  66 * `LALT` - stop recording/stop playing
  67 * `LGUI` - play recording
  68 * `KC_UP` - speed-up playback
  69 * `KC_DOWN` - slow-down playback
  70
  71 ## MIDI functionalty
  72
  73 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
  74
  75 ## Bluetooth functionality
  76
  77 This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
  78
  79 ## RGB Under Glow Mod
  80
  81 ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
  82
  83 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
  84
  85 For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring the VCC, GND, and DI, you can enable the underglow in your Makefile.
  86
  87     RGBLIGHT_ENABLE = yes
  88
  89 In order to use the underglow animation functions, you need to have `#define RGBLIGHT_ANIMATIONS` in your `config.h`.
  90
  91 Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the `F4` pin by default:
  92
  93     #define RGB_DI_PIN F4     // The pin your RGB strip is wired to
  94     #define RGBLIGHT_ANIMATIONS    // Require for fancier stuff (not compatible with audio)
  95     #define RGBLED_NUM 14     // Number of LEDs
  96     #define RGBLIGHT_HUE_STEP 10
  97     #define RGBLIGHT_SAT_STEP 17
  98     #define RGBLIGHT_VAL_STEP 17
  99
 100 You'll need to edit `RGB_DI_PIN` to the pin you have your `DI` on your RGB strip wired to.
 101
 102 The firmware supports 5 different light effects, and the color (hue, saturation, brightness) can be customized in most effects. To control the underglow, you need to modify your keymap file to assign those functions to some keys/key combinations. For details, please check this keymap. `keyboards/planck/keymaps/yang/keymap.c`
 103
 104 ### WS2812 Wiring
 105
 106 ![WS2812 Wiring](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/WS2812-wiring.jpg)
 107
 108 Please note the USB port can only supply a limited amount of power to the keyboard (500mA by standard, however, modern computer and most usb hubs can provide 700+mA.). According to the data of NeoPixel from Adafruit, 30 WS2812 LEDs require a 5V 1A power supply, LEDs used in this mod should not more than 20.
 109
 110 ## PS/2 Mouse Support
 111
 112 Its possible to hook up a PS/2 mouse (for example touchpads or trackpoints) to your keyboard as a composite device.
 113
 114 To hook up a Trackpoint, you need to obtain a Trackpoint module (i.e. harvest from a Thinkpad keyboard), identify the function of each pin of the module, and make the necessary circuitry between controller and Trackpoint module. For more information, please refer to [Trackpoint Hardware](https://deskthority.net/wiki/TrackPoint_Hardware) page on Deskthority Wiki.
 115
 116 There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended).
 117
 118 ### Busywait version
 119
 120 Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
 121
 122 In rules.mk:
 123
 124 ```
 125 PS2_MOUSE_ENABLE = yes
 126 PS2_USE_BUSYWAIT = yes
 127 ```
 128
 129 In your keyboard config.h:
 130
 131 ```
 132 #ifdef PS2_USE_BUSYWAIT
 133 #   define PS2_CLOCK_PORT  PORTD
 134 #   define PS2_CLOCK_PIN   PIND
 135 #   define PS2_CLOCK_DDR   DDRD
 136 #   define PS2_CLOCK_BIT   1
 137 #   define PS2_DATA_PORT   PORTD
 138 #   define PS2_DATA_PIN    PIND
 139 #   define PS2_DATA_DDR    DDRD
 140 #   define PS2_DATA_BIT    2
 141 #endif
 142 ```
 143
 144 ### Interrupt version
 145
 146 The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
 147
 148 In rules.mk:
 149
 150 ```
 151 PS2_MOUSE_ENABLE = yes
 152 PS2_USE_INT = yes
 153 ```
 154
 155 In your keyboard config.h:
 156
 157 ```
 158 #ifdef PS2_USE_INT
 159 #define PS2_CLOCK_PORT  PORTD
 160 #define PS2_CLOCK_PIN   PIND
 161 #define PS2_CLOCK_DDR   DDRD
 162 #define PS2_CLOCK_BIT   2
 163 #define PS2_DATA_PORT   PORTD
 164 #define PS2_DATA_PIN    PIND
 165 #define PS2_DATA_DDR    DDRD
 166 #define PS2_DATA_BIT    5
 167
 168 #define PS2_INT_INIT()  do {    \
 169     EICRA |= ((1<<ISC21) |      \
 170               (0<<ISC20));      \
 171 } while (0)
 172 #define PS2_INT_ON()  do {      \
 173     EIMSK |= (1<<INT2);         \
 174 } while (0)
 175 #define PS2_INT_OFF() do {      \
 176     EIMSK &= ~(1<<INT2);        \
 177 } while (0)
 178 #define PS2_INT_VECT   INT2_vect
 179 #endif
 180 ```
 181
 182 ### USART version
 183
 184 To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
 185
 186 In rules.mk:
 187
 188 ```
 189 PS2_MOUSE_ENABLE = yes
 190 PS2_USE_USART = yes
 191 ```
 192
 193 In your keyboard config.h:
 194
 195 ```
 196 #ifdef PS2_USE_USART
 197 #define PS2_CLOCK_PORT  PORTD
 198 #define PS2_CLOCK_PIN   PIND
 199 #define PS2_CLOCK_DDR   DDRD
 200 #define PS2_CLOCK_BIT   5
 201 #define PS2_DATA_PORT   PORTD
 202 #define PS2_DATA_PIN    PIND
 203 #define PS2_DATA_DDR    DDRD
 204 #define PS2_DATA_BIT    2
 205
 206 /* synchronous, odd parity, 1-bit stop, 8-bit data, sample at falling edge */
 207 /* set DDR of CLOCK as input to be slave */
 208 #define PS2_USART_INIT() do {   \
 209     PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT);   \
 210     PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT);     \
 211     UCSR1C = ((1 << UMSEL10) |  \
 212               (3 << UPM10)   |  \
 213               (0 << USBS1)   |  \
 214               (3 << UCSZ10)  |  \
 215               (0 << UCPOL1));   \
 216     UCSR1A = 0;                 \
 217     UBRR1H = 0;                 \
 218     UBRR1L = 0;                 \
 219 } while (0)
 220 #define PS2_USART_RX_INT_ON() do {  \
 221     UCSR1B = ((1 << RXCIE1) |       \
 222               (1 << RXEN1));        \
 223 } while (0)
 224 #define PS2_USART_RX_POLL_ON() do { \
 225     UCSR1B = (1 << RXEN1);          \
 226 } while (0)
 227 #define PS2_USART_OFF() do {    \
 228     UCSR1C = 0;                 \
 229     UCSR1B &= ~((1 << RXEN1) |  \
 230                 (1 << TXEN1));  \
 231 } while (0)
 232 #define PS2_USART_RX_READY      (UCSR1A & (1<<RXC1))
 233 #define PS2_USART_RX_DATA       UDR1
 234 #define PS2_USART_ERROR         (UCSR1A & ((1<<FE1) | (1<<DOR1) | (1<<UPE1)))
 235 #define PS2_USART_RX_VECT       USART1_RX_vect
 236 #endif
 237 ```
 238
 239 ### Additional Settings
 240
 241 #### PS/2 mouse features
 242
 243 These enable settings supported by the PS/2 mouse protocol: http://www.computer-engineering.org/ps2mouse/
 244
 245 ```
 246 /* Use remote mode instead of the default stream mode (see link) */
 247 #define PS2_MOUSE_USE_REMOTE_MODE
 248
 249 /* Enable the scrollwheel or scroll gesture on your mouse or touchpad */
 250 #define PS2_MOUSE_ENABLE_SCROLLING
 251
 252 /* Some mice will need a scroll mask to be configured. The default is 0xFF. */
 253 #define PS2_MOUSE_SCROLL_MASK 0x0F
 254
 255 /* Applies a transformation to the movement before sending to the host (see link) */
 256 #define PS2_MOUSE_USE_2_1_SCALING
 257
 258 /* The time to wait after initializing the ps2 host */
 259 #define PS2_MOUSE_INIT_DELAY 1000 /* Default */
 260 ```
 261
 262 You can also call the following functions from ps2_mouse.h
 263
 264 ```
 265 void ps2_mouse_disable_data_reporting(void);
 266
 267 void ps2_mouse_enable_data_reporting(void);
 268
 269 void ps2_mouse_set_remote_mode(void);
 270
 271 void ps2_mouse_set_stream_mode(void);
 272
 273 void ps2_mouse_set_scaling_2_1(void);
 274
 275 void ps2_mouse_set_scaling_1_1(void);
 276
 277 void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
 278
 279 void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
 280 ```
 281
 282 #### Fine control
 283
 284 Use the following defines to change the sensitivity and speed of the mouse.
 285 Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads).
 286
 287 ```
 288 #define PS2_MOUSE_X_MULTIPLIER 3
 289 #define PS2_MOUSE_Y_MULTIPLIER 3
 290 #define PS2_MOUSE_V_MULTIPLIER 1
 291 ```
 292
 293 #### Scroll button
 294
 295 If you're using a trackpoint, you will likely want to be able to use it for scrolling.
 296 Its possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving.
 297 To enable the feature, you must set a scroll button mask as follows:
 298
 299 ```
 300 #define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BUTTON_MIDDLE) /* Default */
 301 ```
 302
 303 To disable the scroll button feature:
 304
 305 ```
 306 #define PS2_MOUSE_SCROLL_BTN_MASK 0
 307 ```
 308
 309 The available buttons are:
 310
 311 ```
 312 #define PS2_MOUSE_BTN_LEFT      0
 313 #define PS2_MOUSE_BTN_RIGHT     1
 314 #define PS2_MOUSE_BTN_MIDDLE    2
 315 ```
 316
 317 You can also combine buttons in the mask by `|`ing them together.
 318
 319 Once you've configured your scroll button mask, you must configure the scroll button send interval.
 320 This is the interval before which if the scroll buttons were released they would be sent to the host.
 321 After this interval, they will cause the mouse to scroll and will not be sent.
 322
 323 ```
 324 #define PS2_MOUSE_SCROLL_BTN_SEND 300 /* Default */
 325 ```
 326
 327 To disable sending the scroll buttons:
 328 ```
 329 #define PS2_MOUSE_SCROLL_BTN_SEND 0
 330 ```
 331
 332 Fine control over the scrolling is supported with the following defines:
 333
 334 ```
 335 #define PS2_MOUSE_SCROLL_DIVISOR_H 2
 336 #define PS2_MOUSE_SCROLL_DIVISOR_V 2
 337 ```
 338
 339 #### Debug settings
 340
 341 To debug the mouse, add `debug_mouse = true` or enable via bootmagic.
 342
 343 ```
 344 /* To debug the mouse reports */
 345 #define PS2_MOUSE_DEBUG_HID
 346 #define PS2_MOUSE_DEBUG_RAW
 347 ```
 348
 349 ## Safety Considerations
 350
 351 You probably don't want to "brick" your keyboard, making it impossible
 352 to rewrite firmware onto it.  Here are some of the parameters to show
 353 what things are (and likely aren't) too risky.
 354
 355 - If your keyboard map does not include RESET, then, to get into DFU
 356   mode, you will need to press the reset button on the PCB, which
 357   requires unscrewing the bottom.
 358 - Messing with tmk_core / common files might make the keyboard
 359   inoperable
 360 - Too large a .hex file is trouble; `make dfu` will erase the block,
 361   test the size (oops, wrong order!), which errors out, failing to
 362   flash the keyboard, leaving it in DFU mode.
 363   - To this end, note that the maximum .hex file size on Planck is
 364     7000h (28672 decimal)
 365
 366 ```
 367 Linking: .build/planck_rev4_cbbrowne.elf                                                            [OK]
 368 Creating load file for Flash: .build/planck_rev4_cbbrowne.hex                                       [OK]
 369
 370 Size after:
 371    text    data     bss     dec     hex filename
 372       0   22396       0   22396    577c planck_rev4_cbbrowne.hex
 373 ```
 374
 375   - The above file is of size 22396/577ch, which is less than
 376     28672/7000h
 377   - As long as you have a suitable alternative .hex file around, you
 378     can retry, loading that one
 379   - Some of the options you might specify in your keyboard's Makefile
 380     consume extra memory; watch out for BOOTMAGIC_ENABLE,
 381     MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
 382 - DFU tools do /not/ allow you to write into the bootloader (unless
 383   you throw in extra fruitsalad of options), so there is little risk
 384   there.
 385 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
 386   firmware repeatedly and continually; that'll burn the EEPROM
 387   eventually.
 388