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

Brick #19851

Merged
merged 13 commits into from
Feb 18, 2023
24 changes: 0 additions & 24 deletions keyboards/brick/readme.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright 2023 Juno Nguyen <juno.ngx@gmail.com>
/* Copyright 2023 Jason Chestnut <pauperboards@gmail.com> @pauperboards
*
* 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
Expand Down Expand Up @@ -28,4 +28,4 @@ bool encoder_update_kb(uint8_t index, bool clockwise) {
}
return true;
}
#endif
#endif
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright 2023 Juno Nguyen <juno.ngx@gmail.com>
/* Copyright 2023 Jason Chestnut <pauperboards@gmail.com> @pauperboards
*
* 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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright 2023 Juno Nguyen <juno.ngx@gmail.com>
/* Copyright 2023 Jason Chestnut <pauperboards@gmail.com> @pauperboards
pauperboards marked this conversation as resolved.
Show resolved Hide resolved
*
* 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
Expand Down Expand Up @@ -41,4 +41,4 @@
#endif

#define ENCODERS_PAD_A { F4 }
#define ENCODERS_PAD_B { F5 }
#define ENCODERS_PAD_B { F5 }
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"keyboard_name": "Brick",
"manufacturer": "Pauper",
"manufacturer": "pauperboards",
"url": "https://p3dstore.com/products/cervello-pcb-only-group-buy",
"maintainer": "JunoNgx",
"maintainer": "pauper",
"usb": {
"vid": "0xFEFE",
"pid": "0x0001",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
/* Copyright 2023 Juno Nguyen <juno.ngx@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/>.
*/

drashna marked this conversation as resolved.
Show resolved Hide resolved
#include QMK_KEYBOARD_H
pauperboards marked this conversation as resolved.
Show resolved Hide resolved

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
Expand All @@ -24,16 +8,16 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | Tab | A | S | D | F | G | H | J | K | L | ; | " |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | Shift| Z | X | C | V | B | N | M | , | . | Up |Enter |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Ctrl | GUI | Caps | Alt |Layer1| Space |Layer2| / | Left | Down |Right |
* `-----------------------------------------------------------------------------------'
* | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
* `------+------+------+------+------+------+------+------+------+------+------+------'
* | Caps | Ctrl | Alt | Space L1 | Space L2 | Alt | GUI | Ctrl |
* `---------------------------------------------------------------------'
*/
[0] = LAYOUT_ortho_4x12 (
[0] = LAYOUT_ortho_2x2u (
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, 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_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_ENT,
KC_LCTL, KC_LGUI, KC_CAPS, KC_LALT, MO(1), KC_SPC, KC_SPC, MO(2), KC_SLSH, KC_LEFT, KC_DOWN, KC_RGHT
KC_CAPS, KC_LCTL, KC_LALT, LT(1,KC_SPC), LT(2,KC_SPC), KC_LALT, KC_LGUI, KC_LCTL
),

/* Layer 1
Expand All @@ -42,16 +26,16 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* |------+------+------+------+------+-------------+------+------+------+------+------|
* | | Vol- | Vol+ | Mute | | | | F11 | F12 | | | |
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | | | | | | | | | | | | |
* | | | | | | | | | | | | RST |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | Reset| | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
* | | | | | | | | |
* `---------------------------------------------------------------------'
*/
[1] = LAYOUT_ortho_4x12 (
[1] = LAYOUT_ortho_2x2u (
KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, _______,
_______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______, _______, KC_F11, KC_F12, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, QK_BOOT,
_______, _______, _______, _______, _______, _______, _______, _______
),

/* Layer 2 (r_ Indicates RGB Controls)
Expand All @@ -62,13 +46,58 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* |------+------+------+------+------+------|------+------+------+------+------+------|
* | |BL_TOG|BL_STEP| | | | | | | | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | | | | | |
* `-----------------------------------------------------------------------------------'
* | | | | | | | | |
* `---------------------------------------------------------------------'
*/
[2] = LAYOUT_ortho_4x12 (
[2] = LAYOUT_ortho_2x2u (
_______, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______,
_______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, _______, _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS,
_______, BL_TOGG, BL_STEP, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
_______, _______, _______, _______, _______, _______, _______, _______
)
};


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) {

if (IS_LED_ON(usb_led, USB_LED_NUM_LOCK)) {

} else {

}

if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {

} else {

}

if (IS_LED_ON(usb_led, USB_LED_SCROLL_LOCK)) {

} else {

}

if (IS_LED_ON(usb_led, USB_LED_COMPOSE)) {

} else {

}

if (IS_LED_ON(usb_led, USB_LED_KANA)) {

} else {

}

}
pauperboards marked this conversation as resolved.
Show resolved Hide resolved
28 changes: 28 additions & 0 deletions keyboards/pauperboards/brick/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Brick

