Skip to content

Commit

Permalink
[Keyboard] Update the Speedo firmware for v3.0 (#10657)
Browse files Browse the repository at this point in the history 
* Update the Speedo firmware for v3.0

* Cleanup recommendations from the PR checklist

* Address PR feedback

* Update build instructions in readme

* Restructure folders and restore v2 firmware

* Clean up layouts in info.json

* Remove unnecessary files

* Address more PR feedback
  • Loading branch information
@pcewing
pcewing authored Oct 29, 2020
1 parent 68fc044 commit 92ca6b9
Show file tree
Hide file tree
Showing 25 changed files with 565 additions and 392 deletions.
26 changes: 26 additions & 0 deletions keyboards/cozykeys/speedo/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Speedo

![Speedo](http://assets.cozykeys.xyz/images/keyboards/speedo/speedo-v3.0-angle-led-front_1600x1600.png)

- Keyboard Maintainer: [Paul Ewing](https://github.com/pcewing)
- Hardware Supported: Elite-C
- Hardware Availability: [Speedo Repository](https://github.com/cozykeys/speedo)

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

make speedo:default

Flashing example for this keyboard:

make speedo: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).

## Flashing the Firmware

See the QMK docs for handwiring a keyboard; there is a section with
instructions on how to flash the *.hex* file to the Teensy 2.0 controller.
17 changes: 17 additions & 0 deletions keyboards/cozykeys/speedo/speedo.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
Copyright 2020 Paul Ewing
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 "speedo.h"
23 changes: 23 additions & 0 deletions keyboards/cozykeys/speedo/speedo.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
Copyright 2020 Paul Ewing
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

#ifdef KEYBOARD_cozykeys_speedo_v2
#include "speedo_v2.h"
#elif KEYBOARD_cozykeys_speedo_v3
#include "speedo_v3.h"
#endif
44 changes: 44 additions & 0 deletions keyboards/cozykeys/speedo/v2/config.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
Copyright 2020 Paul Ewing
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 0x1192
#define DEVICE_VER 0x0002
#define MANUFACTURER CozyKeys
#define PRODUCT Speedo

// Key matrix size
#define MATRIX_ROWS 5
#define MATRIX_COLS 14

// Keyboard Matrix Assignments
#define MATRIX_ROW_PINS { D1, D2, D3, C6, C7 }
#define MATRIX_COL_PINS { F0, F1, F4, F5, F6, F7, B6, B5, D0, B7, B3, B2, B1, B0 }
#define UNUSED_PINS { D5, D4, D6, D7, B4 }
#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
79 changes: 79 additions & 0 deletions keyboards/cozykeys/speedo/v2/info.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"keyboard_name": "Speedo",
"url": "https://github.com/cozykeys/speedo",
"maintainer": "pcewing",
"width": 14,
"height": 5,
"layouts": {
"LAYOUT": {
"layout": [
{ "label": "k01", "x": 0.693, "y": 0.0, "r": 10 },
{ "label": "k02", "x": 1.675, "y": 0.173, "r": 10 },
{ "label": "k03", "x": 2.685, "y": 0.191, "r": 10 },
{ "label": "k04", "x": 3.712, "y": 0.106, "r": 10 },
{ "label": "k05", "x": 4.64, "y": 0.589, "r": 10 },
{ "label": "k06", "x": 5.577, "y": 1.021, "r": 10 },
{ "label": "k07", "x": 7.571, "y": 1.021, "r": -10 },
{ "label": "k08", "x": 8.507, "y": 0.589, "r": -10 },
{ "label": "k09", "x": 9.435, "y": 0.106, "r": -10 },
{ "label": "k10", "x": 10.463, "y": 0.191, "r": -10 },
{ "label": "k11", "x": 11.472, "y": 0.173, "r": -10 },
{ "label": "k12", "x": 12.454, "y": 0.0, "r": -10 },
{ "label": "k13", "x": 0.52, "y": 0.982, "r": 10 },
{ "label": "k14", "x": 1.502, "y": 1.155, "r": 10 },
{ "label": "k15", "x": 2.511, "y": 1.174, "r": 10 },
{ "label": "k16", "x": 3.539, "y": 1.088, "r": 10 },
{ "label": "k17", "x": 4.467, "y": 1.572, "r": 10 },
{ "label": "k18", "x": 5.403, "y": 2.003, "r": 10 },
{ "label": "k19", "x": 6.574, "y": 2.559, "r": 0 },
{ "label": "k20", "x": 7.744, "y": 2.003, "r": -10 },
{ "label": "k21", "x": 8.681, "y": 1.572, "r": -10 },
{ "label": "k22", "x": 9.608, "y": 1.088, "r": -10 },
{ "label": "k23", "x": 10.636, "y": 1.174, "r": -10 },
{ "label": "k24", "x": 11.645, "y": 1.155, "r": -10 },
{ "label": "k25", "x": 12.628, "y": 0.982, "r": -10 },
{ "label": "k26", "x": 0.346, "y": 1.964, "r": 10 },
{ "label": "k27", "x": 1.329, "y": 2.138, "r": 10 },
{ "label": "k28", "x": 2.338, "y": 2.156, "r": 10 },
{ "label": "k29", "x": 3.366, "y": 2.07, "r": 10 },
{ "label": "k30", "x": 4.294, "y": 2.554, "r": 10 },
{ "label": "k31", "x": 5.23, "y": 2.986, "r": 10 },
{ "label": "k32", "x": 6.574, "y": 3.557, "r": 0 },
{ "label": "k33", "x": 7.917, "y": 2.986, "r": -10 },
{ "label": "k34", "x": 8.854, "y": 2.554, "r": -10 },
{ "label": "k35", "x": 9.781, "y": 2.07, "r": -10 },
{ "label": "k36", "x": 10.809, "y": 2.156, "r": -10 },
{ "label": "k37", "x": 11.819, "y": 2.138, "r": -10 },
{ "label": "k38", "x": 12.801, "y": 1.964, "r": -10 },
{ "label": "k39", "x": 0.173, "y": 2.947, "r": 10 },
{ "label": "k40", "x": 1.155, "y": 3.12, "r": 10 },
{ "label": "k41", "x": 2.165, "y": 3.138, "r": 10 },
{ "label": "k42", "x": 3.193, "y": 3.053, "r": 10 },
{ "label": "k43", "x": 4.12, "y": 3.536, "r": 10 },
{ "label": "k44", "x": 5.057, "y": 3.968, "r": 10 },
{ "label": "k45", "x": 6.075, "y": 4.554, "r": 0 },
{ "label": "k46", "x": 7.072, "y": 4.554, "r": 0 },
{ "label": "k47", "x": 8.09, "y": 3.968, "r": -10 },
{ "label": "k48", "x": 9.027, "y": 3.536, "r": -10 },
{ "label": "k49", "x": 9.954, "y": 3.053, "r": -10 },
{ "label": "k50", "x": 10.982, "y": 3.138, "r": -10 },
{ "label": "k51", "x": 11.992, "y": 3.12, "r": -10 },
{ "label": "k52", "x": 12.974, "y": 2.947, "r": -10 },
{ "label": "k53", "x": 0.0, "y": 3.929, "r": 10 },
{ "label": "k54", "x": 0.982, "y": 4.102, "r": 10 },
{ "label": "k55", "x": 1.992, "y": 4.12, "r": 10 },
{ "label": "k56", "x": 3.02, "y": 4.035, "r": 10 },
{ "label": "k57", "x": 3.947, "y": 4.518, "r": 10 },
{ "label": "k58", "x": 4.994, "y": 5.235, "r": 40 },
{ "label": "k59", "x": 5.753, "y": 6.064, "r": 55 },
{ "label": "k60", "x": 7.395, "y": 6.064, "r": -55 },
{ "label": "k61", "x": 8.154, "y": 5.235, "r": 40 },
{ "label": "k62", "x": 9.2, "y": 4.518, "r": -10 },
{ "label": "k63", "x": 10.128, "y": 4.035, "r": -10 },
{ "label": "k64", "x": 11.155, "y": 4.12, "r": -10 },
{ "label": "k65", "x": 12.165, "y": 4.102, "r": -10 },
{ "label": "k66", "x": 13.147, "y": 3.929, "r": -10 }
]
}
}
}
72 changes: 29 additions & 43 deletions keyboards/speedo/keymaps/default/keymap.c → ...zykeys/speedo/v2/keymaps/default/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -1,51 +1,53 @@
/* Copyright 2017 Paul Ewing
*
* 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/>.
*/
/*
Copyright 2020 Paul Ewing
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 FN MO(_FN)
#define TORST TO(_RESET)
#define TODFT TO(_DEFAULT)
#define TODO KC_NO
enum {
LAYER_DEFAULT,
LAYER_FN,
LAYER_RESET,

enum speedo_layers {
_DEFAULT,
_FN,
_RESET
__LAYER_COUNT,
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
#define FN MO(LAYER_FN)
#define TORST TO(LAYER_RESET)
#define TODFT TO(LAYER_DEFAULT)
#define TODO KC_NO

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

[_DEFAULT] = LAYOUT(
[LAYER_DEFAULT] = LAYOUT(
KC_EQL, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, \
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_UP, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS, \
KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_DOWN, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LEFT, KC_RGHT, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, \
KC_LCTL, KC_LGUI, KC_LALT, KC_GRV, FN, KC_BSPC, KC_DEL, KC_ENT, KC_SPC, FN, TODO, KC_RALT, KC_RGUI, KC_RCTL \
),

[_FN] = LAYOUT(
[LAYER_FN] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, TORST, \
_______, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, _______, KC_PGUP, KC_HOME, KC_END, _______, _______, _______, \
KC_CAPS, KC_F5, KC_F6, KC_F7, KC_F8, KC_PAUS, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, _______, _______, \
_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_INS, _______, _______, KC_PGDN, KC_LBRC, KC_RBRC, _______, _______, _______, \
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \
),

[_RESET] = LAYOUT(
[LAYER_RESET] = LAYOUT(
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, TODFT, \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
Expand All @@ -54,19 +56,3 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
)

};

void matrix_init_user(void) {

}

void matrix_scan_user(void) {

}

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
return true;
}

void led_set_user(uint8_t usb_led) {

}
1 change: 1 addition & 0 deletions keyboards/cozykeys/speedo/v2/keymaps/default/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CozyKeys Speedo v2 Default Keymap
22 changes: 22 additions & 0 deletions keyboards/cozykeys/speedo/v2/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = halfkay

# 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 = no # 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
17 changes: 17 additions & 0 deletions keyboards/cozykeys/speedo/v2/speedo_v2.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
Copyright 2020 Paul Ewing
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 "speedo_v2.h"
36 changes: 36 additions & 0 deletions keyboards/cozykeys/speedo/v2/speedo_v2.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2020 Paul Ewing
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 ___ KC_NO

#define LAYOUT( \
k01, k02, k03, k04, k05, k06, k07, k08, k09, k10, k11, k12, \
k13, k14, k15, k16, k17, k18, k19, k20, k21, k22, k23, k24, k25, \
k26, k27, k28, k29, k30, k31, k32, k33, k34, k35, k36, k37, k38, \
k39, k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k50, k51, k52, \
k53, k54, k55, k56, k57, k58, k59, k60, k61, k62, k63, k64, k65, k66 \
) \
{ \
{ k01, k01, k03, k04, k05, k06, ___, ___, k07, k08, k09, k10, k11, k12 }, \
{ k13, k15, k15, k16, k17, k18, k19, ___, k20, k21, k22, k23, k24, k25 }, \
{ k26, k28, k28, k29, k30, k31, ___, k32, k33, k34, k35, k36, k37, k38 }, \
{ k39, k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k50, k51, k52 }, \
{ k53, k54, k55, k56, k57, k58, k59, k60, k61, k62, k63, k64, k65, k66 } \
}
Loading

0 comments on commit 92ca6b9

Please sign in to comment.