Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clueboard refresh #4902

Merged
merged 24 commits into from
Jan 23, 2019
Merged

Clueboard refresh #4902

merged 24 commits into from
Jan 23, 2019

Conversation

skullydazed
Copy link
Member

Description

Update Clueboard to follow modern practices.

Special thanks to @noroadsleft for doing the initial cleanup work.

Types of changes

  • Core
  • Bugfix
  • New Feature
  • Enhancement/Optimization
  • Keyboard (addition or update)
  • Keymap/Layout/Userspace (addition or update)
  • Documentation

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. (https://docs.qmk.fm/#/contributing)
  • 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).

noroadsleft and others added 21 commits January 19, 2019 17:19
- renamed layout macro KEYMAP to LAYOUT
- reformatted layout macro to more closely resemble physical device layout
- keymaps now use #include QMK_KEYBOARD_H
- config.h files updated to use #pragma once method
- deleted outdated QUANTUM_DIR code blocks from rules.mk files
- white space changes on rules.mk files (alignment/readability)
- added image
- updated Docs links
- removed k31 and k84 from LAYOUT
  - both appear to be unsupported for this PCB according to images on clueboard.co
  - updated block comment mock-ups to match changes
- rebuilt info.json file
- delete removed keys from default keymap.c
- fix make example
- updated Docs links
Updated to use #include QMK_KEYBOARD_H
- renamed layout macro KEYMAP to LAYOUT_all
- renamed layout macro KEYMAP_AEK to LAYOUT_aek
- removed redundant KC_TRNS definitions from keymaps
- all keymaps now use #include QMK_KEYBOARD_H
Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to the specific comments,

  • clueboard/2x1800 keymaps are failing because AUDIO_ENABLE and FAUXCLICKY_ENABLE are both enabled. I guess the features conflict somehow.
  • Something about the RGB_PIN_DI setting for clueboard/66 in revs. 2 and 3 and clueboard/card is wonky. That's as far as I've gotten.

Here's where I'm at right now.

pr4902_01.diff.txt


/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 6

/* Prevent modifiers from being stuck on after layer changes. */
#define PREVENT_STUCK_MODIFIERS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't actually do anything anymore; it has been the default behaviour for QMK since #3107 was merged.

The override for this setting - to turn PREVENT_STUCK_MODIFIERS off - is #define STRICT_LAYER_RELEASE.

Line 57 should be either commented out, or entirely removed.

keyboards/clueboard/66/rules.mk Show resolved Hide resolved
keyboards/clueboard/66/rev2/config.h Show resolved Hide resolved
@drashna drashna requested a review from mechmerlin January 21, 2019 19:28
keyboards/clueboard/2x1800/rules.mk Outdated Show resolved Hide resolved
keyboards/clueboard/66/config.h Show resolved Hide resolved
keyboards/clueboard/66_hotswap/gen1/config.h Outdated Show resolved Hide resolved
keyboards/clueboard/66_hotswap/config.h Outdated Show resolved Hide resolved
keyboards/clueboard/60/config.h Show resolved Hide resolved
keyboards/clueboard/card/config.h Outdated Show resolved Hide resolved
Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1dd51c5 + the diff below = every keymap for every clueboard/66 revision compiles, except for default_60_iso (66% ISO layout sample), which is a problem with that keymap, rather than anything here.

It's almost entirely:

  • updating the keymap config.h files to use #pragma once instead of referring to the now-deleted clueboard/66/config.h directly
  • using #include QMK_KEYBOARD_H instead of #include "66.h"

Could be out-of-scope for this PR, but I figured there should be a record of the issues at least.

diff --git a/keyboards/clueboard/66/keymaps/bloodlvst/config.h b/keyboards/clueboard/66/keymaps/bloodlvst/config.h
index 456936cf9..60c6ad4a1 100644
--- a/keyboards/clueboard/66/keymaps/bloodlvst/config.h
+++ b/keyboards/clueboard/66/keymaps/bloodlvst/config.h
@@ -1,7 +1,3 @@
-#ifndef CONFIG_USER_H
-#define CONFIG_USER_H
-
-#include "../../config.h"
+#pragma once
 
 #define DISABLE_SPACE_CADET_ROLLOVER
