Add "wk84" keybaord #24731

gskygithub · 2024-12-20T01:30:26Z

Description

Add wk84 keybaord

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

Co-authored-by: Duncan Sutherland <[email protected]>

waffle87

As per the PR checklist:

PRs should contain the smallest amount of modifications required for a single change to the codebase
- multiple keyboards at the same time is not acceptable
- the smaller the PR, the higher likelihood of a quicker review, higher likelihood of quicker merge, and less chance of conflicts

drashna · 2024-12-22T19:35:44Z

Also, it looks like you have keyboard files outside of the keyboard folder. These would need to be moved/removed.

keyboards/glencreag/wk84/readme.md

keyboards/glencreag/wk84/keyboard.json

keyboards/glencreag/wk84/keymaps/default/keymap.c

keyboards/glencreag/wk84/mcuconf.h

keyboards/glencreag/wk84/config.h

dunk2k · 2024-12-23T12:53:28Z

@gskygithub
please could files relating to keyboard projectd/65/projectd_65_iso be removed from this PR? as said keyboard is under PR #21941

drashna · 2024-12-24T05:58:43Z

keyboards/glencreag/wk84/config.h

+/* RGB Matrix */
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_MATRIX_STARTUP_MODE 13
+#define RGB_TRIGGER_ON_KEYDOWN
+


These are handled in the keyboard.json.

Suggested change

/* RGB Matrix */

#define RGB_MATRIX_FRAMEBUFFER_EFFECTS

#define RGB_MATRIX_STARTUP_MODE 13

#define RGB_TRIGGER_ON_KEYDOWN

drashna · 2024-12-24T06:02:19Z

keyboards/glencreag/wk84/keymaps/default/keymap.c

Per PR checklist:

default keymaps should be "pristine"

bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap

what does pristine mean? no custom keycodes. no advanced features like tap dance or macros. basic mod taps and home row mods would be acceptable where their use is necessary

standard layouts preferred in these keymaps, if possible

should use encoder map feature, rather than encoder_update_user()

default keymap should not enable VIA -- keymaps targeting VIA support should be submitted to the VIA QMK Userspace repository

drashna · 2024-12-24T06:03:24Z

keyboards/glencreag/wk84/wk84.c

