From 23df763a310d739859e070f67b16018652531615 Mon Sep 17 00:00:00 2001 From: mechanicalguy21 <63573424+mechanicalguy21@users.noreply.github.com> Date: Sat, 18 Apr 2020 19:58:58 -0500 Subject: [PATCH] [Keyboard] Adding Novem keyboard (macropad) and demo layout (#8781) * Adding Novem keyboard (macropad) and demo layout * Making changes suggested during pull request * Removing keyboards/novem/keymaps/default/config.h as suggested during the pull request * Moving keyboard to the handwired folder and changing the build line from readme in order to reflect this new location --- keyboards/handwired/novem/config.h | 60 +++++++++++++++ keyboards/handwired/novem/info.json | 18 +++++ .../handwired/novem/keymaps/default/keymap.c | 77 +++++++++++++++++++ .../handwired/novem/keymaps/default/readme.md | 1 + keyboards/handwired/novem/novem.c | 18 +++++ keyboards/handwired/novem/novem.h | 31 ++++++++ keyboards/handwired/novem/readme.md | 16 ++++ keyboards/handwired/novem/rules.mk | 32 ++++++++ 8 files changed, 253 insertions(+) create mode 100644 keyboards/handwired/novem/config.h create mode 100644 keyboards/handwired/novem/info.json create mode 100644 keyboards/handwired/novem/keymaps/default/keymap.c create mode 100644 keyboards/handwired/novem/keymaps/default/readme.md create mode 100644 keyboards/handwired/novem/novem.c create mode 100644 keyboards/handwired/novem/novem.h create mode 100644 keyboards/handwired/novem/readme.md create mode 100644 keyboards/handwired/novem/rules.mk diff --git a/keyboards/handwired/novem/config.h b/keyboards/handwired/novem/config.h new file mode 100644 index 0000000000..a8c012a45f --- /dev/null +++ b/keyboards/handwired/novem/config.h @@ -0,0 +1,60 @@ +/* +Copyright 2020 Jose I. Martinez + +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 . +*/ + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0x0000 +#define DEVICE_VER 0x0001 +#define MANUFACTURER Jose I. Martinez +#define PRODUCT novem +#define DESCRIPTION A custom keyboard + +/* key matrix size */ +#define MATRIX_ROWS 3 +#define MATRIX_COLS 3 + +/* + * Keyboard Matrix Assignments + * + * Change this to how you wired your keyboard + * COLS: AVR pins used for columns, left to right + * ROWS: AVR pins used for rows, top to bottom + * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) + * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) + * + */ +#define MATRIX_ROW_PINS { E6, B4, B5 } +#define MATRIX_COL_PINS { B3, B2, B6 } +#define UNUSED_PINS + +/* COL2ROW, ROW2COL*/ +#define DIODE_DIRECTION COL2ROW + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCE 5 + +/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ +#define LOCKING_SUPPORT_ENABLE +/* Locking resynchronize hack */ +#define LOCKING_RESYNC_ENABLE + + + diff --git a/keyboards/handwired/novem/info.json b/keyboards/handwired/novem/info.json new file mode 100644 index 0000000000..df0b693201 --- /dev/null +++ b/keyboards/handwired/novem/info.json @@ -0,0 +1,18 @@ +{ + "keyboard_name": "novem", + "url": "", + "maintainer": "Jose I. Martinez", + "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/keyboards/handwired/novem/keymaps/default/keymap.c b/keyboards/handwired/novem/keymaps/default/keymap.c new file mode 100644 index 0000000000..ca6f318882 --- /dev/null +++ b/keyboards/handwired/novem/keymaps/default/keymap.c @@ -0,0 +1,77 @@ +/* Copyright 2020 Jose I. Martinez + * + * 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 . + */ +#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 { + GITSTTS = SAFE_RANGE, + GITPULL, + GITPUSH, + GITCOM +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + /* Base */ + [_BASE] = LAYOUT( + KC_ESCAPE, KC_HOME, KC_DEL, + MO(_FN) , KC_UP , KC_ENTER, + KC_LEFT , KC_DOWN, KC_RIGHT + ), + [_FN] = LAYOUT( + KC_TRNS, GITCOM, GITPUSH, + KC_TRNS, GITSTTS, GITPULL, + KC_TRNS, KC_TRNS, KC_TRNS + ) +}; + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case GITSTTS: + if (record->event.pressed) { + // when keycode GITSTTS is pressed + SEND_STRING("git status"); + } + break; + case GITPULL: + if (record->event.pressed) { + // when keycode GITPULL is pressed + SEND_STRING("git pull"); + } + break; + case GITPUSH: + if (record->event.pressed) { + // when keycode GITPUSH is pressed + SEND_STRING("git push"); + } + break; + case GITCOM: + if (record->event.pressed) { + // when keycode GITCOM is pressed + SEND_STRING("git commit -m "); + } + break; + default: + return true; + } + return true; +} + diff --git a/keyboards/handwired/novem/keymaps/default/readme.md b/keyboards/handwired/novem/keymaps/default/readme.md new file mode 100644 index 0000000000..0f833a09d3 --- /dev/null +++ b/keyboards/handwired/novem/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for novem diff --git a/keyboards/handwired/novem/novem.c b/keyboards/handwired/novem/novem.c new file mode 100644 index 0000000000..967ec828f0 --- /dev/null +++ b/keyboards/handwired/novem/novem.c @@ -0,0 +1,18 @@ +/* Copyright 2020 Jose I. Martinez + * + * 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 . + */ + +#include "novem.h" + diff --git a/keyboards/handwired/novem/novem.h b/keyboards/handwired/novem/novem.h new file mode 100644 index 0000000000..b1040094e0 --- /dev/null +++ b/keyboards/handwired/novem/novem.h @@ -0,0 +1,31 @@ +/* Copyright 2020 Jose I. Martinez + * + * 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 . + */ + +#pragma once + +#include "quantum.h" + + +#define LAYOUT( \ + k00, k01, k02, \ + k03, k04, k05, \ + k06, k07, k08 \ +) \ +{ \ + { k00, k01, k02 }, \ + { k03, k04, k05 }, \ + { k06, k07, k08 }, \ +} diff --git a/keyboards/handwired/novem/readme.md b/keyboards/handwired/novem/readme.md new file mode 100644 index 0000000000..c259c2cb82 --- /dev/null +++ b/keyboards/handwired/novem/readme.md @@ -0,0 +1,16 @@ +# novem + +![novem](https://i.imgur.com/nPjBE9b.jpg) + +A short description of the keyboard/project + +* Keyboard Maintainer: [Jose I. Martinez](https://github.com/mechanicalguy21) +* Hardware Supported: This is a handwired keyboard created over a 3d printed case. +STL will be shared soon. +* Hardware Availability: STL files will be shared soon. + +Make example for this keyboard (after setting up your build environment): + + make handwired/novem:default + +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). diff --git a/keyboards/handwired/novem/rules.mk b/keyboards/handwired/novem/rules.mk new file mode 100644 index 0000000000..3891651f3b --- /dev/null +++ b/keyboards/handwired/novem/rules.mk @@ -0,0 +1,32 @@ +# MCU name +MCU = atmega32u4 + +# Bootloader selection +# Teensy halfkay +# Pro Micro caterina +# Atmel DFU atmel-dfu +# LUFA DFU lufa-dfu +# QMK DFU qmk-dfu +# ATmega32A bootloadHID +# ATmega328P USBasp +BOOTLOADER = caterina + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration +MOUSEKEY_ENABLE = no # Mouse keys +EXTRAKEY_ENABLE = no # Audio control and System control +CONSOLE_ENABLE = no # Console for debug +COMMAND_ENABLE = no # Commands for debug and configuration +# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +NKRO_ENABLE = no # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +MIDI_ENABLE = no # MIDI support +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches +HD44780_ENABLE = no # Enable support for HD44780 based LCDs