summaryrefslogtreecommitdiff
path: root/keyboards/kinesis/stapelberg
diff options
context:
space:
mode:
authorDavid Olsson <david.olsson@softhouse.se>2017-01-18 22:58:49 +0100
committerDavid Olsson <david.olsson@softhouse.se>2017-01-18 22:58:49 +0100
commitf35adb4f37965489b846468567f9dc65c5eec05a (patch)
tree1e8c5673cf99b056c70e1b7a45bd0799ffe14655 /keyboards/kinesis/stapelberg
parentd910b94a3c9101dbe89a877236346ede1751c0da (diff)
parent3d264adfc5e4538b57315cb8d3d429b9ed310f25 (diff)
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/kinesis/stapelberg')
-rw-r--r--keyboards/kinesis/stapelberg/Makefile3
-rw-r--r--keyboards/kinesis/stapelberg/config.h50
-rw-r--r--keyboards/kinesis/stapelberg/images/controller_board.jpgbin0 -> 129312 bytes
-rw-r--r--keyboards/kinesis/stapelberg/images/exterior_reset.jpgbin0 -> 97794 bytes
-rw-r--r--keyboards/kinesis/stapelberg/images/teensy_detail.jpgbin0 -> 119748 bytes
-rw-r--r--keyboards/kinesis/stapelberg/readme.md55
-rw-r--r--keyboards/kinesis/stapelberg/rules.mk10
-rw-r--r--keyboards/kinesis/stapelberg/stapelberg.c28
-rw-r--r--keyboards/kinesis/stapelberg/stapelberg.h72
9 files changed, 218 insertions, 0 deletions
diff --git a/keyboards/kinesis/stapelberg/Makefile b/keyboards/kinesis/stapelberg/Makefile
new file mode 100644
index 0000000000..bd09e5885d
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/Makefile
@@ -0,0 +1,3 @@
+ifndef MAKEFILE_INCLUDED
+ include ../../../Makefile
+endif
diff --git a/keyboards/kinesis/stapelberg/config.h b/keyboards/kinesis/stapelberg/config.h
new file mode 100644
index 0000000000..0677e0adeb
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/config.h
@@ -0,0 +1,50 @@
+#ifndef STAPELBERG_CONFIG_H
+#define STAPELBERG_CONFIG_H
+
+#include "../config.h"
+
+/* USB Device descriptor parameter */
+#define PRODUCT_ID 0x6060
+#define DEVICE_VER 0x0002
+
+/* key matrix size */
+#define MATRIX_ROWS 15
+#define MATRIX_COLS 7
+
+/*
+ * 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 { D0, D1, D2, D3, D4, D5, D6, D7, C0, C1, C2, C3, C4, C5, C6 }
+#define MATRIX_COL_PINS { B0, B1, B2, B3, B4, B5, B6 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCING_DELAY 5
+
+/* don't know if this should be defined at the board or top level. Assuming board
+#define MOUSEKEY_DELAY 100
+#define MOUSEKEY_INTERVAL 20
+#define MOUSEKEY_MAX_SPEED 3
+#define MOUSEKEY_TIME_TO_MAX 10
+*/
+
+#define IGNORE_MOD_TAP_INTERRUPT
+
+/* key combination for magic key command */
+#define IS_COMMAND() ( \
+ keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+
+#endif
diff --git a/keyboards/kinesis/stapelberg/images/controller_board.jpg b/keyboards/kinesis/stapelberg/images/controller_board.jpg
new file mode 100644
index 0000000000..b18f76f7ef
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/images/controller_board.jpg
Binary files differ
diff --git a/keyboards/kinesis/stapelberg/images/exterior_reset.jpg b/keyboards/kinesis/stapelberg/images/exterior_reset.jpg
new file mode 100644
index 0000000000..6edda81306
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/images/exterior_reset.jpg
Binary files differ
diff --git a/keyboards/kinesis/stapelberg/images/teensy_detail.jpg b/keyboards/kinesis/stapelberg/images/teensy_detail.jpg
new file mode 100644
index 0000000000..12e6c1c8ae
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/images/teensy_detail.jpg
Binary files differ
diff --git a/keyboards/kinesis/stapelberg/readme.md b/keyboards/kinesis/stapelberg/readme.md
new file mode 100644
index 0000000000..b04a0bd49c
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/readme.md
@@ -0,0 +1,55 @@
+# kinesis_stapelberg keyboard firmware
+
+This folder contains the firmware customization required to run QMK on the custom controller for the Kinesis Advantage created by Michael Stapelberg.
+It differs from the `alvicstep keyboard in that the existing QMK Kinesis Advantage project uses the existing controller board provided by Kinesis.
+
+The controller board hardware is described
+[here](http://michael.stapelberg.de/Artikel/kinesis_custom_controller)
+
+Mapping the pin assignments was done using the corresponding matrix description provided at this
+[link](https://github.com/stapelberg/kinesis-firmware/blob/master/kb_kinesis/config.kspec)
+
+This code makes no attempt to drive the four LEDs provided on the controller board.
+
+
+## Building the Hardware
+
+If you want to perform this customization, these parts may be helpful.
+
+| Function | Quantity | Vendor | Part Number |
+| ------------------------------------------------------ | -------- | ------- | ------------ |
+| 13 pin connector for function keys and finger keywells | 4 | Digi-Key | WM14526-ND |
+| 10 pin headers for thumb clusters | 4 | Digi-Key | 609-3250-ND |
+| 8 pin cable for thumb clusters | 2 | Digi-Key | SAM8928-ND |
+| Teensy++ 2.0 | 1 | Digi-Key | 1528-1056-ND |
+| 2 pin right angle header for reset | 1 | Digi-Key | 3M9467-ND |
+| Reset cables | 2 | Sparkfun | PRT-09140 |
+
+The board and connections are shown here
+![](images/controller_board.jpg)
+
+The Teensy mounting detail can be seen here.
+I used a socket for prototyping.
+![](images/teensy_detail.jpg)
+
+
+Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board.
+Shorting these two pins together will reset the board.
+I also put female to male header jumper cables on these so they could be accessed outside the enclosure.
+The exterior cables can be seen here.
+![](images/exterior_reset.jpg)
+
+
+## Keymaps
+
+### Default
+
+To build with the default keymap, run `make default` while in the
+`kinesis_stapelberg` working directory.
+
+### Dvorak
+
+This keymap contains a dvorak implementation as well as media and symbol layers.
+
+Run `make dvorak` while in the `kinesis_stapelberg` working directory.
+
diff --git a/keyboards/kinesis/stapelberg/rules.mk b/keyboards/kinesis/stapelberg/rules.mk
new file mode 100644
index 0000000000..fb421a34fc
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/rules.mk
@@ -0,0 +1,10 @@
+ifndef QUANTUM_DIR
+ include ../../../Makefile
+endif
+
+# just silently stop, since we need to upload with teensy uploader
+upload: build
+
+
+
+
diff --git a/keyboards/kinesis/stapelberg/stapelberg.c b/keyboards/kinesis/stapelberg/stapelberg.c
new file mode 100644
index 0000000000..111db81feb
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/stapelberg.c
@@ -0,0 +1,28 @@
+#include "stapelberg.h"
+
+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/keyboards/kinesis/stapelberg/stapelberg.h b/keyboards/kinesis/stapelberg/stapelberg.h
new file mode 100644
index 0000000000..c90fc3d52d
--- /dev/null
+++ b/keyboards/kinesis/stapelberg/stapelberg.h
@@ -0,0 +1,72 @@
+#ifndef KINESIS_STAPELBERG_H
+#define KINESIS_STAPELBERG_H
+
+#include "quantum.h"
+
+// This a shortcut to help you visually see your layout.
+// The first section contains all of the arguments as on the physical keyboard
+// The second converts the arguments into the 2-D scanned array
+
+#define KEYMAP( \
+ kC0,kD0,kE0,kC1,kD1,kE1,kC2,kD2,kE2, \
+ k00,k10,k20,k30,k40,k50, \
+ k01,k11,k21,k31,k41,k51, \
+ k02,k12,k22,k32,k42,k52, \
+ k03,k13,k23,k33,k43,k53, \
+ k14,k24,k34,k54, \
+ k56,k55, \
+ k35, \
+ k36,k46,k25, \
+ kC3,kD3,kE3,kC4,kD4,kE4,kC5,kE5,kD5, \
+ k60,k70,k80,k90,kA0,kB0, \
+ k61,k71,k81,k91,kA1,kB1, \
+ k62,k72,k82,k92,kA2,kB2, \
+ k63,k73,k83,k93,kA3,kB3, \
+ k64,k84,k94,kA4, \
+ k96,k85, \
+ k86, \
+ k66,k75,k65 \
+) { \
+ { k00, k01, k02, k03, KC_NO, KC_NO, KC_NO }, \
+ { k10, k11, k12, k13, k14, KC_NO, KC_NO }, \
+ { k20, k21, k22, k23, k24, k25, KC_NO }, \
+ { k30, k31, k32, k33, k34, k35, k36 }, \
+ { k40, k41, k42, k43, KC_NO, KC_NO, k46 }, \
+ { k50, k51, k52, k53, k54, k55, k56 }, \
+ { k60, k61, k62, k63, k64, k65, k66 }, \
+ { k70, k71, k72, k73, KC_NO, k75, KC_NO }, \
+ { k80, k81, k82, k83, k84, k85, k86 }, \
+ { k90, k91, k92, k93, k94, KC_NO, k96 }, \
+ { kA0, kA1, kA2, kA3, kA4, KC_NO, KC_NO }, \
+ { kB0, kB1, kB2, kB3, KC_NO, KC_NO, KC_NO }, \
+ { kC0, kC1, kC2, kC3, kC4, kC5, KC_NO }, \
+ { kD0, kD1, kD2, kD3, kD4, kD5, KC_NO }, \
+ { kE0, kE1, kE2, kE3, kE4, kE5, KC_NO } \
+}
+
+/*
+This is the Stapelberg matrix as published at
+https://github.com/stapelberg/kinesis-firmware/blob/master/kb_kinesis/config.kspec
+Along with the pins for each row and column
+ PB0 PB1 PB2 PB3 PB4 PB5 PB6
+ kx0 kx1 kx2 kx3 kx4 kx5 kx6
+PD0 k0x Row: EQL TAB CAP LSH X2 -- --
+PD1 k1x Row: 1 Q A Z BQ -- --
+PD2 k2x Row: 2 W S X INS END --
+PD3 k3x Row: 3 E D C LFT HOM BAK
+PD4 k4x Row: 4 R F V -- -- DEL
+PD5 k5x Row: 5 T G B RT LAL LCT
+PD6 k6x Row: 6 Y H N UP SPC PGD
+PD7 k7x Row: 7 U J M -- RET --
+PB0 k8x Row: 8 I K COM DWN RCT PGU
+PB1 k9x Row: 9 O L PER LBR -- RAL
+PB2 kAx Row: 0 P SEM SLA RBR -- --
+PB3 kBx Row: MIN BSL APO RSH X1 -- --
+PB4 kCx Row: ESC F3 F6 F9 F12 PAU --
+PB5 kDx Row: F1 F4 F7 F10 PRT PRG --
+PB6 kEx Row: F2 F5 F8 F11 SLK KEY --
+*/
+
+
+
+#endif