summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2019-11-02 13:06:03 +1100
committerFlorian Didron <fdidron@users.noreply.github.com>2020-01-09 08:57:11 +0900
commit1836a6f5d22faca8a8db828d64d47bbfb7d8e45e (patch)
tree4b9ba621a2269ab3f6fc875ea91053450ae9fbb3
parent619d2ffcb61b0a5c51e9c5ca6aac463a213d3d63 (diff)
Template updates (#7221)
* Template updates * Flesh out info.json & keymap.c, and turn double spaces section into a list * Add enum to demonstrate layer naming * Semicolon
-rw-r--r--quantum/template/avr/readme.md6
-rw-r--r--quantum/template/avr/rules.mk1
-rw-r--r--quantum/template/base/info.json18
-rw-r--r--quantum/template/base/keyboard.c50
-rw-r--r--quantum/template/base/keyboard.h36
-rw-r--r--quantum/template/base/keymaps/default/keymap.c18
-rw-r--r--quantum/template/ps2avrgb/readme.md6
-rw-r--r--quantum/template/ps2avrgb/rules.mk18
-rwxr-xr-xutil/new_keyboard.sh2
9 files changed, 139 insertions, 16 deletions
diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md
index 719222d377..0430dd0fc9 100644
--- a/quantum/template/avr/readme.md
+++ b/quantum/template/avr/readme.md
@@ -4,9 +4,9 @@
A short description of the keyboard/project
-Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
-Hardware Supported: The PCBs, controllers supported
-Hardware Availability: links to where you can find this hardware
+* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
+* Hardware Supported: The PCBs, controllers supported
+* Hardware Availability: Links to where you can find this hardware
Make example for this keyboard (after setting up your build environment):
diff --git a/quantum/template/avr/rules.mk b/quantum/template/avr/rules.mk
index f227ea9cde..74fcf945a0 100644
--- a/quantum/template/avr/rules.mk
+++ b/quantum/template/avr/rules.mk
@@ -15,6 +15,7 @@ BOOTLOADER = atmel-dfu
# If you don't know the bootloader type, then you can specify the
# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line
+# Otherwise, delete this section
# Teensy halfKay 512
# Teensy++ halfKay 1024
# Atmel DFU loader 4096
diff --git a/quantum/template/base/info.json b/quantum/template/base/info.json
index e69de29bb2..b8e8f1f2db 100644
--- a/quantum/template/base/info.json
+++ b/quantum/template/base/info.json
@@ -0,0 +1,18 @@
+{
+ "keyboard_name": "%KEYBOARD%",
+ "url": "",
+ "maintainer": "%YOUR_NAME%",
+ "width": 3,
+ "height": 2,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"label":"k00", "x":0, "y":0},
+ {"label":"k01", "x":1, "y":0},
+ {"label":"k02", "x":2, "y":0},
+ {"label":"k10", "x":0, "y":1, "w":1.5},
+ {"label":"k12", "x":1.5, "y":1, "w":1.5}
+ ]
+ }
+ }
+}
diff --git a/quantum/template/base/keyboard.c b/quantum/template/base/keyboard.c
new file mode 100644
index 0000000000..55e4fffd3a
--- /dev/null
+++ b/quantum/template/base/keyboard.c
@@ -0,0 +1,50 @@
+/* Copyright %YEAR% %YOUR_NAME%
+ *
+ * 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
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "%KEYBOARD%.h"
+
+// Optional override functions below.
+// You can leave any or all of these undefined.
+// These are only required if you want to perform custom actions.
+
+/*
+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);
+}
+*/
diff --git a/quantum/template/base/keyboard.h b/quantum/template/base/keyboard.h
new file mode 100644
index 0000000000..8a21d92578
--- /dev/null
+++ b/quantum/template/base/keyboard.h
@@ -0,0 +1,36 @@
+/* Copyright %YEAR% %YOUR_NAME%
+ *
+ * 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
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+ k00, k01, k02, \
+ k10, k12 \
+) \
+{ \
+ { k00, k01, k02 }, \
+ { k10, KC_NO, k12 } \
+}
diff --git a/quantum/template/base/keymaps/default/keymap.c b/quantum/template/base/keymaps/default/keymap.c
index 308cb92a77..0002d91216 100644
--- a/quantum/template/base/keymaps/default/keymap.c
+++ b/quantum/template/base/keymaps/default/keymap.c
@@ -15,12 +15,25 @@
*/
#include QMK_KEYBOARD_H
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _FN
+};
+
// Defines the keycodes used by our macros in process_record_user
enum custom_keycodes { QMKBEST = SAFE_RANGE, QMKURL };
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
- [0] = LAYOUT(/* Base */
- KC_A, KC_1, KC_H, KC_TAB, KC_SPC),
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_A, KC_1, MO(_FN),
+ KC_TAB, KC_SPC
+ ),
+ [_FN] = LAYOUT(
+ QMKBEST, QMKURL, _______,
+ RESET, XXXXXXX
+ )
};
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
@@ -45,6 +58,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
return true;
}
+
void matrix_init_user(void) {}
void matrix_scan_user(void) {}
diff --git a/quantum/template/ps2avrgb/readme.md b/quantum/template/ps2avrgb/readme.md
index c01e7bca52..fa17018b29 100644
--- a/quantum/template/ps2avrgb/readme.md
+++ b/quantum/template/ps2avrgb/readme.md
@@ -4,9 +4,9 @@
A short description of the keyboard/project
-Keyboard Maintainer: [You](https://github.com/yourusername)
-Hardware Supported: The PCBs, controllers supported
-Hardware Availability: links to where you can find this hardware
+* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
+* Hardware Supported: The PCBs, controllers supported
+* Hardware Availability: links to where you can find this hardware
Make example for this keyboard (after setting up your build environment):
diff --git a/quantum/template/ps2avrgb/rules.mk b/quantum/template/ps2avrgb/rules.mk
index 52d9988125..a1dcce4b05 100644
--- a/quantum/template/ps2avrgb/rules.mk
+++ b/quantum/template/ps2avrgb/rules.mk
@@ -7,14 +7,16 @@ MCU = atmega32a
# automatically (+60). See bootloader.mk for all options.
BOOTLOADER = bootloadHID
-# build options
-BOOTMAGIC_ENABLE = full
-MOUSEKEY_ENABLE = no
-EXTRAKEY_ENABLE = yes
-CONSOLE_ENABLE = yes
-COMMAND_ENABLE = yes
-BACKLIGHT_ENABLE = no
-RGBLIGHT_ENABLE = yes
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = yes # Console for debug
+COMMAND_ENABLE = yes # Commands for debug and configuration
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
WS2812_DRIVER = i2c
OPT_DEFS = -DDEBUG_LEVEL=0
diff --git a/util/new_keyboard.sh b/util/new_keyboard.sh
index 35d89e4026..7c5cdd3030 100755
--- a/util/new_keyboard.sh
+++ b/util/new_keyboard.sh
@@ -86,6 +86,7 @@ replace_year_placeholders() {
replace_keyboard_placeholders() {
local replace_keyboard_filenames=(
"${keyboard_dir}/config.h"
+ "${keyboard_dir}/info.json"
"${keyboard_dir}/readme.md"
"${keyboard_dir}/${keyboard_name}.c"
"${keyboard_dir}/keymaps/default/readme.md"
@@ -97,6 +98,7 @@ replace_keyboard_placeholders() {
replace_name_placeholders() {
local replace_name_filenames=(
"${keyboard_dir}/config.h"
+ "${keyboard_dir}/info.json"
"${keyboard_dir}/readme.md"
"${keyboard_dir}/${keyboard_name}.c"
"${keyboard_dir}/${keyboard_name}.h"