added Sofle RGB to upstream

v2 including gerber release
pcb files based on sofle v2 with up to 36 leds added
plates for rgb version with tenting using m3/m4 bolts and thumb screws
oled cover plate - should fit original sofle as well
simple build guide and pics

.gitignore

@@ -1,3 +1,7 @@
 PCB/gerber*
 Case/PCBBottom/gerb*
 Case/PCBTop/gerb*
+
+Sofle_RGB/PCB/gerb*
+Case/Sofle_RGB/PCBTop/gerb*
+Case/Sofle_RGB/PCBBottom/gerb*

Case/Sofle_RGB/PCBTop/SofleKeyboardTopPlate.pro

@@ -0,0 +1,61 @@
+
+update=2018 March 15, Thursday 14:41:19
+version=1
+last_client=kicad
+[pcbnew]
+version=1
+LastNetListRead=
+UseCmpFile=1
+PadDrill=0.600000000000
+PadDrillOvalY=0.600000000000
+PadSizeH=1.500000000000
+PadSizeV=1.500000000000
+PcbTextSizeV=1.500000000000
+PcbTextSizeH=1.500000000000
+PcbTextThickness=0.300000000000
+ModuleTextSizeV=1.000000000000
+ModuleTextSizeH=1.000000000000
+ModuleTextSizeThickness=0.150000000000
+SolderMaskClearance=0.000000000000
+SolderMaskMinWidth=0.000000000000
+DrawSegmentWidth=0.200000000000
+BoardOutlineThickness=0.100000000000
+ModuleOutlineThickness=0.150000000000
+[cvpcb]
+version=1
+NetIExt=net
+[general]
+version=1
+[eeschema]
+version=1
+LibDir=
+[eeschema/libraries]
+LibName1=power
+LibName2=device
+LibName3=transistors
+LibName4=conn
+LibName5=linear
+LibName6=regul
+LibName7=74xx
+LibName8=cmos4000
+LibName9=adc-dac
+LibName10=memory
+LibName11=xilinx
+LibName12=microcontrollers
+LibName13=dsp
+LibName14=microchip
+LibName15=analog_switches
+LibName16=motorola
+LibName17=texas
+LibName18=intel
+LibName19=audio
+LibName20=interface
+LibName21=digital-audio
+LibName22=philips
+LibName23=display
+LibName24=cypress
+LibName25=siliconi
+LibName26=opto
+LibName27=atmel
+LibName28=contrib
+LibName29=valves

Sofle_RGB/Build_guide/build_guide.md

