aboutsummaryrefslogtreecommitdiff
path: root/keyboards/deltasplit75
diff options
context:
space:
mode:
authorunknown <itsaferbie@gmail.com>2017-08-26 14:16:52 -0400
committerJack Humbert <jack.humb@gmail.com>2017-08-26 23:31:47 -0400
commita6fe0320f5dbbeca1822d9b02159678fde3da8a5 (patch)
treeea8095982891ca9e443ddcdd3d0199d33898e8cc /keyboards/deltasplit75
parent78ab926cc8e2cda53f177eba586053b42797d341 (diff)
downloadqmk_firmware-a6fe0320f5dbbeca1822d9b02159678fde3da8a5.tar.gz
qmk_firmware-a6fe0320f5dbbeca1822d9b02159678fde3da8a5.zip
Updated readme to new standard.
Diffstat (limited to 'keyboards/deltasplit75')
-rw-r--r--keyboards/deltasplit75/readme.md137
1 files changed, 9 insertions, 128 deletions
diff --git a/keyboards/deltasplit75/readme.md b/keyboards/deltasplit75/readme.md
index 04ed35c29..a1e35e337 100644
--- a/keyboards/deltasplit75/readme.md
+++ b/keyboards/deltasplit75/readme.md
@@ -1,137 +1,18 @@
1DeltaSplit75 1DeltaSplit75
2====== 2======
3 3
4This readme and most of the code are from https://github.com/ahtn/tmk_keyboard/ and https://github.com/qmk/qmk_firmware/tree/master/keyboards/lets_split 4A split 75% keyboard made by xyxjj. [More info on qmk.fm](http://qmk.fm/deltasplit75/)
5 5
6Credit to ahtn and wootpatoot for work on the split keyboard firmware 6Keyboard Maintainer: [xyxjj](https://github.com/xyxjj)
7Hardware Supported: Pro Micro
8Hardware Availability: Group Buy
7 9
8Split keyboard firmware for Arduino Pro Micro or other ATmega32u4 10Make example for this keyboard (after setting up your build environment):
9based boards.
10 11
11## Case Files 12 make deltasplit75-v2-default
12Files are available here: https://github.com/xyxjj/DeltaSplit75-Case-files
13 13
14## Build Guide 14See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
15The build guide should be found at https://qmk.fm/deltasplit75
16 15
16Files are available here: [DeltaSplit75 Case Files](https://github.com/xyxjj/DeltaSplit75-Case-files)
17 17
18## First Time Setup 18The build guide should be found here: [DeltaSplit75 Build Guide](http://qmk.fm/deltasplit75/)
19
20Download or clone the whole firmware and navigate to the keyboards/deltasplit75 directory. Once your dev env is setup, you'll be able to generate the .hex using:
21
22```
23make v2
24
25or
26
27make v2-YOUR_KEYMAP_NAME (if you make a folder for your keymap)
28
29or
30
31make protosplit (if you have one of the prototype PCBs)
32```
33
34You will see a lot of output and if everything worked correctly you will see the built hex files:
35
36```
37deltasplit75_v2_protosplit.hex
38
39or
40
41deltasplit74_v2_YOUR_KEYMAP_NAME.hex
42
43or
44
45deltasplit75_v2_default.hex
46
47```
48
49
50For 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.
51
52### DeltaSplit75 V2
53The PCBs available in groupbuy are all v2, if you've bought one of my prototype PCBs (it says DeltaSplit65 on the silkscreen instead of 75), use the code make protosplit instead
54
55Features
56--------
57
58For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
59
60Some features supported by the firmware:
61
62* Either half can connect to the computer via USB, or both halves can be used
63 independently.
64* 75% formfactor
65* Support for multiple Bottom Rows
66* RGB underglow support
67* Split Backspace and ISO support
68
69
70Flashing
71-------
72I personally use xLoader to upload my hex files to the keyboard, though any other working software is fine too
73
74
75Choosing which board to plug the USB cable into (choosing Master)
76--------
77Because the two boards are identical, the firmware has logic to differentiate the left and right board.
78
79It 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.
80
81The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
82
83The 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.
84
85### Setting the left hand as master
86If 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.
87
88### Setting the right hand as master
89If you always plug the usb cable into the right board, add an extra flag to your `config.h`
90```
91 #define MASTER_RIGHT
92```
93
94### Setting EE_hands to use either hands as master
95If you define `EE_HANDS` in your `config.h`, you will need to set the
96EEPROM for the left and right halves.
97
98The EEPROM is used to store whether the
99half is left handed or right handed. This makes it so that the same firmware
100file will run on both hands instead of having to flash left and right handed
101versions of the firmware to each half. To flash the EEPROM file for the left
102half run:
103```
104avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
105// or the equivalent in dfu-programmer
106
107```
108and similarly for right half
109```
110avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
111// or the equivalent in dfu-programmer
112```
113
114NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
115
116After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
117
118Note that you need to program both halves, but you have the option of using
119different keymaps for each half. You could program the left half with a QWERTY
120layout and the right half with a Colemak layout using bootmagic's default layout option.
121Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
122right half is connected.
123
124
125Notes on Using Pro Micro 3.3V
126-----------------------------
127
128Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
129the frequency on the 3.3V board.
130
131Also, if the slave board is producing weird characters in certain columns,
132update the following line in `matrix.c` to the following:
133
134```
135// _delay_us(30); // without this wait read unstable value.
136_delay_us(300); // without this wait read unstable value.
137```