Kumo Keyboard added with 3 layouts #5770

LEdiodes · 2019-05-03T17:44:23Z

Description

I added a keyboard, the Minivan Kumo which was a kickstarter keyboard

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project.
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).

added readme.md files for the layouts and the Kumo keyboard

mechmerlin

Quite a few general comments here

rules.mk, and config.h are included as part of every keymap here. I would take the common parts of each and just stick it into the parent kumo rules.mk and config.h. Only specific things to that Keymap need to be in there.
Kumo should be in thevankeyboards directory
There doesn't seem to be a QMK Configurator info.json file
What you have here are actually 3 different keymaps not layouts. A layout refers to the physical layout of a board, what keys go where and what keys are what size. A keymap is how each key in that specific layout is programmed.
Also this seems to share the exact same matrix/pins as the minivan. The physical layout itself is the LAYOUT_arrow as you can see in https://config.qmk.fm/#/thevankeyboards/minivan/LAYOUT_arrow

Perhaps simply updating the minivan readme and throwing in these keymaps would suffice?

keyboards/kumo/config.h

mechmerlin · 2019-05-03T18:11:06Z

keyboards/kumo/config.h

+#define VENDOR_ID       0xFEAE
+#define PRODUCT_ID      0x8847
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    TheVan Keyboards


We should probably put this in thevankeyboards directory

Ahh I did not know this existed, thanks!

keyboards/kumo/keymaps/LEdiodes/config.h

keyboards/kumo/keymaps/LEdiodes/keymap.c

mechmerlin · 2019-05-03T18:15:57Z

keyboards/kumo/keymaps/LEdiodes/keymap.c

