~ruther/qmk_firmware

c8a58691146495e5506a355d6fb6d65edbc78e79 — qpockets 4 years ago 376968a
[Keyboard] add synapse pcb (#14428)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/synapse/config.h => keyboards/synapse/config.h +59 -0
@@ 0,0 1,59 @@
/* Copyright 2021 qpockets
 *
 * 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 0x7170
#define PRODUCT_ID 0x5359
#define DEVICE_VER 0x0001
#define MANUFACTURER drmmr
#define PRODUCT synapse

/* key matrix size */
#define MATRIX_ROWS 4
#define MATRIX_COLS 12

#define MATRIX_ROW_PINS \
    { E6, B0, F4, F1 }
#define MATRIX_COL_PINS \
    { F0, D4, F5, B1, B2, B3, B7, D0, D1, D2, D3, B6 }

#define UNUSED_PINS

/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

/* ROTARY ENCODERS */
#define ENCODERS_PAD_A \
    { D6, C6 }
#define ENCODERS_PAD_B \
    { D7, C7 }

#define ENCODER_RESOLUTION 4
#define ENCODER_DIRECTION_FLIP

#define DEBOUNCE 5

#define LOCKING_SUPPORT_ENABLE

//#define RGB_DI_PIN D5
//#define RGBLED_NUM 4

//#define DRIVER_LED_TOTAL RGBLED_NUM
//#define RGBLIGHT_DEFAULT_HUE 130

A keyboards/synapse/info.json => keyboards/synapse/info.json +96 -0
@@ 0,0 1,96 @@
{
  "keyboard_name": "synapse",
  "url": "",
  "maintainer": "qpockets",
  "layouts": {
    "LAYOUT_default": {
	  "layout": [
			{"x":0, "y":0},
			{"x":1, "y":0},
			{"x":2, "y":0},
			{"x":3, "y":0},
			{"x":4, "y":0},
			{"x":5, "y":0},
			{"x":6, "y":0}, 
			{"x":7, "y":0},
			{"x":8, "y":0},
			{"x":9, "y":0},
			{"x":10, "y":0},
			{"x":11, "y":0},
			{"x":0, "y":1, "w":1.25},
			{"x":1.25, "y":1},
			{"x":2.25, "y":1},
			{"x":3.25, "y":1},
			{"x":4.25, "y":1},
			{"x":5.25, "y":1},
			{"x":6.25, "y":1},
			{"x":7.25, "y":1},
			{"x":8.25, "y":1},
			{"x":9.25, "y":1},
			{"x":10.25, "y":1, "w":1.75},
			{"x":0, "y":2, "w":1.75},
			{"x":1.75, "y":2},
			{"x":2.75, "y":2},
			{"x":3.75, "y":2},
			{"x":4.75, "y":2},
			{"x":5.75, "y":2},
			{"x":6.75, "y":2},
			{"x":7.75, "y":2},
			{"x":8.75, "y":2},
			{"x":9.75, "y":2},
			{"x":10.75, "y":2, "w":1.25},
			{"x":0, "y":3},
			{"x":1, "y":3},
			{"x":2, "y":3},
			{"x":3, "y":3, "w":3},
			{"x":6, "y":3, "w":3},
			{"x":9, "y":3},
			{"x":10, "y":3},
			{"x":11, "y":3}
			]
        },
			"LAYOUT_7u_space": {
      "layout": [
			{"x":0, "y":0},
			{"x":1, "y":0},
			{"x":2, "y":0},
			{"x":3, "y":0},
			{"x":4, "y":0},
			{"x":5, "y":0},
			{"x":6, "y":0},
			{"x":7, "y":0},
			{"x":8, "y":0},
			{"x":9, "y":0}, 
			{"x":10, "y":0},
			{"x":11, "y":0},
			{"x":0, "y":1, "w":1.25},
			{"x":1.25, "y":1},
			{"x":2.25, "y":1},
			{"x":3.25, "y":1},
			{"x":4.25, "y":1},
			{"x":5.25, "y":1},
			{"x":6.25, "y":1},
			{"x":7.25, "y":1},
			{"x":8.25, "y":1},
			{"x":9.25, "y":1},
			{"x":10.25, "y":1, "w":1.75},
			{"x":0, "y":2, "w":1.75},
			{"x":1.75, "y":2},
			{"x":2.75, "y":2},
			{"x":3.75, "y":2},
			{"x":4.75, "y":2},
			{"x":5.75, "y":2},
			{"x":6.75, "y":2},
			{"x":7.75, "y":2},
			{"x":8.75, "y":2},
			{"x":9.75, "y":2},
			{"x":10.75, "y":2, "w":1.25},
			{"x":0, "y":3},
			{"x":1, "y":3, "w":1.5},
			{"x":2.5, "y":3, "w":7},
			{"x":9.5, "y":3, "w":1.5},
			{"x":11, "y":3}
			]
        }
    }
}

A keyboards/synapse/keymaps/7u_space/config.h => keyboards/synapse/keymaps/7u_space/config.h +27 -0
@@ 0,0 1,27 @@
/* Copyright 2021 qpockets
 *
 * 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

/*Modtaps*/
#define TAPPING_TERM 165
#define IGNORE_MOD_TAP_INTERRUPT

/*Combos*/
#ifdef COMBO_ENABLE
#    define COMBO_COUNT 5
#    define COMBO_TERM 50
#endif 
\ No newline at end of file

A keyboards/synapse/keymaps/7u_space/keymap.c => keyboards/synapse/keymaps/7u_space/keymap.c +77 -0
@@ 0,0 1,77 @@
/* Copyright 2021 qpockets
 *
 * 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 QMK_KEYBOARD_H

enum layers{
  _BASE,
  _SYM,
  _NAV
};

enum combo_events {
 COMBO_BSPC,
 COMBO_ENT,
 COMBO_TAB,
 COMBO_ESC,
 COMBO_DEL
};
#define KC_DN_CTL LT(_NAV, KC_LCTL)
#define KC_UP_SPC LT(_SYM, KC_SPC)
#define KC_SF LSFT_T(KC_F)
#define KC_SJ RSFT_T(KC_J)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [_BASE] = LAYOUT_7u_space(
    KC_DEL,  KC_Q,  KC_W,  KC_E,  KC_R,  KC_T, KC_Y, KC_U,  KC_I,    KC_O,   KC_P,    KC_BSPC,
    KC_TAB,  KC_A,  KC_S,  KC_D,  KC_SF, KC_G, KC_H, KC_SJ, KC_K,    KC_L,   KC_QUOT,
    KC_LSFT, KC_Z,  KC_X,  KC_C,  KC_V,  KC_B, KC_N, KC_M,  KC_COMM, KC_DOT, KC_SLSH,
    KC_LGUI, KC_DN_CTL, 	 			  KC_UP_SPC, 				KC_RALT,   KC_RGUI
  ),

 [_SYM] = LAYOUT_7u_space(
    KC_TRNS, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,    KC_TRNS,
    KC_GRV,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_EQUAL, KC_MINS,
    KC_TRNS, KC_PIPE, KC_BSLS, KC_LPRN, KC_LBRC, KC_SCLN, KC_COLN, KC_RBRC, KC_RPRN, KC_PLUS,  KC_UNDS,
    KC_TRNS, KC_TRNS,  							  KC_TRNS,      				    KC_TRNS, KC_TRNS
  ),

  [_NAV] = LAYOUT_7u_space(
    RESET,   KC_TRNS, KC_HOME, KC_UP,   KC_END,   KC_PGUP,  KC_F1, KC_F2,  KC_F3,  KC_F4,  KC_BSPC, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT, KC_PGDN,  KC_F4, KC_F5,  KC_F6,  KC_F7,  KC_TAB,
    KC_LCAP, KC_TRNS, KC_MPRV, KC_MPLY, KC_MNXT,  KC_TRNS,  KC_F9, KC_F10, KC_F11, KC_F12, KC_ENT,
    KC_TRNS,  KC_TRNS,  						  KC_TRNS, 						KC_TRNS, KC_TRNS
  ),
};




#ifdef COMBO_ENABLE
const uint16_t PROGMEM combo_bspc[] = {KC_O, KC_P, COMBO_END};
const uint16_t PROGMEM combo_ent[] = {KC_K, KC_L, COMBO_END};
const uint16_t PROGMEM combo_tab[] = {KC_S, KC_D, COMBO_END};
const uint16_t PROGMEM combo_esc[] = {KC_T, KC_Y, COMBO_END};
const uint16_t PROGMEM combo_del[] = {KC_Q, KC_W, COMBO_END};

combo_t key_combos[COMBO_COUNT] = {
  [COMBO_BSPC] = COMBO(combo_bspc,KC_BSPC),
  [COMBO_ENT] = COMBO(combo_ent,KC_ENT),
  [COMBO_TAB] = COMBO(combo_tab,KC_TAB),
  [COMBO_ESC] = COMBO(combo_esc,KC_ESC),
  [COMBO_DEL] = COMBO(combo_del,KC_DEL)
};
#endif

A keyboards/synapse/keymaps/7u_space/rules.mk => keyboards/synapse/keymaps/7u_space/rules.mk +1 -0
@@ 0,0 1,1 @@
COMBO_ENABLE = yes

A keyboards/synapse/keymaps/default/config.h => keyboards/synapse/keymaps/default/config.h +27 -0
@@ 0,0 1,27 @@
/* Copyright 2021 qpockets
 *
 * 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

/*Modtaps*/
#define TAPPING_TERM 165
#define IGNORE_MOD_TAP_INTERRUPT

/*Combos*/
#ifdef COMBO_ENABLE
#    define COMBO_COUNT 5
#    define COMBO_TERM 50
#endif 
\ No newline at end of file

A keyboards/synapse/keymaps/default/keymap.c => keyboards/synapse/keymaps/default/keymap.c +77 -0
@@ 0,0 1,77 @@
/* Copyright 2021 qpockets
 *
 * 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 QMK_KEYBOARD_H

enum layers{
  _BASE,
  _SYM,
  _NAV
};

enum combo_events {
 COMBO_BSPC,
 COMBO_ENT,
 COMBO_TAB,
 COMBO_ESC,
 COMBO_DEL
};
#define KC_DN_BSPC LT(_NAV, KC_BSPC)
#define KC_UP_SPC LT(_SYM, KC_SPC)
#define KC_SF LSFT_T(KC_F)
#define KC_SJ RSFT_T(KC_J)

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [_BASE] = LAYOUT_default(
    KC_DEL,  KC_Q,  KC_W,  KC_E,  KC_R,  KC_T, KC_Y, KC_U,  KC_I,    KC_O,   KC_P,    KC_BSPC,
    KC_TAB,  KC_A,  KC_S,  KC_D,  KC_SF, KC_G, KC_H, KC_SJ, KC_K,    KC_L,   KC_QUOT,
    KC_LSFT, KC_Z,  KC_X,  KC_C,  KC_V,  KC_B, KC_N, KC_M,  KC_COMM, KC_DOT, KC_SLSH,
    KC_LALT, KC_LGUI, KC_LCTL, KC_DN_BSPC,    KC_UP_SPC, KC_RALT,   KC_RGUI, KC_RCTL
  ),

 [_SYM] = LAYOUT_default(
    KC_TRNS, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,    KC_TRNS,
    KC_GRV,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_EQUAL, KC_MINS,
    KC_TRNS, KC_PIPE, KC_BSLS, KC_LPRN, KC_LBRC, KC_SCLN, KC_COLN, KC_RBRC, KC_RPRN, KC_PLUS,  KC_UNDS,
    KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS,      KC_TRNS,    KC_TRNS, KC_TRNS, KC_TRNS
  ),

  [_NAV] = LAYOUT_default(
    RESET,   KC_TRNS, KC_HOME, KC_UP,   KC_END,   KC_PGUP,  KC_F1, KC_F2,  KC_F3,  KC_F4,  KC_BSPC, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT, KC_PGDN,  KC_F4, KC_F5,  KC_F6,  KC_F7,  KC_TAB,
    KC_LCAP, KC_TRNS, KC_MPRV, KC_MPLY, KC_MNXT,  KC_TRNS,  KC_F9, KC_F10, KC_F11, KC_F12, KC_ENT,
    KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
  ),
};




#ifdef COMBO_ENABLE
const uint16_t PROGMEM combo_bspc[] = {KC_O, KC_P, COMBO_END};
const uint16_t PROGMEM combo_ent[] = {KC_K, KC_L, COMBO_END};
const uint16_t PROGMEM combo_tab[] = {KC_S, KC_D, COMBO_END};
const uint16_t PROGMEM combo_esc[] = {KC_T, KC_Y, COMBO_END};
const uint16_t PROGMEM combo_del[] = {KC_Q, KC_W, COMBO_END};

combo_t key_combos[COMBO_COUNT] = {
  [COMBO_BSPC] = COMBO(combo_bspc,KC_BSPC),
  [COMBO_ENT] = COMBO(combo_ent,KC_ENT),
  [COMBO_TAB] = COMBO(combo_tab,KC_TAB),
  [COMBO_ESC] = COMBO(combo_esc,KC_ESC),
  [COMBO_DEL] = COMBO(combo_del,KC_DEL)
};
#endif

A keyboards/synapse/keymaps/default/rules.mk => keyboards/synapse/keymaps/default/rules.mk +1 -0
@@ 0,0 1,1 @@
COMBO_ENABLE = yes

A keyboards/synapse/readme.md => keyboards/synapse/readme.md +27 -0
@@ 0,0 1,27 @@
# synapse

![synapse](https://i.imgur.com/OQNNPBhh.jpg)

Stagger PCB for Cervello!

* Keyboard Maintainer: https://github.com/qpockets
* Hardware Availability: [P3D Store](https://p3dstore.com/products/cervello-acrylic-keyboard-case-and-pcb-group-buy?_pos=4&_sid=fd078da46&_ss=r&variant=40398412677304) Group Buy

Make example for this keyboard (after setting up your build environment):

    make synapse:default

Flashing example for this keyboard:

    make synapse:default:flash

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 (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `RESET` if it is available
* 

A keyboards/synapse/rules.mk => keyboards/synapse/rules.mk +22 -0
@@ 0,0 1,22 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
MOUSEKEY_ENABLE = yes       # Mouse keys
EXTRAKEY_ENABLE = yes       # 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 = yes           # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE =  no      # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output
ENCODER_ENABLE = yes

A keyboards/synapse/synapse.c => keyboards/synapse/synapse.c +34 -0
@@ 0,0 1,34 @@
/* Copyright 2021 qpockets
 *
 * 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 "synapse.h"

bool encoder_update_kb(uint8_t index, bool clockwise) {
    if (!encoder_update_user(index, clockwise)) { return false; }
    if (index == 1) { /* left encoder*/
                if (clockwise){
                    tap_code(KC_WH_U);
                } else {
                    tap_code(KC_WH_D);
                }
    } else if (index == 0) { /* right encoder */
                if (clockwise){
                    tap_code(KC_VOLU);
                } else {
                    tap_code(KC_VOLD);
        }
    }
    return true;
}

A keyboards/synapse/synapse.h => keyboards/synapse/synapse.h +48 -0
@@ 0,0 1,48 @@
/* Copyright 2021 qpockets
 *
 * 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"

#define XXX KC_NO

#define LAYOUT_default( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K50, K60, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K51, \
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K52, \
    K30, K31, K32, K33,           K36,      K38, K39, K53 \
) \
{ \
    {K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K50, K60}, \
    {K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K51, XXX}, \
    {K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K52, XXX}, \
    {K30, K31, K32, K33, XXX, XXX, K36, XXX, K38, K39, K53, XXX} \
} \

#define LAYOUT_7u_space( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K50, K60, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K51, \
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K52, \
    K30, K31,	   K33,                     	 K39, K53 \
) \
{ \
    {K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K50, K60}, \
    {K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K51, XXX}, \
    {K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K52, XXX}, \
    {K30, K31, XXX, K33, XXX, XXX, XXX, XXX, XXX, K39, K53, XXX} \
}