From 6e931dc85df9f9d54f5f8fbd2b8ba978f5826876 Mon Sep 17 00:00:00 2001 From: wholteza Date: Sun, 20 Jul 2025 12:49:43 +0200 Subject: [PATCH] Changes related to pr checklist --- keyboards/handwired/planck/keyboard.json | 88 +++++++++---------- .../handwired/planck/keymaps/default/keymap.c | 2 +- keyboards/handwired/planck/readme.md | 20 +++-- 3 files changed, 58 insertions(+), 52 deletions(-) diff --git a/keyboards/handwired/planck/keyboard.json b/keyboards/handwired/planck/keyboard.json index 9da6b6ec547..dde4ecb9e6a 100644 --- a/keyboards/handwired/planck/keyboard.json +++ b/keyboards/handwired/planck/keyboard.json @@ -1,10 +1,8 @@ { + "manufacturer": "OLKB", "keyboard_name": "Planck", "maintainer": "Wholteza ", - "manufacturer": "OLKB", - "url": "https://blog.roastpotatoes.co/guide/2015/11/04/how-to-handwire-a-planck/", "bootloader": "halfkay", - "processor": "atmega32u4", "diode_direction": "COL2ROW", "features": { "bootmagic": true, @@ -16,61 +14,63 @@ "cols": ["C7", "D6", "D7", "B4", "B5", "B6", "F7", "F6", "F5", "F4", "F1", "F0"], "rows": ["E6", "B3", "B7", "D0"] }, + "processor": "atmega32u4", + "url": "https://blog.roastpotatoes.co/guide/2015/11/04/how-to-handwire-a-planck/", "usb": { "device_version": "1.0.0", - "pid": "0x1234", + "pid": "0x0053", "vid": "0xFEED" }, "layouts": { "LAYOUT": { "layout": [ - {"matrix": [0, 0], "x": 0, "y": 0}, - {"matrix": [0, 1], "x": 1, "y": 0}, - {"matrix": [0, 2], "x": 2, "y": 0}, - {"matrix": [0, 3], "x": 3, "y": 0}, - {"matrix": [0, 4], "x": 4, "y": 0}, - {"matrix": [0, 5], "x": 5, "y": 0}, - {"matrix": [0, 6], "x": 6, "y": 0}, - {"matrix": [0, 7], "x": 7, "y": 0}, - {"matrix": [0, 8], "x": 8, "y": 0}, - {"matrix": [0, 9], "x": 9, "y": 0}, + {"matrix": [0, 0], "x": 0, "y": 0}, + {"matrix": [0, 1], "x": 1, "y": 0}, + {"matrix": [0, 2], "x": 2, "y": 0}, + {"matrix": [0, 3], "x": 3, "y": 0}, + {"matrix": [0, 4], "x": 4, "y": 0}, + {"matrix": [0, 5], "x": 5, "y": 0}, + {"matrix": [0, 6], "x": 6, "y": 0}, + {"matrix": [0, 7], "x": 7, "y": 0}, + {"matrix": [0, 8], "x": 8, "y": 0}, + {"matrix": [0, 9], "x": 9, "y": 0}, {"matrix": [0, 10], "x": 10, "y": 0}, {"matrix": [0, 11], "x": 11, "y": 0}, - {"matrix": [1, 0], "x": 0, "y": 1}, - {"matrix": [1, 1], "x": 1, "y": 1}, - {"matrix": [1, 2], "x": 2, "y": 1}, - {"matrix": [1, 3], "x": 3, "y": 1}, - {"matrix": [1, 4], "x": 4, "y": 1}, - {"matrix": [1, 5], "x": 5, "y": 1}, - {"matrix": [1, 6], "x": 6, "y": 1}, - {"matrix": [1, 7], "x": 7, "y": 1}, - {"matrix": [1, 8], "x": 8, "y": 1}, - {"matrix": [1, 9], "x": 9, "y": 1}, + {"matrix": [1, 0], "x": 0, "y": 1}, + {"matrix": [1, 1], "x": 1, "y": 1}, + {"matrix": [1, 2], "x": 2, "y": 1}, + {"matrix": [1, 3], "x": 3, "y": 1}, + {"matrix": [1, 4], "x": 4, "y": 1}, + {"matrix": [1, 5], "x": 5, "y": 1}, + {"matrix": [1, 6], "x": 6, "y": 1}, + {"matrix": [1, 7], "x": 7, "y": 1}, + {"matrix": [1, 8], "x": 8, "y": 1}, + {"matrix": [1, 9], "x": 9, "y": 1}, {"matrix": [1, 10], "x": 10, "y": 1}, {"matrix": [1, 11], "x": 11, "y": 1}, - {"matrix": [2, 0], "x": 0, "y": 2}, - {"matrix": [2, 1], "x": 1, "y": 2}, - {"matrix": [2, 2], "x": 2, "y": 2}, - {"matrix": [2, 3], "x": 3, "y": 2}, - {"matrix": [2, 4], "x": 4, "y": 2}, - {"matrix": [2, 5], "x": 5, "y": 2}, - {"matrix": [2, 6], "x": 6, "y": 2}, - {"matrix": [2, 7], "x": 7, "y": 2}, - {"matrix": [2, 8], "x": 8, "y": 2}, - {"matrix": [2, 9], "x": 9, "y": 2}, + {"matrix": [2, 0], "x": 0, "y": 2}, + {"matrix": [2, 1], "x": 1, "y": 2}, + {"matrix": [2, 2], "x": 2, "y": 2}, + {"matrix": [2, 3], "x": 3, "y": 2}, + {"matrix": [2, 4], "x": 4, "y": 2}, + {"matrix": [2, 5], "x": 5, "y": 2}, + {"matrix": [2, 6], "x": 6, "y": 2}, + {"matrix": [2, 7], "x": 7, "y": 2}, + {"matrix": [2, 8], "x": 8, "y": 2}, + {"matrix": [2, 9], "x": 9, "y": 2}, {"matrix": [2, 10], "x": 10, "y": 2}, {"matrix": [2, 11], "x": 11, "y": 2}, - {"matrix": [3, 0], "x": 0, "y": 3}, - {"matrix": [3, 1], "x": 1, "y": 3}, - {"matrix": [3, 2], "x": 2, "y": 3}, - {"matrix": [3, 3], "x": 3, "y": 3}, - {"matrix": [3, 4], "x": 4, "y": 3}, - {"matrix": [3, 5], "x": 5, "y": 3}, - {"matrix": [3, 7], "x": 7, "y": 3}, - {"matrix": [3, 8], "x": 8, "y": 3}, - {"matrix": [3, 9], "x": 9, "y": 3}, + {"matrix": [3, 0], "x": 0, "y": 3}, + {"matrix": [3, 1], "x": 1, "y": 3}, + {"matrix": [3, 2], "x": 2, "y": 3}, + {"matrix": [3, 3], "x": 3, "y": 3}, + {"matrix": [3, 4], "x": 4, "y": 3}, + {"matrix": [3, 5], "x": 5, "y": 3}, + {"matrix": [3, 7], "x": 7, "y": 3}, + {"matrix": [3, 8], "x": 8, "y": 3}, + {"matrix": [3, 9], "x": 9, "y": 3}, {"matrix": [3, 10], "x": 10, "y": 3}, - {"matrix": [3, 11], "x": 11, "y": 3}, + {"matrix": [3, 11], "x": 11, "y": 3} ] } } diff --git a/keyboards/handwired/planck/keymaps/default/keymap.c b/keyboards/handwired/planck/keymaps/default/keymap.c index b89d50b20cf..0891a733a7d 100644 --- a/keyboards/handwired/planck/keymaps/default/keymap.c +++ b/keyboards/handwired/planck/keymaps/default/keymap.c @@ -1,4 +1,4 @@ -/* Copyright 2025 Zackarias Montell @Wholteza +/* Copyright 2025 Zackarias Montel (@Wholteza) * * 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 diff --git a/keyboards/handwired/planck/readme.md b/keyboards/handwired/planck/readme.md index 86b1902f5d8..d47a1beeb77 100644 --- a/keyboards/handwired/planck/readme.md +++ b/keyboards/handwired/planck/readme.md @@ -2,20 +2,26 @@ ![plank handwired](https://i.imgur.com/khseWs7.jpeg) -A compact 40% (12x4) ortholinear keyboard kit sold by OLKB before they developed the rev1 PCB. +A compact 40% (12x4) ortholinear keyboard kit sold by OLKB before the PCB was released. Keyboard Maintainer: [Wholteza](https://github.com/wholteza) Hardware Supported: [Teensy 2.0](https://www.pjrc.com/store/teensy.html) - -## Compile and Flash +Hardware Availability: [PJRC](https://www.pjrc.com/store/teensy.html) Make example for this keyboard (after setting up your build environment): - qmk compile --keyboard handwired/planck --keymap default + make handwired/planck:default -To flash the keyaboard, use the Teensy Loader application provided by [PJRC](https://www.pjrc.com/teensy/loader.html). +Flashing example for this keyboard: -## Pinout + make handwired/planck:default:flash -The pinout can be found in the `keyboard.json` and looking at your keyboards wiring (flipped with the keycaps facing down) column and row 0 is **top left**. +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (top right) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the front of the PCB. +* **Keycode in layout**: Press the key mapped to `QK_BOOT`. With the default keymap press these keys in order: "lower" + "raise" + "escape".