Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add rp2040_ce and add elite-pi and helios as alias #19628

Merged
merged 2 commits into from
Feb 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions data/mappings/defaults.hjson
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@
"processor": "STM32F411",
"bootloader": "stm32-dfu",
"board": "BONSAI_C4"
},
"helios": {
"processor": "RP2040",
"bootloader": "rp2040",
"board": "QMK_PM2040"
}
}
}
2 changes: 1 addition & 1 deletion data/schemas/keyboard.jsonschema
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
},
"development_board": {
"type": "string",
"enum": ["promicro", "elite_c", "elite_pi", "proton_c", "kb2040", "promicro_rp2040", "blok", "bit_c_pro", "stemcell", "bluepill", "blackpill_f401", "blackpill_f411", "bonsai_c4"]
"enum": ["promicro", "elite_c", "elite_pi", "proton_c", "kb2040", "promicro_rp2040", "blok", "bit_c_pro", "stemcell", "bluepill", "blackpill_f401", "blackpill_f411", "bonsai_c4", "helios"]
},
"pin_compatible": {
"type": "string",
Expand Down
23 changes: 23 additions & 0 deletions docs/feature_converters.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ Currently the following converters are available:
| `promicro` | `stemcell` |
| `promicro` | `bonsai_c4` |
| `promicro` | `elite_pi` |
| `promicro` | `rp2040_ce` |
| `promicro` | `elite_pi` |
| `promicro` | `helios` |
| `elite_c` | `rp2040_ce` |
| `elite_c` | `stemcell` |
| `elite_c` | `elite_pi` |
| `elite_c` | `helios` |

See below for more in depth information on each converter.

Expand Down Expand Up @@ -81,6 +86,7 @@ If a board currently supported in QMK uses a [Pro Micro](https://www.sparkfun.co
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [customMK Bonsai C4](https://shop.custommk.com/products/bonsai-c4-microcontroller-board) | `bonsai_c4` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |

Converter summary:

Expand All @@ -93,7 +99,9 @@ Converter summary:
| `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` |
| `rp2040_ce` | `-e CONVERT_TO=rp2040_ce` | `CONVERT_TO=rp2040_ce` | `#ifdef CONVERT_TO_RP2040_CE` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |

### Proton C :id=proton_c

Expand Down Expand Up @@ -165,18 +173,33 @@ If a board currently supported in QMK uses an [Elite-C](https://keeb.io/products
|----------------------------------------------------------------------------------|-------------------|
| [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` |
| [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040) | `elite_pi` |
| [0xCB Helios](https://keeb.supply/products/0xcb-helios) | `helios` |

Converter summary:

| Target | Argument | `rules.mk` | Condition |
|-------------------|---------------------------------|------------------------------|-------------------------------------|
| `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` |
| `elite_pi` | `-e CONVERT_TO=elite_pi` | `CONVERT_TO=elite_pi` | `#ifdef CONVERT_TO_ELITE_PI` |
| `helios` | `-e CONVERT_TO=helios` | `CONVERT_TO=helios` | `#ifdef CONVERT_TO_HELIOS` |

### STeMCell :id=stemcell_elite

Currently identical to [STeMCell](#stemcell) with support for the additional bottom row of pins.

### RP2040 Community Edition :id=rp2040_ce

many rp2040 based boards like the splinky, sea-picro, helios, elite-pi, liatris and frood follow [this](https://user-images.githubusercontent.com/103112489/211809556-065e49f5-225e-4497-b922-987aec14e5d0.png) common pinout standard.

It originated from the BastardKB Discord Server
(please add all boards following the standard here)
### Elite-Pi :id=elite_pi

Currently identical to [Adafruit KB2040](#kb2040), with support for the additional bottom row of pins.

### Helios :id=helios

Follows the [RP2040 Community Edition](#rp2040_ce) standard, with from D+ and D- moved to the board center and GP10 and GP11 at the top (at the unused spots).
With support for the additional bottom row of pins, 2 extra top pins, a 5V level shifted extra pin (to drive RGB LEDs for example) and a user led.

Please consult the [pinout](https://github.com/0xCB-dev/0xCB-Helios/blob/main/rev1.0/helios.webp) for further reference.
1 change: 1 addition & 0 deletions docs/squeezing_avr.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ That said, there are a number of Pro Micro replacements with ARM controllers:
* [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288)
* [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622)
* [Elite-Pi](https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040)
* [0xCB Helios](https://keeb.supply/products/0xcb-helios) ([Open Source](https://github.com/0xCB-dev/0xCB-Helios), DIY/PCBA/Shop)

There are other, non-Pro Micro compatible boards out there. The most popular being:
* [WeAct Blackpill F411](https://www.aliexpress.com/item/1005001456186625.html) (~$6 USD)
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONVERTER:=platforms/chibios/converters/elite_c_to_rp2040_ce
ACTIVE_CONVERTER:=rp2040_ce
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONVERTER:=platforms/chibios/converters/elite_c_to_rp2040_ce
ACTIVE_CONVERTER:=rp2040_ce
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 QMK
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Elite-Pi MCU settings for converting AVR projects
# rp2040_ce MCU settings for converting AVR projects
MCU := RP2040
BOARD := QMK_PM2040
BOOTLOADER := rp2040
Expand All @@ -7,3 +7,4 @@ BOOTLOADER := rp2040
SERIAL_DRIVER ?= vendor
WS2812_DRIVER ?= vendor
BACKLIGHT_DRIVER ?= software
OPT_DEFS += -DUSB_VBUS_PIN=19U
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONVERTER:=platforms/chibios/converters/promicro_to_rp2040_ce
ACTIVE_CONVERTER:=rp2040_ce
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONVERTER:=platforms/chibios/converters/promicro_to_rp2040_ce
ACTIVE_CONVERTER:=rp2040_ce
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 QMK
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Elite-Pi MCU settings for converting AVR projects
# rp2040_ce MCU settings for converting AVR projects
MCU := RP2040
BOARD := QMK_PM2040
BOOTLOADER := rp2040
Expand All @@ -7,3 +7,4 @@ BOOTLOADER := rp2040
SERIAL_DRIVER ?= vendor
WS2812_DRIVER ?= vendor
BACKLIGHT_DRIVER ?= software
OPT_DEFS += -DUSB_VBUS_PIN=19U