aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJack Sangdahl <[email protected]>2024-08-17 00:03:04 -0600
committerJack Sangdahl <[email protected]>2024-08-17 00:03:04 -0600
commit1db590d8ab488eeae6c01efd94fd960c7a4f5887 (patch)
tree1e661ded4ae293c05b6cf05e4b81ce3137af2711 /readme.md
parent3b890af3256772bf3338cae7f067c48f5d4a5f2f (diff)
downloadsweep-1db590d8ab488eeae6c01efd94fd960c7a4f5887.tar.gz
sweep-1db590d8ab488eeae6c01efd94fd960c7a4f5887.zip
Fix some part numbers, add more notes, add images
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md49
1 files changed, 31 insertions, 18 deletions
diff --git a/readme.md b/readme.md
index 1ee1942..804c50c 100644
--- a/readme.md
+++ b/readme.md
@@ -3,7 +3,8 @@
A [Ferris Sweep](https://github.com/davidphilipbarr/Sweep) variant
designed with an integrated RP2040 and some other added features.
-![keyboard](img/keyboard.png)
+![top](img/pcb_top.svg)
+![bottom](img/pcb_bottom.svg)
## Comments & Modifications
This PCB has the exact same dimensions and mounting points (via
@@ -34,37 +35,49 @@ quantity and colour as desired)
- **Column**: 2, **Row**: 1
3. For PCB assembly, choose **Economic** PCBA type and **Top Side** for
assembly side. If you would like the LEDs and related components to be
-installed, choose **Standard** and **Both Sides**.
+installed by PCBA, choose **Standard** and **Both Sides**.
4. Upload BOM file from [production/bom.csv](production/bom.csv) on the
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.
-6. Select the appropriate components on the following screen. This
-usually just means adding to cart since LCSC part numbers are already
-in BOM file.
+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
+some.
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
will usually correct this without issue.
+### Additional components
+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 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) |
+
## Build Instructions
These steps assume you already have an assembled PCB and are installing
-switches, RGB LEDs, displays, and/or other peripherals.
+switches, RGB LEDs, displays, and/or other peripherals. If you are
+hand-assebling the PCBs with all components, the [interactive BOM](https://html-preview.github.io/?url=https://git.pngu.org/sweep/tree/ibom.html)
+will be helpful.
-1. **Ensure keyboard is functional** by flashing firmware if necessary
+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.** 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 displays** if desired. If using I2C OLED displays, install
+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
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
@@ -83,4 +96,4 @@ operate Cirque Trackpad by I2C, adjust `rules.mk` file so that
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).
+LS011B7DH03 display, also known as [Nice!View display](https://nicekeyboards.com/nice-view).