Add support for Starry FRL (#24626)
Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
		
							parent
							
								
									64fe4aff31
								
							
						
					
					
						commit
						ce9713c47d
					
				
					 5 changed files with 236 additions and 0 deletions
				
			
		
							
								
								
									
										17
									
								
								keyboards/salane/starryfrl/config.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								keyboards/salane/starryfrl/config.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,17 @@
 | 
			
		|||
/*
 | 
			
		||||
Copyright 2024 Salane
 | 
			
		||||
This program is free software: you can redistribute it and/or modify
 | 
			
		||||
it under the terms of the GNU General Public License as published by
 | 
			
		||||
the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
(at your option) any later version.
 | 
			
		||||
This program is distributed in the hope that it will be useful,
 | 
			
		||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
GNU General Public License for more details.
 | 
			
		||||
You should have received a copy of the GNU General Public License
 | 
			
		||||
along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#define RP2040_FLASH_GENERIC_03H
 | 
			
		||||
							
								
								
									
										143
									
								
								keyboards/salane/starryfrl/keyboard.json
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										143
									
								
								keyboards/salane/starryfrl/keyboard.json
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,143 @@
 | 
			
		|||
{
 | 
			
		||||
    "keyboard_name": "Starry FRL",
 | 
			
		||||
    "manufacturer": "Salane",
 | 
			
		||||
    "url": "",
 | 
			
		||||
    "maintainer": "Mai The San",
 | 
			
		||||
    "processor": "RP2040",
 | 
			
		||||
    "bootloader": "rp2040",
 | 
			
		||||
    "usb": {
 | 
			
		||||
        "vid": "0x534C",
 | 
			
		||||
        "pid": "0x0A01",
 | 
			
		||||
        "device_version": "0.0.1"
 | 
			
		||||
    },
 | 
			
		||||
    "matrix_pins": {
 | 
			
		||||
        "rows": ["GP25", "GP0", "GP18", "GP23", "GP24"],
 | 
			
		||||
        "cols": ["GP27", "GP26", "GP14", "GP13", "GP12", "GP11", "GP10", "GP9", "GP8", "GP7", "GP6", "GP5", "GP4", "GP3", "GP2", "GP1", "GP22", "GP21", "GP20"]
 | 
			
		||||
    },
 | 
			
		||||
    "diode_direction": "COL2ROW",
 | 
			
		||||
    "features": {
 | 
			
		||||
        "bootmagic": true,
 | 
			
		||||
        "mousekey": true,
 | 
			
		||||
        "extrakey": true,
 | 
			
		||||
        "console": false,
 | 
			
		||||
        "command": false,
 | 
			
		||||
        "nkro": false,
 | 
			
		||||
        "rgblight": true,
 | 
			
		||||
        "encoder": true
 | 
			
		||||
    },
 | 
			
		||||
    "encoder": {
 | 
			
		||||
        "rotary": [
 | 
			
		||||
            {"pin_a": "GP29", "pin_b": "GP28"}
 | 
			
		||||
        ]
 | 
			
		||||
    },
 | 
			
		||||
    "rgblight": {
 | 
			
		||||
        "led_count": 2,
 | 
			
		||||
        "saturation_steps": 8,
 | 
			
		||||
        "brightness_steps": 8,
 | 
			
		||||
        "sleep": true,
 | 
			
		||||
        "animations": {
 | 
			
		||||
            "alternating": true,
 | 
			
		||||
            "breathing": true,
 | 
			
		||||
            "christmas": true,
 | 
			
		||||
            "knight": true,
 | 
			
		||||
            "rainbow_mood": true,
 | 
			
		||||
            "rainbow_swirl": true,
 | 
			
		||||
            "snake": true,
 | 
			
		||||
            "static_gradient": true,
 | 
			
		||||
            "twinkle": true
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    "ws2812": {
 | 
			
		||||
        "pin": "GP19",
 | 
			
		||||
        "driver": "vendor"
 | 
			
		||||
    },
 | 
			
		||||
    "layouts": {
 | 
			
		||||
        "LAYOUT": {
 | 
			
		||||
            "layout": [
 | 
			
		||||
                {"label": "K00", "matrix": [0, 0], "x": 0, "y": 0},
 | 
			
		||||
                {"label": "K01", "matrix": [0, 1], "x": 1, "y": 0},
 | 
			
		||||
                {"label": "K02", "matrix": [0, 2], "x": 2.25, "y": 0},
 | 
			
		||||
                {"label": "K03", "matrix": [0, 3], "x": 3.25, "y": 0},
 | 
			
		||||
                {"label": "K04", "matrix": [0, 4], "x": 4.25, "y": 0},
 | 
			
		||||
                {"label": "K05", "matrix": [0, 5], "x": 5.25, "y": 0},
 | 
			
		||||
                {"label": "K06", "matrix": [0, 6], "x": 6.25, "y": 0},
 | 
			
		||||
                {"label": "K07", "matrix": [0, 7], "x": 7.25, "y": 0},
 | 
			
		||||
                {"label": "K08", "matrix": [0, 8], "x": 8.25, "y": 0},
 | 
			
		||||
                {"label": "K09", "matrix": [0, 9], "x": 9.25, "y": 0},
 | 
			
		||||
                {"label": "K0A", "matrix": [0, 10], "x": 10.25, "y": 0},
 | 
			
		||||
                {"label": "K0B", "matrix": [0, 11], "x": 11.25, "y": 0},
 | 
			
		||||
                {"label": "K0C", "matrix": [0, 12], "x": 12.25, "y": 0},
 | 
			
		||||
                {"label": "K0D", "matrix": [0, 13], "x": 13.25, "y": 0},
 | 
			
		||||
                {"label": "K0E", "matrix": [0, 14], "x": 14.25, "y": 0},
 | 
			
		||||
                {"label": "K0F", "matrix": [0, 15], "x": 15.25, "y": 0},
 | 
			
		||||
                {"label": "K2F", "matrix": [2, 15], "x": 16.25, "y": 0},
 | 
			
		||||
                {"label": "K0G", "matrix": [0, 16], "x": 17.5, "y": 0},
 | 
			
		||||
                {"label": "K0H", "matrix": [0, 17], "x": 18.5, "y": 0},
 | 
			
		||||
                {"label": "K0I", "matrix": [0, 18], "x": 19.5, "y": 0},
 | 
			
		||||
                {"label": "K12", "matrix": [1, 2], "x": 2.25, "y": 1, "w": 1.5},
 | 
			
		||||
                {"label": "K13", "matrix": [1, 3], "x": 3.75, "y": 1},
 | 
			
		||||
                {"label": "K14", "matrix": [1, 4], "x": 4.75, "y": 1},
 | 
			
		||||
                {"label": "K15", "matrix": [1, 5], "x": 5.75, "y": 1},
 | 
			
		||||
                {"label": "K16", "matrix": [1, 6], "x": 6.75, "y": 1},
 | 
			
		||||
                {"label": "K17", "matrix": [1, 7], "x": 7.75, "y": 1},
 | 
			
		||||
                {"label": "K18", "matrix": [1, 8], "x": 8.75, "y": 1},
 | 
			
		||||
                {"label": "K19", "matrix": [1, 9], "x": 9.75, "y": 1},
 | 
			
		||||
                {"label": "K1A", "matrix": [1, 10], "x": 10.75, "y": 1},
 | 
			
		||||
                {"label": "K1B", "matrix": [1, 11], "x": 11.75, "y": 1},
 | 
			
		||||
                {"label": "K1C", "matrix": [1, 12], "x": 12.75, "y": 1},
 | 
			
		||||
                {"label": "K1D", "matrix": [1, 13], "x": 13.75, "y": 1},
 | 
			
		||||
                {"label": "K1E", "matrix": [1, 14], "x": 14.75, "y": 1},
 | 
			
		||||
                {"label": "K1F", "matrix": [1, 15], "x": 15.75, "y": 1, "w": 1.5},
 | 
			
		||||
                {"label": "K1G", "matrix": [1, 16], "x": 17.5, "y": 1},
 | 
			
		||||
                {"label": "K1H", "matrix": [1, 17], "x": 18.5, "y": 1},
 | 
			
		||||
                {"label": "K1I", "matrix": [1, 18], "x": 19.5, "y": 1},
 | 
			
		||||
                {"label": "K21", "matrix": [2, 1], "x": 0.25, "y": 1.25, "w": 1.5, "h": 1.5},
 | 
			
		||||
                {"label": "K22", "matrix": [2, 2], "x": 2.25, "y": 2, "w": 1.75},
 | 
			
		||||
                {"label": "K23", "matrix": [2, 3], "x": 4, "y": 2},
 | 
			
		||||
                {"label": "K24", "matrix": [2, 4], "x": 5, "y": 2},
 | 
			
		||||
                {"label": "K25", "matrix": [2, 5], "x": 6, "y": 2},
 | 
			
		||||
                {"label": "K26", "matrix": [2, 6], "x": 7, "y": 2},
 | 
			
		||||
                {"label": "K27", "matrix": [2, 7], "x": 8, "y": 2},
 | 
			
		||||
                {"label": "K28", "matrix": [2, 8], "x": 9, "y": 2},
 | 
			
		||||
                {"label": "K29", "matrix": [2, 9], "x": 10, "y": 2},
 | 
			
		||||
                {"label": "K2A", "matrix": [2, 10], "x": 11, "y": 2},
 | 
			
		||||
                {"label": "K2B", "matrix": [2, 11], "x": 12, "y": 2},
 | 
			
		||||
                {"label": "K2C", "matrix": [2, 12], "x": 13, "y": 2},
 | 
			
		||||
                {"label": "K2D", "matrix": [2, 13], "x": 14, "y": 2},
 | 
			
		||||
                {"label": "K2E", "matrix": [2, 14], "x": 15, "y": 2, "w": 2.25},
 | 
			
		||||
                {"label": "K30", "matrix": [3, 0], "x": 0, "y": 3},
 | 
			
		||||
                {"label": "K31", "matrix": [3, 1], "x": 1, "y": 3},
 | 
			
		||||
                {"label": "K32", "matrix": [3, 2], "x": 2.25, "y": 3, "w": 1.25},
 | 
			
		||||
                {"label": "K33", "matrix": [3, 3], "x": 3.5, "y": 3},
 | 
			
		||||
                {"label": "K34", "matrix": [3, 4], "x": 4.5, "y": 3},
 | 
			
		||||
                {"label": "K35", "matrix": [3, 5], "x": 5.5, "y": 3},
 | 
			
		||||
                {"label": "K36", "matrix": [3, 6], "x": 6.5, "y": 3},
 | 
			
		||||
                {"label": "K37", "matrix": [3, 7], "x": 7.5, "y": 3},
 | 
			
		||||
                {"label": "K38", "matrix": [3, 8], "x": 8.5, "y": 3},
 | 
			
		||||
                {"label": "K39", "matrix": [3, 9], "x": 9.5, "y": 3},
 | 
			
		||||
                {"label": "K3A", "matrix": [3, 10], "x": 10.5, "y": 3},
 | 
			
		||||
                {"label": "K3B", "matrix": [3, 11], "x": 11.5, "y": 3},
 | 
			
		||||
                {"label": "K3C", "matrix": [3, 12], "x": 12.5, "y": 3},
 | 
			
		||||
                {"label": "K3D", "matrix": [3, 13], "x": 13.5, "y": 3},
 | 
			
		||||
                {"label": "K3E", "matrix": [3, 14], "x": 14.5, "y": 3, "w": 1.75},
 | 
			
		||||
                {"label": "K3F", "matrix": [3, 15], "x": 16.25, "y": 3},
 | 
			
		||||
                {"label": "K3H", "matrix": [3, 17], "x": 18.5, "y": 3},
 | 
			
		||||
                {"label": "K40", "matrix": [4, 0], "x": 0, "y": 4},
 | 
			
		||||
                {"label": "K41", "matrix": [4, 1], "x": 1, "y": 4},
 | 
			
		||||
                {"label": "K42", "matrix": [4, 2], "x": 2.25, "y": 4, "w": 1.5},
 | 
			
		||||
                {"label": "K43", "matrix": [4, 3], "x": 3.75, "y": 4},
 | 
			
		||||
                {"label": "K44", "matrix": [4, 4], "x": 4.75, "y": 4, "w": 1.5},
 | 
			
		||||
                {"label": "K47", "matrix": [4, 7], "x": 6.25, "y": 4, "w": 3},
 | 
			
		||||
                {"label": "K49", "matrix": [4, 9], "x": 9.25, "y": 4},
 | 
			
		||||
                {"label": "K4B", "matrix": [4, 11], "x": 10.25, "y": 4, "w": 2},
 | 
			
		||||
                {"label": "K4C", "matrix": [4, 12], "x": 12.25, "y": 4},
 | 
			
		||||
                {"label": "K4D", "matrix": [4, 13], "x": 13.25, "y": 4, "w": 1.5},
 | 
			
		||||
                {"label": "K4E", "matrix": [4, 14], "x": 14.75, "y": 4},
 | 
			
		||||
                {"label": "K4F", "matrix": [4, 15], "x": 15.75, "y": 4, "w": 1.5},
 | 
			
		||||
                {"label": "K4G", "matrix": [4, 16], "x": 17.5, "y": 4},
 | 
			
		||||
                {"label": "K4H", "matrix": [4, 17], "x": 18.5, "y": 4},
 | 
			
		||||
                {"label": "K4I", "matrix": [4, 18], "x": 19.5, "y": 4}
 | 
			
		||||
           ]
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										46
									
								
								keyboards/salane/starryfrl/keymaps/default/keymap.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										46
									
								
								keyboards/salane/starryfrl/keymaps/default/keymap.c
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,46 @@
 | 
			
		|||
/* Copyright 2023 SawnsProjects
 | 
			
		||||
 *
 | 
			
		||||
 * This program is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 *
 | 
			
		||||
 * This program is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU General Public License for more details.
 | 
			
		||||
 *
 | 
			
		||||
 * You should have received a copy of the GNU General Public License
 | 
			
		||||
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 */
 | 
			
		||||
#include QMK_KEYBOARD_H
 | 
			
		||||
 | 
			
		||||
enum {
 | 
			
		||||
    _BASE,
 | 
			
		||||
    _FN
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
			
		||||
    [_BASE] = LAYOUT(
 | 
			
		||||
        KC_F1,   KC_F2,   KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,  KC_BSPC,     KC_INS,  KC_HOME, KC_PGUP,
 | 
			
		||||
                          KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,               KC_DEL,  KC_END,  KC_PGDN,
 | 
			
		||||
                 KC_MUTE, KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,
 | 
			
		||||
        KC_F3,   KC_F4,   KC_LSFT, KC_NO,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_LSFT, MO(_FN),                        KC_UP,
 | 
			
		||||
        KC_F5,   KC_F6,   KC_LCTL, KC_LGUI, KC_LALT,          KC_SPC,           KC_SPC,           KC_SPC,           KC_SPC,  KC_RGUI, KC_MENU, KC_RCTL,               KC_LEFT, KC_DOWN, KC_RGHT
 | 
			
		||||
        ),
 | 
			
		||||
    [_FN] = LAYOUT(
 | 
			
		||||
        KC_F7,   KC_F8,   _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  _______,     _______, _______, _______,
 | 
			
		||||
                          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,               UG_PREV, UG_TOGG, UG_NEXT,
 | 
			
		||||
                 _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
 | 
			
		||||
        KC_F9,   KC_F10,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                        _______,
 | 
			
		||||
        KC_F11,  KC_F12,  _______, _______, _______, _______,                   _______,          _______,          _______, _______, _______, _______,               _______, _______, _______
 | 
			
		||||
        )
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#if defined(ENCODER_MAP_ENABLE)
 | 
			
		||||
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
 | 
			
		||||
    [_BASE] = { ENCODER_CCW_CW(KC_PGDN, KC_PGUP) },
 | 
			
		||||
    [_FN] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) }
 | 
			
		||||
};
 | 
			
		||||
