Skip to content

Commit f032cc7

Browse files
tommyalatalodrashnafauxpark
authored andcommitted
[Keyboard] Add alt34 keyboard (qmk#17223)
* Add files for alt34 keyboard * Add link to hardware bill of materials for alt34 * Change keyboard image link to imgur * Remove platform specific defines from rev1.h * Remove bluetooth and sleep led rules etc * Add GPL license header to all source code files * Shorten comment for NKRO_ENABLE Co-authored-by: Drashna Jaelre <drashna@live.com> * Simplify option usage comment in rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Set imgur link to largest size option Co-authored-by: Drashna Jaelre <drashna@live.com> * Move rules.mk into rev1 folder entirely * Remove .noci file * Update keyboards/alt34/rev1/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
1 parent a37da81 commit f032cc7

File tree

11 files changed

+367
-0
lines changed

11 files changed

+367
-0
lines changed

keyboards/alt34/alt34.c

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#include "alt34.h"

keyboards/alt34/alt34.h

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#include "quantum.h"
21+
22+
#ifdef KEYBOARD_alt34_rev1
23+
#include "rev1.h"
24+
#endif

keyboards/alt34/config.h

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#include "config_common.h"

keyboards/alt34/info.json

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
{
2+
"keyboard_name": "alt34",
3+
"url": "https://gitlab.com/altosys/alt34",
4+
"maintainer": "@altosys",
5+
"layouts": {
6+
"LAYOUT_split_3x5_2": {
7+
"layout": [
8+
{"x": 0, "y": 0.93},
9+
{"x": 1, "y": 0.31},
10+
{"x": 2, "y": 0},
11+
{"x": 3, "y": 0.28},
12+
{"x": 4, "y": 0.42},
13+
14+
{"x": 7, "y": 0.42},
15+
{"x": 8, "y": 0.28},
16+
{"x": 9, "y": 0},
17+
{"x": 10, "y": 0.31},
18+
{"x": 11, "y": 0.93},
19+
20+
{"x": 0, "y": 1.93},
21+
{"x": 1, "y": 1.31},
22+
{"x": 2, "y": 1},
23+
{"x": 3, "y": 1.28},
24+
{"x": 4, "y": 1.42},
25+
26+
{"x": 7, "y": 1.42},
27+
{"x": 8, "y": 1.28},
28+
{"x": 9, "y": 1},
29+
{"x": 10, "y": 1.31},
30+
{"x": 11, "y": 1.93},
31+
32+
{"x": 0, "y": 2.93},
33+
{"x": 1, "y": 2.31},
34+
{"x": 2, "y": 2},
35+
{"x": 3, "y": 2.28},
36+
{"x": 4, "y": 2.42},
37+
38+
{"x": 7, "y": 2.42},
39+
{"x": 8, "y": 2.28},
40+
{"x": 9, "y": 2},
41+
{"x": 10, "y": 2.31},
42+
{"x": 11, "y": 2.93},
43+
44+
{"x": 3.5, "y": 3.45},
45+
{"x": 4.5, "y": 3.7},
46+
47+
{"x": 6.5, "y": 3.7},
48+
{"x": 7.5, "y": 3.45}
49+
]
50+
}
51+
}
52+
}
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
/* Use I2C or Serial, not both */
21+
#define USE_I2C
22+
/* #define USE_SERIAL */
23+
24+
/* Select hand configuration */
25+
#define EE_HANDS
26+
/* #define MASTER_LEFT */
27+
/* #define MASTER_RIGHT */
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#include QMK_KEYBOARD_H
19+
20+
// Define aliases for layers
21+
enum layers {
22+
BASE,
23+
};
24+
25+
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
26+
[BASE] = LAYOUT_split_3x5_2(
27+
KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P,
28+
KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN,
29+
KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH,
30+
KC_SPC, KC_TAB, KC_BSPC, KC_ENT
31+
)
32+
};

