Skip to content

Commit 0088c1a

Browse files
committed
Clarify build documentation and add communication wiring diagram.
1 parent 67806e0 commit 0088c1a

File tree

3 files changed

+29
-13
lines changed

3 files changed

+29
-13
lines changed

build_instructions.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,55 @@
33

44
### Diodes
55

6-
Both SMD and through-hole types of diodes are supported. I recommend through-hole ones, because (after you solder them)
7-
you can use their wires as a pins for ProMicros.
6+
Both SMD and through-hole types of diodes are supported. The stripe on the diode should match the silk screen so that the line on the diode is on the same side.
87

8+
Through-hole diodes are nice when using Mill-Max sockets because the trimmed diode wires can be used as the ProMicro pins.
99

10-
### Switch sockets
1110

12-
I recommend the following way of soldering the switch sockets. Take the top plate, insert all switches into the top plate holes. Then place the top plate onto the PCB. Take switch sockets and place them to their dedicated places on the bottom side of the PCB. The switch sockets will be fixed with the switch pins stopping them from falling away or move anywhere around. Now solder the switch sockets to the PCB (with comfort).
11+
### Switch hotswap sockets
1312

13+
Install the hotswap sockets on the same side as the diodes.
14+
15+
I recommend the following way of soldering the hotswap sockets. Take the top plate, insert all switches into the top plate holes. Then place the top plate onto the PCB. Take switch sockets and place them to their dedicated places on the bottom side of the PCB. The switch sockets will be fixed with the switch pins stopping them from falling away or move anywhere around. Now solder the switch sockets to the PCB (with comfort).
16+
17+
### Component locations
18+
19+
![v4 Component locations](images/avalanche_v4-component_locations.jpg)
1420

1521
### ProMicro sockets
1622

17-
Solder the sockets to the PCBs. Solder one pin, check that the row of sockets is positioned with a straight 90 degrees angle to the PCB. Resolder if it is not. Only after that solder other pins. When soldering the socket's pins keep your soldering iron away from the unused pads. You should not short circuit unused pads with the pins.
23+
Mill-Max headers must be used, standard header pins do not fit.
24+
25+
Install the ProMicro on the opposite side as the sockets and diodes. Install the ProMicro upside down for a cleaner look, the silk screen indicates where the headers should be seated. To install the ProMicro right side up, use the other header position.
1826

19-
Solder the pins (remember the pieces of wire left from the diodes?) to the ProMicros. Put some painter's tape (or similar) between sockets and ProMicros before soldering the pins. Otherwise the pins could be soldered with the sockets.
27+
Solder the sockets to the PCBs. Solder one pin, adjust by resoldering the one pin until socket is positioned at 90 degrees. Only after that solder other pins. Be careful when soldering the socket's pins to avoid bridging the unused pads. You should not short circuit unused pads with the pins.
28+
29+
For low profile Mill-Max type headers, you can now solder the ProMicro header pins. This is a good time to re-use the diode legs if through-hole diodes were used. Solid core 24 AWG wire also works very well. Put some painter's tape (or similar) between sockets and ProMicros before soldering the pins. Otherwise the pins could be soldered with the sockets.
2030

2131

2232
### Reset switch and TRRS socket
2333

24-
Just solder them. It is simple.
34+
Solder them on the same side as the ProMicro.
35+
36+
### OLED
37+
38+
Install headers below the ProMicro sockets and bridge the nearby pads on the same side as the OLED. If the ProMicro has already been installed you may need to remobe it in order to access the pads.
2539

2640

2741
### Choose Serial or I2C
28-
I recommend to use I2C, because it provides less latency in communication between the halves of the
29-
keyboard. And this latency difference is noticable (subjectively).
42+
I2C provides less latency in communication between the halves of the keyboard. This latency difference begins to be noticible when typing above 100 words per minute.
3043

31-
* For I2C you should solder resistors R1, R2 on the master (left by default) half.
32-
Then connect P1 with R1 (closest hole) and P2 with R2 (again the closest hole).
33-
Modify your qmk firmware to support I2C.
44+
* I2C: On the master board (left by default) solder 4.7k resistors R1, R2.
45+
On the secondary board (right by default) connect P1 to R1 and P2 to R2 (the closest holes to each).
46+
Modify your qmk firmware `config.h` with `#define USE_I2C` instead of `#define USE_SERIAL`.
3447
Use only TRRS cable to connect keyboard halves.
3548

36-
* For Serial you should short circuit the W1 jumper. Modify your qmk firmware to support Serial.
49+
* Serial: On both halves you should short circuit the W1 jumper.
50+
Modify your qmk firmware `config.h` with `#define USE_SERIAL` instead of `#define USE_I2C`.
3751
Use TRS or TRRS cable to connect keyboard halves.
3852

53+
![Communication wiring](images/communication_wiring.jpg)
54+
3955
This doc of the [QMK site](https://beta.docs.qmk.fm/using-qmk/hardware-features/feature_split_keyboard) has
4056
additional information.
4157

523 KB
Loading

images/communication_wiring.jpg

505 KB
Loading

0 commit comments

Comments
 (0)