qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (1977B)

      1 # Ferris sweep
      2 
      3 ![Ferris sweep, top view](https://i.imgur.com/5qCZUv6h.jpg)
      4 ![Ferris sweep, bottom view](https://i.imgur.com/ZC47CJth.jpg)
      5 
      6 A version of the Ferris keyboard that uses a daughterboard, designed by the fantastic @davidphilipbarr with some input from @pierrechevalier83 for the copper pad. All PCB files are available on the [project's github page](https://github.com/davidphilipbarr/Sweep)
      7 
      8 ## Keyboard Info
      9 
     10 * Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
     11 * Hardware Supported: [Sweep](https://github.com/davidphilipbarr/Sweep) (all versions)
     12 * Hardware Availability: Print the PCB with gerber files from the repository
     13 
     14 Make example for this keyboard (after setting up your build environment):
     15 
     16     make ferris/sweep:default
     17 
     18 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).
     19 
     20 ## Bootloader
     21 
     22 Enter the bootloader in 3 ways:
     23 
     24 * **Bootmagic reset**: Hold down the top left key on the left half (or the top right key on the right half) and plug in the controller on that side.
     25 * **Physical reset button**: Briefly press the reset button soldered on the PCB.
     26 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is configured.
     27 
     28 ## Swapped Pins
     29 
     30 If you printed one of the PCB variant with swapped letters `Q` and `B` / `P` and `N`, add the following code to your keymap's `config.h` to swap pins `E6` and `D7` in the firmware:
     31 ```c
     32 #undef DIRECT_PINS
     33 #define DIRECT_PINS { \
     34     { D7, F7, F6, F5, F4 }, \
     35     { B1, B3, B2, B6, D3 }, \
     36     { D1, D0, D4, C6, E6 }, \
     37     { B4, B5, NO_PIN, NO_PIN, NO_PIN } \
     38 }
     39 #undef DIRECT_PINS_RIGHT
     40 #define DIRECT_PINS_RIGHT { \
     41     { F4, F5, F6, F7, D7 }, \
     42     { D3, B6, B2, B3, B1 }, \
     43     { E6, C6, D4, D0, D1 }, \
     44     { B5, B4, NO_PIN, NO_PIN, NO_PIN } \
     45 }
     46 ```
     47