Add crkbd keymap by manna harbour #9461

manna-harbour · 2020-06-18T06:55:19Z

This keymap includes crkbd-specific hardware feature support. It provides easy selection of the following:

hotswap trackpoint module in OLED port, or OLED with new or old drivers
automatic mouse buttons layer activation on trackpoint movement
keyboard-side mouse acceleration, or low rates for use with host-side acceleration
static image display, or use as caps lock indicator
built-in logo, or image from data file, with automatic rotation
automatic conversion of image files
matrix, light, or underglow RGB

It imports miryoku, an ergonomic, minimal, orthogonal layout for ergo or ortho keyboards.

Description

This PR depends on the following open PRs:

~~Add movement hook to ps2_mouse #8805 "Add movement hook to ps2_mouse" to build with make argument MH_AUTO_BUTTONS=yes~~ [now merged]
~~Update miryoku #9442 "Update miryoku" to build with the default imported keymap~~ [now merged]

This PR would benefit from the following open PRs:

Fix sharing of mouse button state from mousekeys to ps2_mouse #9124 "Fix sharing of mouse button state from mousekeys to ps2_mouse" to eliminate extra mouse button clicks when building with make argument MH_AUTO_BUTTONS=yes [now merged]

This PR provides solutions or work-arounds for the following closed issues:

[Question] Possibility to auto-switch layers when using trackpoint? #1925 "[Question] Possibility to auto-switch layers when using trackpoint?" by building with make argument MH_AUTO_BUTTONS=yes
OLED doesn't turn off after timeout #5982 "OLED doesn't turn off after timeout" with default macro MH_OLED_TIMEOUT
split keyboard halves in different state, can't reset #6594 "split keyboard halves in different state, can't reset" with default macro MH_RGB_TOGGLE_OFF

This PR provides enhancements to the following closed PRs:

Update logo and commonize it #4151 "Update logo and commonize it" by including a full size corne logo with make argument MH_OLED_IMAGE=corne.c
Added oled_write_raw and oled_write_raw_P functions to the OLED driver #7237 "Added oled_write_raw and oled_write_raw_P functions to the OLED driver" by providing automatic conversion of image files with make argument MH_OLED_IMAGE=image.c
[keymap] Display logo for caps lock indication on crkbd using old OLED driver #7535 "[keymap] Display logo for caps lock indication on crkbd using old OLED driver" by supporting the new OLED driver and arbitrary images with make arguments MH_MODULE=oled and MH_OLED_IMAGE=image.c
Add shift-to-disable to RGB_TOG keycode #9142 "Add shift-to-disable to RGB_TOG keycode" by providing a keymap-level work around with default macro MH_RGB_TOGGLE_OFF

Types of Changes

Keymap/layout/userspace (addition or update)

Checklist

My code follows the code style of this project.
I have read the CONTRIBUTING document.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

manna-harbour · 2020-07-02T22:49:01Z

All of the prerequisite PRs have now been merged and this is now ready for review. Thanks!

manna-harbour · 2020-07-12T23:19:07Z

Thanks @drashna!

This keymap includes crkbd-specific hardware feature support. It provides easy selection of the following: - hotswap trackpoint module in OLED port, or OLED with new or old drivers - automatic mouse buttons layer activation on trackpoint movement - keyboard-side mouse acceleration, or low rates for use with host-side acceleration - static image display, or use as caps lock indicator - built-in logo, or image from data file, with automatic rotation - automatic conversion of image files - matrix, light, or underglow RGB It imports miryoku, an ergonomic, minimal, orthogonal layout for ergo or ortho keyboards.

drashna · 2021-07-14T04:23:07Z

keyboards/crkbd/keymaps/manna-harbour/keymap.c

+#if defined SSD1306OLED
+#include "ssd1306.h"
+#endif


Ideally, the SSD1306OLED code shouldn't be used, at all. Instead, the oled driver feature should be used in its placen

Suggested change