keyboards/alt34/readme.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# alt34
2+
3+
![alt34](https://i.imgur.com/GDv0dL0h.png)
4+
5+
alt34 was designed as a minimalistic, 'no frills' workhorse keyboard with focus on efficiency and ergonomics.
6+
This breaks down into the following priorities in the design:
7+
8+
* Keyboard Maintainer: [Tommy Alatalo](https://github.com/altosys)
9+
* Hardware Supported:
10+
* Compact 34 key split layout with two thumb keys per hand
11+
* Orthogonal layout with a somewhat aggressive column stagger
12+
* Compatibility with standard controllers (Elite-C, Pro Micro etc.)
13+
* Cherry MX switch support
14+
* Kailh hotswap socket support
15+
* Tenting puck support
16+
17+
## Hardware
18+
19+
A bill of materials for building alt34 is found in [the alt34 git repo](https://gitlab.com/altosys/alt34)
20+
21+
## Bootloader
22+
23+
Enter the bootloader in 3 ways:
24+
25+
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
26+
* **Physical reset jumper**: Briefly short the pads just below the TRRS connector on the PCB
27+
* **Keycode in layout**: Press the key mapped to `RESET` if it is available
28+
29+
Latest updates and information for alt34 is found at https://gitlab.com/altosys/alt34
30+
31+
## Build Guide
32+
33+
There is no dedicated build guide for alt34. If you are a novice builder and need guidance then suggested reading would be build guides for the Corne keyboard (aka. crkbd), they will cover the usual installation of the controller, diodes and hotswap sockets, which is essentially all there is to assembling the alt34.
34+
35+
## Flashing QMK Firmware
36+
37+
Set up your build environment according to the QMK documentation, then after cloning the `qmk_firmware` repository you can run the below commands in the repo root to build and flash the firmware onto your controller.
38+
39+
Note that this method enables `EE_HANDS` mode which allows you to connect the USB cable to either half of alt34 when using the keyboard.
40+
41+
42+
Flash `EE_HANDS` to the left hand half, this updates the persistent EEPROM storage along with the firmware.
43+
Run the below command and then set the board into bootloader mode by bridging the reset pads below the TRRS connector with a paper clip or similar.
44+
```
45+
make alt34/rev1:default:dfu-split-left
46+
```
47+
48+
Do the same for the right hand side:
49+
```
50+
make alt34/rev1:default:dfu-split-right
51+
```
52+
53+
Now you should be able to connect the USB cable to either side of the split and it should work the same.
54+
55+
For any further changes it is enough to flash only the firmware and not the EEPROM:
56+
```
57+
make alt34/rev1:default:flash
58+
```
59+
60+
It is still recommended to do this for both sides of the split when updating keymaps etc.
61+
62+
**Note I:** the above examples are using an Elite-C controller with an `atmel-dfu` bootloader, adjust this according to your own hardware.
63+
64+
**Note II:** the included keymap is rudimentary, the recommended layout to use with alt34 is `miryoku`, see the [miryoku docs](https://github.com/manna-harbour/miryoku) for instructions.
65+
66+
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).

keyboards/alt34/rev1/config.h

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
/* USB Device descriptor parameter */
21+
#define VENDOR_ID 0x1ABC
22+
#define PRODUCT_ID 0x0001
23+
#define DEVICE_VER 0x0001
24+
#define MANUFACTURER altosys
25+
#define PRODUCT alt34
26+
27+
/* key matrix size */
28+
// Rows are doubled-up
29+
#define MATRIX_ROWS 8
30+
#define MATRIX_COLS 5
31+
32+
// wiring of each half
33+
#define MATRIX_ROW_PINS { D7, E6, B4, B5 }
34+
#define MATRIX_COL_PINS { B6, B2, B3, B1, F7 }
35+
#define DIODE_DIRECTION COL2ROW
36+
37+
/* Set 0 if debouncing isn't needed */
38+
#define DEBOUNCE 5
39+
40+
/* serial.c configuration for split keyboard */
41+
/* #define SOFT_SERIAL_PIN D0 */
42+
43+
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
44+
#define LOCKING_SUPPORT_ENABLE
45+
/* Locking resynchronize hack */
46+
#define LOCKING_RESYNC_ENABLE

keyboards/alt34/rev1/rev1.c

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#include "alt34.h"

keyboards/alt34/rev1/rev1.h

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/*
2+
Copyright 2022 Tommy Alatalo <@altosys>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#include "alt34.h"
21+
#include "quantum.h"
22+
23+
#define ____ KC_NO
24+
25+
/* left hand right hand */
26+
#define LAYOUT_split_3x5_2(\
27+
K0_0, K0_1, K0_2, K0_3, K0_4, K0_5, K0_6, K0_7, K0_8, K0_9,\
28+
K1_0, K1_1, K1_2, K1_3, K1_4, K1_5, K1_6, K1_7, K1_8, K1_9,\
29+
K2_0, K2_1, K2_2, K2_3, K2_4, K2_5, K2_6, K2_7, K2_8, K2_9,\
30+
K3_2, K3_3, K3_4, K3_5 )\
31+
/* matrix positions */\
32+
{\
33+
{K0_0, K0_1, K0_2, K0_3, K0_4},\
34+
{K1_0, K1_1, K1_2, K1_3, K1_4},\
35+
{K2_0, K2_1, K2_2, K2_3, K2_4},\
36+
{____, ____, ____, K3_2, K3_3},\
37+
\
38+
{K0_9, K0_8, K0_7, K0_6, K0_5},\
39+
{K1_9, K1_8, K1_7, K1_6, K1_5},\
40+
{K2_9, K2_8, K2_7, K2_6, K2_5},\
41+
{____, ____, ____, K3_5, K3_4} \
42+
}

keyboards/alt34/rev1/rules.mk

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# MCU name
2+
MCU = atmega32u4
3+
4+
# Bootloader selection
5+
BOOTLOADER = atmel-dfu
6+
7+
# Build Options
8+
# change to "no" to disable the options
9+
#
10+
BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
11+
MOUSEKEY_ENABLE = no # Mouse keys
12+
EXTRAKEY_ENABLE = no # Audio control and System control
13+
CONSOLE_ENABLE = no # Console for debug
14+
COMMAND_ENABLE = no # Commands for debug and configuration
15+
NKRO_ENABLE = no # Enable N-Key Rollover
16+
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
17+
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
18+
AUDIO_ENABLE = no # Audio output
19+
20+
SPLIT_KEYBOARD = yes
21+
LAYOUTS = split_3x5_2
22+
DEFAULT_FOLDER = alt34/rev1

0 commit comments

Comments
 (0)