Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Keyboard] Add keyboard reviung46 #24245

Merged
merged 14 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 113 additions & 0 deletions keyboards/reviung/reviung46/keyboard.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
{
"keyboard_name": "reviung46",
"manufacturer": "gtips",
"url": "https://github.com/gtips/reviung/tree/master/reviung46/",
"maintainer": "gtips",
"usb": {
"vid": "0x4E95",
"pid": "0x4E19",
"device_version": "0.0.1"
},
"rgblight": {
"hue_steps": 16,
"saturation_steps": 16,
"brightness_steps": 16,
"led_count": 10,
"sleep": true,
"animations": {
"breathing": true,
"rainbow_mood": true,
"rainbow_swirl": true,
"snake": true,
"knight": true,
"christmas": true,
"static_gradient": true,
"rgb_test": true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"rgb_test": true,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.
I fixed it.

"alternating": true,
"twinkle": true
}
},
"ws2812": {
"pin": "D3"
},
"features": {
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": false,
"nkro": false,
waffle87 marked this conversation as resolved.
Show resolved Hide resolved
"rgblight": true
},
"qmk": {
"locking": {
"enabled": true,
"resync": true
}
},
"matrix_pins": {
"cols": ["B5", "C6", "D4", "D0", "D1", "D2"],
"rows": ["B6", "B2", "B3", "B1", "F7", "F6", "F5", "F4"]
},
"diode_direction": "COL2ROW",
"processor": "atmega32u4",
"bootloader": "caterina",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"processor": "atmega32u4",
"bootloader": "caterina",
"development_board": "promicro",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.
I fixed it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't appear so, did you forget to push this change?

Copy link
Contributor Author

@gtips gtips Aug 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed it and pushed it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lines suggested for removal have not been removed. They are not needed when using development_board.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.
I fixed it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed it.
Request review.

"layout_aliases": {
"LAYOUT_reviung53": "LAYOUT"
},
waffle87 marked this conversation as resolved.
Show resolved Hide resolved
"layouts": {
"LAYOUT": {
"layout": [
{"matrix": [0, 0], "x": 2, "y": 0, "w": 1.5},
{"matrix": [0, 1], "x": 3.5, "y": 0},
{"matrix": [0, 2], "x": 4.5, "y": 0},
{"matrix": [0, 3], "x": 5.5, "y": 0},
{"matrix": [0, 4], "x": 6.5, "y": 0},
{"matrix": [0, 5], "x": 7.5, "y": 0},
{"matrix": [4, 0], "x": 8.5, "y": 0},
{"matrix": [4, 1], "x": 9.5, "y": 0},
{"matrix": [4, 2], "x": 10.5, "y": 0},
{"matrix": [4, 3], "x": 11.5, "y": 0},
{"matrix": [4, 4], "x": 12.5, "y": 0},
{"matrix": [4, 5], "x": 13.5, "y": 0, "w": 1.5},

{"matrix": [1, 0], "x": 2, "y": 1, "w": 1.75},
{"matrix": [1, 1], "x": 3.75, "y": 1},
{"matrix": [1, 2], "x": 4.75, "y": 1},
{"matrix": [1, 3], "x": 5.75, "y": 1},
{"matrix": [1, 4], "x": 6.75, "y": 1},
{"matrix": [1, 5], "x": 7.75, "y": 1},
{"matrix": [5, 0], "x": 8.75, "y": 1},
{"matrix": [5, 1], "x": 9.75, "y": 1},
{"matrix": [5, 2], "x": 10.75, "y": 1},
{"matrix": [5, 3], "x": 11.75, "y": 1},
{"matrix": [5, 4], "x": 12.75, "y": 1},
{"matrix": [5, 5], "x": 13.75, "y": 1, "w": 1.25},

{"matrix": [2, 0], "x": 1, "y": 2.25},
{"matrix": [2, 1], "x": 2.25, "y": 2, "w": 2},
{"matrix": [2, 2], "x": 4.25, "y": 2},
{"matrix": [2, 3], "x": 5.25, "y": 2},
{"matrix": [2, 4], "x": 6.25, "y": 2},
{"matrix": [2, 5], "x": 7.25, "y": 2},
{"matrix": [6, 0], "x": 8.25, "y": 2},
{"matrix": [6, 1], "x": 9.25, "y": 2},
{"matrix": [6, 2], "x": 10.25, "y": 2},
{"matrix": [6, 3], "x": 11.25, "y": 2},
{"matrix": [6, 4], "x": 12.25, "y": 2},
{"matrix": [6, 5], "x": 13.25, "y": 2, "w": 1.75},

{"matrix": [3, 0], "x": 0, "y": 3.25},
{"matrix": [3, 1], "x": 1, "y": 3.25},
{"matrix": [3, 2], "x": 2, "y": 3.25},
{"matrix": [3, 3], "x": 3.25, "y": 3, "w": 1.5},
{"matrix": [3, 4], "x": 4.75, "y": 3, "w": 1.25},
{"matrix": [3, 5], "x": 6, "y": 3, "w": 2.25},
{"matrix": [7, 0], "x": 8.25, "y": 3, "w": 2.75},
{"matrix": [7, 1], "x": 11, "y": 3, "w": 1.25},
{"matrix": [7, 2], "x": 12.25, "y": 3, "w": 1.25},
{"matrix": [7, 3], "x": 13.5, "y": 3, "w": 1.5}
]
}
}
}
51 changes: 51 additions & 0 deletions keyboards/reviung/reviung46/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright 2024 gtips (@gtips)
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H