#if defined SSD1306OLED

#include "ssd1306.h"

#endif

tzarc · 2021-11-05T02:47:18Z

Can we also get GPL2+ compatible copyright headers on all source files, please?

drashna · 2021-11-05T16:52:24Z

keyboards/crkbd/keymaps/manna-harbour/config.h

@@ -0,0 +1,98 @@
+// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org


Could you add a GPL2+ compatible license header here?

For instance:

// Copyright 2021 Your Name (@yourgithub) // SPDX-License-Identifier: GPL-2.0-or-later

Or

qmk_firmware/data/templates/base/keyboard.c

Lines 1 to 15 in 6b299fa

/* Copyright %YEAR% %YOUR_NAME%

*

* 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/>.

*/

drashna · 2021-11-05T16:52:47Z

keyboards/crkbd/keymaps/manna-harbour/config.h

+#if defined RGB_MATRIX_ENABLE
+  #define RGB_MATRIX_KEYPRESSES
+  #define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+  #define RGB_DISABLE_WHEN_USB_SUSPENDED true


Suggested change

#define RGB_DISABLE_WHEN_USB_SUSPENDED true

#define RGB_DISABLE_WHEN_USB_SUSPENDED

drashna · 2021-11-05T16:53:00Z

keyboards/crkbd/keymaps/manna-harbour/config.h

+  #define RGBLIGHT_HUE_STEP 8
+  #define RGBLIGHT_SAT_STEP 8
+  #define RGBLIGHT_VAL_STEP 8
+  #define RGBLIGHT_ANIMATIONS


Could you explicitly define which animations are enabled?

Suggested change

#define RGBLIGHT_ANIMATIONS

#define RGBLIGHT_EFFECT_BREATHING

#define RGBLIGHT_EFFECT_RAINBOW_MOOD

#define RGBLIGHT_EFFECT_RAINBOW_SWIRL

#define RGBLIGHT_EFFECT_SNAKE

#define RGBLIGHT_EFFECT_KNIGHT

#define RGBLIGHT_EFFECT_CHRISTMAS

#define RGBLIGHT_EFFECT_STATIC_GRADIENT

#define RGBLIGHT_EFFECT_RGB_TEST

#define RGBLIGHT_EFFECT_ALTERNATING

#define RGBLIGHT_EFFECT_TWINKLE

drashna · 2021-11-05T16:53:12Z

keyboards/crkbd/keymaps/manna-harbour/keymap.c

@@ -0,0 +1,181 @@
+// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org


Could you add a GPL2+ compatible license header here?

For instance:

// Copyright 2021 Your Name (@yourgithub) // SPDX-License-Identifier: GPL-2.0-or-later

Or

qmk_firmware/data/templates/base/keyboard.c

Lines 1 to 15 in 6b299fa

/* Copyright %YEAR% %YOUR_NAME%

*

* 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/>.

*/

drashna · 2021-11-05T16:53:22Z

keyboards/crkbd/keymaps/manna-harbour/keymap.c

+#if defined SSD1306OLED
+#include "ssd1306.h"
+#endif


Suggested change

#if defined SSD1306OLED

#include "ssd1306.h"

#endif

drashna · 2021-11-05T16:53:41Z

keyboards/crkbd/keymaps/manna-harbour/keymap.c

+#endif // defined MH_OLED_IMAGE_FILE && defined OLED_DRIVER_ENABLE
+
+
+#if defined OLED_DRIVER_ENABLE


Suggested change

#if defined OLED_DRIVER_ENABLE

#if defined OLED_ENABLE

drashna · 2021-11-05T16:54:07Z

keyboards/crkbd/keymaps/manna-harbour/keymap.c