![Brick, top view](https://i.imgur.com/BLJ6Tum.jpg)
![Brick, layout options](https://i.imgur.com/JhsWzY7.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
![Brick, top view](https://i.imgur.com/BLJ6Tum.jpg)
![Brick, layout options](https://i.imgur.com/JhsWzY7.png)
![Brick, top view](https://i.imgur.com/BLJ6Tumh.jpg)
![Brick, layout options](https://i.imgur.com/JhsWzY7h.png)

per the PR checklist:

if imgur is used, images should be resized appropriately: append “h” to the image url i.e. https://i.imgur.com/vqgE7Ok.jpg becomes https://i.imgur.com/vqgE7Okh.jpg

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in next push.


Brick is a 12u, 4 row ortholinear keyboard designed as a drop in replacement for PCBs like the Niu Mini. Brick features a USB-C port, an ATMega32u4, RGB underglow, three possible rotary encoder locations, and multiple ortho layout options.

* Keyboard Maintainer: [pauper](https://github.com/pauperboards)
* Hardware Supported:
* Brick v0.1 - prototype first run with red solder mask and needing a bodge wire across the top row encoder location.
* Brick v0.2 - same layout and components as v0.1, but with the bodge fixed. This version was run as part of Cervello group buy by [P3DStore](http://p3dstore.com).
* Hardware Availability: Some remaining pcbs might be available for purchase from [P3D](http://p3dstore.com/collections/pcbs/products/cervello-pcb-only-group-buy).

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

make pauper/brick:default

Flashing example for this keyboard:

make pauper/brick:default:flash
pauperboards marked this conversation as resolved.
Show resolved Hide resolved

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 one of 2 ways:

* **Physical Reset Button**: Briefly press the button on the underside of the pcb, near the MCU.
* **Keycode**: Press the key mapped to `QK_BOOT` in your keymap, if available.
File renamed without changes.
34 changes: 34 additions & 0 deletions users/pauper/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
pauperboards marked this conversation as resolved.
Show resolved Hide resolved
* Copyright 2023 Jason Chestnut <jason.chestnut@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

// Tapping term settings
#define COMBO_COUNT 1
#define TAPPING_TERM 150
#define IGNORE_MOD_TAP_INTERRUPT

#ifdef RGBLIGHT_ENABLE
# define RGBLIGHT_SLEEP
# define RBG_HUE_STEP 16
# define RGB_SAT_STEP 16
# define RGB_VAL_STEP 16

# define RBGLIGHT_EFFECT_BREATHING
# define RBGLIGHT_EFFECT_KNIGHT
# define RBGLIGHT_EFFECT_SNAKE
# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
#endif
16 changes: 16 additions & 0 deletions users/pauper/pauper.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Copyright 2023 Jason Chestnut <jason.chestnut@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/>.
*/
82 changes: 82 additions & 0 deletions users/pauper/pauper.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/*
* Copyright 2023 Jason Chestnut <jason.chestnut@gmail.com> @pauperboards
*
* 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 QMK_KEYBOARD_H

#include "wrappers.h"

enum userspace_layers {
_BASE,
_NAV,
_SYMBOL,
_NUMBER,
_ADJUST
};

enum userspace_keycodes {
BASE = SAFE_RANGE,
NAV,
SYMBOL,
NUMBER,
ADJUST
};

/*
* Mod-taps.
*/
#define KC_CTLA MT(MOD_LCTL, KC_A)
#define KC_ALTS MT(MOD_LALT, KC_S)
#define KC_SFTD MT(MOD_LSFT, KC_D)
#define KC_GUIF MT(MOD_LGUI, KC_F)

#define KC_GUIJ MT(MOD_LGUI, KC_J)
#define KC_SFTK MT(MOD_LSFT, KC_K)
#define KC_ALTL MT(MOD_LALT, KC_L)
#define KC_CTLCLN MT(MOD_LCTL, KC_SCLN)

#define KC_SFTLP MT(MOD_LSFT, KC_LPRN)

/*
* Layer-taps.
*/
#define LT_NUM LT(_NUMBER, KC_BSPC)
#define LT_NAV LT(_NAV, KC_ESC)
#define LT_SYM LT(_SYMBOL, KC_SPC)
#define LT_ADJ LT(_ADJUST, KC_ENT)

/*
* Key shortcuts.
*/
#define DT_NXT LCTL(KC_RGHT)
#define DT_PRV LCTL(KC_LEFT)

/*
* Common key combos used in multiple keymaps.
*/

#ifdef COMBO_ENABLE
enum combos {
ESC_COMBO
};

const uint16_t PROGMEM esc_combo [] = {KC_Q, KC_W, COMBO_END};

combo_t key_combos[COMBO_COUNT] = {
[ESC_COMBO] = COMBO(esc_combo, KC_ESC)
};
#endif

24 changes: 24 additions & 0 deletions users/pauper/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Copyright 2023 Jason Chestnut <jason.chestnut@gmail.com> @pauperboards @shurikai

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/>.

# Overview

My user-space sets up a common keymap for use with most of the boards I own.
Extensive reuse from @Drashna as a starting point.

My usercode utilizes the layout wrappers contained in [wrappers.h](wrappers.h).
All of the keymaps are derivative of the Ferris 34-key keymap.

more to follow ...
Loading