From 508a2e0e584eba88627ee8069db5b038d549b2a1 Mon Sep 17 00:00:00 2001 From: nart38 Date: Sun, 9 Mar 2025 17:33:08 +0300 Subject: [PATCH 1/3] Fix broken link to qmk doc on half-duplex --- docs/buildguide_3DP.md | 2 +- docs/buildguide_acrylic.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/buildguide_3DP.md b/docs/buildguide_3DP.md index 598606e..13e632d 100644 --- a/docs/buildguide_3DP.md +++ b/docs/buildguide_3DP.md @@ -15,7 +15,7 @@ | OLED module | 02 | SSD1306 128x64 pixel OLED Displays | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | -| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/serial_driver.md#usart-half-duplex)| +| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex)| | EC11 encoder | 02 | You can use any EC11 encoder, but it will look better if you use a short one, like the EC11N1524402 | | encoder knob | 02 | The design works best with a 2,2cm encoder knob. I'd recommend kilo international knobs with a number starting with 90. You could also use the [knob](/knob/) I designed for the KLOR, based on the kilo knob. | USB cable | 01 | For connecting the keyboard to your PC | diff --git a/docs/buildguide_acrylic.md b/docs/buildguide_acrylic.md index 2f437b6..a01315e 100644 --- a/docs/buildguide_acrylic.md +++ b/docs/buildguide_acrylic.md @@ -15,7 +15,7 @@ | OLED module | 02 | SSD1306 128x64 pixel OLED Displays | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | -| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/serial_driver.md#usart-half-duplex)| +| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex)| | EC11 encoder | 02 | You can use any EC11 encoder, but it will look better if you use a short one, like the EC11N1524402 | | encoder knob | 02 | The design works best with a 2,2cm encoder knob. I'd recommend kilo international knobs with a number starting with 90. You could also use the [knob](/knob/) I designed for the KLOR, based on the kilo knob. | USB cable | 01 | For connecting the keyboard to your PC | From e72b9e615dce3862eeced24f87d4d1d00350f3a9 Mon Sep 17 00:00:00 2001 From: nart38 Date: Sun, 9 Mar 2025 17:45:11 +0300 Subject: [PATCH 2/3] improve clarification on TRRS cable remark --- docs/buildguide_3DP.md | 2 +- docs/buildguide_acrylic.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/buildguide_3DP.md b/docs/buildguide_3DP.md index 13e632d..9a179d2 100644 --- a/docs/buildguide_3DP.md +++ b/docs/buildguide_3DP.md @@ -15,7 +15,7 @@ | OLED module | 02 | SSD1306 128x64 pixel OLED Displays | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | -| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex)| +| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex) if your MCU has an ARM chip. Otherwise, if your MCU based on an AVR chip just like Arduino ProMicro, you must use TRRS cable | | EC11 encoder | 02 | You can use any EC11 encoder, but it will look better if you use a short one, like the EC11N1524402 | | encoder knob | 02 | The design works best with a 2,2cm encoder knob. I'd recommend kilo international knobs with a number starting with 90. You could also use the [knob](/knob/) I designed for the KLOR, based on the kilo knob. | USB cable | 01 | For connecting the keyboard to your PC | diff --git a/docs/buildguide_acrylic.md b/docs/buildguide_acrylic.md index a01315e..352dca2 100644 --- a/docs/buildguide_acrylic.md +++ b/docs/buildguide_acrylic.md @@ -15,7 +15,7 @@ | OLED module | 02 | SSD1306 128x64 pixel OLED Displays | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | -| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex)| +| TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex) if your MCU has an ARM chip. Otherwise, if your MCU based on an AVR chip just like Arduino ProMicro, you must use TRRS cable | | EC11 encoder | 02 | You can use any EC11 encoder, but it will look better if you use a short one, like the EC11N1524402 | | encoder knob | 02 | The design works best with a 2,2cm encoder knob. I'd recommend kilo international knobs with a number starting with 90. You could also use the [knob](/knob/) I designed for the KLOR, based on the kilo knob. | USB cable | 01 | For connecting the keyboard to your PC | From fd4546f656eb2dd261cbde44076b495dcfea7270 Mon Sep 17 00:00:00 2001 From: nart38 Date: Sun, 9 Mar 2025 17:49:57 +0300 Subject: [PATCH 3/3] improve clarification on OLED display remark --- docs/buildguide_3DP.md | 2 +- docs/buildguide_acrylic.md | 2 +- docs/buildguide_acrylic_ble.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/buildguide_3DP.md b/docs/buildguide_3DP.md index 9a179d2..b56be35 100644 --- a/docs/buildguide_3DP.md +++ b/docs/buildguide_3DP.md @@ -12,7 +12,7 @@ | switch socket | 42 | 40 sockets for Konrad / 38 sockets for Yubitsume / 36 sockets for Saegewerk | | diodes 1N4148W| 44 | These are surface mount diodes in SOD123 package. 42 for Konrad / 40 for Yubitsume / 38 for Saegewerk | | 1u MX keycaps | 42 | 40 keycaps for Konrad / 38 keycaps for Yubitsume / 36 keycaps for Saegewerk | -| OLED module | 02 | SSD1306 128x64 pixel OLED Displays | +| OLED module | 02 | SSD1306 128x64 pixel I2C OLED Displays with 4 pins | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | | TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex) if your MCU has an ARM chip. Otherwise, if your MCU based on an AVR chip just like Arduino ProMicro, you must use TRRS cable | diff --git a/docs/buildguide_acrylic.md b/docs/buildguide_acrylic.md index 352dca2..71e9b99 100644 --- a/docs/buildguide_acrylic.md +++ b/docs/buildguide_acrylic.md @@ -12,7 +12,7 @@ | switch socket | 42 | 40 sockets for Konrad / 38 sockets for Yubitsume / 36 sockets for Saegewerk | | diodes 1N4148W| 44 | These are surface mount diodes in SOD123 package. 42 for Konrad / 40 for Yubitsume / 38 for Saegewerk | | 1u MX keycaps | 42 | 40 keycaps for Konrad / 38 keycaps for Yubitsume / 36 keycaps for Saegewerk | -| OLED module | 02 | SSD1306 128x64 pixel OLED Displays | +| OLED module | 02 | SSD1306 128x64 pixel I2C OLED Displays with 4 pins | | reset button | 02 | Alps SKRTLAE010 | | TRRS jack | 02 | MJ-4PP-9 or PJ320A | | TRRS cable | 01 | Alternatively, you can use a TRS cable for [half-duplex](https://github.com/qmk/qmk_firmware/blob/master/docs/drivers/serial.md#usart-half-duplex) if your MCU has an ARM chip. Otherwise, if your MCU based on an AVR chip just like Arduino ProMicro, you must use TRRS cable | diff --git a/docs/buildguide_acrylic_ble.md b/docs/buildguide_acrylic_ble.md index 5ec5dd9..658591f 100644 --- a/docs/buildguide_acrylic_ble.md +++ b/docs/buildguide_acrylic_ble.md @@ -12,7 +12,7 @@ | switch socket | 42 | 40 sockets for Konrad / 38 sockets for Yubitsume / 36 sockets for Saegewerk | | diodes 1N4148W| 44 | These are surface mount diodes in SOD123 package. 42 for Konrad / 40 for Yubitsume / 38 for Saegewerk | | 1u MX keycaps | 42 | 40 keycaps for Konrad / 38 keycaps for Yubitsume / 36 keycaps for Saegewerk | -| OLED module | 02 | SSD1306 128x64 pixel OLED Displays | +| OLED module | 02 | SSD1306 128x64 pixel I2C OLED Displays with 4 pins | | reset button | 02 | Alps SKRTLAE010 | | power switch | 02 | MSK12C02 | | EC11 encoder | 02 | You can use any EC11 encoder, but it will look better if you use a short one, like the EC11N1524402 | @@ -404,4 +404,4 @@ The design works best with 23mm (0.9") diameter encoder knobs. My recomendation This is how the final keyboard will look like. In this picture you see the KLOR saegewerk, with RAMA Grid keycaps in NOCT. -![KLOR acrylic case](/docs/images/buildguide/acrylic_case.jpg) \ No newline at end of file +![KLOR acrylic case](/docs/images/buildguide/acrylic_case.jpg)