forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master'
- Loading branch information
Showing
50 changed files
with
2,937 additions
and
1,420 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # skullY's Clueboard Layout | ||
|
|
||
| This layout is what I (@skullydazed) use on my personal Clueboards. I mostly use it for programming, CAD, and general typing. | ||
|
|
||
| The most notable change from the default layout is putting Ctrl on the Capslock key. I also swap Alt and Cmd because I mostly use a Mac day to day. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,97 @@ | ||
| Clueboard keyboard firmware | ||
| ====================== | ||
|
|
||
| TODO: to be updated. | ||
| DIY/Assembled compact 66% keyboard by [Clueboard](http://clueboard.co). | ||
|
|
||
| For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md). | ||
|
|
||
| ## First Time Setup | ||
|
|
||
| Download or clone the whole firmware and navigate to the keyboards/clueboard directory. Once your dev env is setup, you'll be able to generate the default .hex: | ||
|
|
||
| ``` | ||
| $ make | ||
| ``` | ||
|
|
||
| You will see a lot of output and if everything worked correctly you will see something similar to this: | ||
|
|
||
| ``` | ||
| Size after: | ||
| text data bss dec hex filename | ||
| 0 19992 0 19992 4e18 clueboard_rev2_default.hex | ||
| ``` | ||
|
|
||
| At this point you can press RESET on your Clueboard and flash your keyboard with this command: | ||
|
|
||
| ``` | ||
| $ make dfu | ||
| ``` | ||
|
|
||
| If you would like to use one of the alternative keymaps, or create your own, see below. | ||
|
|
||
| ## Clueboard 1.0 | ||
|
|
||
| If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add `SUBPROJECT=rev1` to your make command, like this: | ||
|
|
||
| ``` | ||
| $ make SUBPROJECT=rev1 | ||
| ``` | ||
|
|
||
| And when flashing your keyboard: | ||
|
|
||
| ``` | ||
| $ make SUBPROJECT=rev1 dfu | ||
| ``` | ||
|
|
||
| If you are flashing an alternative layout to your rev1, include both `SUBPROJECT=rev1` and `KEYMAP=<keymap>` in your command, for example when flashing max: | ||
|
|
||
| ``` | ||
| $ make SUBPROJECT=rev1 KEYMAP=max dfu | ||
| ``` | ||
|
|
||
| ## Alternate Keymaps | ||
|
|
||
| There are many alternative and user-contributed layouts available in the [keymaps/](keymaps/) directory. To compile and flash an alternative you will want to add `KEYMAP=<keymap>` to your command: | ||
|
|
||
| ``` | ||
| $ make KEYMAP=skully | ||
| ``` | ||
|
|
||
| And when flashing your keyboard, put `KEYMAP=<keymap>` between "make" and "dfu": | ||
|
|
||
| ``` | ||
| $ make KEYMAP=skully dfu | ||
| ``` | ||
|
|
||
| ### Notable Layouts | ||
|
|
||
| These layouts are notable for one reason or another. If you are looking for ideas or inspiration you should look at these first: | ||
|
|
||
| * [keymaps/default](keymaps/default) - The default Clueboard layout | ||
| * [keymaps/max](keymaps/max) - A maximised layout that makes use of every key and feature of the Clueboard 2.0 PCB. | ||
| * [keymaps/skully](keymaps/skully) - The layout that @skullydazed uses on his own Clueboards. | ||
|
|
||
| ## Create Your Own Keymap | ||
|
|
||
| There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. As a way to get started, here is the procedure I recommend: | ||
|
|
||
| * Copy `[keymaps/default](keymaps/default/)` to `keymaps/<your_layout>`. | ||
| * Compile the firmware (`$ make KEYMAP=<your_layout>`) | ||
| * Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) | ||
| * Make sure everything works like the default keyboard | ||
| * Modify `keymaps/<your_layout>/readme.md` to tell others about your layout. | ||
| * Modify `keymaps/<your_layout>/keymap.c` to reflect your desired layout. | ||
| * Compile your new custom firmware (`$ make KEYMAP=<your_layout>`) | ||
| ** If you have warnings you may flash without fixing them, but something may not work right. | ||
| ** If you have any errors you must fix them before continuing. | ||
| * Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) | ||
|
|
||
| ## Share Your Keymap | ||
|
|
||
| Got your layout dialed in? Please share it with the world so we can benefit from your work! Simply submit a pull request with your layout and we'll include it in the official repository. Please use the following guidelines when putting together your pull request: | ||
|
|
||
| * Include a readme.md that states what your primary keyboard use is, how your layout differs from the default, and highlights anything you think makes your layout particularly great. | ||
| * If your layout requires certain features (EG, RGB underlight or backlighting) ensure you have a Makefile and config.h that reflects that | ||
| * If your layout requires special hardware to be added, please describe that in the readme.md | ||
|
|
||
| TODO: Write up or link quick how-to on creating and submitting a PR. (Pull requests accepted. :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,4 +36,4 @@ | |
| #define RGBLIGHT_SAT_STEP 17 | ||
| #define RGBLIGHT_VAL_STEP 17 | ||
|
|
||
| #endif | ||
| #endif | ||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| #include "cluecard.h" | ||
| #define BL_RED OCR1B | ||
| #define BL_GREEN OCR1A | ||
| #define BL_BLUE OCR1C | ||
|
|
||
| void matrix_init_kb(void) { | ||
| // put your keyboard start-up code here | ||
| // runs once when the firmware starts up | ||
|
|
||
| matrix_init_user(); | ||
| } | ||
|
|
||
| void matrix_scan_kb(void) { | ||
| // put your looping keyboard code here | ||
| // runs every cycle (a lot) | ||
|
|
||
| matrix_scan_user(); | ||
| } | ||
|
|
||
| bool process_record_kb(uint16_t keycode, keyrecord_t *record) { | ||
| // put your per-action keyboard code here | ||
| // runs for every action, just before processing by the firmware | ||
|
|
||
| return process_record_user(keycode, record); | ||
| } | ||
|
|
||
| void led_set_kb(uint8_t usb_led) { | ||
| // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here | ||
|
|
||
| led_set_user(usb_led); | ||
| } | ||
|
|
||
| void backlight_init_ports(void) | ||
| { | ||
| // Set B5, B6, and B7 as output | ||
| DDRB |= (1<<7)|(1<<6)|(1<<5); | ||
|
|
||
| // Setup PWM | ||
| ICR1 = 0xFFFF; | ||
| TCCR1A = 0b10101010; | ||
| TCCR1B = 0b00011001; | ||
|
|
||
| BL_RED = 0xFFFF; | ||
| BL_GREEN = 0xFFFF; | ||
| BL_BLUE = 0xFFFF; | ||
| } | ||
|
|
||
| void backlight_set(uint8_t level) | ||
| { | ||
| // Set the RGB color | ||
| switch (level) | ||
| { | ||
| case 0: | ||
| // Off | ||
| BL_RED = 0xFFFF; | ||
| BL_GREEN = 0xFFFF; | ||
| BL_BLUE = 0xFFFF; | ||
| break; | ||
| case 1: | ||
| // Red | ||
| BL_RED = 0x0000; | ||
| BL_GREEN = 0xFFFF; | ||
| BL_BLUE = 0xFFFF; | ||
| break; | ||
| case 2: | ||
| // Green | ||
| BL_RED = 0xFFFF; | ||
| BL_GREEN = 0x0000; | ||
| BL_BLUE = 0xFFFF; | ||
| break; | ||
| case 3: | ||
| // Blue | ||
| BL_RED = 0xFFFF; | ||
| BL_GREEN = 0xFFFF; | ||
| BL_BLUE = 0x0000; | ||
| break; | ||
| case 4: | ||
| // Magenta | ||
| BL_RED = 0x4000; | ||
| BL_GREEN = 0x4000; | ||
| BL_BLUE = 0x4000; | ||
| break; | ||
| case 5: | ||
| // Purple | ||
| BL_RED = 0x0000; | ||
| BL_GREEN = 0xFFFF; | ||
| BL_BLUE = 0x0000; | ||
| break; | ||
| case 6: | ||
| // Yellow | ||
| BL_RED = 0x0000; | ||
| BL_GREEN = 0x0000; | ||
| BL_BLUE = 0xFFFF; | ||
| break; | ||
| default: | ||
| xprintf("Unknown level: %d\n", level); | ||
| } | ||
| } |
Oops, something went wrong.