+
+#include "spi_master.h"
+
+void spi_init(void) {


Is there a reason for this?

drashna · 2024-12-24T06:06:56Z

keyboards/glencreag/wk84/config.h

+#define RGB_TRIGGER_ON_KEYDOWN
+
+/* WS2812 */
+#define WS2812_SPI_DRIVER SPIDM2


Why is this using a different driver than the one above?

drashna · 2024-12-24T06:07:27Z

keyboards/glencreag/wk84/wk84.c

+
+#endif
+
+void keyboard_pre_init_kb(void) {


Is there is a reason for this? This pin doesn't appear to be used, at all.

waffle87 · 2024-12-24T18:07:28Z

keyboards/glencreag/wk84/config.h

+
+/* WS2812 */
+#define WS2812_SPI_DRIVER SPIDM2
+#define WS2812_SPI_DIVISOR 16


Default value.

Suggested change

#define WS2812_SPI_DIVISOR 16

waffle87 · 2024-12-24T18:07:52Z

keyboards/glencreag/wk84/keyboard.json

+    "dynamic_keymap": {
+        "layer_count": 4
+    },


Default value.

Suggested change

"dynamic_keymap": {

"layer_count": 4

},

waffle87 · 2024-12-24T18:08:34Z

keyboards/glencreag/wk84/keyboard.json

+        "layer_count": 4
+    },
+    "eeprom": {
+        "driver": "wear_leveling",


Default value.

Suggested change

"driver": "wear_leveling",

waffle87 · 2024-12-24T18:09:18Z

keyboards/glencreag/wk84/keyboard.json

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


Suggested change

"console": false,

"extrakey": true,

"mousekey": true,

"nkro": true,

"rgb_matrix": true,

"console": false,

"extrakey": true,

"mousekey": true,

"nkro": true,

"rgb_matrix": true

waffle87 · 2024-12-24T18:09:56Z

keyboards/glencreag/wk84/keyboard.json

+            {"matrix": [0, 15], "x": 150, "y": 0, "flags": 4}
+        ],
+        "react_on_keyup": true,
+        "led_count": 84,


This is inferred.

Suggested change

"led_count": 84,

waffle87 · 2024-12-24T18:11:32Z

keyboards/glencreag/wk84/keyboard.json

+        "val_steps": 40,
+        "speed_steps": 60,


These seem like rather large values to set as the default. Users should configure this themselves if they'd like.

Suggested change

"val_steps": 40,

"speed_steps": 60,

waffle87 · 2024-12-24T18:13:50Z

keyboards/glencreag/wk84/readme.md

+A keyboard, Equipped with the WestBerry Q95 microcontroller.
+
+* Keyboard Maintainer: [GSKY](https://github.com/gksygithub)
+* Hardware Supported: WK84


Please provide a link to where this keyboard can be purchased, or at least where more information can be found.

Suggested change

* Hardware Supported: WK84

* Hardware Supported: WK84

* Hardware Availability: *Links to where you can find this hardware*

waffle87 · 2024-12-24T18:20:05Z

keyboards/glencreag/wk84/keyboard.json

+        "center_point": [77, 30],
+        "driver": "ws2812",
+        "layout": [
+            {"matrix": [5, 4], "x": 37, "y": 50, "flags": 4},


These coordinates do not look right.

The expected range of values for { x, y } is the inclusive range { 0..224, 0..64 }.

waffle87 · 2024-12-24T18:20:42Z

keyboards/glencreag/wk84/keyboard.json

+            "splash": true,
+            "typing_heatmap": true
+        },
+        "center_point": [77, 30],


Should not be needed with correct coordinates.

Suggested change

"center_point": [77, 30],

gskygithub added 30 commits June 7, 2022 09:19

Add files via upload

d9588c0

[keyboard]

8c7aff1

[Keyboard]

1dd4c87

Delete flash_spi.c

74e52d3

Delete flash_spi.h

19b7d38

Delete wb32_spi_master.c

7f77d7a

Delete wb32_spi_master.h

2c0fe84

[Keyboard]

ecbff72

Resolved requested changes

9c423d1

Resolved requested changes

318c463

Changed rules.mk file accordingly.

dd42220

Resolved changes accordingly.

52a3301

Update config.h file and rules.mk file

1c3f1e6

Removed eeprom_flash.c file

8db03c1

Update default/keymap.c file

6b050ac

Delete keyboards/darkproject/kd83a_bfg_edition directory

03ff34c

Add keyboard

da0a8e5

Merge branch 'qmk:master' into master

733cf2c

Add keyboard

273d1da

Delete darkproject/kd83a_bfg_edition directory

4f3f6c9

Resolved Changes

4773980

Merge branch 'qmk:master' into master

ded388f

Resolved requested changes

e79a657

Merge branch 'qmk:master' into master

5fedd8a

keyboard

c89ae6b

Add keyboard

45d803f

Delete keyboard

11e36a3

Merge branch 'qmk:master' into master

1dce29e

Merge branch 'qmk:master' into master

71157f0

Add keyboard

5d9043d

gskygithub and others added 13 commits April 3, 2024 16:10

Merge branch 'qmk:master' into projectd_65_iso

f06f9f5

Delete keyboards/projectd/65/projectd_65_iso/keymaps/default/config.h

90cd00c

Resolved requested changes

c744797

Merge branch 'qmk:master' into projectd_65_iso

d2c81e4

Merge branch 'qmk:master' into projectd_65_iso

c41e91c

Rename info.json to keyboard.json

91ff4fe

Delete keyboards/projectd/65/projectd_65_iso/rules.mk

46657a3

Update keyboard.json

f53fbd8

Update keyboards/projectd/65/projectd_65_iso/keyboard.json

a87214e

Co-authored-by: Duncan Sutherland <[email protected]>

Delete keyboards/projectd/65/projectd_65_iso/keymaps/via directory

56ff4cd

update default keymap.c file

0ac1d5e

Update keyboard.json file

4c9488b

Add wk84 keyboard

c1ac025

github-actions bot added keyboard keymap labels Dec 20, 2024

waffle87 reviewed Dec 20, 2024

View reviewed changes

Merge branch 'qmk:master' into wk84

7692579

gskygithub added 4 commits December 23, 2024 09:21

Move wk84 folder to keyboard folder

8488a7e

Delete glencreag/wk84 directory

600e534

Merge branch 'qmk:master' into wk84

1e24fbb

Upload new files

eed39cd

dunk2k suggested changes Dec 23, 2024

View reviewed changes

gskygithub added 3 commits December 24, 2024 10:32

Delete keyboards/projectd/65/projectd_65_iso directory

3bddf6e

Add files via upload

7fba355

Updated readme.md

fe6229f

gskygithub requested a review from dunk2k December 24, 2024 06:00

drashna requested changes Dec 24, 2024

View reviewed changes

waffle87 requested changes Dec 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "wk84" keybaord #24731

Add "wk84" keybaord #24731

gskygithub commented Dec 20, 2024

waffle87 left a comment

drashna commented Dec 22, 2024

dunk2k commented Dec 23, 2024

drashna Dec 24, 2024

drashna Dec 24, 2024

drashna Dec 24, 2024

drashna Dec 24, 2024

drashna Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

waffle87 Dec 24, 2024

	* Hardware Supported: WK84
	* Hardware Supported: WK84
	* Hardware Availability: Links to where you can find this hardware


		#include "spi_master.h"

		void spi_init(void) {


		#endif

		void keyboard_pre_init_kb(void) {

Add "wk84" keybaord #24731

Are you sure you want to change the base?

Add "wk84" keybaord #24731

Conversation

gskygithub commented Dec 20, 2024

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

waffle87 left a comment

Choose a reason for hiding this comment

drashna commented Dec 22, 2024

dunk2k commented Dec 23, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment