diff options
| author | David Hoelscher <infinityis@users.noreply.github.com> | 2022-08-17 19:01:54 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-18 01:01:54 +0100 |
| commit | a645301c827705b04c8f19182153a1962c5c7bcb (patch) | |
| tree | 362f73c19acfb25bbeaea96a630f8fab01154286 /docs/feature_converters.md | |
| parent | 29f47f4cf3722b10538547ab0ecb6c0aae294c38 (diff) | |
Add Bonsai C4 converter (#17711)
Diffstat (limited to 'docs/feature_converters.md')
| -rw-r--r-- | docs/feature_converters.md | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/docs/feature_converters.md b/docs/feature_converters.md index 936ab44559..fe12254efe 100644 --- a/docs/feature_converters.md +++ b/docs/feature_converters.md @@ -16,6 +16,7 @@ Currently the following converters are available: | `promicro` | `blok` | | `promicro` | `bit_c_pro` | | `promicro` | `stemcell` | +| `promicro` | `bonsai_c4` | See below for more in depth information on each converter. @@ -50,14 +51,15 @@ Once a converter is enabled, it exposes the `CONVERT_TO_<target_uppercase>` flag If a board currently supported in QMK uses a [Pro Micro](https://www.sparkfun.com/products/12640) (or compatible board), the supported alternative controllers are: -| Device | Target | -|------------------------------------------------------------------------|-------------------| -| [Proton C](https://qmk.fm/proton-c/) | `proton_c` | -| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` | -| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `promicro_rp2040` | -| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | -| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | -| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | +| Device | Target | +|------------------------------------------------------------------------------------------|-------------------| +| [Proton C](https://qmk.fm/proton-c/) | `proton_c` | +| [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040) | `kb2040` | +| [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `promicro_rp2040` | +| [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | +| [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | +| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | +| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` | Converter summary: @@ -69,6 +71,7 @@ Converter summary: | `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` | | `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` | | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` | +| `bonsai_c4` | `-e CONVERT_TO=bonsai_c4` | `CONVERT_TO=bonsai_c4` | `#ifdef CONVERT_TO_BONSAI_C4` | ### Proton C :id=proton_c @@ -121,3 +124,15 @@ The following additional flags has to be used while compiling, based on the pin | D2 | Not needed | | D1 | -e STMC_IS=yes| | D0 | Not needed | + +### Bonsai C4 :id=bonsai_c4 + +The Bonsai C4 only has one on-board LED (B2), and by default, both the Pro Micro TXLED (D5) and RXLED (B0) are mapped to it. If you want only one of them mapped, you can undefine one and redefine it to another pin by adding these line to your `config.h`: + +```c +#undef B0 +// If Vbus detection is unused, we can send RXLED to the Vbus detect pin instead +#define B0 PAL_LINE(GPIOA, 9) +``` + +No peripherals are enabled by default at this time, but example code to enable SPI, I2C, PWM, and Serial communications can be found [here](/keyboards/custommk/bonsai_c4_template)
\ No newline at end of file |