@@ -0,0 +1,254 @@
+---
+layout: default
+title: Sofle RGB Keyboard - build guide
+---
+
+The Sofle RGB is a copy of the Sofle v2 with the addition of up to 36 RGB leds per side. If you are just looking to try out that layout, and are using the cherry sockets only, then this will work for you. 
+
+I also rolled back to the original pro-micro pinout, and completely redid the routing. 
+
+The OLED placement and OLED cover plate holes have not changed, and a plate has been designed. I haven't yet had one manufactured yet, but will in the next few weeks and refine if needed.
+
+## This Build Guide
+For the most part, this guide is the same as the sofle. I have shamelessly stolen Josef's build guide, and abreviated it heavily to cover mostly the differences. If you need more detail, please refer to his [guide at https://josefadamcik.github.io/SofleKeyboard/](https://josefadamcik.github.io/SofleKeyboard/)
+
+## Bill of materials
+
+The following is needed to build the keyboard.
+
+
+- **2 PCBs**
+- **2 top plates**, **2 bottom plates** for a sandvich-case build.
+
+- **2 Pro Micro** board or clone. With 2x12 pins and ATmega32U4 microcontroller. Just make sure you **don't** buy something like Arduino Micro (a different pinout) or Arduino Mini (different microcontroller). You could also use Elite-C which basically Pro Micro with USB-C.
+- **4x12 pin header (and optionally socket)** for Pro Micros. There are several ways how to mount Pro Micros to the board. Either the male PIN headers you most likely got with the board from the supplier could be used to solder it directly to the board. Build guides for Helix, Corne and Lily58 suggest [those spring pin headers][springpinheader] which are very compact and give you non-permanent connection (you can remove or replace Pro Micros). Another possible approach [is described at splitkb.com][promicrosocketing].
+
+- **58 keyboard switch sockets by Kailh**. The PCB supports sockets for traditional MX switches. They are available on Aliexpress, KBDFans and others.
+- **58 keyboard switches** of your preference, MX. Just make sure you have matching sockets for them.
+- **58 keycaps**. You can use either all in `1u` size but it looks nicer with two `1.5u` for the thumb keys.
+- **58 diodes  1N4148W**. They are surface mount diodes in SOD123 package.
+- **2 TRRS connectors**. The same type which is used for Corne, Lily58 etc. Technically even TRS should work[^1] if you stick to (default) serial communication. 
+- **2 tactile buttons** through-hole, 2 pins. Technically optional: you can use metal tweezers whenever you need to reset the microcontroller. There's also a reset key on default layout so as long as you have firmware flashed and working you shouldn't need reset button on the board. 
+- **1 TRRS cable**. TRS should work if you stick with Serial. 
+- **10 (+4) M2 spacers**. 10 are going to hold the bottom and the top together. Their height depends on which switches you use. A build guide Lily58 Pro suggests  `7mm` for MX. I was not able to get `7mm`, but `6mm` worked well for me with MX switches. I used brass ones but you can also buy nicer from anodised aluminium. 
+- **20 (+8) M2 screws**. 20 are going to hold the boards together (via spacers). I used some I had in my stock so I am not going to tell you exact length. But they need to be long enough to fix a `1.6mm` thick PCB to the spacer and short enough so two of them can fit in one spacer (might be trickier with 4mm spacers for Choc switches)
+- **8 - 10 adhesive rubber feet**. They are really important, trust me.
+- **Micro USB Cable** to connect the keyboard to a computer.
+
+
+**Optional**
+- **OLED/s**
+	- **2 ssd1306 128x32 OLED display module**. Very common everywhere. 
+	- **2x 4 pin header (and optionally socket)** for OLEDs. I have used the most common 1x4 female pin sockets which are quite tall but they also fit the height of ProMicro with the sockets I have used. Unfortunately, the pin headers on my OLED modules (again those very common square male headers you would get with the modules) are loose in the sockets. It works but it's fiddly. I'll have to find a better solution.
+	- **2 OLED cover** This is available in [../../Case/Sofle_RGB/oled_cover.svg ](../../Case/Sofle_RGB/oled_cover.svg )
+
+- **Rotary encoders**
+	- **2 Rotary encoders EC11**, If you are not sure take EC11E. Some other variants (EC11K) may have some additional plastic pins for and require mounting holes for them (which are not included on the PCB).
+	- **A matching knob** for each encoder. 
+
+- **LEDs**
+	- **SK2812 mini rgb leds** make sure that you get the style with irregular shaped pads that are flush to the led, and make very sure that you know what the pinout for your varient is. There are at least  2 common pinouts, thankfully just rotated 180 degrees, but for you the pin 1 marking may be on pin 3.
+		- **1x forward facing layer indicator**
+		- **6x rear facing drop lights**
+		- **29x per key lights** 
+
+
+
+## Tools and materials
+
+- soldering iron
+- solder 
+- good tweezers
+- masking tape
+- isopropyl-alcohol for cleaning
+- screwdriver
+
+## Steps
+
+### Prepare
+
+Make sure you know which side you are working on, and don't make two left hand sides by mistake 
+
+### The LEDs
+![SofleKeyboard](./led-layout.jpg)
+
+
+Work out what leds you wish to have, I have endeavoured to provide plenty of flexibility, and all led configurations are available using the headers available. If you wish to experiment, use 2.54mm headers and jumpers. If you know what you want, use a solder bridge to enable the leds required.  
+The traditional LED header is available, and can be used alone, or theoretically fed back in to one of the other headers if so desired. 
+
+Make sure you know which way around your leds are, different brands have different pin 1 positions. Thankfully it appears that the pad pattern underneath is consistent, so use it. I recommend doing one LED and testing it before continuing. This unfortunately suggests soldering the micro on first, despite it making the back side harder to solder. A good alternative would be to use an existing keyboard with leds to inject the signal and power through the LED header.
+
+#### LED pinouts
+
+![LED pinout from the crkbd build guide. I've found this to be the only consistent method](./led-pinout.jpg)
+
+The above picture is from the crkbd guide shows pin 4 on the following table (the table is viewed from the top of the LED). 
+
+Using the base pattern is the only consistent pattern between at least two different models with different pin 1 definitions and markings.
+
+| pin | net | net | pin |
+|---|---|---|---|
+| 1 | Dout | Vcc | 4 | 
+| 2 | Gnd  | Din | 3 | 
+
+![datasheet](./LED-datasheet.png)
+This version of the led has a different numbering pattern. But shows the same pattern and net lables on the bottom.
+
+The sofle RGB uses the following table, with the silkscreen marking at pin 1 (Dout) 
+| pin | net | net | pin |
+|---|---|---|---|
+| 1 | Dout | Vcc | 4 | 
+| 2 | Gnd  | Din | 3 | 
+
+
+The surface mount LEDs are easier to solder, and there are only 1+6 of them on each side, so are a good place to start if you aren't used to soldering them. Use a fairly low temperature (240c) and lots of flux. Place the led in position, heat one of the pads on the board for several seconds before moving the iron to touch the pin on the led , then add solder. Moving the iron back and forth from the pin can help to flow the solder under the LED, 
+
+I have added a single LED to the top surface to act as a layer indicator, this is enabled by bridging 2-3 on J6(indicator bypass).
+
+To enable drop lighting, short pins 1-2 of J4(Light select), to enable only per key lighting short pins 2-3 of J4. 
+If you wish to use per key lighting, you also need to short pins 1-2 of 5. 
+
+| Indicator | Drop lighting | Per key 	| j6 	| j4 	|j5 	| 
+| ---		| ---			| ---		| --- 	| ---  	| --- 	| 
+| Y			|  N			|   N		| 1-2	|		| 		| 
+|	Y		|  Y			|	N		|	1-2	|	1-2 | 		|
+|	Y		|	Y			|	Y		|	1-2 |  1-2	| 1-2	|
+|	Y		|	N			|	Y 		| 	1-2 |	2-3 | 1-2	|
+|	N		|   N			|   Y 		|  2-3	|   2-3 | 1-2   | 
+|   N		|   Y			| 	N 		|  2-3	|   1-2 | 		|
+|	N 		|	Y 			|   Y 		|  2-3	| 	1-2	| 1-2 	| 	
+
+
+The per key lighting is painful and slow. For these it is definitely best to do them in order, and test regularly. Use as low a temperature as you can manage, place the board flat on a table, and drop an led in. Create a solder bridge from the led to the board, not spending too much time with the iron on the led (few seconds) otherwise it will burn out. 
+
+
+If the part of the string stops working, resolder the last working one, and the first to fail, then if needed replace them. 
+
+#### LED Layouts 
+Indicator + drop lighting
+![LED layout underlighting](./board-underlighting.png)
+Indicator + per key lighting
+![LED layout per key ](./board-perkey.png)
+Indicator + drop lighting + per key lighting
+![LED layout both ](./board-both.png)
+
+
+### Components on the backside
+
+- Start with the diodes. Make sure you have orientation right - they are all oriented to the same side. The end with the thin line is Cathode (-) and it should go in the direction of the "arrow" symbol on the PCB.
+
+- Sockets for switches belong again on the back side, the same side as diodes. Make sure they are flush with PCB and match the orientation shown on the silkscreen. 
+
+### Bridge the oled pads
+This is done on the top side, all 4 solder bridges must be completed. This is easier before the pro micro headers are soldered 
+
+
+### Components on the front side
+
+- Button and TRRS sockets belong to the top. Use a piece of tape to fix them and apply solder from the bottom side.
+
+
+### Pro Micro and displays
+
+- The pro micro must be installed with the components facing the pcb, and the plain back side facing out. Theoretically I think these could be installed on the under side for a lower profile. 
+
+Make sure that you use the outlined headers from whichever side of the board that you mount the micro on. 
+
+- Install the oled so it sits over the pro micro 
+
+
+
+### Rotary encoders
+
+- Add rotary encoders last, they are big, and make soldering harder 
+
+
+### Keyboard switches and plates
+
+- Mount the stand-offs to the top plate.
+
+- Snap first switches into corners of the plate.
+
+- Carefully snap the first switches to the sockets. Be careful so you don't bend their contacts.
+
+- Add the rest of the switches
+
+- Mount the bottom plate.
+
+### Finishing touches
+
+- Install the rotary encoder knob.
+
+- Optionally add oled covers
+
+- Put at least 4 adhesive rubber feet in the corners so the keyboard is not moving when you type.
+
+
+## Warnings and disclaimers
+
+- Don't connect or disconnect the TRRS cable when the keyboard is powered. It may short out. Always disconnect the USB cable first.
+- Be gentle with micro USB ports on your microcontrollers. They are easy to break.
+- Keep in mind that this is a prototype of a DIY keyboard. It's not a polished product.
+
+## Firmware and programming
+
+Sofle keyboard uses [QMK Firmware][qmk_firmware] and support for the board is part of the main QMK repository. There's also a basic support in [QMK Configurator][qmk_configurator] but there's no encoder  or led support.
+
+Suggested approach is to build the firmware yourself. You should be familiar with QMK and be able to make it work on your local environment. If not, please [follow the instructions in the documentation][qmkintro].
+
+- Make sure your QMK environment [is setup][qmkintro].
+- Make sure halves are not connected together with TRRS cable.
+- Connect one half to USB, flash the firmware: `make sofle:defaultRGB:avrdude` (you may need to use `sudo` depending on your setup). Use the reset button to reset the keyboard when you are asked to in console.
+- Connect the second half and flash it in the same way as the previous one.
+- Disconnect the USB cable. Connect both halves together with TRRS cable.
+- Connect USB cable to the **left** side. 
+- Enjoy SofleKeyboard!
+
+## Troubleshooting
+
+See the Sofle build guide.
+
+## Links
+
+- [Github with KiCad projects][soflegithub]
+- [Layout in KeyboardLayout editor][soflelayout]
+- [QMK Firmware][qmk_firmware]
+- [QMK Configurator][qmk_configurator]
+
+
+## Firmware 
+
+SofleRGB uses [QMK firmware](https://qmk.fm/), it can use any Sofle keymap. 
+
+
+## Default layout 
+
+The default layout for the SofleRGB is in the qmk repo, and demonstrates some LED functions. 
+
+![Default layout for SofleRGB Keyboard](../../Images/soflekeyboard.png)
+
+## Images of keyboard
+
+![SofleRGBKeyboard](../../Images/SofleRGB_1.png)
+
+![SofleRGBKeyboard](../../Images/SofleRGB_2.png)
+
+![SofleRGBKeyboard PCB](../../Images/SofleRGB_boards.png)
+
+## Footnotes
+[layoutarticle]: <https://josef-adamcik.cz/electronics/in-search-of-the-best-custom-keyboard-layout.html> "In search of the best custom keyboard layout"
+[introductionarticle]: <https://josef-adamcik.cz/electronics/let-me-introduce-you-sofle-keyboard-split-keyboard-based-on-lily58.html> "Let me introduce you SofleKeyboard - a split keyboard based on Lily58 and Crkbd"
+[soflelayout]: http://www.keyboard-layout-editor.com/#/gists/76efb423a46cbbea75465cb468eef7ff "Sofle Keyboard layout at keyboard-layout-editor.com"
+[soflegerber]: https://github.com/josefadamcik/SofleKeyboard/releases "SofleKeyboard - gerber files"
+[qmk_firmware]: https://github.com/qmk/qmk_firmware/ "QMK firmware"
+
+[qmk_configurator]: https://config.qmk.fm/#/sofle/rev1/LAYOUT "QMK configurator"
+[springpinheader]: <https://yushakobo.jp/shop/a01mc-00/> "Spring pin headers - Japaneese"
+[qmkprotonc]: https://qmk.fm/proton-c/ "QMK Proton-C"
+[promicrosocketing]: <https://docs.splitkb.com/hc/en-us/articles/360011263059> "How do I socket a microcontroller? by splitkb.com"
+[qmkintro]: <https://beta.docs.qmk.fm/newbs/newbs_getting_started> "QMK getting started"
+[qmkhandedness]: <https://docs.qmk.fm/#/feature_split_keyboard?id=setting-handedness> "QMK firmware - setting handedness"
+[manufacturingproblems]: https://josef-adamcik.cz/electronics/corne-keyboard-build-log.html#manufacturing-at-jlcpcb---update-27112019 "Possible problems when manufacturing top plate for Corne"
+[nooledlag]: https://github.com/qmk/qmk_firmware/issues/7522 "No OLED lag bug"
+[soflegithub]: https://github.com/josefadamcik/SofleKeyboard "SofleKeyboard - KiCad project on Github.com"
+[sourcing]: <{{ site.baseurl }}/sourcing_parts.html> "Sourcing parts"

Sofle_RGB/Build_guide/led-layout.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-12-24T00:05:13.770Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36" etag="uZUcbY7GU0MxClSl1LZ-" version="14.1.1" type="device"><diagram id="m1DZjbyZRsrUGZoKf5Fs" name="Page-1">7Vxbc5s4GP01fmyGu+3H5tadTDuTbTqzTV8yGFRQgxEVSmLvr18Ji5s+bNjYBof0yZaQBZxzviskE/NiufpE3ST8QnwUTQzNX03My4lh6LOZwz/EzHozM3O0zURAsS8XlRN3+F8kJ/NlT9hHaW0hIyRiOKlPeiSOkcdqcy6l5KW+7CeJ6mdN3ACBiTvPjeDsP9hnobwLWyvn/0I4CPMz65o8snTzxXIiDV2fvFSmzKuJeUEJYZtvy9UFigR4OS6b311vOVpcGEUx6/IDHC2S9d31dM3Q8+Lh1gq+ffn9Qe7y7EZP8oYTSsTVY098ZtfN1jkYlDzFPhL7aRPz/CXEDN0lrieOvnD6+VzIlhEf6fwrvL78ZIgytKpMyev9hMgSMbrmS+RRS0IntaNP5filZCKXU1ghwZRzruQ+KDYu4eFfJEL/Ay1jDiBBPpeLHBLKQhKQ2I2uytnzOmjlms+EJBKqX4ixtdS++8RIHUi0wux75fu92OrMtuTwciW3zgbryuAWUcxvHNF8LvY/CpPgw5jEaDNzjQUG2fGtjKXkiXpoFzCbdQKMnbxSFLkMP9dtq4km+dNbgvmlFHowZ3VBmLbCNHNpgJj8VUk2v2t3XVmWiAXpjvMowrMMu25aLevz6yq1trmCUnkFJnuIEZguEKewNMx92Wd3gaJbkmKGScwPLQhjZMkZL3ySoN9307DQqRvhQCz1uBaEgKqCzLf9KNcwIWSxVyLOu1wFIhScoYj7YyrWnZGEkYfNmMTYS88i5D+InTIiEL16RoKPg/mNwufmfMyh4ygcddVzOPaRPIf5h6xtZE0VsoxZj2T9HaU4DIn1Lfj91fu1+Dq9n/34ALl5W16eY/C9OpBb5cNyq2xU7NUpOigu/nXhwpKJXOatd6yz53uGkb1s1vpjs1sTM2dAm20kazakzWp1m91tsi1mVppvabH3+fl2mO/rrdHuaI16P0neVInd0+PkeFtOc9yUbVCV1iPL9FAyVaKM1Rpm+EiNWccXb08VStG3KCqHbuo9lMLs9pjVdxGv24qlmTaIFUZDqFDt/mChQu9QOUH5Vw3qtRlWoyEauw2xB79udbSNCmF2A2H53L4mpCl6cRQhbG4cmBDYyFI3spXk48i2WBB1At6+RWRvxdvrXSuHrpLeU6uWqUhM79fdy77USUisNaE4Zll6VDEZ5qHVtF/86lCY9h3kQWfWgAVhU5BXffvhQHoDmVARMQfLhJyBMqGtYLYnK/ZJJStTtQ+ipBhdcxVbyVWKR189BRJ9CpQQccswHHcp7CBepElBW0UcXPisroiUUfKILkhEaKmYn9xdK1Og/aX2vJbY97Nw1WSXdcs9hGkqT3CKZ4gVGVkNMlLLu8OZ5gwQgmOfA8Q4ioa2WCdumr4fPix9aD7mgI9rSjITTrGPxM9LesbKivpA3nRgKd/0QP5orOQbV91WdlqOf9YOHzMbptrCnA3NBmysXFJeUxhaRgqOg/GSYc3bc7teHZbhALBPt/twyO7CEd9ykXVga5J6WvWi0eHlg75LIUeNJFa3pvDR6kUDFtXnrveYRxMUuwuO1Wjdl2OeWL5lwsh+A/upo8Ffz+vaUwkfJnwz9AZGlNHi3/SQql/8YS51Y40Xf1N9SNjQP+wXfxg0b2CzfTT4O5qi/4Z43Cv+FmxNPnveeAnQ1U7i0AHA2tIRfDcETIe2ANgBDOL3RMB8aAJgy2/MGaitZqAQfr1P+G1YAcC6dbzwN7iffuGHBYD5juBvcD79wg/z/xE7n6J1vSP97xd+mP6P2PkA+K2h4YfduBE7HwC/MzT88OWZETsf1fcPr35Y+47Y+QD4B1c/rHxH7HwA/I1/ytUn/LDuHbHzcaz2xlu/8MOqd8TOB8Df8EZLr/A7sOodsfMB8De8wtIv/DDxvOU4GdojEpe9KB8Jj5WSqdH+JHJ+GEom4hW6/N/fbN5kLf+JkHn1Hw==</diagram></mxfile>