+#if defined SSD1306OLED
+
+const char *read_logo(void);
+
+void matrix_init_user(void) {
+  iota_gfx_init(!isLeftHand);
+}
+
+void matrix_render_user(struct CharacterMatrix *matrix) {
+  #if defined MH_OLED_MODE_STATIC
+  matrix_write(matrix, read_logo());
+  #elif defined MH_OLED_MODE_CAPS
+  if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
+    matrix_write(matrix, read_logo());
+  }
+  #endif // defined MH_OLED_MODE_CAPS
+}
+
+void matrix_update(struct CharacterMatrix *dest, const struct CharacterMatrix *source) {
+  if (memcmp(dest->display, source->display, sizeof(dest->display))) {
+    memcpy(dest->display, source->display, sizeof(dest->display));
+    dest->dirty = true;
+  }
+}
+
+void iota_gfx_task_user(void) {
+  struct CharacterMatrix matrix;
+  matrix_clear(&matrix);
+  matrix_render_user(&matrix);
+  matrix_update(&display, &matrix);
+}
+
+void matrix_scan_user(void) {
+   iota_gfx_task();
+}
+
+#endif // defined SSD1306OLED


Suggested change

#if defined SSD1306OLED

const char *read_logo(void);

void matrix_init_user(void) {

iota_gfx_init(!isLeftHand);

}

void matrix_render_user(struct CharacterMatrix *matrix) {

#if defined MH_OLED_MODE_STATIC

matrix_write(matrix, read_logo());

#elif defined MH_OLED_MODE_CAPS

if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {

matrix_write(matrix, read_logo());

}

#endif // defined MH_OLED_MODE_CAPS

}

void matrix_update(struct CharacterMatrix *dest, const struct CharacterMatrix *source) {

if (memcmp(dest->display, source->display, sizeof(dest->display))) {

memcpy(dest->display, source->display, sizeof(dest->display));

dest->dirty = true;

}

}

void iota_gfx_task_user(void) {

struct CharacterMatrix matrix;

matrix_clear(&matrix);

matrix_render_user(&matrix);

matrix_update(&display, &matrix);

}

void matrix_scan_user(void) {

iota_gfx_task();

}

#endif // defined SSD1306OLED

drashna · 2021-11-05T16:55:37Z

keyboards/crkbd/keymaps/manna-harbour/rules.mk

+
+OPT_DEFS += -DMH_USER_NAME_H=\"$(USER_NAME).h\"
+
+ifeq ($(strip $(MH_MODULE)), trackpoint)


All of this should probably go in post_rules.mk

drashna · 2021-11-05T16:56:42Z

keyboards/crkbd/keymaps/manna-harbour/mh_images/converted/corne.c

@@ -0,0 +1,40 @@
+// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org


Could you add a GPL2+ compatible license header here?

For instance:

// Copyright 2021 Your Name (@yourgithub) // SPDX-License-Identifier: GPL-2.0-or-later

Or

qmk_firmware/data/templates/base/keyboard.c

Lines 1 to 15 in 6b299fa

/* Copyright %YEAR% %YOUR_NAME%

*

* 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/>.

*/

drashna · 2021-11-05T16:56:54Z

keyboards/crkbd/keymaps/manna-harbour/mh_images/converted/qmk.c

@@ -0,0 +1,40 @@
+// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org


Could you add a GPL2+ compatible license header here?

For instance:

// Copyright 2021 Your Name (@yourgithub) // SPDX-License-Identifier: GPL-2.0-or-later

Or

qmk_firmware/data/templates/base/keyboard.c

Lines 1 to 15 in 6b299fa

/* Copyright %YEAR% %YOUR_NAME%

*

* 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/>.

*/

keyboard-magpie · 2022-10-06T09:59:49Z

@manna-harbour in the spirit of tidying up, does this PR still need to remain open, or does your current mechanism fulfil all needs? IMO the latter is true.

manna-harbour · 2022-10-07T02:47:36Z

Thanks @drashna and @tzarc for the review.

This PR is now very out of date, and I've found a different method of adding custom code to any keymap at manna-harbour#40, which should be much better than the USER_NAME method used here. The features from this PR will be added there in future, and I'll be sure to incorporate your feedback from this PR at that time.

