keyboards/xwhatsit/ibm/3277_66key/through_hole: added
authorPurdea Andrei <andrei@purdea.ro>
Sat, 18 Jul 2020 06:33:11 +0000 (09:33 +0300)
committerPurdea Andrei <andrei@purdea.ro>
Sat, 18 Jul 2020 06:40:38 +0000 (09:40 +0300)
keyboards/xwhatsit/ibm/3277_66key/through_hole/config.h [new file with mode: 0644]
keyboards/xwhatsit/ibm/3277_66key/through_hole/readme.md [new file with mode: 0644]
keyboards/xwhatsit/ibm/3277_66key/through_hole/rules.mk [new file with mode: 0644]
keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.c [new file with mode: 0644]
keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.h [new file with mode: 0644]
keyboards/xwhatsit/ibm/3277_66key/xwhatsit_rev4/config.h

diff --git a/keyboards/xwhatsit/ibm/3277_66key/through_hole/config.h b/keyboards/xwhatsit/ibm/3277_66key/through_hole/config.h
new file mode 100644 (file)
index 0000000..4e38dcf
--- /dev/null
@@ -0,0 +1,286 @@
+/*
+Copyright 2020 Purdea Andrei
+
+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 "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x0481
+#define PRODUCT_ID 0x0002
+#define DEVICE_VER 0x0001
+#define MANUFACTURER Tom Wong-Cornall/Purdea Andrei/kmnov2017/listofoptions/emdude
+#define PRODUCT IBM 3277 66-key
+#define DESCRIPTION QMK firmware for the IBM 3277 66-key keyboards using emdude sense PCB, and the through hole universal xwhatsit controller PCB
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 17
+
+/*
+ * 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, D5 }
+//#define MATRIX_COL_PINS { B2, B1, B0 }
+//#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+//#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
+
+// #define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+// #define BACKLIGHT_LEVELS 3
+
+// #define RGB_DI_PIN E2
+// #ifdef RGB_DI_PIN
+//   #define RGBLED_NUM 16
+//   #define RGBLIGHT_HUE_STEP 8
+//   #define RGBLIGHT_SAT_STEP 8
+//   #define RGBLIGHT_VAL_STEP 8
+//   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+//   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+// /*== all animations enable ==*/
+//   #define RGBLIGHT_ANIMATIONS
+// /*== or choose animations ==*/
+//   #define RGBLIGHT_EFFECT_BREATHING
+//   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//   #define RGBLIGHT_EFFECT_SNAKE
+//   #define RGBLIGHT_EFFECT_KNIGHT
+//   #define RGBLIGHT_EFFECT_CHRISTMAS
+//   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//   #define RGBLIGHT_EFFECT_RGB_TEST
+//   #define RGBLIGHT_EFFECT_ALTERNATING
+// /*== customize breathing effect ==*/
+//   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+//   /*==== use exp() and sin() ====*/
+//   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+//   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+// #endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+/* defined by default; to change, uncomment and set to the combination you want */
+// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP           H
+//#define MAGIC_KEY_HELP_ALT       SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER0_ALT     GRAVE
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     B
+//#define MAGIC_KEY_BOOTLOADER_ALT ESC
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+/* disable these deprecated features by default */
+#ifndef LINK_TIME_OPTIMIZATION_ENABLE
+  #define NO_ACTION_MACRO
+  #define NO_ACTION_FUNCTION
+#endif
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+//#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 1
+
+/*
+ * HD44780 LCD Display Configuration
+ */
+/*
+#define LCD_LINES           2     //< number of visible lines of the display
+#define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
+
+#define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
+
+#if LCD_IO_MODE
+#define LCD_PORT         PORTB        //< port for the LCD lines
+#define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
+#define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
+#define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
+#define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
+#define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
+#define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
+#define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
+#define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
+#define LCD_RS_PORT      LCD_PORT     //< port for RS line
+#define LCD_RS_PIN       3            //< pin  for RS line
+#define LCD_RW_PORT      LCD_PORT     //< port for RW line
+#define LCD_RW_PIN       2            //< pin  for RW line
+#define LCD_E_PORT       LCD_PORT     //< port for Enable line
+#define LCD_E_PIN        1            //< pin  for Enable line
+#endif
+*/
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
+
+//#define CONTROLLER_IS_XWHATSIT_MODEL_F_OR_WCASS_MODEL_F
+//#define CONTROLLER_IS_XWHATSIT_BEAMSPRING_REV_4
+#define CONTROLLER_IS_THROUGHT_HOLE_BEAMSPRING
+
+#define CAPSENSE_KEYBOARD_SETTLE_TIME_US 8
+#define CAPSENSE_DAC_SETTLE_TIME_US 8
+#define CAPSENSE_HARDCODED_SAMPLE_TIME 4
+
+#define CAPSENSE_CAL_ENABLED 1
+// #define CAPSENSE_CAL_ENABLED 0
+#define CAPSENSE_CAL_DEBUG 1
+// #define CAPSENSE_CAL_DEBUG 0
+#define CAPSENSE_CAL_INIT_REPS 16
+#define CAPSENSE_CAL_EACHKEY_REPS 16
+#define CAPSENSE_CAL_BINS 15
+#define CAPSENSE_CAL_THRESHOLD_OFFSET 120
+
+#if !CAPSENSE_CAL_ENABLED
+#define CAPSENSE_HARDCODED_THRESHOLD 142
+#endif
+
+#define CAPSENSE_KEYMAP_COL_TO_PHYSICAL_COL(col) (((col) <= 7) ? ((col) + 5) : ((col) + 6))
+
+// By default we set up for support of xwhatsit's solenoid driver board.
+// Comment out USING_SOLENOID_ENABLE_PIN if you don't have an enable pin:
+#define USING_SOLENOID_ENABLE_PIN D3
+// Change this if you are using a different pin for the solenoid:
+#define SOLENOID_PIN D2
+// If you are not using a solenoid then commend out the above, and also in rules.mk, remove "HAPTIC_ENABLE += SOLENOID"
+// You can also tune the following for your solenoid:
+//#define SOLENOID_DEFAULT_DWELL 12
+//#define SOLENOID_MIN_DWELL 4
+//#define SOLENOID_MAX_DWELL 100
diff --git a/keyboards/xwhatsit/ibm/3277_66key/through_hole/readme.md b/keyboards/xwhatsit/ibm/3277_66key/through_hole/readme.md
new file mode 100644 (file)
index 0000000..38cecb8
--- /dev/null
@@ -0,0 +1,17 @@
+# xwhatsit/ibm/3277_66key/through_hole
+
+![xwhatsit/ibm/3277_66key/through_hole](https://deskthority.net/wiki/images/thumb/4/4a/IBM_3277_typewriter_keyboard_-_keyboard_top.JPG/375px-IBM_3277_typewriter_keyboard_-_keyboard_top.JPG)
+
+A short description of the keyboard/project
+
+* Keyboard Maintainer: [Purdea Andrei](https://github.com/purdeaandrei)
+* Hardware Supported: Supports the IBM 3277 66-key keyboards, using emdude's sense PCB, using the through hole universal xwhatsit controller PCB.
+* Hardware Availability: Rare collector's item
+
+[Repository for emdude's sense PCB](https://github.com/emdude/XWhatsit-CommonSense-Compatible-IBM-3277-PCB)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make xwhatsit/ibm/3277_66key/through_hole: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/xwhatsit/ibm/3277_66key/through_hole/rules.mk b/keyboards/xwhatsit/ibm/3277_66key/through_hole/rules.mk
new file mode 100644 (file)
index 0000000..e344379
--- /dev/null
@@ -0,0 +1,37 @@
+# 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 = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = yes        # 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
+RAW_ENABLE = yes
+
+CUSTOM_MATRIX=lite
+SRC += keyboards/xwhatsit/matrix.c keyboards/xwhatsit/util_comm.c
+HAPTIC_ENABLE += SOLENOID
diff --git a/keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.c b/keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.c
new file mode 100644 (file)
index 0000000..4b71a72
--- /dev/null
@@ -0,0 +1,58 @@
+/* Copyright 2020 Purdea Andrei
+ *
+ * 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 "through_hole.h"
+
+const char *KEYBOARD_FILENAME = __FILE__; // used by util_comm
+
+void keyboard_post_init_kb(void)
+{
+//    debug_enable=true;
+//    debug_matrix=true;
+}
+
+// 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);
+}
+
+bool led_update_kb(led_t led_state) {
+    // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+
+    return led_update_user(led_state);
+}
+*/
diff --git a/keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.h b/keyboards/xwhatsit/ibm/3277_66key/through_hole/through_hole.h
new file mode 100644 (file)
index 0000000..c6d0a5b
--- /dev/null
@@ -0,0 +1,47 @@
+/* Copyright 2020 Purdea Andrei
+ *
+ * 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( \
+    k31,    k_1  , k_2, k_3, k_4, k_5, k_6, k_7, k_8, k_9, k_0, k_minus, k_equals, k_backspace,                 k_dup,  k_fieldmark, \
+    k32, k_tab, k_q, k_w, k_e, k_r, k_t, k_y, k_u, k_i, k_o, k_p, k_squarebrop, k_squarebrcl,                   k_ins,  k_del, \
+    k33, k_caps,  k_a, k_s, k_d, k_f, k_g, k_h, k_j, k_k, k_l, k_semicolon, k_singlequote, k_return,            k_up,   k_down, \
+    k34, k_lshift,  k_z, k_x, k_c, k_v, k_b, k_n, k_m, k_cm,k_period, k_fwslash,       k_rshift,                k_left, k_right, \
+            k_lreset,                            k_space,                           k_rctrl \
+) \
+{ \
+    { k31, KC_NO,    k_1,    k_2, k_3, k_4, k_5, k_6, k_7, k_8, k_9,  k_0,      k_minus,      k_equals,      k_backspace, k_dup,  k_fieldmark },\
+    { k32, k_tab,    k_q,    k_w, k_e, k_r, k_t, k_y, k_u, k_i, k_o,  k_p,      k_squarebrop, k_squarebrcl,  k_return,    k_ins,  k_del },\
+    { k33, k_lshift, k_caps, k_a, k_s, k_d, k_f, k_g, k_h, k_j, k_k,  k_l,      k_semicolon,  k_singlequote, k_rshift,    k_up,   k_down },\
+    { k34, k_lreset, KC_NO,  k_z, k_x, k_c, k_v, k_b, k_n, k_m, k_cm, k_period, k_fwslash,    k_space,       k_rctrl,     k_left, k_right }\
+}
+
+// Note:
+// * real columns 1..5, 14 are not in use. (and also in position 15 there is a skipped pin, like for all beam springs)
+// * column 7, row 1 (which is encoded as column 1, row 0 in qmk) is a calibration pad)
+// * column 8, row 4 (which is encoded as column 2, row 3 in qmk) is a calibration pad)
index fa14b7f..ffbb103 100644 (file)
@@ -253,6 +253,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 //#define CONTROLLER_IS_XWHATSIT_MODEL_F_OR_WCASS_MODEL_F
 #define CONTROLLER_IS_XWHATSIT_BEAMSPRING_REV_4
+//#define CONTROLLER_IS_THROUGHT_HOLE_BEAMSPRING
 
 #define CAPSENSE_KEYBOARD_SETTLE_TIME_US 8
 #define CAPSENSE_DAC_SETTLE_TIME_US 8