diff options
-rw-r--r-- | img/image1.jpg | bin | 0 -> 10277232 bytes | |||
-rw-r--r-- | img/led_orientation.jpg | bin | 0 -> 10098576 bytes | |||
-rw-r--r-- | readme.md | 44 |
3 files changed, 25 insertions, 19 deletions
diff --git a/img/image1.jpg b/img/image1.jpg Binary files differnew file mode 100644 index 0000000..fc817db --- /dev/null +++ b/img/image1.jpg diff --git a/img/led_orientation.jpg b/img/led_orientation.jpg Binary files differnew file mode 100644 index 0000000..beb87fa --- /dev/null +++ b/img/led_orientation.jpg @@ -3,8 +3,8 @@ A [Ferris Sweep](https://github.com/davidphilipbarr/Sweep) variant designed with an integrated RP2040 and some other added features. +![keyboard_image](img/image1.jpg) ![top](img/pcb_top.svg) -![bottom](img/pcb_bottom.svg) ## Comments & Modifications This PCB has the exact same dimensions and mounting points (via @@ -37,6 +37,7 @@ Bill of Materials page 5. Upload CPL file from [production/positions.csv](production/positions.csv) as well. Disregard any message like "J7, J8 won't be assembled due to missing data". These are the display pin headers. +- Choose "File Provided as Complete File, proceed with my own files" 6. Select appropriate components on the following screen by typing in the shown part number and select it. An effort has been made to choose as few extended components as possible, but this is not possible for @@ -44,7 +45,9 @@ some. Note, footprints D1 & D2 are power indication LEDs. They can be left unpopulated if you'd rather not have an LED that is always lit. If you would like them installed while not being blinded, try to find an LED with a lower forward current and voltage (supply is 5v), -perhaps something in the realm of 2v and 1-5mA. +perhaps something in the realm of 2v and 1-5mA. Note number 2, the +current-smoothing capacitors for the RGB LEDs are not required for the +LEDs to function. 7. Give a quick look at the component placement and make sure nothing looks wildly wrong. It is normal for some components to be shown oriented incorrectly or not quite where they belong. The PCB reviewers @@ -55,10 +58,10 @@ For components that are not carried or commonly out of stock at JLCPCB: | Item | Quantity | Remarks | |------|----------|---------| | Cirque Trackpad ([TM035035](https://www.mouser.com/ProductDetail/355-TM0350352024-003)) | 1 or 2 | Also available in 23mm & 40mm diameter | -| FPC Connector ([FH33J-12S-0.5SH](https://www.mouser.com/ProductDetail/798-FH33J12S05SH10)) | 1 per trackpad | Quite doable by hand-soldering | +| FPC Connector ([FH33J-12S-0.5SH](https://www.mouser.com/ProductDetail/798-FH33J12S05SH10)) | 1 per trackpad | Not terribly difficult to do by hand-soldering | | FPC Cable ([98266-0118](https://www.mouser.com/ProductDetail/Molex/98266-0118)) | 1 per trackpad | Change length as desired | | Nice!View Display ([LS011B7DH03](https://nicekeyboards.com/nice-view)) | 1 or 2 | Available at a lower price if comfortable hand-wiring [here](https://www.aliexpress.us/item/3256801622787441.html) | -| Acrylic Cover ([cover.dxf](cover.dxf)) | 1 or 2 | Each uses 4x 5mm M2 screws and 2x 5mm M2 standofffs | +| Acrylic Cover ([cover.dxf](cover.dxf)) | 1 or 2 | Each uses 4x ~4mm M2 screws and 2x ~4mm M2 standofffs. Unfortunately due to the limited space, the cover can only be used **without** a display or trackpad | ## Build Instructions These steps assume you already have an assembled PCB and are installing @@ -69,32 +72,35 @@ will be helpful. 1. Ensure keyboard is functional by flashing firmware if necessary and testing by shorting switch footprint pins with metal tweezers. This should output keypresses on the computer. -2. Install RGB LEDs if desired. See below pictures for orientation and -data chain. Please double check orientation, as an incorrectly oriented -LED will result in your keyboard not working. It is wise to test the -LEDs as you install them (eg. install a couple, then plug in keyboard). -The per-key LEDs will need to be installed and working before the -underglow LEDs will work. -<!--- ![per_key_orientation](img/per_key_led.png) ---> -<!--- ![underglow_orienation](img/underglow_led.png) ---> -<!--- ![led_data_chain](img/led_data_chain.png) ---> -3. Install display if desired. If using I2C OLED displays, install +2. Install RGB LEDs if desired. The chopped-off corner should align with +the marked corner on PCB - this applies to both per-key and underglow +LEDs. Please double check orientation, as an incorrectly oriented LED +will result in keyboard not working. It is wise to test the LEDs as you +install them (eg. install a couple, then plug in keyboard). The per-key +LEDs will need to be installed and working before the underglow LEDs +will work. +![orienation](img/led_orientation.jpg) +3. Install display(s) if desired. If using I2C OLED displays, install 1x4 header in left-most four pins and configure fimware appropriately. 4. If adding a Cirque Trackpad, SPI will be used by default. This means that footprint R1 on the trackpad needs to be populated with a 4.7k resistor (refer to datasheet for additional info). If you would rather -use I2C, the two jumpers on the back of each PCB need to be bridged. No -further hardware modification on the trackpad is necessary. +use I2C, the two jumpers on the back of each PCB need to be bridged and +the R1 resistor on trackpad unpopulated. Configure firmware appropriately. +Connect FPC cable to connector on PCB, and to connector on trackpad. ## Firmware Only support for QMK Firmware has been written at this time, it can be found [here](https://git.pngu.org/qmk_me/tree/keyboards/sweep). -Enter bootloader mode by holding RESET button and tapping BOOT button. +Enter bootloader mode by holding BOOT button and tapping RESET button. The PCB supports full-duplex serial communication, VBUS detection for setting handedness, and RGB data level-shifted to 5v. If you choose to operate Cirque Trackpad by I2C, adjust `rules.mk` file so that `POINTING_DEVICE_DRIVERS` is set to `cirque_pinnacle_i2c` and that I2C is enabled in `halconf.h` file. Similarly, if you are using I2C OLED displays, ensure `features.quantum_painter` is set to `false`, and -`features.oled` is set to `true`. Current firmware has been written for -LS011B7DH03 display, also known as [Nice!View display](https://nicekeyboards.com/nice-view). +`features.oled` is set to `true` in `keyboard.json` file. Current +firmware has been written for LS011B7DH03 display, also known as +[Nice!View display](https://nicekeyboards.com/nice-view). It is rather +experimental at this time, as this display is not officially supported +by QMK. |