~ruther/qmk_firmware

bad662b830bc5d93e244aec73d3115a65d7ccf17 — Fidel Coria 5 years ago c3ab205
[Keyboard] Handwired pteron38 (#10035)

* setup handwired pteron38

* Clean up readme

* readme follow template

* c formatting conventions

* remove  file size comments from rules.mk

* use direct link to imgur image

* Apply suggestions from code review

* add license
A keyboards/handwired/pteron38/config.h => keyboards/handwired/pteron38/config.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2020 Fidel Coria
 *
 * 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       0xFEED
#define PRODUCT_ID      0x6060
#define DEVICE_VER      0x0001
#define MANUFACTURER    QMK Community
#define PRODUCT         Pteron38 Keyboard

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

/* key matrix pins */
#define MATRIX_ROW_PINS { E6, B4, B5, B6 }
#define MATRIX_COL_PINS { F6, F5, F7, B1, B3, C6, D4, D0, D1, D2 }
#define UNUSED_PINS     { D7, F4, D3 }

/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5  /* 5 is default */

A keyboards/handwired/pteron38/info.json => keyboards/handwired/pteron38/info.json +58 -0
@@ 0,0 1,58 @@
{
  "keyboard_name": "pteron38",
  "url": "",
  "maintainer": "fidelcoria",
  "width": 17,
  "height": 5.95,
  "layouts": {
    "LAYOUT_split_3x5_4": {
      "layout": [
        {"label":"K101", "x":1, "y":1.75},
        {"label":"K102", "x":2, "y":1.25},
        {"label":"K103", "x":3, "y":1},
        {"label":"K104", "x":4, "y":1.35},
        {"label":"K105", "x":5, "y":1.45},

        {"label":"K106", "x":11, "y":1.45},
        {"label":"K107", "x":12, "y":1.35},
        {"label":"K108", "x":13, "y":1},
        {"label":"K109", "x":14, "y":1.25},
        {"label":"K110", "x":15, "y":1.75},

        {"label":"K201", "x":1, "y":2.75},
        {"label":"K202", "x":2, "y":2.25},
        {"label":"K203", "x":3, "y":2},
        {"label":"K204", "x":4, "y":2.35},
        {"label":"K205", "x":5, "y":2.45},

        {"label":"K206", "x":11, "y":2.45},
        {"label":"K207", "x":12, "y":2.35},
        {"label":"K208", "x":13, "y":2},
        {"label":"K209", "x":14, "y":2.25},
        {"label":"K210", "x":15, "y":2.75},

        {"label":"K301", "x":1, "y":3.75},
        {"label":"K302", "x":2, "y":3.25},
        {"label":"K303", "x":3, "y":3},
        {"label":"K304", "x":4, "y":3.35},
        {"label":"K305", "x":5, "y":3.45},

        {"label":"K306", "x":11, "y":3.45},
        {"label":"K307", "x":12, "y":3.35},
        {"label":"K308", "x":13, "y":3},
        {"label":"K309", "x":14, "y":3.25},
        {"label":"K310", "x":15, "y":3.75},

        {"label":"K402", "x":4, "y":4.35},
        {"label":"K403", "x":5, "y":4.45},
        {"label":"K404", "x":6, "y":4.65},
        {"label":"K405", "x":7, "y":4.95},

        {"label":"K406", "x":9, "y":4.95},
        {"label":"K407", "x":10, "y":4.65},
        {"label":"K408", "x":11, "y":4.45},
        {"label":"K409", "x":12, "y":4.35}
      ]
    }
  }
}

A keyboards/handwired/pteron38/keymaps/default/keymap.c => keyboards/handwired/pteron38/keymaps/default/keymap.c +48 -0
@@ 0,0 1,48 @@
/* Copyright 2020 Fidel Coria
 *
 * 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

#define SFT_Z LSFT_T(KC_Z)
#define SFT_FSL RSFT_T(KC_SLSH)

#define UNLOCK LCA(KC_DEL)
#define LOCK   RGUI(KC_L)
#define CTL_S  RCTL(KC_RSFT) // used with arrow keys for word highlight
#define G_SHFT RGUI(KC_RSFT) // plus arrow to switch window to other screen

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT_split_3x5_4(
        KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,           KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,
        KC_A,   KC_S,   KC_D,   KC_F,   KC_G,           KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,
        SFT_Z,  KC_X,   KC_C,   KC_V,   KC_B,           KC_N,   KC_M,   KC_COMM,KC_DOT, SFT_FSL,
                MO(1),  KC_BSPC,MO(2),  KC_LCTL,        KC_RSFT,KC_ENT, KC_SPC, KC_RALT
    ),

    [1] = LAYOUT_split_3x5_4(
        KC_TAB, KC_HOME,KC_UP,  KC_END, UNLOCK,          KC_GRV, KC_LPRN,KC_RPRN,KC_MINS,KC_EQL,
        KC_ESC, KC_LEFT,KC_DOWN,KC_RGHT,LOCK,            KC_QUOT,KC_LCBR,KC_RCBR,KC_RGUI,KC_QUOT,
        _______,KC_DEL, KC_ENT, KC_SPC, KC_CAPS,         CTL_S,  KC_LBRC,KC_RBRC,G_SHFT, KC_BSLS,
                _______,_______,_______,_______,         _______,_______,KC_RCTL,KC_RALT
    ),

    [2] = LAYOUT_split_3x5_4(
        KC_1,   KC_2,   KC_3,   KC_4,   KC_5,           KC_6,   KC_7,   KC_8,   KC_9,   KC_0,
        KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,          KC_F6,  KC_F7,  KC_F8,  KC_F9,  KC_F10,
        _______,_______,_______,KC_F11, KC_F12,         KC_INS, _______,RESET,  _______,_______,
                _______,_______,_______,_______,        _______,_______,KC_RCTL,KC_RALT
    )
};

A keyboards/handwired/pteron38/pteron38.c => keyboards/handwired/pteron38/pteron38.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2020 Fidel Coria
 *
 * 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 "pteron38.h"

A keyboards/handwired/pteron38/pteron38.h => keyboards/handwired/pteron38/pteron38.h +31 -0
@@ 0,0 1,31 @@
/* Copyright 2020 Fidel Coria
 *
 * 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 LAYOUT_split_3x5_4( \
    K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, \
    K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, \
    K301, K302, K303, K304, K305, K306, K307, K308, K309, K310, \
          K402, K403, K404, K405, K406, K407, K408, K409  \
) { \
    { K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110 }, \
    { K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210 }, \
    { K301,  K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310 }, \
    { KC_NO, K402,  K403,  K404,  K405,  K406,  K407,  K408,  K409,  KC_NO }  \
}

A keyboards/handwired/pteron38/readme.md => keyboards/handwired/pteron38/readme.md +15 -0
@@ 0,0 1,15 @@
# Pteron38

![Pteron38](https://i.imgur.com/75030bal.jpg)

An ergonomic keyboard heavily inspired by the [Atreus](https://github.com/technomancy/atreus), [Iris](https://github.com/keebio/iris-case) and [Atreis](https://github.com/dekonnection/atreis) keyboards. More info and files for laser cutting plates and case are in the [Pteron repository](https://github.com/FSund/pteron-keyboard).

* Keyboard Maintainer:  [Fidel Coria](https://github.com/fidelcoria)
* Hardware Supported: Elite C
* Hardware Availability: Handwired, no PCB's available (for now)

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

    make handwired/pteron38: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).

A keyboards/handwired/pteron38/rules.mk => keyboards/handwired/pteron38/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 = 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 = 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
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output