Merge branch 'master' of github.com:tompi/cheapino

2024-04-06 13:18:50 +02:00
parent 4fb6fe80df c80efa0a05
commit 1355b80bf6
6 changed files with 57 additions and 4 deletions
@@ -27,7 +27,7 @@ This can easily be the most expensive
 | RJ45 Socket |  4 | [AliExpress](https://www.aliexpress.com/item/32902228456.html) | 5.00 (for 10 pcs)|
 | EC11 Rotary encoder |  2 | [AliExpress](https://www.aliexpress.com/item/10000000931574.html) | 5.00 (for 2 pcs) |
 | Encoder knob |  2 | [AliExpress](https://www.aliexpress.com/item/32749281108.html) | 5.00 (for 2 pcs)|
-| Diodes 1N4148 | 72 | [AliExpress](https://www.aliexpress.com/item/32660088529.html) | 2.00 (for 100 pcs) |
+| Diodes 1N4148 | 80 | [AliExpress](https://www.aliexpress.com/item/32660088529.html) | 2.00 (for 100 pcs) |

 ![Components](images/parts.jpeg)

@@ -87,6 +87,9 @@ Try to solder one column at a time, use something to align the switches, and tap

 One trick from [TentacleSenpai69](https://www.reddit.com/user/TentacleSenpai69/) is to put on keycaps on a column and use a space bar to keep the column aligned, and then tape it.

+If you have a 3D printer you could print these excellent fork-helpers from @MrBarbie: https://www.printables.com/model/582030-switch-alignment-rail
+Make sure you print the 19mm version, since the cheapino uses 19.00 mm spacing instead of the traditional 19.05 mm spacing...
+
 ![Switches A1](images/switches_alt1.jpg)
 ![Switches A2](images/switches_alt2.jpg)
 ![Switches A3](images/switches_alt3.jpg)
@@ -7,9 +7,9 @@ This is the recipe for windows(for mac/linux, install qmk the recommended way an

 1. Install qmk msys from https://msys.qmk.fm/
 2. Inside qmk msys, type qmk setup - this will create a qmk_firmware folder that has cloned the main branch of qmk from git.
-3. Run this command to add a reference to the cheapino qmk fork:
+3. Run this command(make sure you are in the "qmk_firmware"folder) to add a reference to the cheapino qmk fork:
 ```sh
-git remote add tompi https://github.com/tompi/qmk_firmware..
+git remote add tompi https://github.com/tompi/qmk_firmware
 ```
 4. Run this command to actually fetch the code(replace "cheapino" with "cheapinov2" if you are using cheapino v2 pcbs):
 ```sh
@@ -42,8 +42,17 @@ qmk flash -kb cheapino -km thebestkeymap

 To help learn your keymap, @omark96 made this tool that works on windows: https://github.com/omark96/qmk_keymap_overlay

-Tweaking the encoder actions needs to be done in the keyboards/cheapino/encoder.c file.
+# Encoder customization
+
+Tweaking the encoder actions needs to be done in the keyboards/cheapino/encoder.c file, they are not part of the keymap.
 (you dont HAVE to be a progammer to change it, but you may call yourself a novice programmer once you do...)
+In the method called "turned", there are actions defined for multiple layers, this one is tweaked for my personal layer...
+The "else" section at line 26, will send page down for clockwise encoder turns, and page down for counter clockwise.
+The first if, line 20, sends volume up/down if you are on layer 6. 
+
+The encoder push is defined to media pause/play in the "clicked" method on line 15.
+Feel free to remap it to different keys depending on layers, like the turns are done.
+TBH, I dont really use the encoder much, so I didnt spend much time tweaking this...

 Once you change the encoder file, run the command from step 6 and 7 to deploy changes to your keyboard.

@@ -0,0 +1,39 @@
+# Cheapino troubleshooting
+
+## Single switches are not working
+
+Usually, this is caused by either not soldering the diode, soldering the diode in the wrong direction, or in some very rare cases a malfunctioning diode or switch.
+
+To rule out the switch: try to short the two pins of the switch with a wire.
+If this fires the key, you got a bad switch: desolder it and put in a new one.
+(Get yourself an "engineer ss02", its amazing for desoldering work...)
+
+If it doesnt, try to short the circuit "before" the diode. If this works the diode is either bad or in the wrong direction. Desolder and realign or switch it.
+
+## Entire rows or entire columns are not working
+
+This could be caused by several things:
+
+### Bad connection on MCU
+
+Check that the pins of your rp2040-zero are all soldered ok. There should not be a "blob" of solder, it should look like a volcano. Retouch any strange looking soldering points on the MCU.
+
+### Shorts on the MCU or the RJ45 socket
+
+Check your soldering on both MCU and the RJ45 sockets. If there are any shorts, try sucking up some solder with e.g. some solder wick or your solder sucker.
+
+### Ethernet crossover cable
+
+Not all ethernet cables are the same... There are different variants more or less rare, for different purposes. The most common which will create problems for the cheapino is the crossover cable: https://en.wikipedia.org/wiki/Ethernet_crossover_cable
+
+Try different cables, if one is working fine, this is your issue. 
+
+## Suddenly my cheapino outputs A LOT of random characters
+
+This will happen with some cheap encoders, they may not de-tent properly, and get stuck in a position which creates problems for the firmware. The solution to this is just to turn the encoder a little, and it should go away...
+
+## I Ordered a beta of the version 2 and the 2 middle columns on each side are not working
+
+This is my fault... You need to run a bodge wire between 2 points on each half:
+![Missing connection on v2 beta](images/bodge.png) 
+![Fixed on both sides](images/bodge2.png) 
@@ -14,6 +14,8 @@ support 18 switches and an encoder on the right side).

 Checkout the [build guide](doc/buildguide_v1.md) for more details and pictures.

+Checkout the [troubleshooting guide](doc/troubleshooting.md) if your Cheapino does not work.
+
 See the [firmware guide](doc/firmware.md) for how to build and customize keyboard firmware.

 If you just want to flash [Miryoku](https://github.com/manna-harbour/miryoku)