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