// Defines names for use in layer keycodes and the keymap
enum layer_names {
_BASE,
_LOWER,
_RAISE,
_ADJUST
drashna marked this conversation as resolved.
Show resolved Hide resolved
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define ADJUST MO(_ADJUST)

waffle87 marked this conversation as resolved.
Show resolved Hide resolved
#define SF_SS RSFT_T(KC_SLSH)
#define SP_LO LT(LOWER, KC_SPC)
#define SP_RA LT(RAISE, KC_SPC)
waffle87 marked this conversation as resolved.
Show resolved Hide resolved

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_BASE] = LAYOUT(
drashna marked this conversation as resolved.
Show resolved Hide resolved
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT,
KC_UP, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, SF_SS,
KC_LEFT, KC_DOWN, KC_RGHT, KC_LCTL, KC_LALT, SP_LO, SP_RA, KC_LALT, KC_RGUI, KC_RCTL
),
[_LOWER] = LAYOUT(
drashna marked this conversation as resolved.
Show resolved Hide resolved
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
_______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, XXXXXXX, KC_QUOT,
_______, _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, XXXXXXX, XXXXXXX, XXXXXXX, KC_SLSH,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[_RAISE] = LAYOUT(
drashna marked this conversation as resolved.
Show resolved Hide resolved
KC_ESC, 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_LBRC, KC_RBRC, KC_BSLS, KC_HOME, KC_END, KC_PGUP, KC_PGDN, XXXXXXX, KC_DQUO,
_______, _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, XXXXXXX, XXXXXXX, XXXXXXX, KC_QUES,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[_ADJUST] = LAYOUT(
drashna marked this conversation as resolved.
Show resolved Hide resolved
RGB_VAI, RGB_SAI, RGB_HUI, RGB_MOD, XXXXXXX, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
RGB_VAD, RGB_SAD, RGB_HUD, RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RGB_VAI, RGB_SAI, RGB_HUI, RGB_MOD, XXXXXXX, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
RGB_VAD, RGB_SAD, RGB_HUD, RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
UG_VALU, UG_SATU, UG_HUEU, UG_NEXT, XXXXXXX, UG_TOGG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
UG_VALD, UG_SATD, UG_HUED, UG_PREV, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.
I fixed it.

KC_VOLU, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
KC_MUTE, KC_VOLD, KC_MPLY, XXXXXXX, XXXXXXX, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX
),
drashna marked this conversation as resolved.
Show resolved Hide resolved
};

layer_state_t layer_state_set_user(layer_state_t state) {
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
}
51 changes: 51 additions & 0 deletions keyboards/reviung/reviung46/keymaps/via/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Copyright 2021 gtips (@gtips)
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H

// Defines names for use in layer keycodes and the keymap
enum layer_names {
_BASE,
_LOWER,
_RAISE,
_ADJUST
};

#define LOWER MO(_LOWER)
#define RAISE MO(_RAISE)
#define ADJUST MO(_ADJUST)

waffle87 marked this conversation as resolved.
Show resolved Hide resolved
#define SF_SS RSFT_T(KC_SLSH)
#define SP_LO LT(LOWER, KC_SPC)
#define SP_RA LT(RAISE, KC_SPC)
waffle87 marked this conversation as resolved.
Show resolved Hide resolved

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_BASE] = LAYOUT(
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT,
KC_UP, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, SF_SS,
KC_LEFT, KC_DOWN, KC_RGHT, KC_LCTL, KC_LALT, SP_LO, SP_RA, KC_LALT, KC_RGUI, KC_RCTL
),
[_LOWER] = LAYOUT(
KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL,
_______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, XXXXXXX, KC_QUOT,
_______, _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, XXXXXXX, XXXXXXX, XXXXXXX, KC_SLSH,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[_RAISE] = LAYOUT(
KC_ESC, 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_LBRC, KC_RBRC, KC_BSLS, KC_HOME, KC_END, KC_PGUP, KC_PGDN, XXXXXXX, KC_DQUO,
_______, _______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, XXXXXXX, XXXXXXX, XXXXXXX, KC_QUES,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
[_ADJUST] = LAYOUT(
RGB_VAI, RGB_SAI, RGB_HUI, RGB_MOD, XXXXXXX, RGB_TOG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
RGB_VAD, RGB_SAD, RGB_HUD, RGB_RMOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
KC_VOLU, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, QK_BOOT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
KC_MUTE, KC_VOLD, KC_MPLY, XXXXXXX, XXXXXXX, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX
),
};

layer_state_t layer_state_set_user(layer_state_t state) {
return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
}
1 change: 1 addition & 0 deletions keyboards/reviung/reviung46/keymaps/via/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VIA_ENABLE = yes
27 changes: 27 additions & 0 deletions keyboards/reviung/reviung46/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# reviung46

![reviung46](https://github.com/gtips/reviung/blob/master/reviung46/image/reviung46-01.jpg)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image here shows multiple layouts are capable, so there should probably be more than 1 defined in keyboard.json

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.
I designed the PCB so that multiple key layouts can work with one layout keyboard.json.
I have confirmed that it works properly on the test board.
The PCB design is similar to REVIUNG53.
https://github.com/gtips/reviung/tree/master/reviung53

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@zvecr zvecr Aug 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I designed the PCB so that multiple key layouts can work with one layout keyboard.json.

Incorrect. Your PCB clearly supports multiple layouts. The expectation is that you add multiple layout macros to support these.

Request review.

There is nothing to review as you have not implemented the extra layouts in keyboard.json.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m so sorry.
It was my lack of understanding.
The last time I made a keyboard was three years ago, so I mixed up the way I did it three years ago.

I've fixed keyboard.json so I'm requesting a review.


The REVIUNG46 is 42-46 key keyboard.

* Keyboard Maintainer: [gtips](https://github.com/gtips)
* Hardware Supported: REVIUNG46 PCB.
* Hardware Availability: [PCB & Case Data](https://github.com/gtips/reviung/tree/master/reviung46)

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

make reviung46:default

Flashing example for this keyboard:

make reviung46: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 `QK_BOOT` if it is available