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 AVR keyboard that allows access to the C6 or B5 port (`#define C6_AUDIO` and/or `#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 If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration:
   7
   8 ```
   9 STARTUP_SONG // plays when the keyboard starts up (audio.c)
  10 GOODBYE_SONG // plays when you press the RESET key (quantum.c)
  11 AG_NORM_SONG // plays when you press AG_NORM (quantum.c)
  12 AG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)
  13 MUSIC_ON_SONG // plays when music mode is activated (process_music.c)
  14 MUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)
  15 CHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)
  16 GUITAR_SONG // plays when the guitar music mode is selected (process_music.c)
  17 VIOLIN_SONG // plays when the violin music mode is selected (process_music.c)
  18 MAJOR_SONG // plays when the major music mode is selected (process_music.c)
  19 ```
  20
  21 You can override the default songs by doing something like this in your `config.h`:
  22
  23 ```c
  24 #ifdef AUDIO_ENABLE
  25   #define STARTUP_SONG SONG(STARTUP_SOUND)
  26 #endif
  27 ```
  28
  29 A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).
  30
  31 To play a custom sound at a particular time, you can define a song like this (near the top of the file):
  32
  33 ```c
  34 float my_song[][2] = SONG(QWERTY_SOUND);
  35 ```
  36
  37 And then play your song like this:
  38
  39 ```c
  40 PLAY_SONG(my_song);
  41 ```
  42
  43 Alternatively, you can play it in a loop like this:
  44
  45 ```c
  46 PLAY_LOOP(my_song);
  47 ```
  48
  49 It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif` to avoid causing problems when audio isn't built into the keyboard.
  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 * `MU_MOD` - Cycle through the music modes:
  63   * `CHROMATIC_MODE` - Chromatic scale, row changes the octave
  64   * `GUITAR_MODE` - Chromatic scale, but the row changes the string (+5 st)
  65   * `VIOLIN_MODE` - Chromatic scale, but the row changes the string (+7 st)
  66   * `MAJOR_MODE` - Major scale
  67
  68 In music mode, the following keycodes work differently, and don't pass through:
  69
  70 * `LCTL` - start a recording
  71 * `LALT` - stop recording/stop playing
  72 * `LGUI` - play recording
  73 * `KC_UP` - speed-up playback
  74 * `KC_DOWN` - slow-down playback
  75
  76 By default, `MUSIC_MASK` is set to `keycode < 0xFF` which means keycodes less than `0xFF` are turned into notes, and don't output anything. You can change this by defining this in your `config.h` like this:
  77
  78     #define MUSIC_MASK keycode != KC_NO
  79
  80 Which will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!
  81
  82 The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, add something like this to your `config.h`:
  83
  84     #define PITCH_STANDARD_A 432.0f
  85
  86 ## MIDI functionalty
  87
  88 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
  89
  90 ## Bluetooth functionality
  91
  92 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.
  93
  94 ## RGB Under Glow Mod
  95
  96 ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
  97
  98 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
  99
 100 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.
 101
 102     RGBLIGHT_ENABLE = yes
 103
 104 In order to use the underglow animation functions, you need to have `#define RGBLIGHT_ANIMATIONS` in your `config.h`.
 105
 106 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:
 107
 108     #define RGB_DI_PIN F4     // The pin your RGB strip is wired to
 109     #define RGBLIGHT_ANIMATIONS    // Require for fancier stuff (not compatible with audio)
 110     #define RGBLED_NUM 14     // Number of LEDs
 111     #define RGBLIGHT_HUE_STEP 10
 112     #define RGBLIGHT_SAT_STEP 17
 113     #define RGBLIGHT_VAL_STEP 17
 114
 115 You'll need to edit `RGB_DI_PIN` to the pin you have your `DI` on your RGB strip wired to.
 116
 117 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`
 118
 119 ### WS2812 Wiring
 120
 121 ![WS2812 Wiring](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/WS2812-wiring.jpg)
 122
 123 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.
 124
 125 ## PS/2 Mouse Support
 126
 127 Its possible to hook up a PS/2 mouse (for example touchpads or trackpoints) to your keyboard as a composite device.
 128
 129 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.
 130
 131 There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended).
 132
 133 ### Busywait version
 134
 135 Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
 136
 137 In rules.mk:
 138
 139 ```
 140 PS2_MOUSE_ENABLE = yes
 141 PS2_USE_BUSYWAIT = yes
 142 ```
 143
 144 In your keyboard config.h:
 145
 146 ```
 147 #ifdef PS2_USE_BUSYWAIT
 148 #   define PS2_CLOCK_PORT  PORTD
 149 #   define PS2_CLOCK_PIN   PIND
 150 #   define PS2_CLOCK_DDR   DDRD
 151 #   define PS2_CLOCK_BIT   1
 152 #   define PS2_DATA_PORT   PORTD
 153 #   define PS2_DATA_PIN    PIND
 154 #   define PS2_DATA_DDR    DDRD
 155 #   define PS2_DATA_BIT    2
 156 #endif
 157 ```
 158
 159 ### Interrupt version
 160
 161 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.
 162
 163 In rules.mk:
 164
 165 ```
 166 PS2_MOUSE_ENABLE = yes
 167 PS2_USE_INT = yes
 168 ```
 169
 170 In your keyboard config.h:
 171
 172 ```
 173 #ifdef PS2_USE_INT
 174 #define PS2_CLOCK_PORT  PORTD
 175 #define PS2_CLOCK_PIN   PIND
 176 #define PS2_CLOCK_DDR   DDRD
 177 #define PS2_CLOCK_BIT   2
 178 #define PS2_DATA_PORT   PORTD
 179 #define PS2_DATA_PIN    PIND
 180 #define PS2_DATA_DDR    DDRD
 181 #define PS2_DATA_BIT    5
 182
 183 #define PS2_INT_INIT()  do {    \
 184     EICRA |= ((1<<ISC21) |      \
 185               (0<<ISC20));      \
 186 } while (0)
 187 #define PS2_INT_ON()  do {      \
 188     EIMSK |= (1<<INT2);         \
 189 } while (0)
 190 #define PS2_INT_OFF() do {      \
 191     EIMSK &= ~(1<<INT2);        \
 192 } while (0)
 193 #define PS2_INT_VECT   INT2_vect
 194 #endif
 195 ```
 196
 197 ### USART version
 198
 199 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.
 200
 201 In rules.mk:
 202
 203 ```
 204 PS2_MOUSE_ENABLE = yes
 205 PS2_USE_USART = yes
 206 ```
 207
 208 In your keyboard config.h:
 209
 210 ```
 211 #ifdef PS2_USE_USART
 212 #define PS2_CLOCK_PORT  PORTD
 213 #define PS2_CLOCK_PIN   PIND
 214 #define PS2_CLOCK_DDR   DDRD
 215 #define PS2_CLOCK_BIT   5
 216 #define PS2_DATA_PORT   PORTD
 217 #define PS2_DATA_PIN    PIND
 218 #define PS2_DATA_DDR    DDRD
 219 #define PS2_DATA_BIT    2
 220
 221 /* synchronous, odd parity, 1-bit stop, 8-bit data, sample at falling edge */
 222 /* set DDR of CLOCK as input to be slave */
 223 #define PS2_USART_INIT() do {   \
 224     PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT);   \
 225     PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT);     \
 226     UCSR1C = ((1 << UMSEL10) |  \
 227               (3 << UPM10)   |  \
 228               (0 << USBS1)   |  \
 229               (3 << UCSZ10)  |  \
 230               (0 << UCPOL1));   \
 231     UCSR1A = 0;                 \
 232     UBRR1H = 0;                 \
 233     UBRR1L = 0;                 \
 234 } while (0)
 235 #define PS2_USART_RX_INT_ON() do {  \
 236     UCSR1B = ((1 << RXCIE1) |       \
 237               (1 << RXEN1));        \
 238 } while (0)
 239 #define PS2_USART_RX_POLL_ON() do { \
 240     UCSR1B = (1 << RXEN1);          \
 241 } while (0)
 242 #define PS2_USART_OFF() do {    \
 243     UCSR1C = 0;                 \
 244     UCSR1B &= ~((1 << RXEN1) |  \
 245                 (1 << TXEN1));  \
 246 } while (0)
 247 #define PS2_USART_RX_READY      (UCSR1A & (1<<RXC1))
 248 #define PS2_USART_RX_DATA       UDR1
 249 #define PS2_USART_ERROR         (UCSR1A & ((1<<FE1) | (1<<DOR1) | (1<<UPE1)))
 250 #define PS2_USART_RX_VECT       USART1_RX_vect
 251 #endif
 252 ```
 253
 254 ### Additional Settings
 255
 256 #### PS/2 mouse features
 257
 258 These enable settings supported by the PS/2 mouse protocol: http://www.computer-engineering.org/ps2mouse/
 259
 260 ```
 261 /* Use remote mode instead of the default stream mode (see link) */
 262 #define PS2_MOUSE_USE_REMOTE_MODE
 263
 264 /* Enable the scrollwheel or scroll gesture on your mouse or touchpad */
 265 #define PS2_MOUSE_ENABLE_SCROLLING
 266
 267 /* Some mice will need a scroll mask to be configured. The default is 0xFF. */
 268 #define PS2_MOUSE_SCROLL_MASK 0x0F
 269
 270 /* Applies a transformation to the movement before sending to the host (see link) */
 271 #define PS2_MOUSE_USE_2_1_SCALING
 272
 273 /* The time to wait after initializing the ps2 host */
 274 #define PS2_MOUSE_INIT_DELAY 1000 /* Default */
 275 ```
 276
 277 You can also call the following functions from ps2_mouse.h
 278
 279 ```
 280 void ps2_mouse_disable_data_reporting(void);
 281
 282 void ps2_mouse_enable_data_reporting(void);
 283
 284 void ps2_mouse_set_remote_mode(void);
 285
 286 void ps2_mouse_set_stream_mode(void);
 287
 288 void ps2_mouse_set_scaling_2_1(void);
 289
 290 void ps2_mouse_set_scaling_1_1(void);
 291
 292 void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
 293
 294 void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
 295 ```
 296
 297 #### Fine control
 298
 299 Use the following defines to change the sensitivity and speed of the mouse.
 300 Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads).
 301
 302 ```
 303 #define PS2_MOUSE_X_MULTIPLIER 3
 304 #define PS2_MOUSE_Y_MULTIPLIER 3
 305 #define PS2_MOUSE_V_MULTIPLIER 1
 306 ```
 307
 308 #### Scroll button
 309
 310 If you're using a trackpoint, you will likely want to be able to use it for scrolling.
 311 Its possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving.
 312 To enable the feature, you must set a scroll button mask as follows:
 313
 314 ```
 315 #define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BUTTON_MIDDLE) /* Default */
 316 ```
 317
 318 To disable the scroll button feature:
 319
 320 ```
 321 #define PS2_MOUSE_SCROLL_BTN_MASK 0
 322 ```
 323
 324 The available buttons are:
 325
 326 ```
 327 #define PS2_MOUSE_BTN_LEFT      0
 328 #define PS2_MOUSE_BTN_RIGHT     1
 329 #define PS2_MOUSE_BTN_MIDDLE    2
 330 ```
 331
 332 You can also combine buttons in the mask by `|`ing them together.
 333
 334 Once you've configured your scroll button mask, you must configure the scroll button send interval.
 335 This is the interval before which if the scroll buttons were released they would be sent to the host.
 336 After this interval, they will cause the mouse to scroll and will not be sent.
 337
 338 ```
 339 #define PS2_MOUSE_SCROLL_BTN_SEND 300 /* Default */
 340 ```
 341
 342 To disable sending the scroll buttons:
 343 ```
 344 #define PS2_MOUSE_SCROLL_BTN_SEND 0
 345 ```
 346
 347 Fine control over the scrolling is supported with the following defines:
 348
 349 ```
 350 #define PS2_MOUSE_SCROLL_DIVISOR_H 2
 351 #define PS2_MOUSE_SCROLL_DIVISOR_V 2
 352 ```
 353
 354 #### Debug settings
 355
 356 To debug the mouse, add `debug_mouse = true` or enable via bootmagic.
 357
 358 ```
 359 /* To debug the mouse reports */
 360 #define PS2_MOUSE_DEBUG_HID
 361 #define PS2_MOUSE_DEBUG_RAW
 362 ```
 363
 364 ## Safety Considerations
 365
 366 You probably don't want to "brick" your keyboard, making it impossible
 367 to rewrite firmware onto it.  Here are some of the parameters to show
 368 what things are (and likely aren't) too risky.
 369
 370 - If your keyboard map does not include RESET, then, to get into DFU
 371   mode, you will need to press the reset button on the PCB, which
 372   requires unscrewing the bottom.
 373 - Messing with tmk_core / common files might make the keyboard
 374   inoperable
 375 - Too large a .hex file is trouble; `make dfu` will erase the block,
 376   test the size (oops, wrong order!), which errors out, failing to
 377   flash the keyboard, leaving it in DFU mode.
 378   - To this end, note that the maximum .hex file size on Planck is
 379     7000h (28672 decimal)
 380
 381 ```
 382 Linking: .build/planck_rev4_cbbrowne.elf                                                            [OK]
 383 Creating load file for Flash: .build/planck_rev4_cbbrowne.hex                                       [OK]
 384
 385 Size after:
 386    text    data     bss     dec     hex filename
 387       0   22396       0   22396    577c planck_rev4_cbbrowne.hex
 388 ```
 389
 390   - The above file is of size 22396/577ch, which is less than
 391     28672/7000h
 392   - As long as you have a suitable alternative .hex file around, you
 393     can retry, loading that one
 394   - Some of the options you might specify in your keyboard's Makefile
 395     consume extra memory; watch out for BOOTMAGIC_ENABLE,
 396     MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
 397 - DFU tools do /not/ allow you to write into the bootloader (unless
 398   you throw in extra fruitsalad of options), so there is little risk
 399   there.
 400 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
 401   firmware repeatedly and continually; that'll burn the EEPROM
 402   eventually.
 403