`3c359529445942eda9c9efc3e448f059a5d24cc0`

Author: nuess0r <nussgipfel@brain4free.org>
Committer: GitHub <noreply@github.com>
Date: 2024-12-09 06:21 UTC

Message

Adding ctrl-M replacement controller for IBM Model M (#24375)

* This is a configuration of QMK intended to be used with the [ctrl-M controller](https://github.com/nuess0r/ctrl-M).

* Move USB_MAX_POWER_CONSUMPTION to data driven due to upstream change

* Clean up according to PR checklist

Check the keymaps/nuess0r how you can make better use of your Model M
including Windows, multimedia keys etc.

* Move CAPS_HOLD feature from default build to custom keymap

* More data driven configuration

Move layout definition from ctrl_m.h to info.json
Move has_ghost to info.json -> this makes the config.h file obsolete

* Implement changes suggested by review

* Removing user keymap (nuess0r) to follow current guidelines

The nuess0r keymap which is shipped with the ctrl-M controller is kept here:
https://github.com/nuess0r/qmk_firmware/tree/nuess0r_keymap

* Changed image hosting location to Github

requested in review by drashna

* Changed image hosting location to imgur

* Settings removed from info.json that are disabled by default.

* Change URL as suggested by @dunk2k

Not pointing to the QMK firmware but to the replacement controller electronics
project.

* Migrate build target markers to keyboard.json

* Adding tindie link and implement review suggestions

* Removing via keymap to follow current guidelines

Will be moved to the https://github.com/the-via/qmk_userspace_via repo.

* Add LAYOUT_all to support ANSI and ISO keyboards with the same firmware

Add a LAYOUT_all similar to other keyboards that defines all available keys.
Change the default keymap to use the _all layout so both ANSI and ISO Model M
variants work out of the box.

* Remove unnecessary enum from default keymap

Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>

---------

Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>

Diff

This diff is truncated to protect this page.

  1diff --git a/keyboards/ibm/model_m/ctrl_m/keyboard.json b/keyboards/ibm/model_m/ctrl_m/keyboard.json
  2new file mode 100644
  3index 0000000000000000000000000000000000000000..41801215c1313498b8870504b1905fb96fcb33c3
  4--- /dev/null
  5+++ b/keyboards/ibm/model_m/ctrl_m/keyboard.json
  6@@ -0,0 +1,409 @@
  7+{
  8+    "keyboard_name": "ctrl-M",
  9+    "manufacturer": "nuess0r",
 10+    "url": "https://github.com/nuess0r/ctrl-m",
 11+    "maintainer": "nuess0r",
 12+    "usb": {
 13+        "vid": "0x1D50",
 14+        "pid": "0x6180",
 15+        "device_version": "1.0.0",
 16+        "max_power": 100
 17+    },
 18+    "features": {
 19+        "bootmagic": true,
 20+        "extrakey": true,
 21+        "mousekey": true,
 22+        "nkro": false
 23+    },
 24+    "matrix_pins": {
 25+        "cols": ["A15", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "C13", "C14", "C15", "F0", "F1", "A0", "A1", "A2"],
 26+        "rows": ["A3", "A4", "A5", "A6", "A7", "B0", "B1", "B2"],
 27+        "ghost": true
 28+    },
 29+    "diode_direction": "ROW2COL",
 30+    "indicators": {
 31+        "num_lock": "B10",
 32+        "caps_lock": "B12",
 33+        "scroll_lock": "B11",
 34+        "on_state": 0
 35+    },
 36+    "bootmagic": {
 37+        "matrix": [0, 2]
 38+    },
 39+    "processor": "STM32F072",
 40+    "bootloader": "stm32-dfu",
 41+    "layouts": {
 42+        "LAYOUT_fullsize_ansi_wkl": {
 43+            "layout": [
 44+                {"label": "Esc", "matrix": [0, 2], "x": 0, "y": 0},
 45+
 46+                {"label": "F1", "matrix": [2, 3], "x": 2, "y": 0},
 47+                {"label": "F2", "matrix": [2, 4], "x": 3, "y": 0},
 48+                {"label": "F3", "matrix": [1, 4], "x": 4, "y": 0},
 49+                {"label": "F4", "matrix": [0, 4], "x": 5, "y": 0},
 50+
 51+                {"label": "F5", "matrix": [0, 6], "x": 6.5, "y": 0},
 52+                {"label": "F6", "matrix": [0, 8], "x": 7.5, "y": 0},
 53+                {"label": "F7", "matrix": [1, 9], "x": 8.5, "y": 0},
 54+                {"label": "F8", "matrix": [2, 9], "x": 9.5, "y": 0},
 55+
 56+                {"label": "F9", "matrix": [2, 6], "x": 11, "y": 0},
 57+                {"label": "F10", "matrix": [3, 6], "x": 12, "y": 0},
 58+                {"label": "F11", "matrix": [3, 11], "x": 13, "y": 0},
 59+                {"label": "F12", "matrix": [3, 12], "x": 14, "y": 0},
 60+
 61+                {"label": "PrtSc", "matrix": [3, 15], "x": 15.25, "y": 0},
 62+                {"label": "Scroll Lock", "matrix": [4, 15], "x": 16.25, "y": 0},
 63+                {"label": "Pause", "matrix": [6, 14], "x": 17.25, "y": 0},
 64+
 65+                {"label": "~", "matrix": [2, 2], "x": 0, "y": 1.5},
 66+                {"label": "!", "matrix": [3, 2], "x": 1, "y": 1.5},
 67+                {"label": "@", "matrix": [3, 3], "x": 2, "y": 1.5},
 68+                {"label": "#", "matrix": [3, 4], "x": 3, "y": 1.5},
 69+                {"label": "$", "matrix": [3, 5], "x": 4, "y": 1.5},
 70+                {"label": "%", "matrix": [2, 5], "x": 5, "y": 1.5},
 71+                {"label": "^", "matrix": [2, 7], "x": 6, "y": 1.5},
 72+                {"label": "&", "matrix": [3, 7], "x": 7, "y": 1.5},
 73+                {"label": "*", "matrix": [3, 8], "x": 8, "y": 1.5},
 74+                {"label": "(", "matrix": [3, 9], "x": 9, "y": 1.5},
 75+                {"label": ")", "matrix": [3, 10], "x": 10, "y": 1.5},
 76+                {"label": "_", "matrix": [2, 10], "x": 11, "y": 1.5},
 77+                {"label": "+", "matrix": [2, 8], "x": 12, "y": 1.5},
 78+                {"label": "Backspace", "matrix": [1, 6], "x": 13, "y": 1.5, "w": 2},
 79+
 80+                {"label": "Insert", "matrix": [2, 12], "x": 15.25, "y": 1.5},
 81+                {"label": "Home", "matrix": [2, 14], "x": 16.25, "y": 1.5},
 82+                {"label": "PgUp", "matrix": [2, 13], "x": 17.25, "y": 1.5},
 83+
 84+                {"label": "Num Lock", "matrix": [6, 11], "x": 18.5, "y": 1.5},
 85+                {"label": "/", "matrix": [6, 12], "x": 19.5, "y": 1.5},
 86+                {"label": "*", "matrix": [6, 13], "x": 20.5, "y": 1.5},
 87+                {"label": "-", "matrix": [7, 13], "x": 21.5, "y": 1.5},
 88+
 89+                {"label": "Tab", "matrix": [1, 2], "x": 0, "y": 2.5, "w": 1.5},
 90+                {"label": "Q", "matrix": [4, 2], "x": 1.5, "y": 2.5},
 91+                {"label": "W", "matrix": [4, 3], "x": 2.5, "y": 2.5},
 92+                {"label": "E", "matrix": [4, 4], "x": 3.5, "y": 2.5},
 93+                {"label": "R", "matrix": [4, 5], "x": 4.5, "y": 2.5},
 94+                {"label": "T", "matrix": [1, 5], "x": 5.5, "y": 2.5},
 95+                {"label": "Y", "matrix": [1, 7], "x": 6.5, "y": 2.5},
 96+                {"label": "U", "matrix": [4, 7], "x": 7.5, "y": 2.5},
 97+                {"label": "I", "matrix": [4, 8], "x": 8.5, "y": 2.5},
 98+                {"label": "O", "matrix": [4, 9], "x": 9.5, "y": 2.5},
 99+                {"label": "P", "matrix": [4, 10], "x": 10.5, "y": 2.5},
100+                {"label": "{", "matrix": [1, 10], "x": 11.5, "y": 2.5},
101+                {"label": "}", "matrix": [1, 8], "x": 12.5, "y": 2.5},
102+                {"label": "|", "matrix": [5, 6], "x": 13.5, "y": 2.5, "w": 1.5},
103+
104+                {"label": "Delete", "matrix": [2, 11], "x": 15.25, "y": 2.5},
105+                {"label": "End", "matrix": [3, 14], "x": 16.25, "y": 2.5},
106diff --git a/keyboards/ibm/model_m/ctrl_m/keymaps/default/keymap.c b/keyboards/ibm/model_m/ctrl_m/keymaps/default/keymap.c
107new file mode 100644
108index 0000000000000000000000000000000000000000..741cb1c4ba7ad4720be4103dc8d78d8af24a2e97
109--- /dev/null
110+++ b/keyboards/ibm/model_m/ctrl_m/keymaps/default/keymap.c
111@@ -0,0 +1,27 @@
112+/* Copyright 2020 Michael Schwingen
113+ *
114+ * This program is free software: you can redistribute it and/or modify
115+ * it under the terms of the GNU General Public License as published by
116+ * the Free Software Foundation, either version 2 of the License, or
117+ * (at your option) any later version.
118+ *
119+ * This program is distributed in the hope that it will be useful,
120+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
121+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
122+ * GNU General Public License for more details.
123+ *
124+ * You should have received a copy of the GNU General Public License
125+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
126+ */
127+#include QMK_KEYBOARD_H
128+
129+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
130+  [0] = LAYOUT_all( /* Base layer - standard layout without any special functions */
131+    KC_ESC ,          KC_F1  , KC_F2  , KC_F3  , KC_F4  , KC_F5  , KC_F6  , KC_F7  , KC_F8  , KC_F9  , KC_F10 , KC_F11 , KC_F12 , KC_PSCR, KC_SCRL, KC_PAUS,
132+    KC_GRV , KC_1   , KC_2   , KC_3   , KC_4   , KC_5   , KC_6   , KC_7   , KC_8   , KC_9   , KC_0   , KC_MINS, KC_EQL , KC_BSPC, KC_INS , KC_HOME, KC_PGUP, KC_NUM,  KC_PSLS, KC_PAST, KC_PMNS,
133+    KC_TAB , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , KC_Y   , KC_U   , KC_I   , KC_O   , KC_P   , KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL , KC_END , KC_PGDN, KC_P7,   KC_P8  , KC_P9  , KC_PPLS,
134+    KC_CAPS, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_H   , KC_J   , KC_K   , KC_L   , KC_SCLN, KC_QUOT, KC_NUHS, KC_ENT ,                            KC_P4,   KC_P5  , KC_P6  ,
135+    KC_LSFT, KC_NUBS, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH,          KC_RSFT,          KC_UP  ,          KC_P1,   KC_P2  , KC_P3  , KC_PENT,
136+    KC_LCTL,          KC_LALT,                            KC_SPC ,                                     KC_RALT,          KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0,            KC_PDOT
137+  )
138+};
139diff --git a/keyboards/ibm/model_m/ctrl_m/readme.md b/keyboards/ibm/model_m/ctrl_m/readme.md
140new file mode 100644
141index 0000000000000000000000000000000000000000..aab3a685f2e0238740f7a565881c0e219c3f4971
142--- /dev/null
143+++ b/keyboards/ibm/model_m/ctrl_m/readme.md
144@@ -0,0 +1,27 @@
145+# ctrl-M
146+
147+![ctrl-M PCB](https://i.imgur.com/wUqY8N3.jpeg)
148+