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

[Keyboard] Re-org Hillside folders as new model prep. Fix default keymap. #16128

Merged
merged 4 commits into from
Jan 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
96 changes: 96 additions & 0 deletions keyboards/handwired/hillside/0_1/info.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
{
"manufacturer": "mmccoyd",
"maintainer": "mmccoyd",

"keyboard_name": "Hillside",
"url": "http://github.com/mmccoyd/hillside/",

"tags": ["split", "column stagger", "choc v1", "choc spaced" ],

"processor": "atmega32u4",

"matrix_pins": {
"rows": ["D7", "E6", "B4", "B5"],
"cols": ["F6", "F7", "B1", "B3", "B2", "B6"]
Expand All @@ -9,5 +19,91 @@
"vid": "0xFEED",
"pid": "0x67C0",
"device_ver": "0x0001"
},

"features": {
"encoder": true,
"extrakey": true,
"rgblight": true
},
"split": {
"soft_serial_pin": "D2",
"main": "left"
},

"rgblight": {
"led_count": 5,
"pin": "D3",
"split": true,
"hue_steps": 8,
"saturation_steps": 8,
"brightness_steps": 8
},

"layouts": {
"LAYOUT": {
"layout": [

{"label": "Tab", "x": 0, "y": 0.93},
{"label": "Q", "x": 1, "y": 0.93},
{"label": "W", "x": 2, "y": 0.31},
{"label": "E", "x": 3, "y": 0},
{"label": "R", "x": 4, "y": 0.28},
{"label": "T", "x": 5, "y": 0.42},

{"label": "Y", "x": 9.5, "y": 0.42},
{"label": "U", "x": 10.5, "y": 0.28},
{"label": "I", "x": 11.5, "y": 0},
{"label": "O", "x": 12.5, "y": 0.31},
{"label": "P", "x": 13.5, "y": 0.93},
{"label": "Backspace", "x": 14.5, "y": 0.93},


{"label": "Ctrl", "x": 0, "y": 1.93},
{"label": "A", "x": 1, "y": 1.93},
{"label": "S", "x": 2, "y": 1.31},
{"label": "D", "x": 3, "y": 1},
{"label": "F", "x": 4, "y": 1.28},
{"label": "G", "x": 5, "y": 1.42},

{"label": "H", "x": 9.5, "y": 1.42},
{"label": "J", "x": 10.5, "y": 1.28},
{"label": "K", "x": 11.5, "y": 1},
{"label": "L", "x": 12.5, "y": 1.31},
{"label": ";", "x": 13.5, "y": 1.93},
{"label": "'", "x": 14.5, "y": 1.93},


{"label": "Shift", "x": 0, "y": 2.93},
{"label": "Z", "x": 1, "y": 2.93},
{"label": "X", "x": 2, "y": 2.31},
{"label": "C", "x": 3, "y": 2},
{"label": "V", "x": 4, "y": 2.28},
{"label": "B", "x": 5, "y": 2.42},
{"label": "`", "x": 6, "y": 2.78},

{"label": "Esc", "x": 8.5, "y": 2.78},
{"label": "N", "x": 9.5, "y": 2.42},
{"label": "M", "x": 10.5, "y": 2.28},
{"label": ",", "x": 11.5, "y": 2},
{"label": ".", "x": 12.5, "y": 2.31},
{"label": "/", "x": 13.5, "y": 2.93},
{"label": "Shift", "x": 14.5, "y": 2.93},


{"label": "Enter", "x": 2, "y": 3.31},
{"label": "Gui", "x": 3.5, "y": 3.28},
{"label": "Alt", "x": 4.5, "y": 3.42},
{"label": "Num", "x": 5.5, "y": 3.78},
{"label": "Nav", "x": 6.5, "y": 4.14},


{"label": "Sym", "x": 8, "y": 4.14},
{"label": "Space", "x": 9, "y": 3.78},
{"label": "Alt", "x": 10, "y": 3.42},
{"label": "Gui", "x": 11, "y": 3.28},
{"label": "App", "x": 12.5, "y": 3.31}
]
}
}
}
101 changes: 101 additions & 0 deletions keyboards/handwired/hillside/0_1/keymaps/default/keymap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
{ "version": 1,
"notes": "",
"documentation": "\"This file is a QMK Configurator export. You can import this at <https://config.qmk.fm>. It can also be used directly with QMK's source code.\n\nTo setup your QMK environment check out the tutorial: <https://docs.qmk.fm/#/newbs>\n\nYou can convert this file to a keymap.c using this command: `qmk json2c {keymap}`\n\nYou can compile this keymap using this command: `qmk compile {keymap}`\"\n",
"keyboard": "handwired/hillside/0_1",
"keymap": "default",
"layout": "LAYOUT",
"layers": [
["KC_TAB" , "KC_Q" , "KC_W" , "KC_E" , "KC_R" , "KC_T",
"KC_Y" , "KC_U" , "KC_I" , "KC_O" , "KC_P" , "KC_BSPC",

"KC_CAPS", "KC_A" , "KC_S" , "KC_D" , "KC_F" , "KC_G",
"KC_H" , "KC_J" , "KC_K" , "KC_L" , "KC_SCLN" , "KC_ENT",

"KC_LSFT", "KC_Z" , "KC_X" , "KC_C" , "KC_V" , "KC_B" , "KC_GRV",
"KC_ESC" , "KC_N" , "KC_M" , "KC_COMM" , "KC_DOT" , "KC_SLSH" , "KC_RSFT",

"KC_LCTL", "KC_LGUI" , "KC_LALT" , "MO(5)" , "MO(3)",
"MO(4)" , "KC_SPC" , "KC_LALT" , "KC_RGUI" , "KC_QUOT"

],
["KC_TAB" , "KC_QUOT" , "KC_COMM" , "KC_DOT" , "KC_P" , "KC_Y",
"KC_F" , "KC_G" , "KC_C" , "KC_R" , "KC_L" , "KC_BSPC",

"KC_CAPS", "KC_A" , "KC_O" , "KC_E" , "KC_U" , "KC_I",
"KC_D" , "KC_H" , "KC_T" , "KC_N" , "KC_S" , "KC_ENT",

"KC_LSFT", "KC_SCLN" , "KC_Q" , "KC_J" , "KC_K" , "KC_X" , "KC_GRV",
"KC_ESC" , "KC_B" , "KC_M" , "KC_W" , "KC_V" , "KC_Z" , "KC_RSFT",

"KC_LCTL", "KC_LGUI" , "KC_LALT" , "MO(5)" , "MO(3)",
"MO(4)" , "KC_SPC" , "KC_LALT" , "KC_RGUI" , "KC_SLSH"

],
["KC_TAB" , "KC_Q" , "KC_W" , "KC_F" , "KC_P" , "KC_B",
"KC_J" , "KC_L" , "KC_U" , "KC_Y" , "KC_SCLN" , "KC_BSPC",

"KC_CAPS", "KC_A" , "KC_R" , "KC_S" , "KC_T" , "KC_G",
"KC_M" , "KC_N" , "KC_E" , "KC_I" , "KC_O" , "KC_ENT",

"KC_LSFT", "KC_Z" , "KC_X" , "KC_C" , "KC_D" , "KC_V" , "KC_GRV",
"KC_ESC" , "KC_K" , "KC_H" , "KC_COMM" , "KC_DOT" , "KC_SLSH" , "KC_RSFT",

"KC_LCTL", "KC_LGUI" , "KC_LALT" , "MO(5)" , "MO(3)",
"MO(4)" , "KC_SPC" , "KC_LALT" , "KC_RGUI" , "KC_QUOT"

],
["KC_NO" , "KC_INS" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_VOLU",
"KC_PGUP", "KC_HOME" , "KC_NO" , "KC_END" , "KC_NO" , "KC_DEL",

"KC_NO" , "KC_LGUI" , "KC_LALT" , "KC_LCTL" , "KC_LSFT" , "KC_VOLD",
"KC_PGDN", "KC_LEFT" , "KC_UP" , "KC_RGHT" , "KC_NO" , "KC_TRNS",

"KC_LSFT", "LCTL(KC_Z)" , "LCTL(KC_X)" , "LCTL(KC_C)", "LCTL(KC_V)" , "LCTL(KC_Y)", "KC_MUTE",
"KC_ESC" , "OSM(MOD_RALT)", "LCTL(KC_LEFT)", "KC_DOWN" , "LCTL(KC_RGHT)", "KC_APP" , "KC_TRNS",

"KC_TRNS", "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS",
"MO(6)" , "KC_BSPC" , "KC_TRNS" , "KC_TRNS" , "KC_RCTL"

],
["KC_F11" , "KC_EXLM" , "KC_AT" , "KC_HASH" , "KC_DLR" , "KC_PERC",
"KC_CIRC", "KC_AMPR" , "KC_ASTR" , "KC_LPRN" , "KC_RPRN" , "KC_TRNS",

"KC_F12" , "KC_F1" , "KC_F2" , "KC_F3" , "KC_F4" , "KC_F5",
"KC_PIPE", "KC_LSFT" , "KC_LCTL" , "KC_LALT" , "KC_LGUI" , "KC_TRNS",

"KC_LSFT", "KC_F6" , "KC_F7" , "KC_F8" , "KC_F9" , "KC_F10" , "KC_PSCR",
"KC_ESC" , "KC_BSLS" , "KC_LBRC" , "KC_RBRC" , "KC_LCBR" , "KC_RCBR" , "KC_TRNS",

"KC_TRNS", "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "MO(6)",
"KC_TRNS", "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_RCTL"

],
["KC_TAB" , "KC_MINS" , "KC_PLUS" , "KC_EQL" , "KC_SLSH" , "KC_ASTR",
"KC_COMM", "KC_7" , "KC_8" , "KC_9" , "KC_NO" , "KC_TRNS",

"KC_NO" , "KC_LGUI" , "KC_LALT" , "KC_LCTL" , "KC_LSFT" , "KC_NO",
"KC_0" , "KC_1" , "KC_2" , "KC_3" , "KC_UNDS" , "KC_TRNS",

"KC_TRNS", "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO",
"KC_NO" , "KC_DOT" , "KC_4" , "KC_5" , "KC_6" , "KC_NO" , "KC_TRNS",

"KC_TRNS", "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_NO",
"KC_NO" , "KC_BSPC" , "KC_TRNS" , "KC_TRNS" , "KC_RCTL"

],
["KC_NO" , "DF(0)" , "DF(1)" , "DF(2)" , "AG_SWAP" , "AG_NORM",
"KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO",

"KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "CL_SWAP" , "CL_NORM",
"RGB_MOD", "RGB_VAI" , "RGB_HUI" , "RGB_SAI" , "KC_NO" , "KC_NO",

"RESET" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO",
"RGB_TOG", "RGB_RMOD" , "RGB_VAD" , "RGB_HUD" , "RGB_SAD" , "KC_NO" , "KC_NO",

"KC_NO" , "KC_NO" , "KC_NO" , "KC_NO" , "KC_TRNS",
"KC_TRNS", "KC_NO" , "KC_NO" , "KC_NO" , "KC_NO"

]
],
"author": "@mmccoyd"
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,60 +27,56 @@ We've deliberately omitted some features:

```
| TAB | Q | W | E | R | T |---------------------------| Y | U | I | O | P | BKSPC |
| CTRL | A | S | D | F | G |---------------------------| H | J | K | L | ; | ' |
| CAPS | A | S | D | F | G |---------------------------| H | J | K | L | ; | ENTER |
| SHIFT | Z | X | C | V | B | ~ |---------------| ESC | N | M | , | . | / | SHIFT |
--------------|ENTER|-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| APP |--------------
--------------|CTRL |-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| ' |--------------
```

The base layer can be either of QWERTY, Colemak-DH or Dvorak,
with identical non-alpha and non-symbol keys.
QWERTY is the default.
The base layer provides a very standard key layout:

A standard keyboard layout is used for:

- Tab, backspace and shift keys in the outer columns.
- Alt/option and GUI/command keys on both thumbs, with the location swappable for windows or mac.
- Return, Tab, backspace and shift keys in the outer columns.
- Alt/option and win/command keys on both thumbs, with the location swappable for windows or mac.
- A space key on the right thumb.

The differences from a standard layout are:

- There are three additional "shift" keys
to access the navigation/editing, symbol/function, and number layers.
- Enter is on the left thumb or ring finger.
This location allowed preserving the more common right-hand keys.
Feel free to swap it with the quote key or have it share the right shift key
as a mod-tap key.
- Control is in the caps lock spot.
- Esc and `~ are above the thumbs.
- The rarer AltGr key is in a layer.
- The Menu and AltGr keys are on a layer.

The default layout is QWERTY with alternatives of Dvorak and Colemak-DH
and the alt/option and win/command key locations are swappable for windows or mac.

<details>
<summary>Details of Dvorak and Colemak-DH</summary>
In the Dvorak layout, the outer home row key is the "/?" symbols
The Dvorak and Colemak-DH base layers
have identical non-alpha and non-symbol keys as the QWERTY base layer.
In the Dvorak layout, the symbol key in the bottom row is the "/?" symbols
so that the same 12 symbols are taken care of on the base layer.

```
Dvorak
| TAB | ' | , | . | P | Y |---------------------------| F | G | C | R | L | BKSPC |
| CTRL | A | O | E | U | I |---------------------------| D | H | T | N | S | / |
| CAPS | A | O | E | U | I |---------------------------| D | H | T | N | S | ENTER |
| SHIFT | ; | Q | J | K | X | ~ |---------------| ESC | B | M | W | V | Z | SHIFT |
--------------|ENTER|-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| APP |--------------
--------------|CTRL |-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| / |--------------

Colemak-DH
| TAB | Q | W | F | P | B |---------------------------| J | L | U | Y | ; | BKSPC |
| CTRL | A | R | S | T | G |---------------------------| M | N | E | I | O | ' |
| CAPS | A | R | S | T | G |---------------------------| M | N | E | I | O | ENTER |
| SHIFT | Z | X | C | D | V | ~ |---------------| ESC | K | H | , | . | / | SHIFT |
--------------|ENTER|-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| APP |--------------
--------------|CTRL |-----| GUI | ALT | Num | Nav |---| Sym |SPACE| ALT | GUI |-----| ' |--------------
```
</details>

## Navigation, Editing and Media Layer

```
| CAPS | INS | | | |VOL+ |---------------------------|PG_UP|HOME | | END| | DEL |
| CTRL | GUI | ALT |CTRL |SHIFT|VOL- |---------------------------|PG_DN|LEFT | UP |RIGHT| | CTRL |
| SHIFT |UNDO | CUT |COPY |PASTE|REDO |MUTE |---------------| ESC | |WORDL|DOWN |WORDR|RALT | SHIFT |
--------------|ENTER|-----| GUI | ALT | Num | *** |---| Adj |BSPC | ALT | GUI |-----| APP |--------------
| | INS | | | |VOL+ |---------------------------|PG_UP|HOME | | END| | DEL |
| | GUI | ALT |CTRL |SHIFT|VOL- |---------------------------|PG_DN|LEFT | UP |RIGHT| | ENTER |
| SHIFT |UNDO | CUT |COPY |PASTE|REDO |MUTE |---------------| ESC |RALT |WORDL|DOWN |WORDR|MENU | SHIFT |
--------------|CTRL |-----| GUI | ALT | Num | *** |---| Adj |BSPC | ALT | GUI |-----|CTRL |--------------
```
Holding down the Nav key accesses a navigation and editing layer:

Expand All @@ -96,33 +92,33 @@ Holding down the Nav key accesses a navigation and editing layer:
- The base layer modifiers and escape are in the same spots as on the base layer,
and a right-hand control key is added.
- Media volume and play keys are on the left, accessible with one hand.
- AltGr and caps lock fill out the layer.
- Menu and AltGr keys fill out the layer.
- A few keys do nothing and are available for more user-specific needs.

## Symbol and Function Layer

```
| F12 | ! | @ | # | $ | % |---------------------------| ^ | & | * | ( | ) | BSPC |
| CTRL | F1 | F2 | F3 | F4 | F5 |---------------------------| | |SHIFT|CTRL | ALT | GUI | CTRL |
| SHIFT | F6 | F7 | F8 | F9 | F10 | F11 |---------------| ESC | \ | [ | ] | { | } | SHIFT |
--------------|ENTER|-----| GUI | ALT | Num | Adj |---| *** |SPACE| ALT | GUI |-----| APP |--------------
| F11 | ! | @ | # | $ | % |---------------------------| ^ | & | * | ( | ) | BSPC |
| F12 | F1 | F2 | F3 | F4 | F5 |---------------------------| | |SHIFT|CTRL | ALT | GUI | ENTER |
| SHIFT | F6 | F7 | F8 | F9 | F10 |PRTSC|---------------| ESC | \ | [ | ] | { | } | SHIFT |
--------------|CTRL |-----| GUI | ALT | Num | Adj |---| *** |SPACE| ALT | GUI |-----|CTRL |--------------
```
Holding down the Sym key accesses a layer of symbol and function keys:

- The symbols usually found on the number keys are in the top row.
If desired, you can use these positions for other things,
as the symbols are also accessible from the number pad layer with the shift key.
- The remaining symbols appear on the right.
- Several more symbols appear on the right.
- The function keys are on the left, beginning with two rows of five.
- A row of modifiers in the home row allows the comfortable creation of any modifier and function key combination.
- The base layer modifier and escape keys are still available, as is a right-hand control key.

## Number Pad and Algebraic Layer
```
| | - | + | = | / | * |---------------------------| . | 7 | 8 | 9 | | BSPC |
| CTRL | GUI | ALT |CTRL |SHIFT| |---------------------------| 0 | 1 | 2 | 3 | _ | CTRL |
| TAB | - | + | = | / | * |---------------------------| . | 7 | 8 | 9 | | BSPC |
| | GUI | ALT |CTRL |SHIFT| |---------------------------| 0 | 1 | 2 | 3 | _ | ENTER |
| SHIFT | | | | | | |---------------| ESC | , | 4 | 5 | 6 | | SHIFT |
--------------|ENTER|-----| GUI | ALT | *** | |---| |BSPC | ALT | GUI |-----| APP |--------------
--------------|CTRL |-----| GUI | ALT | *** | |---| |BSPC | ALT | GUI |-----|CTRL |--------------
```
Holding down the Num key accesses a number pad and arithmetic symbols:

Expand All @@ -136,7 +132,7 @@ Holding down the Num key accesses a number pad and arithmetic symbols:
## Adjust Layer
```
| |QWERT|DVORK|COLMK|AG_SWAP|AG_NORM|-----------------------| | | | | | |
| | | | | | |---------------------------|MOD+ |BRI+ |HUE+ |SAT+ | | |
| | | | |CTR_S|CTR_N|---------------------------|MOD+ |BRI+ |HUE+ |SAT+ | | |
| RESET | | | | | | |--------------|RGBTOG|MOD- |BRI- |HUE- |SAT- | | |
--------------| |-----| | | | *** |---| *** | | | |-----| |--------------
```
Expand Down Expand Up @@ -204,7 +200,7 @@ Or, you can use the graphical configurator to edit the keymap. To do that:
- Save the keymap using the green down arrow button.
- Copy those changes back into your QMK repository and reformat for easy reading using the format script:
```
./keyboards/handwired/hillside/keymaps/json2hill.py --input <Your download directory>/default.json > ./keyboards/handwired/hillside/keymaps/default/keymap.json
./keyboards/handwired/hillside/0_1/keymaps/json2hill.py --input <Your download directory>/default.json > ./keyboards/handwired/hillside/0_1/keymaps/default/keymap.json
```
You may need to make that script executable with ```chmod +x```. After your keymap is safely copied and formated, you may want to remove the keymap from your download directory so later downloads will automatically receive the same file name.

Expand Down