Skip to content

Commit

Permalink
[Keyboard] add The Galleon by swiftrax (qmk#11700)
Browse files Browse the repository at this point in the history 
* initial addition

* fix keymap / keyboard.h

* add animation

* change pid

* fix layout macro

* Apply suggestions from code review

* Update keyboards/handwired/swiftrax/the_galleon/info.json

* move wpm enable
  • Loading branch information
@swiftrax
swiftrax committed Feb 5, 2021
1 parent 0bf0644 commit fe68657
Show file tree
Hide file tree
Showing 10 changed files with 497 additions and 0 deletions.
49 changes: 49 additions & 0 deletions keyboards/handwired/swiftrax/the_galleon/config.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
Copyright 2021 Swiftrax <swiftrax@gmail.com>
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 0x04D8
#define PRODUCT_ID 0xEA2D
#define DEVICE_VER 0x0001
#define MANUFACTURER Swiftrax
#define PRODUCT The Galleon

/* key matrix size */
#define MATRIX_ROWS 14
#define MATRIX_COLS 9

// ROWS: Top to bottom, COLS: Left to right

#define MATRIX_ROW_PINS { B1, B0, D2, B7, D5, D3, D6, D4, B4, D7, B6, B5, C7, C6}
#define MATRIX_COL_PINS { E6, F0, F1, F4, F5, F6, F7, B3, B2 }


/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION ROW2COL

/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST

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

/*EEPROM for via*/
#define DYNAMIC_KEYMAP_LAYER_COUNT 3
137 changes: 137 additions & 0 deletions keyboards/handwired/swiftrax/the_galleon/info.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
{
"keyboard_name": "The Galleon",
"url": "github.com/swiftrax",
"maintainer": "swiftrax",
"width": 19.5,
"height": 7.5,
"layouts": {
"LAYOUT_all": {
"layout": [
{"label":"0,0", "x":0, "y":0},
{"label":"1,0", "x":1.25, "y":0},
{"label":"0,1", "x":2.25, "y":0},
{"label":"1,1", "x":3.25, "y":0},
{"label":"0,2", "x":4.25, "y":0},
{"label":"1,2", "x":5.5, "y":0},
{"label":"0,3", "x":6.5, "y":0},
{"label":"1,3", "x":7.5, "y":0},
{"label":"0,4", "x":8.5, "y":0},
{"label":"1,4", "x":9.75, "y":0},
{"label":"0,5", "x":10.75, "y":0},
{"label":"1,5", "x":11.75, "y":0},
{"label":"0,6", "x":12.75, "y":0},
{"label":"0,7", "x":15.5, "y":0},
{"label":"1,7", "x":16.5, "y":0},
{"label":"0,8", "x":17.5, "y":0},
{"label":"1,8", "x":18.5, "y":0},

{"label":"2,0", "x":0, "y":1},
{"label":"3,0", "x":1.25, "y":1},
{"label":"2,1", "x":2.25, "y":1},
{"label":"3,1", "x":3.25, "y":1},
{"label":"2,2", "x":4.25, "y":1},
{"label":"3,2", "x":5.5, "y":1},
{"label":"2,3", "x":6.5, "y":1},
{"label":"3,3", "x":7.5, "y":1},
{"label":"2,4", "x":8.5, "y":1},
{"label":"3,4", "x":9.75, "y":1},
{"label":"2,5", "x":10.75, "y":1},
{"label":"3,5", "x":11.75, "y":1},
{"label":"2,6", "x":12.75, "y":1},
{"label":"2,7", "x":15.5, "y":1},
{"label":"3,7", "x":16.5, "y":1},
{"label":"2,8", "x":17.5, "y":1},
{"label":"3,8", "x":18.5, "y":1},

{"label":"4,0", "x":0, "y":2.25},
{"label":"5,0", "x":1, "y":2.25},
{"label":"4,1", "x":2, "y":2.25},
{"label":"5,1", "x":3, "y":2.25},
{"label":"4,2", "x":4, "y":2.25},
{"label":"5,2", "x":5, "y":2.25},
{"label":"4,3", "x":6, "y":2.25},
{"label":"5,3", "x":7, "y":2.25},
{"label":"4,4", "x":8, "y":2.25},
{"label":"5,4", "x":9, "y":2.25},
{"label":"4,5", "x":10, "y":2.25},
{"label":"5,5", "x":11, "y":2.25},
{"label":"4,6", "x":12, "y":2.25},
{"label":"5,6", "x":13, "y":2.25},
{"label":"9,6", "x":14, "y":2.25},
{"label":"4,7", "x":15.5, "y":2.25},
{"label":"5,7", "x":16.5, "y":2.25},
{"label":"4,8", "x":17.5, "y":2.25},
{"label":"5,8", "x":18.5, "y":2.25},

{"label":"6,0", "x":0, "y":3.25, "w":1.5},
{"label":"7,0", "x":1.5, "y":3.25},
{"label":"6,1", "x":2.5, "y":3.25},
{"label":"7,1", "x":3.5, "y":3.25},
{"label":"6,2", "x":4.5, "y":3.25},
{"label":"7,2", "x":5.5, "y":3.25},
{"label":"6,3", "x":6.5, "y":3.25},
{"label":"7,3", "x":7.5, "y":3.25},
{"label":"6,4", "x":8.5, "y":3.25},
{"label":"7,4", "x":9.5, "y":3.25},
{"label":"6,5", "x":10.5, "y":3.25},
{"label":"7,5", "x":11.5, "y":3.25},
{"label":"6,6", "x":12.5, "y":3.25},
{"label":"7,6", "x":13.5, "y":3.25, "w":1.5},
{"label":"6,7", "x":15.5, "y":3.25},
{"label":"7,7", "x":16.5, "y":3.25},
{"label":"6,8", "x":17.5, "y":3.25},
{"label":"7,8", "x":18.5, "y":3.25},

{"label":"8,0", "x":0, "y":4.25, "w":1.75},
{"label":"9,0", "x":1.75, "y":4.25},
{"label":"8,1", "x":2.75, "y":4.25},
{"label":"9,1", "x":3.75, "y":4.25},
{"label":"8,2", "x":4.75, "y":4.25},
{"label":"9,2", "x":5.75, "y":4.25},
{"label":"8,3", "x":6.75, "y":4.25},
{"label":"9,3", "x":7.75, "y":4.25},
{"label":"8,4", "x":8.75, "y":4.25},
{"label":"9,4", "x":9.75, "y":4.25},
{"label":"8,5", "x":10.75, "y":4.25},
{"label":"9,5", "x":11.75, "y":4.25},
{"label":"8,6", "x":12.75, "y":4.25, "w":2.25},
{"label":"8,7", "x":15.5, "y":4.25},
{"label":"9,7", "x":16.5, "y":4.25},
{"label":"8,8", "x":17.5, "y":4.25},
{"label":"9,8", "x":18.5, "y":4.25},

{"label":"10,0", "x":0, "y":5.25, "w":2.25},
{"label":"11,0", "x":2.25, "y":5.25},
{"label":"10,1", "x":3.25, "y":5.25},
{"label":"11,1", "x":4.25, "y":5.25},
{"label":"10,2", "x":5.25, "y":5.25},
{"label":"11,2", "x":6.25, "y":5.25},
{"label":"10,3", "x":7.25, "y":5.25},
{"label":"11,3", "x":8.25, "y":5.25},
{"label":"10,4", "x":9.25, "y":5.25},
{"label":"11,4", "x":10.25, "y":5.25},
{"label":"10,5", "x":11.25, "y":5.25},
{"label":"10,6", "x":12.25, "y":5.25, "w":1.75},
{"label":"11,6", "x":14.25, "y":5.5},
{"label":"10,7", "x":15.5, "y":5.25},
{"label":"11,7", "x":16.5, "y":5.25},
{"label":"10,8", "x":17.5, "y":5.25},
{"label":"11,8", "x":18.5, "y":5.25},

{"label":"12,0", "x":0, "y":6.25, "w":1.25},
{"label":"13,0", "x":1.25, "y":6.25, "w":1.25},
{"label":"12,1", "x":2.5, "y":6.25, "w":1.25},
{"label":"12,2", "x":3.75, "y":6.25, "w":6.25},
{"label":"12,4", "x":10, "y":6.25},
{"label":"13,4", "x":11, "y":6.25},
{"label":"12,5", "x":12, "y":6.25},
{"label":"12,6", "x":13.25, "y":6.5},
{"label":"13,6", "x":14.25, "y":6.5},
{"label":"12,7", "x":15.25, "y":6.5},
{"label":"13,7", "x":16.5, "y":6.25},
{"label":"12,8", "x":17.5, "y":6.25},
{"label":"13,8", "x":18.5, "y":6.25}
]
}
}
}
105 changes: 105 additions & 0 deletions keyboards/handwired/swiftrax/the_galleon/keymaps/default/keymap.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
/* Copyright 2021 swiftrax
*
* 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

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

[0] = LAYOUT_all(
KC_MUTE, KC_F13, KC_F14, KC_F15, KC_F16, KC_F17, KC_F18, KC_F19, KC_F20, KC_F21, KC_F22, KC_F23, KC_F24, KC_MPRV, KC_VOLU, KC_VOLD, KC_MNXT,
KC_ESC, 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_HOME, KC_PGUP, KC_PGDN, KC_END,
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_DEL, KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_P7, KC_P8, KC_P9, KC_PPLS,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_P4, KC_P5, KC_P6, KC_PPLS,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_P1, KC_P2, KC_P3, KC_PENT,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, KC_PDOT, KC_PENT),
[1] = LAYOUT_all(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
[2] = LAYOUT_all(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
};

#ifdef OLED_DRIVER_ENABLE

oled_rotation_t oled_init_user(oled_rotation_t rotation) {
return OLED_ROTATION_0;
}

#define IDLE_FRAMES 2
#define IDLE_SPEED 10

#define ANIM_SIZE 600 // number of bytes in array, minimize for adequate firmware size, max is 1024
#define ANIM_FRAME_DURATION 200 //how long each frame lasts in ms

uint32_t anim_timer = 0;
uint32_t anim_sleep = 0;
uint8_t current_idle_frame = 0;

static void render_anim(void){
static const char PROGMEM idle[IDLE_FRAMES][ANIM_SIZE] = {
{
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 7, 12, 56,224,128, 0,128,128,192,192,192, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 64,128, 0, 8, 48, 64, 0, 24,224, 0, 0, 0,192, 32, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,128, 64,255,255,255,255,255,255,255,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2,130,132, 72, 72, 8,192,225,242,248,252,252,252,252,248,240,225,192, 4, 2, 34, 18, 9, 8, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 48, 24, 14, 3, 28,112,255,255,255,255,255,255,255, 0, 0, 0, 0, 0, 0, 0,255,255,254,252,252,252,124, 62, 30, 15, 7, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 17, 16, 16, 8,136, 64, 35, 7, 15,159, 63, 63, 63,191, 31, 15, 7, 3, 96,128, 2, 18, 33, 33, 65, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,192, 96, 56, 8, 7, 3, 7, 7, 15, 15, 31,112, 0, 0, 0, 0, 0, 0, 0, 3, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 12, 2, 1, 0, 0, 0, 1, 6, 8, 0, 0, 0, 0, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
},
{
0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2, 4, 4, 8, 48,224,128, 0,128,128,192,192,192, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 64,128, 8, 48, 64, 0, 24,224, 0, 0, 0,192, 32, 0, 0, 0, 0,128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,255,255,255,255,255,255,255,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128,128, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 32, 34, 34, 34, 68, 68, 4,192,225,242,248,252,252,252,252,248,241,224,192, 2, 1, 17, 9,132,132,132, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 64, 32, 16, 8, 20,114,255,255,255,255,255,255,255, 0, 0, 0, 0, 0, 0, 0,127,255,254,252,124, 60, 28, 30, 14, 7, 3, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8, 8, 8, 4,132, 64, 35, 7,143, 31, 63, 63, 63, 63, 31, 15, 7, 3, 96,128, 1, 17, 32, 32, 64, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,127,131, 7, 7, 15, 15, 31,112, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 12, 2, 1, 0, 0, 0, 0, 7, 8, 0, 0, 0, 0, 0, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
}
};
void animation_phase(void) {
current_idle_frame = (current_idle_frame + 1) % IDLE_FRAMES;
oled_write_raw_P(idle[abs((IDLE_FRAMES-1)-current_idle_frame)], ANIM_SIZE);
}

if(get_current_wpm() != 000) {
oled_on(); // not essential but turns on animation OLED with any alpha keypress
if(timer_elapsed32(anim_timer) > ANIM_FRAME_DURATION) {
anim_timer = timer_read32();
animation_phase();
}
anim_sleep = timer_read32();
}
else {
if(timer_elapsed32(anim_sleep) > OLED_TIMEOUT)
oled_off();
else {
if(timer_elapsed32(anim_timer) > ANIM_FRAME_DURATION) {
anim_timer = timer_read32();
animation_phase();
}
}
}
}

void oled_task_user(void) {
render_anim();
}
#endif
1 change: 1 addition & 0 deletions keyboards/handwired/swiftrax/the_galleon/keymaps/default/rules.mk
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
WPM_ENABLE = yes
Loading

0 comments on commit fe68657

Please sign in to comment.