Skip to content

[Keyboard] Add splitkb.com's Halcyon Lily58 rev2 #25144

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
73 changes: 73 additions & 0 deletions keyboards/splitkb/halcyon/lily58/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"manufacturer": "splitkb.com",
"maintainer": "splitkb.com",
"url": "https://splitkb.com",
"usb": {
"device_version": "1.0.0",
"vid": "0x8D1D"
},
"layouts": {
"LAYOUT": {
"layout": [
{"label": "L01", "matrix": [0, 0], "x": 0, "y": 0.5},
{"label": "L02", "matrix": [0, 1], "x": 1, "y": 0.375},
{"label": "L03", "matrix": [0, 2], "x": 2, "y": 0.125},
{"label": "L04", "matrix": [0, 3], "x": 3, "y": 0},
{"label": "L05", "matrix": [0, 4], "x": 4, "y": 0.125},
{"label": "L06", "matrix": [0, 5], "x": 5, "y": 0.25},
{"label": "R06", "matrix": [5, 5], "x": 10.5, "y": 0.25},
{"label": "R05", "matrix": [5, 4], "x": 11.5, "y": 0.125},
{"label": "R04", "matrix": [5, 3], "x": 12.5, "y": 0},
{"label": "R03", "matrix": [5, 2], "x": 13.5, "y": 0.125},
{"label": "R02", "matrix": [5, 1], "x": 14.5, "y": 0.375},
{"label": "R01", "matrix": [5, 0], "x": 15.5, "y": 0.5},
{"label": "L07", "matrix": [1, 0], "x": 0, "y": 1.5},
{"label": "L08", "matrix": [1, 1], "x": 1, "y": 1.375},
{"label": "L09", "matrix": [1, 2], "x": 2, "y": 1.125},
{"label": "L10", "matrix": [1, 3], "x": 3, "y": 1},
{"label": "L11", "matrix": [1, 4], "x": 4, "y": 1.125},
{"label": "L12", "matrix": [1, 5], "x": 5, "y": 1.25},
{"label": "R12", "matrix": [6, 5], "x": 10.5, "y": 1.25},
{"label": "R11", "matrix": [6, 4], "x": 11.5, "y": 1.125},
{"label": "R10", "matrix": [6, 3], "x": 12.5, "y": 1},
{"label": "R09", "matrix": [6, 2], "x": 13.5, "y": 1.125},
{"label": "R08", "matrix": [6, 1], "x": 14.5, "y": 1.375},
{"label": "R07", "matrix": [6, 0], "x": 15.5, "y": 1.5},
{"label": "L13", "matrix": [2, 0], "x": 0, "y": 2.5},
{"label": "L14", "matrix": [2, 1], "x": 1, "y": 2.375},
{"label": "L15", "matrix": [2, 2], "x": 2, "y": 2.125},
{"label": "L16", "matrix": [2, 3], "x": 3, "y": 2},
{"label": "L17", "matrix": [2, 4], "x": 4, "y": 2.125},
{"label": "L18", "matrix": [2, 5], "x": 5, "y": 2.25},
{"label": "R18", "matrix": [7, 5], "x": 10.5, "y": 2.25},
{"label": "R17", "matrix": [7, 4], "x": 11.5, "y": 2.125},
{"label": "R16", "matrix": [7, 3], "x": 12.5, "y": 2},
{"label": "R15", "matrix": [7, 2], "x": 13.5, "y": 2.125},
{"label": "R14", "matrix": [7, 1], "x": 14.5, "y": 2.375},
{"label": "R13", "matrix": [7, 0], "x": 15.5, "y": 2.5},
{"label": "L20", "matrix": [3, 0], "x": 0, "y": 3.5},
{"label": "L21", "matrix": [3, 1], "x": 1, "y": 3.375},
{"label": "L22", "matrix": [3, 2], "x": 2, "y": 3.125},
{"label": "L23", "matrix": [3, 3], "x": 3, "y": 3},
{"label": "L24", "matrix": [3, 4], "x": 4, "y": 3.125},
{"label": "L25", "matrix": [3, 5], "x": 5, "y": 3.25},
{"label": "L19", "matrix": [4, 1], "x": 6, "y": 2.75},
{"label": "R19", "matrix": [9, 1], "x": 9.5, "y": 2.75},
{"label": "R25", "matrix": [8, 5], "x": 10.5, "y": 3.25},
{"label": "R24", "matrix": [8, 4], "x": 11.5, "y": 3.125},
{"label": "R23", "matrix": [8, 3], "x": 12.5, "y": 3},
{"label": "R22", "matrix": [8, 2], "x": 13.5, "y": 3.125},
{"label": "R21", "matrix": [8, 1], "x": 14.5, "y": 3.375},
{"label": "R20", "matrix": [8, 0], "x": 15.5, "y": 3.5},
{"label": "L26", "matrix": [4, 2], "x": 2.5, "y": 4.15},
{"label": "L27", "matrix": [4, 3], "x": 3.5, "y": 4.15},
{"label": "L28", "matrix": [4, 4], "x": 4.5, "y": 4.25},
{"label": "L29", "matrix": [4, 5], "x": 6, "y": 4.25},
{"label": "R29", "matrix": [9, 5], "x": 9.5, "y": 4.25},
{"label": "R28", "matrix": [9, 4], "x": 11, "y": 4.25},
{"label": "R27", "matrix": [9, 3], "x": 12, "y": 4.15},
{"label": "R26", "matrix": [9, 2], "x": 13, "y": 4.15}
]
}
}
}
47 changes: 47 additions & 0 deletions keyboards/splitkb/halcyon/lily58/keymaps/default/keymap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"keyboard": "splitkb/halcyon/lily58/rev2",
"keymap": "default",
"version": 1,
"layout": "LAYOUT",
"layers": [
[
"KC_ESC" , "KC_1" , "KC_2" , "KC_3" , "KC_4" , "KC_5" , "KC_6" , "KC_7" , "KC_8" , "KC_9" , "KC_0" , "KC_GRV" ,
"KC_TAB" , "KC_Q" , "KC_W" , "KC_E" , "KC_R" , "KC_T" , "KC_Y" , "KC_U" , "KC_I" , "KC_O" , "KC_P" , "KC_MINS",
"KC_LCTL", "KC_A" , "KC_S" , "KC_D" , "KC_F" , "KC_G" , "KC_H" , "KC_J" , "KC_K" , "KC_L" , "KC_SCLN", "KC_QUOT",
"KC_LSFT", "KC_Z" , "KC_X" , "KC_C" , "KC_V" , "KC_B" , "KC_LBRC", "KC_RBRC", "KC_N" , "KC_M" , "KC_COMM", "KC_DOT" , "KC_SLSH", "KC_RSFT",
"KC_LALT", "KC_LGUI", "MO(1)" , "KC_SPC" , "KC_ENT" , "MO(2)" , "KC_BSPC", "KC_RGUI"
],
[
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______",
"KC_F1" , "KC_F2", "KC_F3", "KC_F4" , "KC_F5" , "KC_F6" , "KC_F7" , "KC_F8" ,"KC_F9" , "KC_F10" , "KC_F11" , "KC_F12" ,
"KC_GRV" , "KC_EXLM", "KC_AT" , "KC_HASH", "KC_DLR" , "KC_PERC", "KC_CIRC", "KC_AMPR", "KC_ASTR", "KC_LPRN", "KC_RPRN", "KC_TILD",
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "XXXXXXX", "KC_UNDS", "KC_PLUS", "KC_LCBR", "KC_RCBR", "KC_PIPE",
"_______", "_______", "_______", "_______", "_______", "MO(3)" , "_______", "_______"
],
[
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______",
"KC_GRV" , "KC_1" , "KC_2" , "KC_3" , "KC_4" , "KC_5" , "KC_6" , "KC_7" , "KC_8" , "KC_9" , "KC_0" , "_______",
"KC_F1" , "KC_F2" , "KC_F3" , "KC_F4" , "KC_F5" , "KC_F6" , "XXXXXXX", "KC_LEFT", "KC_DOWN", "KC_UP" , "KC_RGHT", "XXXXXXX",
"KC_F7" , "KC_F8" , "KC_F9" , "KC_F10" , "KC_F11" , "KC_F12" , "_______", "_______", "KC_PLUS", "KC_MINS", "KC_EQL" , "KC_LBRC", "KC_RBRC", "KC_BSLS",
"_______", "_______", "MO(3)" , "_______", "_______", "_______", "_______", "_______"
],
[
"QK_BOOT", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX",
"XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX",
"XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "RM_TOGG", "RM_HUEU", "RM_SATU", "RM_VALU",
"XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "XXXXXXX", "RM_NEXT", "RM_HUED", "RM_SATD", "RM_VALD",
"_______", "_______", "_______", "_______", "_______", "_______", "_______", "_______"
]
],
"config": {
"features": {
"encoder_map": true
}
},
"encoders": [
[{"ccw": "KC_VOLD", "cw": "KC_VOLU"}, {"ccw": "KC_PGUP", "cw": "KC_PGDN"}],
[{"ccw": "_______", "cw": "_______"}, {"ccw": "_______", "cw": "_______"}],
[{"ccw": "_______", "cw": "_______"}, {"ccw": "_______", "cw": "_______"}],
[{"ccw": "_______", "cw": "_______"}, {"ccw": "_______", "cw": "_______"}]
]
}
88 changes: 88 additions & 0 deletions keyboards/splitkb/halcyon/lily58/keymaps/default/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Halcyon Lily58's Default Keymap
_This keymap is a copy of the [Lily58 default keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lily58/keymaps/default), with slight modifications._