#endif // ENCODER_MAP_ENABLE
 | 
			
		||||
							
								
								
									
										1
									
								
								keyboards/salane/starryfrl/keymaps/default/rules.mk
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								keyboards/salane/starryfrl/keymaps/default/rules.mk
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1 @@
 | 
			
		|||
ENCODER_MAP_ENABLE = yes
 | 
			
		||||
							
								
								
									
										29
									
								
								keyboards/salane/starryfrl/readme.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								keyboards/salane/starryfrl/readme.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,29 @@
 | 
			
		|||
# Starry FRL
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
 This firmware support for both Solder and Hotswap PCB of Starry FRL
 | 
			
		||||
 | 
			
		||||
 **Firmware files are SPECIFIC to each board. Firmware files from one, will not work on the other.** Please use the `uf2` appropriate for your board.
 | 
			
		||||
 | 
			
		||||
* Keyboard Maintainer: [Mai The San](https://github.com/MaiTheSan) 
 | 
			
		||||
* Hardware Supported: Starry FRL 
 | 
			
		||||
* Hardware Availability: [Waifu.works Discord](https://discord.gg/waifuworks)
 | 
			
		||||
 | 
			
		||||
Make examples for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make salane/starryfrl:default
 | 
			
		||||
 | 
			
		||||
Flashing example for this keyboard:
 | 
			
		||||
 | 
			
		||||
    make salane/starryfrl:default:flash
 | 
			
		||||
 | 
			
		||||
## Bootloader
 | 
			
		||||
 | 
			
		||||
Enter the bootloader in 3 ways:
 | 
			
		||||
 | 
			
		||||
* **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**: Press the key `BOOT` in the back of PCB and plug in keyboard
 | 
			
		||||
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
 | 
			
		||||
 | 
			
		||||
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).
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue