drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Keyboard] Sweep swap hand feature and pin documentation (#15264)

Browse source 
Co-authored-by: filterpaper <filterpaper@localhost>
This commit is contained in:
Albert Y 2021-11-29 16:19:00 +08:00 • committed by GitHub
parent 35a18a8bcd
commit a7bc02bf69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

26
keyboards/ferris/sweep/readme.md
View file

@ -8,9 +8,8 @@ A version of the Ferris keyboard that uses a daughterboard, designed by the fant
## Keyboard Info
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
* Hardware Supported:
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout)
* Hardware Availability: @iamnotyourbroom in the 40% discord chat server may have some spares for you.
* Hardware Supported: [Sweep](https://github.com/davidphilipbarr/Sweep) (all versions)
* Hardware Availability: Print the PCB with gerber files from the repository
Make example for this keyboard (after setting up your build environment):
@ -20,7 +19,7 @@ See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_to
## Setting Handedness
Keyboard uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default. The make commands are:
Firmware uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default and it must be *configured once* on each side. The make commands are:
make ferris/sweep:default:avrdude-split-left
make ferris/sweep:default:avrdude-split-right
@ -35,3 +34,22 @@ Enter the bootloader in 3 ways:
* **Physical reset button**: Briefly press the reset button soldered on the PCB.
* **Keycode in layout**: Press the key mapped to `RESET` if it is configured.
## Swapped Pins
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:
```c
#undef DIRECT_PINS
#define DIRECT_PINS { \
{ D7, F7, F6, F5, F4 }, \
{ B1, B3, B2, B6, D3 }, \
{ D1, D0, D4, C6, E6 }, \
{ B4, B5, NO_PIN, NO_PIN, NO_PIN } \
}
#undef DIRECT_PINS_RIGHT
#define DIRECT_PINS_RIGHT { \
{ F4, F5, F6, F7, D7 }, \
{ D3, B6, B2, B3, B1 }, \
{ E6, C6, D4, D0, D1 }, \
{ B5, B4, NO_PIN, NO_PIN, NO_PIN } \
}
```