A simple default keymap for the Halcyon Lily58
=============================================

Keymaps in general are quite personal, so it is difficult to come up with a default that will suit every user. We hope this keymap serves as a good starting point for your own - although it should be fairly usable out-of-the-box.

What do all these layers do?
----------------------------

### Layer 0: Base layer

![Layer 0](https://i.imgur.com/sq8Rql7h.png)

This is where your basic letters live.

The homing thumb fingers are used to access the different layers.

* The homing left thumb finger gives access to the Symbols (or lower) layer
* The homing right thumb finger gives access to the Navigation (or raise) layer
* Pressing both homing thumb fingers gives access to the Adjust layer

### Layer 1: Lower

![Layer 1](https://i.imgur.com/baSE2OJh.png)

The Lower layer gives access to the F keys on the second row, and shifted number keys on the home row. It also provides some shifted symbol keys.

### Layer 2: Raise

![Layer 2](https://i.imgur.com/CRnDa6Nh.png)

The Raise layer gives access the arrow keys on the right hand, in addition to some unshifted symbols. The left hand provides an alternative set of F keys, while the second row provides an alternative set of number keys.

### Layer 3: Adjust

![Layer 3](https://i.imgur.com/QbCiTcyh.png)

The Adjust layer exposes RGB adjustment keys on the right hand.

Where is the keymap.c?
----------------------

The keymap.c file is not published to the repository. It is generated from `keymap.json` by the build system.

This avoids duplicating information and allow users to edit their keymap from the QMK Configurator web interface.

How do I edit and update the keymap?
------------------------------------

The `keymap.json` file is generated from the QMK Configurator interface and formatted for better readability in the context of the Ferris keyboard.

To edit it, you may:
* Edit it directly from a text editor.
* Edit it from the QMK Configurator.

If you decide to use the latter workflow, here are the steps to follow:

* From the [QMK Configurator](https://config.qmk.fm/#/splitkb/halcyon/lily58/rev2/LAYOUT), hit the "import QMK keymap json file" button (it has a drawing with an up arrow on it).
* Browse to the location of your keymap (for example, `<your qmk repo>/keyboards/splitkb/halcyon/lily58/keymaps/default/keymap.json`)
* Perform any modification to the keymap in the web UI
* Export the keymap to your downloads folder, by hitting the "Export QMK keymap json file" button (it has a drawing with a down arrow on it)
* Replace your original keymap with the one you just downloaded

_**Note:** At the time of writing (the 24th of October 2022), not every feature used in the default keymap is supported by the QMK Configurator. You cannot yet upload the default `keymap.json` due to a file format mismatch - use the "Load Default" button to load the default keymap instead. Additionally, custom configuration options are still being worked on: if your keymap depends on them, please compile your firmware offline for now._

I want to do more than the JSON format supports!
-------------------------------------------------

While the `json` format is easy to use, it does lack certain functionality - most notably custom OLED or encoder behaviour.

To add this, you need to convert it to the `c` format. Do keep in mind that this is generally a one-way operation.

First, from the root of your qmk repo, move to your keymap folder

```bash
cd ./keyboards/splitkb/halcyon/lily58/keymaps/my_personal_keymap
```

Next, convert your `keymap.json` to a `keymap.c`

```bash
qmk json2c -o keymap.c keymap.json
```

You can add custom C code to the newly generated `keymap.c` file. Do note that you have to use **either** a C file **or** a JSON file - you cannot do both!
**If a JSON file is present, the C file is ignored.**
31 changes: 31 additions & 0 deletions keyboards/splitkb/halcyon/lily58/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Halcyon Lily58

![splitkb/halcyon/lily58](https://i.imgur.com/q7VIrbz.png)

The Halcyon Lily58 rev2 is the second Lily58 revision and the fourth keyboard in our Halcyon range. Similar to Aurora, all keyboards in the series share the same feature set. The key highlights:

- Halcyon keyboards come preassembled! You won't need a soldering iron.
- You'll be able to install [VIK](https://github.com/sadekbaroudi/vik) modules.
- It'll come fully documented, which includes the unboxing, assembly (with only a screwdriver), first installation and some advanced use cases.
- Both the connection to the host device as well as the interconnect between the keyboard halves use USB C.
- The controller has full ESD protection on all USB C ports, as well as all switch matrix GPIO!
- The controller is interchangable. If part of your keyboard ever breaks, we can replace just the bits that need replacing.

* Keyboard Maintainer: [splitkb.com](https://github.com/splitkb.com)
* Hardware Availability: [splitkb.com](https://splitkb.com).

Make example for this keyboard (after setting up your build environment):

make splitkb/halcyon/lily58/rev2:default

The keyboard can be flashed by copying the resulting `.uf2` file onto the `RPI-RP2` flash drive.

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).

## Bootloader

Enter the bootloader in 3 ways:

* **Reset button**: Double-tap the reset button at the top of the controller, right above the USB-C port.
* **Bootloader reset**: Hold down the "Boot" button and plug in the keyboard.
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.
32 changes: 32 additions & 0 deletions keyboards/splitkb/halcyon/lily58/rev2/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright 2025 splitkb.com ([email protected])
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

// Make it easier to enter the bootloader
#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET
#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT 1000U

// UART1, communication between the two halves
#define SERIAL_USART_FULL_DUPLEX // Enable full duplex operation mode.
#define SERIAL_USART_TX_PIN GP28 // USART TX pin
#define SERIAL_USART_RX_PIN GP29 // USART RX pin
#define SERIAL_PIO_USE_PIO1 // Use PIO1 as PIO0 is used for WS2812 driver

// VBUS detection
#define USB_VBUS_PIN GP1

//// VIK

// GPIO1 = GP27
// GPIO2 = GP26
// CS = GP13

#define I2C_DRIVER I2C0
#define I2C1_SDA_PIN GP16
#define I2C1_SCL_PIN GP17

#define SPI_DRIVER SPID1
#define SPI_SCK_PIN GP14
#define SPI_MOSI_PIN GP15
#define SPI_MISO_PIN GP12
14 changes: 14 additions & 0 deletions keyboards/splitkb/halcyon/lily58/rev2/halconf.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Copyright 2025 splitkb.com ([email protected])
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

//// VIK

#define HAL_USE_I2C TRUE

#define HAL_USE_SPI TRUE
#define SPI_USE_WAIT TRUE
#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD

#include_next <halconf.h>
Loading