Skip to content

Commit f5ce5ee

Browse files
committed
Add Quefrency LM build guide
1 parent d79ecfa commit f5ce5ee

9 files changed

Lines changed: 103 additions & 0 deletions

File tree

1.06 MB
Loading
846 KB
Loading
566 KB
Loading
1.1 MB
Loading
866 KB
Loading
113 KB
Loading
289 KB
Loading

docs/quefrency-lm-build-guide.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: Quefrency LM
3+
---
4+
5+
## Build Compatibility
6+
7+
This build guide is exclusively for the Quefrency LM.
8+
9+
## Parts List
10+
11+
Get your parts ready:
12+
13+
* [Quefrency LM Kit](https://keeb.io/products/quefrency-lm-kit?utm_source=docs)
14+
* PCBs
15+
* Tray Case
16+
* Silicone liners
17+
* O-rings
18+
* Switch plates
19+
* Switch plate support foam
20+
* 8mm M2 screws
21+
* Shroomie feet
22+
* [USB-C to USB-C cable](https://keeb.io/products/usb-c-to-usb-c-cable)
23+
* [Low-Profile Kailh Choc Switches](https://keeb.io/collections/switches?filter.p.m.keyboard.switch_compatibility=Choc+V2+Low-Profile&sort_by=best-selling&utm_source=docs) - Choc V2
24+
* [Low-Profile Keycaps](https://keeb.io/collections/keycaps?filter.p.m.keyboard.switch_compatibility=Choc+V2+Low-Profile&sort_by=manual&utm_source=docs)
25+
26+
![Quefrency LM Kit Parts](./assets/images/quefrency-lm/IMG_8765.jpeg)
27+
28+
## Build Steps Summary
29+
30+
1. Inspect/Test Parts
31+
2. Add switches
32+
3. Assemble Case
33+
4. Board Notes
34+
35+
## Inspect/Test Parts
36+
37+
Before starting assembly of the board, check if there's any issues with the parts in the keyboard kit.
38+
39+
Plug in the USB-C link cable in between halves and plug in the USB-C cable from your computer to the left half. Both halves should light up. Do the same with plugging into the right half.
40+
41+
If both halves don't light up, check that you're plugging into the correct USB-C port (outermost ones) and that you are not using a charging-only USB-C cable.
42+
43+
Optional: Unscrew the switch plate and inspect that there is switch plate support foam, silicone tray liners, and o-rings on the mounting points. See [Full Breakdown](#full-breakdown) for more information.
44+
45+
## Add switches
46+
47+
To insert a switch, make sure the pins line up with the hotswap socket on the PCB.
48+
49+
![Inserted switch](./assets/images/quefrency-lm/IMG_8766.jpeg)
50+
51+
Then push down on the part of the switch that is above the pins until it clicks into place.
52+
53+
![Insert switch](./assets/images/quefrency-lm/IMG_8768.jpeg)
54+
55+
Add the rest of the switches.
56+
57+
![All switches added](./assets/images/quefrency-lm/IMG_8769.jpeg)
58+
59+
## Test keys
60+
61+
Before reassembling the case, plug the USB cable into the PCB and test all of the keys to make sure everything is working, as it'll be easier to fix switch issues now than later.
62+
63+
![](./assets/images/quefrency-lm/via-switch-test.png)
64+
65+
Note that the `Fn` key won't show up in the switch tester, as a keycode isn't sent to the computer when pressed, so to test it, hold `Fn` while pressing another key. For example, holding down `Fn` while pressing `1` will output `F1` to a computer.
66+
67+
If a key is not working, check that the switch is inserted properly and that the pins are aligned with the hotswap socket. Sometimes, a pin can get bent during insertion, which can cause the switch to not work.
68+
69+
## Add Keycaps
70+
71+
Add keycaps to all of the switches.
72+
73+
![All keycaps added](./assets/images/quefrency-lm/IMG_8771.jpeg)
74+
75+
Plug it in and type away!
76+
77+
![All lit up](./assets/images/quefrency-lm/plugged-in.jpg)
78+
79+
## Default Keymap
80+
81+
Here's the default keymap if you need it: [Quefrency LM Default Keymap](https://github.com/nooges/qmk_userspace_via/blob/main/keyboards/keebio/quefrency_lm/keymaps/via/keymap.c)
82+
83+
## Remapping/reprogramming Board
84+
85+
Looking to remap/reprogram your board? Check out our guide for [remapping your keyboard](remapping-keyboard).
86+
87+
While the bottom plates have a hole at the bottom to allow you to access the reset button to allow your Quefrency LM to be reflashed if you are using QMK, if you don't want to be flipping your board over to press reset, you can also use one of the following options when remapping your Iris:
88+
89+
1. Use [VIA](via.md) to remap your keys. The stock firmware on the Quefrency LM already has VIA support enabled. This allows you to remap the keyboard without having to reflash the board.
90+
2. If you are not using VIA and are using QMK instead, use the `QK_BOOT` keycode to reset the keyboard to allow it to be reflashed without needing to physically press the reset button on the PCB. The default way of using `QK_BOOT` is by pressing `Fn` + `R`.
91+
92+
For reference, the Quefrency LM PCB uses a STM32G431 microcontroller.
93+
94+
## Turning off RGB LEDs
95+
96+
If you'd like to turn the RGB LEDs off, you can control the [RGB settings in VIA](via#lighting).
97+
98+
## Full Breakdown
99+
100+
(Images coming soon)
101+
102+
If you want to fully unscrew the case to check the parts inside, you can unscrew the switch plate and inspect that there is switch plate support foam, silicone tray liners, and o-rings on the mounting points.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ module.exports = {
77
'iris-ce-build-guide',
88
'iris-lm-build-guide',
99
'iris-se-build-guide',
10+
'quefrency-lm-build-guide',
1011
'nyquist-lm-build-guide',
1112
'demod-lm-build-guide',
1213
'dilly-build-guide',

0 commit comments

Comments
 (0)