-#endif
diff --git a/keyboards/clueboard/66/keymaps/bloodlvst/keymap.c b/keyboards/clueboard/66/keymaps/bloodlvst/keymap.c
index 73543cbfa..7c7faba9c 100644
--- a/keyboards/clueboard/66/keymaps/bloodlvst/keymap.c
+++ b/keyboards/clueboard/66/keymaps/bloodlvst/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/jokrik/keymap.c b/keyboards/clueboard/66/keymaps/jokrik/keymap.c
index 118efe0a9..9c6997c34 100644
--- a/keyboards/clueboard/66/keymaps/jokrik/keymap.c
+++ b/keyboards/clueboard/66/keymaps/jokrik/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/magicmonty/config.h b/keyboards/clueboard/66/keymaps/magicmonty/config.h
index d933fa997..65853f6b0 100644
--- a/keyboards/clueboard/66/keymaps/magicmonty/config.h
+++ b/keyboards/clueboard/66/keymaps/magicmonty/config.h
@@ -1,7 +1,4 @@
-#ifndef CONFIG_USER_H
-#define CONFIG_USER_H
-
-#include "../../config.h"
+#pragma once
 
 /*
  * MIDI options
@@ -36,5 +33,3 @@
 #define LSPO_KEY KC_8
 #define RSPC_KEY KC_9
 #define PERMISSIVE_HOLD
-
-#endif
diff --git a/keyboards/clueboard/66/keymaps/magicmonty/keymap.c b/keyboards/clueboard/66/keymaps/magicmonty/keymap.c
index 7f91224cf..8d9371567 100644
--- a/keyboards/clueboard/66/keymaps/magicmonty/keymap.c
+++ b/keyboards/clueboard/66/keymaps/magicmonty/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Helpful defines
 #define xxxxxxx KC_NO
diff --git a/keyboards/clueboard/66/keymaps/magicmonty/rules.mk b/keyboards/clueboard/66/keymaps/magicmonty/rules.mk
index 7ee1ff169..46222e2d3 100644
--- a/keyboards/clueboard/66/keymaps/magicmonty/rules.mk
+++ b/keyboards/clueboard/66/keymaps/magicmonty/rules.mk
@@ -1,6 +1,7 @@
 
 MOUSEKEY_ENABLE = yes
 EXTRAKEY_ENABLE = yes
+RGBLIGHT_ENABLE = yes   # Enable keyboard underlight functionality
 
 MIDI_ENABLE = yes
 
diff --git a/keyboards/clueboard/66/keymaps/manofinterests/keymap.c b/keyboards/clueboard/66/keymaps/manofinterests/keymap.c
index 08815dc5a..e71419980 100644
--- a/keyboards/clueboard/66/keymaps/manofinterests/keymap.c
+++ b/keyboards/clueboard/66/keymaps/manofinterests/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/mrscooty/keymap.c b/keyboards/clueboard/66/keymaps/mrscooty/keymap.c
index abf98615e..302649c92 100644
--- a/keyboards/clueboard/66/keymaps/mrscooty/keymap.c
+++ b/keyboards/clueboard/66/keymaps/mrscooty/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/serubin/keymap.c b/keyboards/clueboard/66/keymaps/serubin/keymap.c
index 32507e918..e77417c3c 100644
--- a/keyboards/clueboard/66/keymaps/serubin/keymap.c
+++ b/keyboards/clueboard/66/keymaps/serubin/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/smt/keymap.c b/keyboards/clueboard/66/keymaps/smt/keymap.c
index 42dcfecac..c1e375690 100644
--- a/keyboards/clueboard/66/keymaps/smt/keymap.c
+++ b/keyboards/clueboard/66/keymaps/smt/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 
 // Each layer gets a name for readability, which is then used in the keymap matrix below.
 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
diff --git a/keyboards/clueboard/66/keymaps/tetris/keymap.c b/keyboards/clueboard/66/keymaps/tetris/keymap.c
index f7c6d4c13..ef3abd667 100644
--- a/keyboards/clueboard/66/keymaps/tetris/keymap.c
+++ b/keyboards/clueboard/66/keymaps/tetris/keymap.c
@@ -1,4 +1,4 @@
-#include "66.h"
+#include QMK_KEYBOARD_H
 #include "tetris_text.h"
 
 // Helpful defines
diff --git a/keyboards/clueboard/66/keymaps/xyverz/config.h b/keyboards/clueboard/66/keymaps/xyverz/config.h
index 4999e4ff6..979cbf576 100644
--- a/keyboards/clueboard/66/keymaps/xyverz/config.h
+++ b/keyboards/clueboard/66/keymaps/xyverz/config.h
@@ -1,3 +1,3 @@
-#include "../config.h"
+#pragma once
 
-#define TAPPING_TERM 600 // ms	
+#define TAPPING_TERM 600 // ms
diff --git a/keyboards/clueboard/66/keymaps/xyverz/keymap.c b/keyboards/clueboard/66/keymaps/xyverz/keymap.c
index e3f413b49..916a448e2 100644
--- a/keyboards/clueboard/66/keymaps/xyverz/keymap.c
+++ b/keyboards/clueboard/66/keymaps/xyverz/keymap.c
@@ -1,7 +1,7 @@
 // Xyverz' keymap.
 // It's based on the default keymap, but Dvorak!
 
-#include "66.h"
+#include QMK_KEYBOARD_H
 #include "action_layer.h"
 #include "eeconfig.h"

@skullydazed
Copy link
Member Author

The only remaining error is a firmware too large, and that's in a user's keymap so I'm not going to touch it for now.

@skullydazed skullydazed merged commit d1f735b into master Jan 23, 2019
@skullydazed skullydazed deleted the clueboard_refresh branch January 23, 2019 17:25
Shinichi-Ohki added a commit to Shinichi-Ohki/qmk_firmware that referenced this pull request Jan 24, 2019
* 'master' of https://github.com/qmk/qmk_firmware: (87 commits)
  [Keyboard] KBD67: enable bootmagic lite by default (qmk#4931)
  [Keymap] Adding keymap for Nyquist (qmk#4918)
  Optimize/Update the new_project script (qmk#4920)
  Remove lfkeyboards parent rules.mk as its only required for mini1800
  [Keyboard] Add BDN9 (qmk#4919)
  [Keyboard] Add KBD67 Hotswap Support (qmk#4916)
  Fixup the clueboard 66 info.json
  Clueboard refresh (qmk#4902)
  Give the keymap folder the proper name
  Fix layouts/default/66_iso keymap
  [Keyboard] Add DataHand keyboard support (qmk#4847)
  [Keymap] Add a compile-time provided macro and assign to _FL (qmk#4908)
  Added info.json for TGR Alice
  Always read two bytes from the endpoint if we have two bytes to read
  Rename i2c_slave functions so it can coexist with i2c_master (qmk#4875)
  Fix for ISO layout in tada68:rys (qmk#4906)
  [Keyboard] Added TGR Alice keyboard support (qmk#4896)
  handwired/retro_refit: refactor, Configurator support and readme update (qmk#4899)
  Initial fixes for vagrant (qmk#4900)
  Tidy up IS_{,HOST_}LED_{ON,OFF} macros (qmk#4894)
  ...
tenderlove added a commit to tenderlove/qmk_firmware that referenced this pull request Jan 24, 2019
* master: (643 commits)
  [Keyboard] Remove hadron ver0 as it is no longer required (qmk#4921)
  Remove unused fn_actions[] and action_function() in default keymaps (qmk#4829)
  [Keyboard] KBD67: enable bootmagic lite by default (qmk#4931)
  [Keymap] Adding keymap for Nyquist (qmk#4918)
  Optimize/Update the new_project script (qmk#4920)
  Remove lfkeyboards parent rules.mk as its only required for mini1800
  [Keyboard] Add BDN9 (qmk#4919)
  [Keyboard] Add KBD67 Hotswap Support (qmk#4916)
  Fixup the clueboard 66 info.json
  Clueboard refresh (qmk#4902)
  Give the keymap folder the proper name
  Fix layouts/default/66_iso keymap
  [Keyboard] Add DataHand keyboard support (qmk#4847)
  [Keymap] Add a compile-time provided macro and assign to _FL (qmk#4908)
  Added info.json for TGR Alice
  Always read two bytes from the endpoint if we have two bytes to read
  Rename i2c_slave functions so it can coexist with i2c_master (qmk#4875)
  Fix for ISO layout in tada68:rys (qmk#4906)
  [Keyboard] Added TGR Alice keyboard support (qmk#4896)
  handwired/retro_refit: refactor, Configurator support and readme update (qmk#4899)
  ...
loadedsith added a commit to loadedsith/qmk_firmware that referenced this pull request Jan 25, 2019
* master: (60 commits)
  [Keymap] New kbd67/hotswap keymap for writing both code and math (qmk#4933)
  Add support for Clueboard 66% rev4
  Fix a typo in link to the Pro Micro ISP firmware
  [Keyboard] Remove hadron ver0 as it is no longer required (qmk#4921)
  Remove unused fn_actions[] and action_function() in default keymaps (qmk#4829)
  [Keyboard] KBD67: enable bootmagic lite by default (qmk#4931)
  [Keymap] Adding keymap for Nyquist (qmk#4918)
  Optimize/Update the new_project script (qmk#4920)
  Remove lfkeyboards parent rules.mk as its only required for mini1800
  [Keyboard] Add BDN9 (qmk#4919)
  [Keyboard] Add KBD67 Hotswap Support (qmk#4916)
  Fixup the clueboard 66 info.json
  Clueboard refresh (qmk#4902)
  Give the keymap folder the proper name
  Fix layouts/default/66_iso keymap
  [Keyboard] Add DataHand keyboard support (qmk#4847)
  [Keymap] Add a compile-time provided macro and assign to _FL (qmk#4908)
  Added info.json for TGR Alice
  Always read two bytes from the endpoint if we have two bytes to read
  Rename i2c_slave functions so it can coexist with i2c_master (qmk#4875)
  ...
zer09 pushed a commit to zer09/qmk_firmware that referenced this pull request Feb 2, 2019
* Cluecard: refactor

- renamed layout macro KEYMAP to LAYOUT
- reformatted layout macro to more closely resemble physical device layout
- keymaps now use #include QMK_KEYBOARD_H
- config.h files updated to use #pragma once method
- deleted outdated QUANTUM_DIR code blocks from rules.mk files
- white space changes on rules.mk files (alignment/readability)

* Cluecard: Configurator support

* Cluecard: readme update

- added image
- updated Docs links

* Clueboard 66% HotSwap: corrected matrix and Configurator data

- removed k31 and k84 from LAYOUT
  - both appear to be unsupported for this PCB according to images on clueboard.co
  - updated block comment mock-ups to match changes
- rebuilt info.json file
- delete removed keys from default keymap.c

* Clueboard 66% HotSwap: readme update

- fix make example
- updated Docs links

* Clueboard 66% HotSwap: 66_ansi keymap update

Updated to use #include QMK_KEYBOARD_H

* Clueboard 60% refactor

- renamed layout macro KEYMAP to LAYOUT_all
- renamed layout macro KEYMAP_AEK to LAYOUT_aek
- removed redundant KC_TRNS definitions from keymaps
- all keymaps now use #include QMK_KEYBOARD_H

* Clueboard 17%: refactor

* Clueboard 17%: Configurator support

* Clueboard 17%: update Docs links in readme

* Cleanup the 2x1800 files

* Update Clueboard 60% to standard matrix

* Update the clueboard default keymaps

* Refresh and update clueboard 17

* Add the 66% hotswap to Clueboard's readme

* Clarify the 66% hotswap's readme

* change the image to imgur

* Update the clueboard 66 to follow modern standards

* update clueboard 66_hotswap to follow modern practices

* Move the logo to imgur

* update clueboard/card to follow modern practices

* remove clueboard/66 as a valid make target

* Address comments in qmk#4902

* fix user keymaps after the changes
dlhextall pushed a commit to dlhextall/qmk_firmware that referenced this pull request May 24, 2019
* Cluecard: refactor

- renamed layout macro KEYMAP to LAYOUT
- reformatted layout macro to more closely resemble physical device layout
- keymaps now use #include QMK_KEYBOARD_H
- config.h files updated to use #pragma once method
- deleted outdated QUANTUM_DIR code blocks from rules.mk files
- white space changes on rules.mk files (alignment/readability)

* Cluecard: Configurator support

* Cluecard: readme update

- added image
- updated Docs links

* Clueboard 66% HotSwap: corrected matrix and Configurator data

- removed k31 and k84 from LAYOUT
  - both appear to be unsupported for this PCB according to images on clueboard.co
  - updated block comment mock-ups to match changes
- rebuilt info.json file
- delete removed keys from default keymap.c

* Clueboard 66% HotSwap: readme update

- fix make example
- updated Docs links

* Clueboard 66% HotSwap: 66_ansi keymap update

Updated to use #include QMK_KEYBOARD_H

* Clueboard 60% refactor

- renamed layout macro KEYMAP to LAYOUT_all
- renamed layout macro KEYMAP_AEK to LAYOUT_aek
- removed redundant KC_TRNS definitions from keymaps
- all keymaps now use #include QMK_KEYBOARD_H

* Clueboard 17%: refactor

* Clueboard 17%: Configurator support

* Clueboard 17%: update Docs links in readme

* Cleanup the 2x1800 files

* Update Clueboard 60% to standard matrix

* Update the clueboard default keymaps

* Refresh and update clueboard 17

* Add the 66% hotswap to Clueboard's readme

* Clarify the 66% hotswap's readme

* change the image to imgur

* Update the clueboard 66 to follow modern standards

* update clueboard 66_hotswap to follow modern practices

* Move the logo to imgur

* update clueboard/card to follow modern practices

* remove clueboard/66 as a valid make target

* Address comments in qmk#4902

* fix user keymaps after the changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants