Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

[Doc] Improve converter references (#21801)

Browse source
This commit is contained in:
フィルターペーパー 2023-11-17 01:48:24 +08:00 • committed by GitHub
commit a6521b8521
Failed to generate hash of commit
1 changed files with 14 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/feature_converters.md
View file

@ -1,12 +1,10 @@
# Converters # Converters
Since many drop-in replacement controllers now exist, we've done our best to make them easy to use in existing designs. This page documents the automated process for converting keyboards to use drop-in replacement controllers. This process is designed to be easy to use and can be completed in a few simple steps.
This page documents the handy automated process for converting keyboards. ## Supported Converters
### Supported Converters The following converters are available at this time:
Currently the following converters are available:
| From | To | | From | To |
|------------|-------------------| |------------|-------------------|
@ -28,14 +26,10 @@ Currently the following converters are available:
| `elite_c` | `helios` | | `elite_c` | `helios` |
| `elite_c` | `liatris` | | `elite_c` | `liatris` |
See below for more in depth information on each converter.
## Overview ## Overview
Each converter category is broken down by its declared `pin compatibility`. Each converter category is broken down by its declared `pin compatibility`. This ensures that only valid combinations are attempted. You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
This ensures that only valid combinations are attempted.
You can generate the firmware by appending `-e CONVERT_TO=<target>` to your compile/flash command. For example:
```sh ```sh
qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c qmk flash -c -kb keebio/bdn9/rev1 -km default -e CONVERT_TO=proton_c
@ -59,14 +53,12 @@ Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag
### Pin Compatibility ### Pin Compatibility
To ensure compatibility, provide validation, and power future workflows, a keyboard should declare its `pin compatibility`. For legacy reasons, this is currently assumed to be `promicro`. To ensure compatibility, provide validation, and enable future workflows, a keyboard should declare its `pin compatibility`. For legacy reasons, this is currently assumed to be `promicro`. The following pin compatibility interfaces are currently defined:
Currently the following pin compatibility interfaces are defined: | Pin Compatibility | Notes |
|-------------------|-----------------------------------|
| Pinout | Notes | | `promicro` | Includes RX/TX LEDs |
|------------|-----------------------------------| | `elite_c` | Includes bottom row pins, no LEDs |
| `promicro` | Includes RX/TX LEDs |
| `elite_c` | Includes bottom row pins, no LEDs |
To declare the base for conversions, add this line to your keyboard's `rules.mk`: To declare the base for conversions, add this line to your keyboard's `rules.mk`:
@ -140,7 +132,7 @@ The following defaults are based on what has been implemented for [RP2040](platf
### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi :id=promicro_rp2040 ### SparkFun Pro Micro - RP2040, Blok, Bit-C PRO and Michi :id=promicro_rp2040
Currently identical to [Adafruit KB2040](#kb2040). Feature set is identical to [Adafruit KB2040](#kb2040).
### STeMCell :id=stemcell ### STeMCell :id=stemcell
@ -150,9 +142,7 @@ There are two versions of STeMCell available, with different pinouts:
- v2.0.0 (pre-release v1.0.1, v1.0.2) - v2.0.0 (pre-release v1.0.1, v1.0.2)
Default official firmware only supports v2.0.0 STeMCell. Default official firmware only supports v2.0.0 STeMCell.
STeMCell has support to swap UART and I2C pins, to enable single-wire uart communication in STM chips. STeMCell has support to swap UART and I2C pins to enable single-wire uart communication in STM chips. The following additional flags has to be used while compiling, based on the pin used for split communication:
The following additional flags has to be used while compiling, based on the pin used for split communication.
| Split Pin | Compile flags | | Split Pin | Compile flags |
|-----------|---------------| |-----------|---------------|
@ -173,11 +163,8 @@ The Bonsai C4 only has one on-board LED (B2), and by default, both the Pro Micro
### RP2040 Community Edition - Elite-Pi, Helios, and Liatris :id=rp2040_ce ### RP2040 Community Edition - Elite-Pi, Helios, and Liatris :id=rp2040_ce
Feature set currently identical to [Adafruit KB2040](#kb2040). Feature set is identical to [Adafruit KB2040](#kb2040). VBUS detection is enabled by default for superior split keyboard support. For more information, refer to the [Community Edition pinout](platformdev_rp2040.md#rp2040_ce) docs.
Enables VBUS detection by default for superior split keyboard support.
For more information, refer to the [RP2040 Community Edition](platformdev_rp2040.md#rp2040_ce) docs.
## Elite-C ## Elite-C
@ -202,8 +189,8 @@ Converter summary:
### STeMCell :id=stemcell_elite ### STeMCell :id=stemcell_elite
Currently identical to [STeMCell](#stemcell) with support for the additional bottom row of pins. Identical to [Pro Micro - STeMCell](#stemcell) with support for the additional bottom row of pins.
### RP2040 Community Edition :id=rp2040_ce_elite ### RP2040 Community Edition :id=rp2040_ce_elite
Currently identical to [RP2040 Community Edition](#rp2040_ce), with support for the additional bottom row of pins. Identical to [Pro Micro - RP2040 Community Edition](#rp2040_ce) with support for the additional bottom row of pins.