aboutsummaryrefslogtreecommitdiff
path: root/keyboards/kprepublic/cstc40/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kprepublic/cstc40/readme.md')
-rw-r--r--keyboards/kprepublic/cstc40/readme.md31
1 files changed, 15 insertions, 16 deletions
diff --git a/keyboards/kprepublic/cstc40/readme.md b/keyboards/kprepublic/cstc40/readme.md
index 211c078cc2..e6493b28a0 100644
--- a/keyboards/kprepublic/cstc40/readme.md
+++ b/keyboards/kprepublic/cstc40/readme.md
@@ -1,26 +1,25 @@
-# cstc40
+# CSTC40
-A 40% hotswap ortholinear RGB keyboard from KP Republic.
+## This keyboard has 3 known hardware revisions, please be sure to flash the correct firmware for your PCB
-* Keyboard Maintainer: [Var](https://github.com/itsvar8)
-* Hardware Supported: CSTC40
-* Hardware Availability: kprepublic.com
+A 40% hotswap ortholinear RGB keyboard from KP Republic
-The differences between the two versions are just the rows and columns pins and the additional small pcb for the daughterboard version.
+### Revision 1: "daughterboard"
-Make example for this keyboard (after setting up your build environment):
+* STM32F402RCT6 MCU with IS31FL3733 LED driver, using `stm32-dfu` bootloader. Uses a separate daughterboard for USB connection.
- for daughterboard version: make kprepublic/cstc40/daughterboard:default
- for single pcb version: make kprepublic/cstc40/single_pcb:default
+* Upon entering bootloader mode QMK Toolbox will display this message:
+`STM32 DFU device connected (WinUSB): STMicroelectronics STM32 BOOTLOADER (0483:DF11:2200)`
-See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+### Revision 2: "single pcb"
-## Bootloader
+* STM32F402RCT6 MCU with IS31FL3733 LED driver, using `stm32-dfu` bootloader. Integrated USB connection.
-Enter the bootloader in 3 ways:
+* Upon entering bootloader mode QMK Toolbox will display this message:
+`STM32 DFU device connected (WinUSB): STMicroelectronics STM32 BOOTLOADER (0483:DF11:2200)`
-* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
-* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
-* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
+### Revision 3: "FXTwink single pcb"
-The single_pcb uses pin A10, which apparently is a design flaw that prevent the bootloader to start every time - https://docs.qmk.fm/#/platformdev_blackpill_f4x1?id=pins-to-be-avoided. There is a simple workaround that works most of the time - press the pin key (generally the letter R) during the boot.
+* STM32F402RCT6 MCU without separate LED driver, using `tinyuf2` bootloader. Integrated USB connection.
+
+* Upon entering bootloader mode the board will appear in your computer's file system as a new USB mass storage device.