Skip to content

Commit

Permalink
[Keyboard] Add keypad Satxri6key (#13423)
Browse files Browse the repository at this point in the history
Co-authored-by: Ryan <fauxpark@gmail.com>
  • Loading branch information
MaiTheSan and fauxpark authored Jul 22, 2021
1 parent 8e905a7 commit 92cca84
Show file tree
Hide file tree
Showing 11 changed files with 399 additions and 0 deletions.
77 changes: 77 additions & 0 deletions keyboards/sawnsprojects/satxri6key/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/* Copyright 2021 SawnsProjects
*
* 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 0x5350
#define PRODUCT_ID 0x0727
#define DEVICE_VER 0x0001
#define MANUFACTURER MaiTheSan
#define PRODUCT Satxri6key

/* key matrix size */
#define MATRIX_ROWS 2
#define MATRIX_COLS 3

/*
* 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 { F7, F6 }
#define MATRIX_COL_PINS { F1, F4, F5 }

#define DIODE_DIRECTION COL2ROW

#define RGB_DI_PIN F0
#ifdef RGB_DI_PIN
#define RGBLED_NUM 6
#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
#endif

#define DRIVER_LED_TOTAL 6
#define RGB_MATRIX_KEYPRESSES // reacts to keypresses
#define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
#define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
#define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
#define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
#define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
#define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_REACTIVE_SIMPLE // Sets the default mode, if none has been set
20 changes: 20 additions & 0 deletions keyboards/sawnsprojects/satxri6key/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"keyboard_name": "Satxri6key",
"url": "",
"maintainer": "qmk",
"width": 3,
"height": 2,
"layouts": {
"LAYOUT": {
"layout": [
{"label":"K00 (F7,F1)", "x":0, "y":1},
{"label":"K01 (F7,F4)", "x":1, "y":1},
{"label":"K02 (F7,F5)", "x":2, "y":1},
{"label":"K10 (F6,F1)", "x":0, "y":2},
{"label":"K11 (F6,F4)", "x":1, "y":2},
{"label":"K12 (F6,F5)", "x":2, "y":2}
]
}
}
,"meta": "https://noroadsleft.github.io/kbf_qmk_converter/"
}
34 changes: 34 additions & 0 deletions keyboards/sawnsprojects/satxri6key/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/* Copyright 2021 SawnsProjects
*
* 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(

KC_ESC, KC_GRV, TO(1),
KC_Z, KC_X, KC_C ),

[1] = LAYOUT(

KC_TRNS, KC_TRNS, TO(0),
KC_TRNS, KC_TRNS, KC_TRNS ),


};

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Default Satxri6key Layout
4 changes: 4 additions & 0 deletions keyboards/sawnsprojects/satxri6key/keymaps/default/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
VIA_ENABLE = no
RGBLIGHT_ENABLE = no
RGB_MATRIX_ENABLE = yes
RGB_MATRIX_DRIVER = WS2812
164 changes: 164 additions & 0 deletions keyboards/sawnsprojects/satxri6key/keymaps/via/keymap.c

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions keyboards/sawnsprojects/satxri6key/keymaps/via/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
VIA_ENABLE = yes
OLED_DRIVER_ENABLE = no
WPM_ENABLE = no
RGBLIGHT_ENABLE = yes
LTO_ENABLE = no
15 changes: 15 additions & 0 deletions keyboards/sawnsprojects/satxri6key/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# satxri6key

![satxri6key](https://cdn.discordapp.com/attachments/860603126151512084/860671133778182194/20210703_051841.jpg)

A 6% (2x3) ortholinear keyboard kit made and sold by SawnsProjects in TamHuyetTournament (Osu! Group).

* Keyboard Maintainer: [Mai The San](https://github.com/MaiTheSan)
* Hardware Supported: Satxri6key
* Hardware Availability: [GitHub](https://github.com/MaiTheSan/Satxri6key)

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

make sawnsprojects/satxri6key: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).
21 changes: 21 additions & 0 deletions keyboards/sawnsprojects/satxri6key/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
# change yes to no to disable
#
BOOTMAGIC_ENABLE = lite # 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
BLUETOOTH_ENABLE = no # Enable Bluetooth
AUDIO_ENABLE = no # Audio output
31 changes: 31 additions & 0 deletions keyboards/sawnsprojects/satxri6key/satxri6key.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/* Copyright 2021 SawnsProjects
*
* 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 "satxri6key.h"
#ifdef RGB_MATRIX_ENABLE
led_config_t g_led_config = { {
//Key Matrix to LED Indexccxxz
{0, 1, 2},
{5, 4, 3}
}, {
//LED Index to Physical Positon
{0, 0}, {112, 0}, {224, 0},
{224, 64}, {112, 64}, {0, 64},
}, {
1, 1, 1,
1, 1, 1,
} };
#endif
27 changes: 27 additions & 0 deletions keyboards/sawnsprojects/satxri6key/satxri6key.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/* Copyright 2021 SawnsProjects
*
* 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(\
K00, K01, K02,\
K10, K11, K12\
) { \
{ K00, K01, K02 },\
{ K10, K11, K12 } \
}

0 comments on commit 92cca84

Please sign in to comment.