+ * | RESET |        |      |             | HOME+END |         |VOL- |MUTE |VOL+ |
+ * `----------------------------------------------------------------------------'
+ */
+[L1] = KEYMAP(LT(KC_F1, KC_GRV), KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \


Suggested change

[L1] = KEYMAP(LT(KC_F1, KC_GRV), KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \

[L1] = LAYOUT(LT(KC_F1, KC_GRV), KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \

keyboards/kumo/keymaps/LEdiodes/keymap.c

mechmerlin · 2019-05-03T18:21:13Z

keyboards/kumo/keymaps/SeaSpider/config.h

+#define DESCRIPTION     Hotswap MiniVan 40% (Kumo)
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+#define MATRIX_ROW_PINS { D7, B5, F7, D4 }


Do the rows and col pins used change per keymap?

noroadsleft · 2019-05-03T22:05:37Z

keyboards/kumo/config.h

+#define TAPPING_TERM      175
+#define LOCKING_SUPPORT_ENABLE
+#define LOCKING_RESYNC_ENABLE
+#define IS_COMMAND() ( \


Lines 23-25 should be commented out. This definition is only necessary if you're not using the default value.

Reference: #4301

Same as above, I recommend deleting them.

keyboards/kumo/keymaps/LEdiodes/config.h

noroadsleft · 2019-05-04T02:58:41Z

keyboards/kumo/keymaps/LEdiodes/config.h

+#define LOCKING_RESYNC_ENABLE
+
+/* key combination for command */
+#define IS_COMMAND() ( \


Lines 25-28 should be commented out. This definition is only necessary if you're not using the default value.

I'd recommend deleting them, actually.

noroadsleft · 2019-05-04T02:59:04Z

keyboards/kumo/keymaps/LEdiodes/config.h

+// #define AUTO_SHIFT_TIMEOUT 100000
+#define NO_AUTO_SHIFT_SPECIAL
+
+#define IS_COMMAND() ( \


Lines 37-39 should be deleted.

noroadsleft · 2019-05-04T02:59:49Z

keyboards/kumo/keymaps/LEdiodes/config.h

+)
+
+/* prevent stuck modifiers */
+#define PREVENT_STUCK_MODIFIERS


This setting is now the default behavior for QMK. Lines 30-31 should be deleted.

Reference: #3107

noroadsleft · 2019-05-04T03:03:39Z

keyboards/kumo/keymaps/SeaSpider/config.h

+#define LOCKING_RESYNC_ENABLE
+
+/* key combination for command */
+#define IS_COMMAND() ( \


Lines 25-28 should be commented out.

noroadsleft · 2019-05-04T03:04:29Z

keyboards/kumo/keymaps/SeaSpider/config.h

+)
+
+/* prevent stuck modifiers */
+#define PREVENT_STUCK_MODIFIERS


This setting is now the default behavior for QMK. Lines 30-31 should be deleted.

noroadsleft · 2019-05-04T03:04:41Z

keyboards/kumo/keymaps/SeaSpider/keymap.c

+// Southpaw + arrow layout for MiniVan Kumo
+// Created by LEdiodes on 5-2-19
+
+#include "kumo.h"


Suggested change

#include "kumo.h"

#include QMK_KEYBOARD_H

noroadsleft · 2019-05-04T03:04:48Z

keyboards/kumo/keymaps/SeaSpider/keymap.c

+// Created by LEdiodes on 5-2-19
+
+#include "kumo.h"
+#include "action_layer.h"


Suggested change

#include "action_layer.h"

noroadsleft · 2019-05-04T03:05:26Z

keyboards/kumo/keymaps/default/keymap.c

+// MiniVan Kumo deafult keymap
+// Created by LEdiodes on 5-2-19
+
+#include "Kumo.h"


Suggested change

#include "Kumo.h"

#include QMK_KEYBOARD_H

keyboards/kumo/keymaps/SeaSpider/config.h

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

renaming keymap to layout Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

ahh sweet! this must be newish.. good to know, thanks! Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

removing #endif after getting advice on this. Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

vomindoraan · 2019-05-06T13:39:41Z

keyboards/kumo/keymaps/SeaSpider/rules.mk

+RGBLIGHT_ENABLE   = yes # Enable keyboard underlight functionality (+4870)
+BACKLIGHT_ENABLE  = yes # Enable keyboard backlight functionality (+1150)
+TAP_DANCE_ENABLE  = yes #
+AUTO_SHIFT_ENABLE = yes  # Enables autoshift


It appears that this is a rules.mk file for a specific keymap. You actually don't need most of this stuff in here, only the lines that are different from the keyboard's base rules.mk file (keyboards/kumo/rules.mk).

Actually, it looks like you've got the base and keymap rules.mk files reversed. This should be the core keyboards/kumo/rules.mk file since it has all the MCU, ARCH etc. definitions; keyboards/kumo/keymaps/SeaSpider/rules.mk should only contain the few things that are different, namely:

CONSOLE_ENABLE = no COMMAND_ENABLE = no

(by the way, I don't recommend disabling Command unless you're low on space)

Similarly, only the main config.h file (keyboards/kumo/config.h) should contain the VENDOR_ID, PRODUCT_ID, etc.; the config.h files in the keymaps don't need any of this.

Finally, you should probably make a default keymap for the keyboard (keyboards/kumo/keymaps/default).

Take a look at how some of the other keyboards organize their base files and keymap-specific files.

drashna

Any update on this?

drashna · 2019-05-10T05:32:39Z

keyboards/kumo/keymaps/LEdiodes/config.h

@@ -0,0 +1,41 @@
+#pragma once
+#include "config_common.h"
+#define VENDOR_ID       0xFEAE


Actually, most of this isn't needed. Only things changed from the base keyboard should be in here.

drashna · 2019-05-10T05:34:25Z

keyboards/kumo/keymaps/LEdiodes/keymap.c

+             ),
+};
+// Macros
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {


Could you remove the action_get_macro function? It's been deprecated in favor of process_record_user.

drashna · 2019-05-10T05:35:11Z

keyboards/kumo/keymaps/LEdiodes/rules.mk

@@ -0,0 +1,70 @@
+# MCU name
+MCU = atmega32u4


All of this stuff isn't needed.

Just the stuff in needed to be changed from default are needed here.

mechmerlin · 2019-05-10T15:07:45Z

@LEdiodes hello just wanted to know if you had looked into my point 5. Can this just be part of the original minivan port or is there something I'm missing here.

drashna · 2019-07-30T07:13:33Z

Any update on this?

drashna · 2019-11-16T17:07:09Z

Given the amount of time that this has been inactive, and hasn't had a response, i'm going to close this.

if you wish to update this and get it merged in, feel free to re-open this PR, or resubmit it as a new PR.

LEdiodes added 2 commits May 3, 2019 12:14

New keyboard MiniVan Kumo

989c61a

added readme.md files for the layouts and the Kumo keyboard

2174f6e

added readme.md files for the layouts and the Kumo keyboard

mechmerlin added the keyboard label May 3, 2019

mechmerlin requested changes May 3, 2019

View reviewed changes

mechmerlin reviewed May 3, 2019

View reviewed changes

drashna requested review from drashna, noroadsleft and yanfali May 4, 2019 00:44

noroadsleft requested changes May 4, 2019

View reviewed changes

vomindoraan reviewed May 6, 2019

View reviewed changes

keyboards/kumo/keymaps/SeaSpider/config.h Show resolved Hide resolved

mechmerlin and others added 12 commits May 6, 2019 07:34

Update keyboards/kumo/config.h

e1bbc03

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/config.h

8aa8e30

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/config.h

6861b6d

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/config.h

ee09d9f

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/config.h

ee15356

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/keymap.c

bd9f7a3

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/keymap.c

08f0b6d

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/keymap.c

b7927a0

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/keymap.c

39457a9

renaming keymap to layout Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/config.h

44b801d

ahh sweet! this must be newish.. good to know, thanks! Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/keymap.c

3a0dd7a

Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

Update keyboards/kumo/keymaps/LEdiodes/config.h

41570f8

removing #endif after getting advice on this. Co-Authored-By: LEdiodes <14025111+LEdiodes@users.noreply.github.com>

vomindoraan reviewed May 6, 2019

View reviewed changes

drashna requested changes May 10, 2019

View reviewed changes

drashna closed this Nov 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kumo Keyboard added with 3 layouts #5770

Kumo Keyboard added with 3 layouts #5770

LEdiodes commented May 3, 2019 •

edited

Loading

mechmerlin left a comment •

edited

Loading

mechmerlin May 3, 2019

LEdiodes May 6, 2019

mechmerlin May 3, 2019

mechmerlin May 3, 2019

noroadsleft May 3, 2019

vomindoraan May 6, 2019

noroadsleft May 4, 2019

vomindoraan May 6, 2019

noroadsleft May 4, 2019

noroadsleft May 4, 2019

LEdiodes May 6, 2019

noroadsleft May 4, 2019

noroadsleft May 4, 2019

noroadsleft May 4, 2019

noroadsleft May 4, 2019

noroadsleft May 4, 2019

vomindoraan May 6, 2019 •

edited

Loading

drashna left a comment

drashna May 10, 2019

drashna May 10, 2019

drashna May 10, 2019

mechmerlin commented May 10, 2019 •

edited

Loading

drashna commented Jul 30, 2019

drashna commented Nov 16, 2019

	[L1] = KEYMAP(LT(KC_F1, KC_GRV), KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \
	[L1] = LAYOUT(LT(KC_F1, KC_GRV), KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, \

Kumo Keyboard added with 3 layouts #5770

Kumo Keyboard added with 3 layouts #5770

Conversation

LEdiodes commented May 3, 2019 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

mechmerlin left a comment • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vomindoraan May 6, 2019 • edited Loading

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

mechmerlin commented May 10, 2019 • edited Loading

drashna commented Jul 30, 2019

drashna commented Nov 16, 2019

LEdiodes commented May 3, 2019 •

edited

Loading

mechmerlin left a comment •

edited

Loading

vomindoraan May 6, 2019 •

edited

Loading

mechmerlin commented May 10, 2019 •

edited

Loading