Added my prototype keyboard K_Pro v1 TKL #23797

ksmosna · 2024-05-25T20:13:43Z

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Modified preview layout in keymap.c

keyboards/k_pro_v1_tkl/config.h

keyboards/k_pro_v1_tkl/info.json

waffle87 · 2024-05-26T15:43:00Z

keyboards/k_pro_v1_tkl/readme.md

+![k_pro_v1_tkl](imgur.com image replace me!)
+
+*A short description of the keyboard/project*
+
+* Keyboard Maintainer: [ksmosna](https://github.com/ksmosna)
+* Hardware Supported: *The PCBs, controllers supported*
+* Hardware Availability: *Links to where you can find this hardware*


Please fill these fields out.

waffle87 · 2024-05-29T05:01:51Z

keyboards/k_pro_v1_tkl/config.h

+#define DRIVER_1_LED_TOTAL 59
+#define DRIVER_2_LED_TOTAL 33
+#define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+


Suggested change

#define DRIVER_1_LED_TOTAL 59

#define DRIVER_2_LED_TOTAL 33

#define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)

waffle87 · 2024-05-29T05:02:15Z

keyboards/k_pro_v1_tkl/config.h

+#define ENCODERS_PAD_A { B8 }
+#define ENCODERS_PAD_B { B9 }


Please migrate this to keyboard.json file.

Suggested change

#define ENCODERS_PAD_A { B8 }

#define ENCODERS_PAD_B { B9 }

waffle87 · 2024-05-29T05:03:12Z

keyboards/k_pro_v1_tkl/halconf.h

This file is missing a license header.

waffle87 · 2024-05-29T05:03:27Z

keyboards/k_pro_v1_tkl/info.json

Please rename this file to keyboard.json.

waffle87 · 2024-05-29T05:03:55Z

keyboards/k_pro_v1_tkl/k_pro_v1_tkl.c

This file is missing a license header.

waffle87 · 2024-05-29T05:06:45Z

keyboards/k_pro_v1_tkl/keymaps/VIA/keymap.c

+
+#ifdef OLED_ENABLE
+bool oled_task_user(void) {
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
+    oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
+    oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+
+    // Host Keyboard RGB backlight status
+    oled_write_P(PSTR("-----"), false);
+    oled_write_P(PSTR("Light"), false);
+    return false;
+}
+#endif


If OLEDs are enabled at the keyboard level, there needs to be configuration for them at the keyboard level as well. This should be moved to the k_pro_v1_tkl.c file using the oled_task_kb() function.

Suggested change

#ifdef OLED_ENABLE

bool oled_task_user(void) {

// Host Keyboard LED Status

led_t led_state = host_keyboard_led_state();

oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR(" "), false);

oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR(" "), false);

oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR(" "), false);

// Host Keyboard RGB backlight status

oled_write_P(PSTR("-----"), false);

oled_write_P(PSTR("Light"), false);

return false;

}

#endif

waffle87 · 2024-05-29T05:07:02Z

keyboards/k_pro_v1_tkl/keymaps/default/keymap.c

+
+#ifdef OLED_ENABLE
+bool oled_task_user(void) {
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
+    oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
+    oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+
+    // Host Keyboard RGB backlight status
+    oled_write_P(PSTR("-----"), false);
+    oled_write_P(PSTR("Light"), false);
+    return false;
+}
+#endif


As above.

Suggested change

#ifdef OLED_ENABLE

bool oled_task_user(void) {

// Host Keyboard LED Status

led_t led_state = host_keyboard_led_state();

oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR(" "), false);

oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR(" "), false);

oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR(" "), false);

// Host Keyboard RGB backlight status

oled_write_P(PSTR("-----"), false);

oled_write_P(PSTR("Light"), false);

return false;

}

#endif

waffle87 · 2024-05-29T05:07:13Z

keyboards/k_pro_v1_tkl/mcuconf.h

This file is missing a license header.

waffle87 · 2024-05-29T05:07:49Z

keyboards/k_pro_v1_tkl/rules.mk

+I2C_DRIVER_REQUIRED = yes
+
+OLED_ENABLE = yes
+OLED_DRIVER = ssd1306
+OLED_TRANSPORT = i2c
+
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = is31fl3733
+
+ENCODER_ENABLE = yes
+ENCODER_MAP_ENABLE = yes


Suggested change

I2C_DRIVER_REQUIRED = yes

OLED_ENABLE = yes

OLED_DRIVER = ssd1306

OLED_TRANSPORT = i2c

RGB_MATRIX_ENABLE = yes

RGB_MATRIX_DRIVER = is31fl3733

ENCODER_ENABLE = yes

ENCODER_MAP_ENABLE = yes

I2C_DRIVER_REQUIRED = yes

RGB_MATRIX_DRIVER = is31fl3733

waffle87 · 2024-05-29T05:08:08Z

keyboards/k_pro_v1_tkl/info.json

+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true


Suggested change

"nkro": true

"nkro": true,

"rgb_matrix": true,

"encoder": true,

"oled": true

…the one received from STMicroelectronics, added missing licence headers

…ess restored to 255

drashna

PB_# keycodes need to be switched out with QK_KB_# keycodes

drashna · 2024-06-12T17:35:52Z

keyboards/skdevices/adler/adler.c

+uint32_t timer = 0;
+uint8_t current_frame = 0;
+
+static void render_logo(void) {


You could reduce the size significantly by removing the columns that are empty. I know it's not as much of a concern here (f411), but may be a good idea, in general.

drashna · 2024-06-12T17:36:23Z

keyboards/skdevices/adler/adler.c

+	};
+	if (!animation_finished && timer_elapsed(timer) > FRAME_DURATION) {
+        timer = timer_read();
+		oled_clear();


this shouldn't be necessary, at all.

drashna · 2024-06-12T17:37:16Z

keyboards/skdevices/adler/adler.c

+	char buffer[32];
+	switch (menu) {
+        case 0: // Main
+			const char* options[3] = {"RGB", "Brightness", "Animation"};


this isn't progmem, so the code that you have below is wrong.

drashna · 2024-06-12T17:37:24Z

keyboards/skdevices/adler/adler.c

+				} else {
+					oled_write_P(PSTR("  "), false);
+				}
+				oled_write_P(options[i], false);


Suggested change

oled_write_P(options[i], false);

oled_write(options[i], false);

drashna · 2024-06-12T17:39:18Z

keyboards/skdevices/adler/adler.c

+            snprintf(buffer, sizeof(buffer), "RGB: %s", rgb_matrix_is_enabled() ? "On" : "Off");
+			oled_write(buffer, false);


This avoids using sprintf, which is rather large in usage.

Suggested change

snprintf(buffer, sizeof(buffer), "RGB: %s", rgb_matrix_is_enabled() ? "On" : "Off");

oled_write(buffer, false);

oled_write_P(PSTR("RGB: "), false);

oled_write_P(rgb_matrix_is_enabled() ? PSTR("On") : PSTR("Off") , false);

drashna · 2024-06-12T17:46:58Z

keyboards/skdevices/adler/keymaps/via/keymap.c

+    [1] = LAYOUT_tkl_ansi(
+        KC_NO,   KC_ESC,           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_NO,   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_PSCR, KC_SCRL, KC_PAUS,
+        KC_NO,   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_INS,  KC_HOME, KC_PGUP,
+        KC_NO,   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_DEL,  KC_END,  KC_PGDN,
+        KC_NO,   KC_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,             KC_UP,
+        KC_NO,   KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,    KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [2] = LAYOUT_tkl_ansi(
+        KC_NO,   KC_ESC,           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_NO,   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_PSCR, KC_SCRL, KC_PAUS,
+        KC_NO,   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_INS,  KC_HOME, KC_PGUP,
+        KC_NO,   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_DEL,  KC_END,  KC_PGDN,
+        KC_NO,   KC_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,             KC_UP,
+        KC_NO,   KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,    KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [3] = LAYOUT_tkl_ansi(
+        KC_NO,   KC_ESC,           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_NO,   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_PSCR, KC_SCRL, KC_PAUS,
+        KC_NO,   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_INS,  KC_HOME, KC_PGUP,
+        KC_NO,   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_DEL,  KC_END,  KC_PGDN,
+        KC_NO,   KC_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,             KC_UP,
+        KC_NO,   KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,    KC_LEFT, KC_DOWN, KC_RGHT
+    )


These are all duplicates of the base layer. These should be removed.

Suggested change

[1] = LAYOUT_tkl_ansi(

KC_NO, KC_ESC, 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_NO, 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_PSCR, KC_SCRL, KC_PAUS,

KC_NO, 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_INS, KC_HOME, KC_PGUP,

KC_NO, 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_DEL, KC_END, KC_PGDN,

KC_NO, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,

KC_NO, KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT

),

[2] = LAYOUT_tkl_ansi(

KC_NO, KC_ESC, 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_NO, 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_PSCR, KC_SCRL, KC_PAUS,

KC_NO, 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_INS, KC_HOME, KC_PGUP,

KC_NO, 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_DEL, KC_END, KC_PGDN,

KC_NO, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,

KC_NO, KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT

),

[3] = LAYOUT_tkl_ansi(

KC_NO, KC_ESC, 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_NO, 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_PSCR, KC_SCRL, KC_PAUS,

KC_NO, 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_INS, KC_HOME, KC_PGUP,

KC_NO, 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_DEL, KC_END, KC_PGDN,

KC_NO, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,

KC_NO, KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT

)

drashna · 2024-06-12T17:47:17Z

keyboards/skdevices/adler/keymaps/via/keymap.c

+    [1] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [2] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [3] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},


Suggested change

[1] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},

[2] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},

[3] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},

drashna · 2024-06-12T17:47:43Z

keyboards/skdevices/adler/readme.md

@@ -0,0 +1,39 @@
+# adler
+
+![adler](imgur.com image replace me!)


drashna · 2024-06-12T17:49:46Z

keyboards/skdevices/adler/adler.c

+#include "keycodes.h"
+#include "i2c_master.h"


Suggested change

#include "keycodes.h"

#include "i2c_master.h"

drashna · 2024-06-12T17:53:11Z

keyboards/skdevices/adler/rules.mk

+I2C_DRIVER_REQUIRED = yes
+PROGRAMMABLE_BUTTON_ENABLE = yes


Suggested change

I2C_DRIVER_REQUIRED = yes

PROGRAMMABLE_BUTTON_ENABLE = yes

i2c driver required setting isn't required.

Also, the programmable button feature isn't meant for macros or custom functionality. It's a host side thing.
https://docs.qmk.fm/features/programmable_button

ksmosna added 2 commits May 25, 2024 19:53

New Keyboard created

124f4a5

Modified default layout + pinout in info.json.

b3643af

Modified preview layout in keymap.c

github-actions bot added keyboard keymap labels May 25, 2024

waffle87 requested changes May 26, 2024

View reviewed changes

waffle87 added the invalid label May 26, 2024

Krzysztof Smosna added 3 commits May 27, 2024 12:59

Created LED matrix

f628e5b

LED matrix updated

bca6a3b

Added Simple VIA support + LED Matrix updated

404e2e1

waffle87 requested changes May 29, 2024

View reviewed changes

ksmosna and others added 3 commits May 30, 2024 12:58

Merge branch 'qmk:master' into master

491b7d8

Changed name of keyboard, moved to keyboard.json

f5735ba

Cleaning up after changing Keyboard name, Changed the pid and vid to …

68a22d1

…the one received from STMicroelectronics, added missing licence headers

github-actions bot added the via Adds via keymap and/or updates keyboard for via support label May 31, 2024

ksmosna and others added 2 commits June 3, 2024 16:26

Merge branch 'qmk:master' into master

cf4b5ff

Added partial keyboard configuration using OLED and knob. Max brightn…

54d0cf7

…ess restored to 255

drashna requested changes Jun 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added my prototype keyboard K_Pro v1 TKL #23797

Added my prototype keyboard K_Pro v1 TKL #23797

ksmosna commented May 25, 2024 •

edited

Loading

waffle87 May 26, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

waffle87 May 29, 2024

drashna left a comment

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

drashna Jun 12, 2024

	#define DRIVER_1_LED_TOTAL 59
	#define DRIVER_2_LED_TOTAL 33
	#define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)

-        "nkro": true
+        "nkro": true,
+        "rgb_matrix": true,
+        "encoder": true,
+        "oled": true

	oled_write_P(options[i], false);
	oled_write(options[i], false);

		snprintf(buffer, sizeof(buffer), "RGB: %s", rgb_matrix_is_enabled() ? "On" : "Off");
		oled_write(buffer, false);

	[1] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
	[2] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
	[3] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},

		@@ -0,0 +1,39 @@
		# adler

		![adler](imgur.com image replace me!)

Added my prototype keyboard K_Pro v1 TKL #23797

Are you sure you want to change the base?

Added my prototype keyboard K_Pro v1 TKL #23797

Conversation

ksmosna commented May 25, 2024 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drashna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksmosna commented May 25, 2024 •

edited

Loading