As an aside, there was 12 months between @drashna's original approval and request for review, and the next review. There may be an issue with the use of the awaiting review label, as it suppresses the stale action, which seems to be the only automated reminder for PRs needing attention. Perhaps an awaiting review reminder action is also needed?

Thanks @keyboard-magpie for the reminder. The Miryoku customisation method is separate from this, but even so, this PR is now obsolete. Closing now.

drashna added the awaiting_pr Relies on another PR to be merged first label Jun 18, 2020

manna-harbour force-pushed the crkbd-pr branch 4 times, most recently from d627a41 to 651dfba Compare June 24, 2020 04:23

manna-harbour mentioned this pull request Jul 3, 2020

Add movement hook to ps2_mouse #8805

Merged

13 tasks

drashna approved these changes Jul 5, 2020

View reviewed changes

drashna requested a review from a team July 5, 2020 01:37

drashna added keymap and removed awaiting_pr Relies on another PR to be merged first labels Jul 5, 2020

drashna added the awaiting review label Jul 13, 2020

manna-harbour force-pushed the crkbd-pr branch from 651dfba to 8a5f1f8 Compare July 27, 2020 10:35

drashna reviewed Jul 14, 2021

View reviewed changes

drashna requested changes Nov 5, 2021

View reviewed changes

manna-harbour closed this Oct 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add crkbd keymap by manna harbour #9461

Add crkbd keymap by manna harbour #9461

manna-harbour commented Jun 18, 2020 •

edited

Loading

manna-harbour commented Jul 2, 2020

manna-harbour commented Jul 12, 2020

drashna Jul 14, 2021

drashna Nov 5, 2021

tzarc commented Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

drashna Nov 5, 2021

keyboard-magpie commented Oct 6, 2022

manna-harbour commented Oct 7, 2022

		@@ -0,0 +1,98 @@
		// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org

	/* Copyright %YEAR% %YOUR_NAME%
	*
	* 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/>.
	*/

	#define RGB_DISABLE_WHEN_USB_SUSPENDED true
	#define RGB_DISABLE_WHEN_USB_SUSPENDED

-  #define RGBLIGHT_ANIMATIONS
+#define RGBLIGHT_EFFECT_BREATHING
+#define RGBLIGHT_EFFECT_RAINBOW_MOOD
+#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#define RGBLIGHT_EFFECT_SNAKE
+#define RGBLIGHT_EFFECT_KNIGHT
+#define RGBLIGHT_EFFECT_CHRISTMAS
+#define RGBLIGHT_EFFECT_STATIC_GRADIENT
+#define RGBLIGHT_EFFECT_RGB_TEST
+#define RGBLIGHT_EFFECT_ALTERNATING
+#define RGBLIGHT_EFFECT_TWINKLE

		@@ -0,0 +1,181 @@
		// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org

		#endif // defined MH_OLED_IMAGE_FILE && defined OLED_DRIVER_ENABLE


		#if defined OLED_DRIVER_ENABLE


		OPT_DEFS += -DMH_USER_NAME_H=\"$(USER_NAME).h\"

		ifeq ($(strip $(MH_MODULE)), trackpoint)

		@@ -0,0 +1,40 @@
		// https://github.com/manna-harbour/qmk_firmware/blob/crkbd/keyboards/crkbd/keymaps/manna-harbour/readme.org

Add crkbd keymap by manna harbour #9461

Add crkbd keymap by manna harbour #9461

Conversation

manna-harbour commented Jun 18, 2020 • edited Loading

Description

Types of Changes

Checklist

manna-harbour commented Jul 2, 2020

manna-harbour commented Jul 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tzarc commented Nov 5, 2021

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

keyboard-magpie commented Oct 6, 2022

manna-harbour commented Oct 7, 2022

manna-harbour commented Jun 18, 2020 •

edited

Loading