Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ad1327cd00 | ||
|
|
f5c8c5d4c8 | ||
|
|
56d2198b3d | ||
|
|
048ef311dc | ||
|
|
9c02e2ab49 | ||
|
|
d639bd2021 | ||
|
|
42ea912fde | ||
|
|
3dbdd15304 | ||
|
|
a3da586505 |
No files matched your search
@@ -1,3 +1,5 @@
|
|||||||
|
SUBPROJECT_DEFAULT = rev2
|
||||||
|
|
||||||
ifndef MAKEFILE_INCLUDED
|
ifndef MAKEFILE_INCLUDED
|
||||||
include ../../Makefile
|
include ../../Makefile
|
||||||
endif
|
endif
|
||||||
@@ -1,2 +1,2 @@
|
|||||||
:080000000000000000000001F7
|
:0B0000000000000000000000000001F4
|
||||||
:00000001FF
|
:00000001FF
|
||||||
@@ -1,2 +1,2 @@
|
|||||||
:080000000000000000000000F8
|
:0B0000000000000000000000000000F5
|
||||||
:00000001FF
|
:00000001FF
|
||||||
@@ -16,8 +16,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
*/
|
*/
|
||||||
#define USE_I2C
|
#define USE_I2C
|
||||||
|
|
||||||
#define I2C_MASTER_LEFT
|
#define MASTER_LEFT
|
||||||
// #define I2C_MASTER_RIGHT
|
// #define _MASTER_RIGHT
|
||||||
|
// #define EE_HANDS
|
||||||
|
|
||||||
#ifdef SUBPROJECT_rev1
|
#ifdef SUBPROJECT_rev1
|
||||||
#include "../../rev1/config.h"
|
#include "../../rev1/config.h"
|
||||||
@@ -27,4 +28,4 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
#endif
|
#endif
|
||||||
#ifdef SUBPROJECT_rev2fliphalf
|
#ifdef SUBPROJECT_rev2fliphalf
|
||||||
#include "../../rev2fliphalf/config.h"
|
#include "../../rev2fliphalf/config.h"
|
||||||
#endif
|
#endif
|
||||||
@@ -18,7 +18,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
|
|
||||||
#define USE_SERIAL
|
#define USE_SERIAL
|
||||||
|
|
||||||
#define EE_HANDS
|
#define MASTER_LEFT
|
||||||
|
// #define _MASTER_RIGHT
|
||||||
|
// #define EE_HANDS
|
||||||
|
|
||||||
|
|
||||||
#ifdef SUBPROJECT_rev1
|
#ifdef SUBPROJECT_rev1
|
||||||
@@ -29,4 +31,4 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
#endif
|
#endif
|
||||||
#ifdef SUBPROJECT_rev2fliphalf
|
#ifdef SUBPROJECT_rev2fliphalf
|
||||||
#include "../../rev2fliphalf/config.h"
|
#include "../../rev2fliphalf/config.h"
|
||||||
#endif
|
#endif
|
||||||
@@ -6,9 +6,45 @@ This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/
|
|||||||
Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
|
Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
|
||||||
based boards.
|
based boards.
|
||||||
|
|
||||||
|
|
||||||
|
## First Time Setup
|
||||||
|
|
||||||
|
Download or clone the whole firmware and navigate to the keyboards/lets_split directory. Once your dev env is setup, you'll be able to generate the default .hex using:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ make rev2
|
||||||
|
```
|
||||||
|
|
||||||
|
You will see a lot of output and if everything worked correctly you will see the built hex files:
|
||||||
|
|
||||||
|
```
|
||||||
|
lets_split_rev2_serial.hex
|
||||||
|
lets_split_rev2_i2c.hex
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would like to use one of the alternative keymaps, or create your own, copy one of the existing [keymaps](keymaps/) and run make like so:
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
$ make rev2-YOUR_KEYMAP_NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
If everything worked correctly you will see a file:
|
||||||
|
|
||||||
|
```
|
||||||
|
lets_split_rev2_YOUR_KEYMAP_NAME.hex
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md.
|
||||||
|
|
||||||
|
### Let's split 1.0
|
||||||
|
If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead.
|
||||||
|
|
||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
|
||||||
|
|
||||||
Some features supported by the firmware:
|
Some features supported by the firmware:
|
||||||
|
|
||||||
* Either half can connect to the computer via USB, or both halves can be used
|
* Either half can connect to the computer via USB, or both halves can be used
|
||||||
@@ -62,7 +98,7 @@ unnecessary in simple use cases.
|
|||||||
Notes on Software Configuration
|
Notes on Software Configuration
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
||||||
Configuring the firmware is similar to any other TMK project. One thing
|
Configuring the firmware is similar to any other QMK project. One thing
|
||||||
to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
|
to note is that `MATIX_ROWS` in `config.h` is the total number of rows between
|
||||||
the two halves, i.e. if your split keyboard has 4 rows in each half, then
|
the two halves, i.e. if your split keyboard has 4 rows in each half, then
|
||||||
`MATRIX_ROWS=8`.
|
`MATRIX_ROWS=8`.
|
||||||
@@ -70,37 +106,59 @@ the two halves, i.e. if your split keyboard has 4 rows in each half, then
|
|||||||
Also the current implementation assumes a maximum of 8 columns, but it would
|
Also the current implementation assumes a maximum of 8 columns, but it would
|
||||||
not be very difficult to adapt it to support more if required.
|
not be very difficult to adapt it to support more if required.
|
||||||
|
|
||||||
|
|
||||||
Flashing
|
Flashing
|
||||||
--------
|
-------
|
||||||
|
|
||||||
From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
|
From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
|
||||||
|
|
||||||
Example: `make rev2-serial-avrdude`
|
Example: `make rev2-serial-avrdude`
|
||||||
|
|
||||||
|
|
||||||
|
Choosing which board to plug the USB cable into (choosing Master)
|
||||||
|
--------
|
||||||
|
Because the two boards are identical, the firmware has logic to differentiate the left and right board.
|
||||||
|
|
||||||
|
It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable.
|
||||||
|
|
||||||
|
The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
|
||||||
|
|
||||||
|
The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
|
||||||
|
|
||||||
|
### Setting the left hand as master
|
||||||
|
If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
|
||||||
|
|
||||||
|
### Setting the right hand as master
|
||||||
|
If you always plug the usb cable into the right board, add an extra flag to your `config.h`
|
||||||
|
```
|
||||||
|
#define MASTER_RIGHT
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setting EE_hands to use either hands as master
|
||||||
If you define `EE_HANDS` in your `config.h`, you will need to set the
|
If you define `EE_HANDS` in your `config.h`, you will need to set the
|
||||||
EEPROM for the left and right halves. The EEPROM is used to store whether the
|
EEPROM for the left and right halves.
|
||||||
|
|
||||||
|
The EEPROM is used to store whether the
|
||||||
half is left handed or right handed. This makes it so that the same firmware
|
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
|
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
|
versions of the firmware to each half. To flash the EEPROM file for the left
|
||||||
half run:
|
half run:
|
||||||
```
|
```
|
||||||
make eeprom-left
|
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
|
||||||
|
// or the equivalent in dfu-programmer
|
||||||
|
|
||||||
```
|
```
|
||||||
and similarly for right half
|
and similarly for right half
|
||||||
```
|
```
|
||||||
make eeprom-right
|
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
|
||||||
|
// or the equivalent in dfu-programmer
|
||||||
```
|
```
|
||||||
|
|
||||||
After you have flashed the EEPROM for the first time, you then need to program
|
NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
|
||||||
the flash memory:
|
|
||||||
```
|
After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
|
||||||
make program
|
|
||||||
```
|
|
||||||
Note that you need to program both halves, but you have the option of using
|
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
|
different keymaps for each half. You could program the left half with a QWERTY
|
||||||
layout and the right half with a Colemak layout. Then if you connect the left
|
layout and the right half with a Colemak layout using bootmagic's default layout option.
|
||||||
half to a computer by USB the keyboard will use QWERTY and Colemak when the
|
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.
|
right half is connected.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -76,10 +76,12 @@ CUSTOM_MATRIX = yes
|
|||||||
|
|
||||||
avrdude: build
|
avrdude: build
|
||||||
ls /dev/tty* > /tmp/1; \
|
ls /dev/tty* > /tmp/1; \
|
||||||
echo "Reset your Pro Micro then hit any key to continue..."; \
|
echo "Reset your Pro Micro now"; \
|
||||||
read -n 1 -s; \
|
while [[ -z $$USB ]]; do \
|
||||||
ls /dev/tty* > /tmp/2; \
|
sleep 1; \
|
||||||
USB=`diff /tmp/1 /tmp/2 | grep '>' | sed -e 's/> //'`; \
|
ls /dev/tty* > /tmp/2; \
|
||||||
|
USB=`diff /tmp/1 /tmp/2 | grep -o '/dev/tty.*'`; \
|
||||||
|
done; \
|
||||||
avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex
|
avrdude -p $(MCU) -c avr109 -P $$USB -U flash:w:$(BUILD_DIR)/$(TARGET).hex
|
||||||
|
|
||||||
.PHONY: avrdude
|
.PHONY: avrdude
|
||||||
@@ -21,7 +21,8 @@ static void setup_handedness(void) {
|
|||||||
#ifdef EE_HANDS
|
#ifdef EE_HANDS
|
||||||
isLeftHand = eeprom_read_byte(EECONFIG_HANDEDNESS);
|
isLeftHand = eeprom_read_byte(EECONFIG_HANDEDNESS);
|
||||||
#else
|
#else
|
||||||
#ifdef I2C_MASTER_RIGHT
|
// I2C_MASTER_RIGHT is deprecated use MASTER_RIGHT instead since this works for both serial and i2c
|
||||||
|
#if defined(I2C_MASTER_RIGHT) || defined(MASTER_RIGHT)
|
||||||
isLeftHand = !has_usb();
|
isLeftHand = !has_usb();
|
||||||
#else
|
#else
|
||||||
isLeftHand = has_usb();
|
isLeftHand = has_usb();
|
||||||
|
|||||||
@@ -280,7 +280,7 @@ const PROGMEM uchar keyboard_hid_report[] = {
|
|||||||
0x95, 0x06, // Report Count (6),
|
0x95, 0x06, // Report Count (6),
|
||||||
0x75, 0x08, // Report Size (8),
|
0x75, 0x08, // Report Size (8),
|
||||||
0x15, 0x00, // Logical Minimum (0),
|
0x15, 0x00, // Logical Minimum (0),
|
||||||
0x25, 0xFF, 0x00, // Logical Maximum(255),
|
0x26, 0xFF, 0x00, // Logical Maximum(255),
|
||||||
0x05, 0x07, // Usage Page (Key Codes),
|
0x05, 0x07, // Usage Page (Key Codes),
|
||||||
0x19, 0x00, // Usage Minimum (0),
|
0x19, 0x00, // Usage Minimum (0),
|
||||||
0x29, 0xFF, // Usage Maximum (255),
|
0x29, 0xFF, // Usage Maximum (255),
|
||||||
@@ -350,7 +350,7 @@ const PROGMEM uchar mouse_hid_report[] = {
|
|||||||
0xa1, 0x01, // COLLECTION (Application)
|
0xa1, 0x01, // COLLECTION (Application)
|
||||||
0x85, REPORT_ID_SYSTEM, // REPORT_ID (2)
|
0x85, REPORT_ID_SYSTEM, // REPORT_ID (2)
|
||||||
0x15, 0x01, // LOGICAL_MINIMUM (0x1)
|
0x15, 0x01, // LOGICAL_MINIMUM (0x1)
|
||||||
0x25, 0xb7, 0x00, // LOGICAL_MAXIMUM (0xb7)
|
0x26, 0xb7, 0x00, // LOGICAL_MAXIMUM (0xb7)
|
||||||
0x19, 0x01, // USAGE_MINIMUM (0x1)
|
0x19, 0x01, // USAGE_MINIMUM (0x1)
|
||||||
0x29, 0xb7, // USAGE_MAXIMUM (0xb7)
|
0x29, 0xb7, // USAGE_MAXIMUM (0xb7)
|
||||||
0x75, 0x10, // REPORT_SIZE (16)
|
0x75, 0x10, // REPORT_SIZE (16)
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip build]"* ]] ; then
|
|||||||
make all-keyboards AUTOGEN="true"
|
make all-keyboards AUTOGEN="true"
|
||||||
: $((exit_code = $exit_code + $?))
|
: $((exit_code = $exit_code + $?))
|
||||||
else
|
else
|
||||||
MKB=$(git diff --name-only -n 1 ${TRAVIS_COMMIT_RANGE} | grep -oP '(?<=keyboards\/)([a-zA-Z_]+)' | sort -u)
|
MKB=$(git diff --name-only -n 1 ${TRAVIS_COMMIT_RANGE} | grep -oP '(?<=keyboards\/)([a-zA-Z0-9_]+)' | sort -u)
|
||||||
for KB in $MKB ; do
|
for KB in $MKB ; do
|
||||||
echo "Making all keymaps for $KB"
|
echo "Making all keymaps for $KB"
|
||||||
make "$KB" AUTOGEN=true
|
make "$KB" AUTOGEN=true
|
||||||
|
|||||||
Reference in new issue
Block a user