Skip to content

Commit

Permalink
Docs update (mattdibi#21)
Browse files Browse the repository at this point in the history
* Updated EE_hands instructions

* Added link to Redox-w firmware sources
  • Loading branch information
mattdibi committed Mar 23, 2019
1 parent 4136d73 commit 4b3afa6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 2 additions & 0 deletions redox-w/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,8 @@ The receiver assembly is pretty straightforward, you can install the components
## Firmware

Firmware sources available here: [https://github.com/mattdibi/redox-w-firmware](https://github.com/mattdibi/redox-w-firmware).

You'll need to upload the firmware to the corresponding MCUs as per the following diagram:

<p align="center">
Expand Down
11 changes: 8 additions & 3 deletions redox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,13 @@ If you define `EE_HANDS` in your `config.h`, you will need to set the EEPROM for
The EEPROM is used to store whether the half is left handed or right handed. This makes it so that the same firmware file will run on both hands instead of having to flash left and right handed versions of the firmware to each half. To flash the EEPROM file for the left half run:
```
$ cd path/to/qmk/folder
$ avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:keyboards/lets_split/eeprom-lefthand.eep
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
// or the equivalent in dfu-programmer
```
and similarly for right half
```
$ avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:keyboards/lets_split/eeprom-righthand.eep
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
// or the equivalent in dfu-programmer
```

> :warning: Replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
Expand All @@ -180,6 +181,10 @@ After you have flashed the EEPROM, you then need to set `EE_HANDS` in `keyboard/
// ...
```

Then rebuild the hex files and reflash.

Note that you need to program both halves, but you have the option of using different keymaps for each half. You could program the left half with a QWERTY layout and the right half with a Colemak layout using bootmagic's default layout option. Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the right half is connected.

## Hot swappable mod

With a few modifications to the original design, it is possible to make a
Expand Down

0 comments on commit 4b3afa6

Please sign in to comment.