Merge pull request #31 from repercussion/master

RGB Underglow Instructions and Alps Switches

ALPS.md

@@ -0,0 +1,36 @@
+# Considerations when Using Alps-Style switches
+
+If you're planning on putting ALPS-style switches in your ergotravel, there are a couple things you'll have to consider.
+
+![A completed Alps build.](images/first_alps_ergotravel.jpg)
+*A completed Alps build.*
+
+Currently, the plates only allow for 2 1u keycaps in the thumbs. As such, you won't be able to put a 2u keycap in there.
+
+![Alps ergotravel plate.](images/alps_ergotravel_plate.jpg)
+*Alps ergotravel plate.*
+
+Because the switches are ever-so-slightly wider than their MX counterparts, you'll have to file down the bottom left and right corners of the switches that sit on top of the ProMicro. This will allow the switch to sit flush upon the PCB. This is also true of the Iris and indeed any other keyboard that has switches right on top of the ProMicro.
+
+![Alps switch resting upon promicro socket pins.](images/alps_switch_hits_promicro_socket_pins.jpg)
+*Alps switch resting upon promicro socket pins.*
+
+You may have to use similar methods to accomodate diode leads in rare occurences. Try to ensure that all switches sit flush prior to soldering them.
+
+![Alps switch resting upon diode leads.](images/alps_switch_resting_on_promicro_socket_pins.jpg)
+*Alps switch resting upon diode leads.*
+
+To do so, simply place a file on the table and run the corner of the switch along it at a 45-degree angle as pictured below.
+
+![Filing down the corner of an Alps switch.](images/alps_switch_filing_down.jpg)
+
+Continue with the other bottom side of the switch until it sits flush on the PCB. This doesn't take much and shouldn't go through the housing at all.
+
+![A corner of an alps switch after filing it down.](images/alps_switch_filed_down.jpg)
+
+When finished, the switches should sit flush against the PCB, the filed down corners now accomodating the promicro's sockets.
+
+![Alps switch sitting flush on top of promicro.](images/alps_switch_flush_pcb.jpg)
+*Alps switch sitting flush on top of promicro.*
+
+You'll also likely have to clip the leads of the switches that sit on top of the pro micro if you're using low-profile sockets or no sockets. These too may make contact with the promicro if left at their full length.

InstallingRGBStrips.md

@@ -1,4 +1,54 @@
-### Instructions on how to install RGB LED Strips as RGB underglow
+## Instructions on how to install RGB LED Strips as RGB underglow
+
+
+## Software Changes
+From a software point of view, make sure you enable the RGB features of the firmware as well as have the keycodes to change the RGB modes on one of your layers.
+
+Update firmware to enable RGB underglow: the  `rules.mk` file must contains the following line:
+
+```
+RGBLIGHT_ENABLE = yes
+```
+
+To control the RGB underglow see the QMK [feature documentation](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_rgblight.md)
+
+There are a few options on how you can install the RGB strips.
+
+## Hardware Changes: Option 1: RGB Strips at the Bottom of PCB
+
+1. Decide which half will be your master.  The master will use the DI pin on the header next to the pro micro. VCC and GND on that same header will also be used.
+
+### Master Half
+
+2. Wire from the TX pad on the PCB to Din pad of the LED strip.  
+3. Wire from the GND on the PCB to the GND on the LED strip.
+4. Wire from the VCC on the PCB to the +5V on the LED strip.
+5. At the other end of the LED strip, wire from DO to the extra data pad on the PCB (resistor next to TRRS connector). 
+
+* Make sure you don't use the resistors; I2C is not yet compatible with RGB underglow. Also make sure you haven't jumpered/soldered the I2C jumper.
+
+When you're done with the master half, it should look like this. With less kapton tape.
+
+![This is what the underside of the MASTER half should look like.](images/RGB_board_connections_master.jpg)
+*This is what the underside of the MASTER half should look like*
+
+### Slave Half
+
+6. On the slave half, the RGB data will appear on the same extra data pin on the resistor pad. This pin will go to the Din pad of the strip.
+7. Wire VCC and GND from the header next to the pro micro to the VCC and GND pads of the led strip.
+8. The Do pad of the slave RGB strip will not be connected anywhere.
+
+When you're done with the slave half, it should look like this. 
+
+![This is what the underside of the SLAVE half should look like.](images/RGB_board_connections_slave.jpg)
+*This is what the underside of the SLAVE half should look like*
+
+
+This should complete the hardware assembly.
+
+
+
+## Hardware Changes: Option  2: RGB Strips at the Bottom of Bottom Plate - using Dupont Connectors
 
 First, check that you have all required parts:
 
@@ -34,10 +84,4 @@ Back of right hand: ![soldered_header_connectors](images/RGB_connection_right.jp
 
 This should complete the hardware assembly.
 
-6. Update firmware to enable RGB underglow: the  `rules.mk` file must contains the following line:
-
-```
-RGBLIGHT_ENABLE = yes
-```
 
-To control the RGB underglow see the QMK [feature documentation](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_rgblight.md)