Merge branch 'master' of https://github.com/jackhumbert/tmk_keyboard
Jack Humbert
10 years ago
commit
623666888f
@ -0,0 +1,139 @@
|
|||||||
|
#----------------------------------------------------------------------------
|
||||||
|
# On command line:
|
||||||
|
#
|
||||||
|
# make all = Make software.
|
||||||
|
#
|
||||||
|
# make clean = Clean out built project files.
|
||||||
|
#
|
||||||
|
# make coff = Convert ELF to AVR COFF.
|
||||||
|
#
|
||||||
|
# make extcoff = Convert ELF to AVR Extended COFF.
|
||||||
|
#
|
||||||
|
# make program = Download the hex file to the device.
|
||||||
|
# Please customize your programmer settings(PROGRAM_CMD)
|
||||||
|
#
|
||||||
|
# make teensy = Download the hex file to the device, using teensy_loader_cli.
|
||||||
|
# (must have teensy_loader_cli installed).
|
||||||
|
#
|
||||||
|
# make dfu = Download the hex file to the device, using dfu-programmer (must
|
||||||
|
# have dfu-programmer installed).
|
||||||
|
#
|
||||||
|
# make flip = Download the hex file to the device, using Atmel FLIP (must
|
||||||
|
# have Atmel FLIP installed).
|
||||||
|
#
|
||||||
|
# make dfu-ee = Download the eeprom file to the device, using dfu-programmer
|
||||||
|
# (must have dfu-programmer installed).
|
||||||
|
#
|
||||||
|
# make flip-ee = Download the eeprom file to the device, using Atmel FLIP
|
||||||
|
# (must have Atmel FLIP installed).
|
||||||
|
#
|
||||||
|
# make debug = Start either simulavr or avarice as specified for debugging,
|
||||||
|
# with avr-gdb or avr-insight as the front end for debugging.
|
||||||
|
#
|
||||||
|
# make filename.s = Just compile filename.c into the assembler code only.
|
||||||
|
#
|
||||||
|
# make filename.i = Create a preprocessed source file for use in submitting
|
||||||
|
# bug reports to the GCC project.
|
||||||
|
#
|
||||||
|
# To rebuild project do "make clean" then "make all".
|
||||||
|
#----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# Target file name (without extension).
|
||||||
|
TARGET = atreus
|
||||||
|
|
||||||
|
|
||||||
|
# Directory common source filess exist
|
||||||
|
TOP_DIR = ../..
|
||||||
|
TMK_DIR = ../../tmk_core
|
||||||
|
|
||||||
|
# Directory keyboard dependent files exist
|
||||||
|
TARGET_DIR = .
|
||||||
|
|
||||||
|
# # project specific files
|
||||||
|
SRC = atreus.c
|
||||||
|
|
||||||
|
ifdef KEYMAP
|
||||||
|
SRC := keymaps/keymap_$(KEYMAP).c $(SRC)
|
||||||
|
else
|
||||||
|
SRC := keymaps/keymap_default.c $(SRC)
|
||||||
|
endif
|
||||||
|
|
||||||
|
CONFIG_H = config.h
|
||||||
|
|
||||||
|
# MCU name
|
||||||
|
#MCU = at90usb1287
|
||||||
|
MCU = atmega32u4
|
||||||
|
|
||||||
|
# Processor frequency.
|
||||||
|
# This will define a symbol, F_CPU, in all source code files equal to the
|
||||||
|
# processor frequency in Hz. You can then use this symbol in your source code to
|
||||||
|
# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
|
||||||
|
# automatically to create a 32-bit value in your source code.
|
||||||
|
#
|
||||||
|
# This will be an integer division of F_USB below, as it is sourced by
|
||||||
|
# F_USB after it has run through any CPU prescalers. Note that this value
|
||||||
|
# does not *change* the processor frequency - it should merely be updated to
|
||||||
|
# reflect the processor speed set externally so that the code can use accurate
|
||||||
|
# software delays.
|
||||||
|
F_CPU = 16000000
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# LUFA specific
|
||||||
|
#
|
||||||
|
# Target architecture (see library "Board Types" documentation).
|
||||||
|
ARCH = AVR8
|
||||||
|
|
||||||
|
# Input clock frequency.
|
||||||
|
# This will define a symbol, F_USB, in all source code files equal to the
|
||||||
|
# input clock frequency (before any prescaling is performed) in Hz. This value may
|
||||||
|
# differ from F_CPU if prescaling is used on the latter, and is required as the
|
||||||
|
# raw input clock is fed directly to the PLL sections of the AVR for high speed
|
||||||
|
# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
|
||||||
|
# at the end, this will be done automatically to create a 32-bit value in your
|
||||||
|
# source code.
|
||||||
|
#
|
||||||
|
# If no clock division is performed on the input clock inside the AVR (via the
|
||||||
|
# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
|
||||||
|
F_USB = $(F_CPU)
|
||||||
|
|
||||||
|
# Interrupt driven control endpoint task(+60)
|
||||||
|
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
|
||||||
|
|
||||||
|
|
||||||
|
# Boot Section Size in *bytes*
|
||||||
|
# Teensy halfKay 512
|
||||||
|
# Teensy++ halfKay 1024
|
||||||
|
# Atmel DFU loader 4096
|
||||||
|
# LUFA bootloader 4096
|
||||||
|
# USBaspLoader 2048
|
||||||
|
OPT_DEFS += -DBOOTLOADER_SIZE=4096
|
||||||
|
|
||||||
|
|
||||||
|
# Build Options
|
||||||
|
# comment out to disable the options.
|
||||||
|
#
|
||||||
|
#BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
|
||||||
|
#MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
|
||||||
|
#EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
|
||||||
|
CONSOLE_ENABLE = yes # Console for debug(+400)
|
||||||
|
COMMAND_ENABLE = yes # Commands for debug and configuration
|
||||||
|
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
||||||
|
# SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
|
||||||
|
NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
|
||||||
|
# BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
|
||||||
|
# MIDI_ENABLE = YES # MIDI controls
|
||||||
|
UNICODE_ENABLE = YES # Unicode
|
||||||
|
# BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
|
||||||
|
|
||||||
|
|
||||||
|
# Optimize size but this may cause error "relocation truncated to fit"
|
||||||
|
#EXTRALDFLAGS = -Wl,--relax
|
||||||
|
|
||||||
|
# Search Path
|
||||||
|
VPATH += $(TARGET_DIR)
|
||||||
|
VPATH += $(TOP_DIR)
|
||||||
|
VPATH += $(TMK_DIR)
|
||||||
|
|
||||||
|
include $(TOP_DIR)/quantum/quantum.mk
|
||||||
|
|
||||||
@ -0,0 +1,184 @@
|
|||||||
|
atreus keyboard firmware
|
||||||
|
======================
|
||||||
|
|
||||||
|
## Note
|
||||||
|
|
||||||
|
This is for the Teensy2 hand wired boards only.
|
||||||
|
|
||||||
|
## Quantum MK Firmware
|
||||||
|
|
||||||
|
You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you.
|
||||||
|
|
||||||
|
BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
|
||||||
|
MIDI_ENABLE = yes # MIDI controls
|
||||||
|
# UNICODE_ENABLE = yes # Unicode support - this is commented out, just as an example. You have to use #, not //
|
||||||
|
BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
|
||||||
|
|
||||||
|
## Quick aliases to common actions
|
||||||
|
|
||||||
|
Your keymap can include shortcuts to common operations (called "function actions" in tmk).
|
||||||
|
|
||||||
|
### Switching and toggling layers
|
||||||
|
|
||||||
|
`MO(layer)` - momentary switch to *layer*. As soon as you let go of the key, the layer is deactivated and you pop back out to the previous layer. When you apply this to a key, that same key must be set as `KC_TRNS` on the destination layer. Otherwise, you won't make it back to the original layer when you release the key (and you'll get a keycode sent). You can only switch to layers *above* your current layer. If you're on layer 0 and you use `MO(1)`, that will switch to layer 1 just fine. But if you include `MO(3)` on layer 5, that won't do anything for you -- because layer 3 is lower than layer 5 on the stack.
|
||||||
|
|
||||||
|
`LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped. Like `MO()`, this only works upwards in the layer stack (`layer` must be higher than the current layer).
|
||||||
|
|
||||||
|
`TG(layer)` - toggles a layer on or off. As with `MO()`, you should set this key as `KC_TRNS` in the destination layer so that tapping it again actually toggles back to the original layer. Only works upwards in the layer stack.
|
||||||
|
|
||||||
|
### Fun with modifier keys
|
||||||
|
|
||||||
|
* `LSFT(kc)` - applies left Shift to *kc* (keycode) - `S(kc)` is an alias
|
||||||
|
* `RSFT(kc)` - applies right Shift to *kc*
|
||||||
|
* `LCTL(kc)` - applies left Control to *kc*
|
||||||
|
* `RCTL(kc)` - applies right Control to *kc*
|
||||||
|
* `LALT(kc)` - applies left Alt to *kc*
|
||||||
|
* `RALT(kc)` - applies right Alt to *kc*
|
||||||
|
* `LGUI(kc)` - applies left GUI (command/win) to *kc*
|
||||||
|
* `RGUI(kc)` - applies right GUI (command/win) to *kc*
|
||||||
|
|
||||||
|
You can also chain these, like this:
|
||||||
|
|
||||||
|
LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
|
||||||
|
|
||||||
|
The following shortcuts automatically add `LSFT()` to keycodes to get commonly used symbols. Their long names are also available and documented in `/quantum/keymap_common.h`.
|
||||||
|
|
||||||
|
KC_TILD ~
|
||||||
|
KC_EXLM !
|
||||||
|
KC_AT @
|
||||||
|
KC_HASH #
|
||||||
|
KC_DLR $
|
||||||
|
KC_PERC %
|
||||||
|
KC_CIRC ^
|
||||||
|
KC_AMPR &
|
||||||
|
KC_ASTR *
|
||||||
|
KC_LPRN (
|
||||||
|
KC_RPRN )
|
||||||
|
KC_UNDS _
|
||||||
|
KC_PLUS +
|
||||||
|
KC_LCBR {
|
||||||
|
KC_RCBR }
|
||||||
|
KC_PIPE |
|
||||||
|
KC_COLN :
|
||||||
|
|
||||||
|
`MT(mod, kc)` - is *mod* (modifier key - MOD_LCTL, MOD_LSFT) when held, and *kc* when tapped. In other words, you can have a key that sends Esc (or the letter O or whatever) when you tap it, but works as a Control key or a Shift key when you hold it down.
|
||||||
|
|
||||||
|
These are the values you can use for the `mod` in `MT()` (right-hand modifiers are not available):
|
||||||
|
|
||||||
|
* MOD_LCTL
|
||||||
|
* MOD_LSFT
|
||||||
|
* MOD_LALT
|
||||||
|
* MOD_LGUI
|
||||||
|
|
||||||
|
These can also be combined like `MOD_LCTL | MOD_LSFT` e.g. `MT(MOD_LCTL | MOD_LSFT, KC_ESC)` which would activate Control and Shift when held, and send Escape when tapped.
|
||||||
|
|
||||||
|
We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
|
||||||
|
|
||||||
|
* `CTL_T(kc)` - is LCTL when held and *kc* when tapped
|
||||||
|
* `SFT_T(kc)` - is LSFT when held and *kc* when tapped
|
||||||
|
* `ALT_T(kc)` - is LALT when held and *kc* when tapped
|
||||||
|
* `GUI_T(kc)` - is LGUI when held and *kc* when tapped
|
||||||
|
* `ALL_T(kc)` - is Hyper (all mods) when held and *kc* when tapped. To read more about what you can do with a Hyper key, see [this blog post by Brett Terpstra](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)
|
||||||
|
|
||||||
|
### Temporarily setting the default layer
|
||||||
|
|
||||||
|
`DF(layer)` - sets default layer to *layer*. The default layer is the one at the "bottom" of the layer stack - the ultimate fallback layer. This currently does not persist over power loss. When you plug the keyboard back in, layer 0 will always be the default. It is theoretically possible to work around that, but that's not what `DF` does.
|
||||||
|
|
||||||
|
### Remember: These are just aliases
|
||||||
|
|
||||||
|
These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action).
|
||||||
|
|
||||||
|
Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them.
|
||||||
|
|
||||||
|
## Macro shortcuts: Send a whole string when pressing just one key
|
||||||
|
|
||||||
|
Instead of using the `ACTION_MACRO` function, you can simply use `M(n)` to access macro *n* - *n* will get passed into the `action_get_macro` as the `id`, and you can use a switch statement to trigger it. This gets called on the keydown and keyup, so you'll need to use an if statement testing `record->event.pressed` (see keymap_default.c).
|
||||||
|
|
||||||
|
```c
|
||||||
|
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) // this is the function signature -- just copy/paste it into your keymap file as it is.
|
||||||
|
{
|
||||||
|
switch(id) {
|
||||||
|
case 0: // this would trigger when you hit a key mapped as M(0)
|
||||||
|
if (record->event.pressed) {
|
||||||
|
return MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END ); // this sends the string 'hello' when the macro executes
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
return MACRO_NONE;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
A macro can include the following commands:
|
||||||
|
|
||||||
|
* I() change interval of stroke in milliseconds.
|
||||||
|
* D() press key.
|
||||||
|
* U() release key.
|
||||||
|
* T() type key(press and release).
|
||||||
|
* W() wait (milliseconds).
|
||||||
|
* END end mark.
|
||||||
|
|
||||||
|
So above you can see the stroke interval changed to 255ms between each keystroke, then a bunch of keys being typed, waits a while, then the macro ends.
|
||||||
|
|
||||||
|
Note: Using macros to have your keyboard send passwords for you is a bad idea.
|
||||||
|
|
||||||
|
### Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
|
||||||
|
|
||||||
|
Everything is assuming you're in Qwerty (in software) by default, but there is built-in support for using a Colemak or Dvorak layout by including this at the top of your keymap:
|
||||||
|
|
||||||
|
#include "keymap_<layout>.h"
|
||||||
|
|
||||||
|
Where <layout> is "colemak" or "dvorak". After including this line, you will get access to:
|
||||||
|
|
||||||
|
* `CM_*` for all of the Colemak-equivalent characters
|
||||||
|
* `DV_*` for all of the Dvorak-equivalent characters
|
||||||
|
|
||||||
|
These implementations assume you're using Colemak or Dvorak on your OS, not on your keyboard - this is referred to as a software-implemented layout. If your computer is in Qwerty and your keymap is in Colemak or Dvorak, this is referred to as a firmware-implemented layout, and you won't need these features.
|
||||||
|
|
||||||
|
To give an example, if you're using software-implemented Colemak, and want to get an `F`, you would use `CM_F` - `KC_F` under these same circumstances would result in `T`.
|
||||||
|
|
||||||
|
## Additional language support
|
||||||
|
|
||||||
|
In `quantum/keymap_extras/`, you'll see various language files - these work the same way as the alternative layout ones do. Most are defined by their two letter country/language code followed by an underscore and a 4-letter abbreviation of its name. `FR_UGRV` which will result in a `ù` when using a software-implemented AZERTY layout. It's currently difficult to send such characters in just the firmware (but it's being worked on - see Unicode support).
|
||||||
|
|
||||||
|
## Unicode support
|
||||||
|
|
||||||
|
You can currently send 4 hex digits with your OS-specific modifier key (RALT for OSX with the "Unicode Hex Input" layout) - this is currently limited to supporting one OS at a time, and requires a recompile for switching. 8 digit hex codes are being worked on. The keycode function is `UC(n)`, where *n* is a 4 digit hexidecimal. Enable from the Makefile.
|
||||||
|
|
||||||
|
## Other firmware shortcut keycodes
|
||||||
|
|
||||||
|
* `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
|
||||||
|
* `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
|
||||||
|
* `BL_ON` - turns the backlight on
|
||||||
|
* `BL_OFF` - turns the backlight off
|
||||||
|
* `BL_<n>` - sets the backlight to level *n*
|
||||||
|
* `BL_INC` - increments the backlight level by one
|
||||||
|
* `BL_DEC` - decrements the backlight level by one
|
||||||
|
* `BL_TOGG` - toggles the backlight
|
||||||
|
* `BL_STEP` - steps through the backlight levels
|
||||||
|
|
||||||
|
Enable the backlight from the Makefile.
|
||||||
|
|
||||||
|
## MIDI functionalty
|
||||||
|
|
||||||
|
This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
|
||||||
|
|
||||||
|
## Bluetooth functionality
|
||||||
|
|
||||||
|
This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Download or clone the whole firmware and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.
|
||||||
|
|
||||||
|
Depending on which keymap you would like to use, you will have to compile slightly differently.
|
||||||
|
|
||||||
|
### Default
|
||||||
|
To build with the default keymap, simply run `make`.
|
||||||
|
|
||||||
|
### Other Keymaps
|
||||||
|
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
|
||||||
|
|
||||||
|
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
|
||||||
|
```
|
||||||
|
$ make KEYMAP=[default|jack|<name>]
|
||||||
|
```
|
||||||
|
Keymaps follow the format **__keymap\_\<name\>.c__** and are stored in the `keymaps` folder.
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
#include "atreus.h"
|
||||||
|
|
||||||
|
__attribute__ ((weak))
|
||||||
|
void * matrix_init_user(void) {
|
||||||
|
// leave these blank
|
||||||
|
};
|
||||||
|
|
||||||
|
__attribute__ ((weak))
|
||||||
|
void * matrix_scan_user(void) {
|
||||||
|
// leave these blank
|
||||||
|
};
|
||||||
|
|
||||||
|
void * matrix_init_kb(void) {
|
||||||
|
// put your keyboard start-up code here
|
||||||
|
// runs once when the firmware starts up
|
||||||
|
|
||||||
|
if (matrix_init_user) {
|
||||||
|
(*matrix_init_user)();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
void * matrix_scan_kb(void) {
|
||||||
|
// put your looping keyboard code here
|
||||||
|
// runs every cycle (a lot)
|
||||||
|
|
||||||
|
if (matrix_scan_user) {
|
||||||
|
(*matrix_scan_user)();
|
||||||
|
}
|
||||||
|
};
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
#ifndef ATREUS_H
|
||||||
|
#define ATREUS_H
|
||||||
|
|
||||||
|
#include "matrix.h"
|
||||||
|
#include "keymap_common.h"
|
||||||
|
#include "backlight.h"
|
||||||
|
#include <stddef.h>
|
||||||
|
|
||||||
|
// This a shortcut to help you visually see your layout.
|
||||||
|
// The following is an example using the Planck MIT layout
|
||||||
|
// The first section contains all of the arguements
|
||||||
|
// The second converts the arguments into a two-dimensional array
|
||||||
|
#define KEYMAP( \
|
||||||
|
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
|
||||||
|
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
|
||||||
|
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
|
||||||
|
k30, k31, k32, k33, k34, k35, k37, k38, k39, k3a, k3b \
|
||||||
|
) \
|
||||||
|
{ \
|
||||||
|
{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
|
||||||
|
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
|
||||||
|
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
|
||||||
|
{ k30, k31, k32, k33, k34, k35, k35, k37, k38, k39, k3a, k3b } \
|
||||||
|
}
|
||||||
|
|
||||||
|
void * matrix_init_user(void);
|
||||||
|
void * matrix_scan_user(void);
|
||||||
|
|
||||||
|
#endif
|
||||||
@ -0,0 +1,82 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2012 Jun Wako <wakojun@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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef CONFIG_H
|
||||||
|
#define CONFIG_H
|
||||||
|
|
||||||
|
#include "config_common.h"
|
||||||
|
|
||||||
|
/* USB Device descriptor parameter */
|
||||||
|
|
||||||
|
#define VENDOR_ID 0xFEED
|
||||||
|
#define PRODUCT_ID 0x6060
|
||||||
|
#define DEVICE_VER 0x0001
|
||||||
|
#define MANUFACTURER Technomancy
|
||||||
|
#define PRODUCT Atreus
|
||||||
|
#define DESCRIPTION q.m.k. keyboard firmware for Atreus
|
||||||
|
|
||||||
|
/* key matrix size */
|
||||||
|
#define MATRIX_ROWS 4
|
||||||
|
#define MATRIX_COLS 11
|
||||||
|
|
||||||
|
// Planck PCB default pin-out
|
||||||
|
// Change this to how you wired your keyboard
|
||||||
|
// COLS: Left to right, ROWS: Top to bottom
|
||||||
|
#define COLS (int []){ F6, F5, F4, B7, B6, B5, B4, B3, B2, B1, B0}
|
||||||
|
#define ROWS (int []){ D0, D1, D2, D3 }
|
||||||
|
|
||||||
|
/* COL2ROW or ROW2COL */
|
||||||
|
#define DIODE_DIRECTION COL2ROW
|
||||||
|
|
||||||
|
/* define if matrix has ghost */
|
||||||
|
//#define MATRIX_HAS_GHOST
|
||||||
|
|
||||||
|
/* number of backlight levels */
|
||||||
|
//#define BACKLIGHT_LEVELS 3
|
||||||
|
|
||||||
|
/* Set 0 if debouncing isn't needed */
|
||||||
|
#define DEBOUNCE 5
|
||||||
|
|
||||||
|
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
|
||||||
|
#define LOCKING_SUPPORT_ENABLE
|
||||||
|
/* Locking resynchronize hack */
|
||||||
|
#define LOCKING_RESYNC_ENABLE
|
||||||
|
|
||||||
|
/* key combination for command */
|
||||||
|
#define IS_COMMAND() ( \
|
||||||
|
keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
|
||||||
|
)
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Feature disable options
|
||||||
|
* These options are also useful to firmware size reduction.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* disable debug print */
|
||||||
|
//#define NO_DEBUG
|
||||||
|
|
||||||
|
/* disable print */
|
||||||
|
//#define NO_PRINT
|
||||||
|
|
||||||
|
/* disable action features */
|
||||||
|
//#define NO_ACTION_LAYER
|
||||||
|
//#define NO_ACTION_TAPPING
|
||||||
|
//#define NO_ACTION_ONESHOT
|
||||||
|
//#define NO_ACTION_MACRO
|
||||||
|
//#define NO_ACTION_FUNCTION
|
||||||
|
|
||||||
|
#endif
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
// this is the style you want to emulate.
|
||||||
|
// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
|
||||||
|
|
||||||
|
#include "atreus.h"
|
||||||
|
|
||||||
|
// Each layer gets a name for readability, which is then used in the keymap matrix below.
|
||||||
|
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
|
||||||
|
// Layer names don't all need to be of the same length, obviously, and you can also skip them
|
||||||
|
// entirely and just use numbers.
|
||||||
|
#define _QW 0
|
||||||
|
#define _RS 1
|
||||||
|
#define _LW 2
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
[_QW] = { /* Qwerty */
|
||||||
|
{KC_Q, KC_W, KC_E, KC_R, KC_T, KC_TRNS, KC_Y, KC_U, KC_I, KC_O, KC_P },
|
||||||
|
{KC_A, KC_S, KC_D, KC_F, KC_G, KC_TRNS, KC_H, KC_J, KC_K, KC_L, KC_SCLN },
|
||||||
|
{KC_Z, KC_X, KC_C, KC_V, KC_B, KC_LALT, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH },
|
||||||
|
{KC_ESC, KC_TAB, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_SPC, MO(_RS), KC_MINS, KC_QUOT, KC_ENT }
|
||||||
|
},
|
||||||
|
[_RS] = { /* [> RAISE <] */
|
||||||
|
{KC_EXLM, KC_AT, KC_LCBR, KC_RCBR, KC_PIPE, KC_TRNS, KC_PGUP, KC_7, KC_8, KC_9, KC_ASTR},
|
||||||
|
{KC_HASH, KC_DLR, KC_LPRN, KC_RPRN, KC_GRV, KC_TRNS, KC_PGDN, KC_4, KC_5, KC_6, KC_PLUS},
|
||||||
|
{KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_TILD, KC_LALT, KC_AMPR, KC_1, KC_2, KC_3, KC_BSLS},
|
||||||
|
{TG(_LW), KC_INS, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_SPC, KC_TRNS, KC_DOT, KC_0, KC_EQL}
|
||||||
|
},
|
||||||
|
[_LW] = { /* [> LOWER <] */
|
||||||
|
{KC_INS, KC_HOME, KC_UP, KC_END, KC_PGUP, KC_TRNS, KC_UP, KC_F7, KC_F8, KC_F9, KC_F10},
|
||||||
|
{KC_DELT, KC_LEFT, KC_DOWN, KC_RGHT, KC_DOWN, KC_TRNS, KC_DOWN, KC_F4, KC_F5, KC_F6, KC_F11},
|
||||||
|
{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_LALT, KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F12},
|
||||||
|
{KC_TRNS, KC_TRNS, KC_LGUI, KC_LSFT, KC_BSPC, KC_LCTL, KC_SPC, DF(_QW), KC_TRNS, KC_TRNS, RESET}
|
||||||
|
}};
|
||||||
|
|
||||||
|
const uint16_t PROGMEM fn_actions[] = {
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
|
||||||
|
{
|
||||||
|
// MACRODOWN only works in this function
|
||||||
|
switch(id) {
|
||||||
|
case 0:
|
||||||
|
if (record->event.pressed) {
|
||||||
|
register_code(KC_RSFT);
|
||||||
|
} else {
|
||||||
|
unregister_code(KC_RSFT);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
return MACRO_NONE;
|
||||||
|
};
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,16 @@
|
|||||||
|
cbbrowne custom keyboard
|
||||||
|
==============================
|
||||||
|
|
||||||
|
Due to cbbrowne@acm.org
|
||||||
|
Christopher Browne
|
||||||
|
|
||||||
|
This was originally based on the default keyboard map, but I have been
|
||||||
|
doing sundry experimentation:
|
||||||
|
|
||||||
|
* To figure things out about the toolset
|
||||||
|
* I'm an Emacs guy, so will be needing a fair bit of tuning
|
||||||
|
* It made sense to mess around some with keyboard maps.
|
||||||
|
- I added Workman alongside Dvorak and Colemak
|
||||||
|
- Boy, oh boy, these don't help
|
||||||
|
- I have done 30 years of learning of Emacs key mappings, and these alternative keyboards massively mess me up
|
||||||
|
- I added a keypad, originally based on keymaps/numpad.c, but mighty substantially revised, as that one seems to be rotated 90 degrees from usual conventions for number pads
|
||||||
@ -0,0 +1,302 @@
|
|||||||
|
#include "planck.h"
|
||||||
|
#ifdef BACKLIGHT_ENABLE
|
||||||
|
#include "backlight.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Each layer is given a name to aid in readability, which is then
|
||||||
|
used in the keymap matrix below. The underscores do not denote
|
||||||
|
anything - you can have a layer called STUFF or any other name.
|
||||||
|
|
||||||
|
Layer names don't all need to be of the same length, obviously, and
|
||||||
|
you could also skip them entirely and just use numbers, though that
|
||||||
|
means needing to manage the numbers.
|
||||||
|
|
||||||
|
It is preferable to keep the symbols short so that a line worth of
|
||||||
|
key mappings fits compactly onto a line of code. */
|
||||||
|
|
||||||
|
/* This was originally based on planck/keymaps/default/default.c, and
|
||||||
|
then cbbrowne has revised things */
|
||||||
|
|
||||||
|
/* Things I did not like about the default mapping
|
||||||
|
|
||||||
|
- I find control too hard to get to. I think I'll want it on a
|
||||||
|
left finger. Gonna need to lose something to do that...
|
||||||
|
- Almost certainly, KC_LCTL should be on [2][1]
|
||||||
|
- having dash on [lower-j] is a bit nonintuitive, but may be OK
|
||||||
|
- I'll bet I should switch ESC/TAB
|
||||||
|
- I'm suspicious that I want to shift M(0) from [4][1] to [4][2],
|
||||||
|
and shift ESC off the first column so KC_LCTL and KC_LALT can
|
||||||
|
be on the first column.
|
||||||
|
- I think I wanna swap ' and ENTER
|
||||||
|
|
||||||
|
- All of the above are done :-)
|
||||||
|
|
||||||
|
- I'm keeping Colemak and Dvorak around for reference, and added
|
||||||
|
Workman just for fun. They're useless to me, though.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
/* Some interesting things implemented
|
||||||
|
|
||||||
|
- There is a macro that writes out "cbbrowne" just because I could
|
||||||
|
- There is a (somewhat cruddy) linear congruential random number
|
||||||
|
generator.
|
||||||
|
- I would like to be seeding it with clock info to make it look
|
||||||
|
more random
|
||||||
|
- There are two macros that use the random number generators
|
||||||
|
- one, M_RANDDIGIT, generates a random digit based on state
|
||||||
|
of the random number generator
|
||||||
|
- the other, M_RANDLETTER, generates a random letter based on state
|
||||||
|
of the random number generator
|
||||||
|
- in both, note the use of register_code()/unregister_code()
|
||||||
|
to indicate the desired key
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* Other things to do...
|
||||||
|
|
||||||
|
- Need to think about what zsh and readline actions I use lots
|
||||||
|
- Wanna figure out macros, so I can put in a "cbbrowne" macro
|
||||||
|
- Ought to ensure that Control-Alt-Delete is convenient enough
|
||||||
|
- How about Alt-F1 thru Alt-F8?
|
||||||
|
- What's the keystroke to get from X to console these days?
|
||||||
|
- I do indeed want a sweet number pad!
|
||||||
|
- A layer for doing console switching would not be a bad idea
|
||||||
|
*/
|
||||||
|
|
||||||
|
enum layers {
|
||||||
|
_QW = 0, /* Qwerty mapping */
|
||||||
|
_LW, /* Lower layer, where top line has symbols !@#$%^&*() */
|
||||||
|
_RS, /* Raised layer, where top line has digits 1234567890 */
|
||||||
|
_KP, /* Key pad */
|
||||||
|
};
|
||||||
|
|
||||||
|
enum macro_id {
|
||||||
|
M_LED = 0,
|
||||||
|
M_USERNAME,
|
||||||
|
M_RANDDIGIT,
|
||||||
|
M_RANDLETTER
|
||||||
|
};
|
||||||
|
|
||||||
|
/* Note that Planck has dimensions 4 rows x 12 columns */
|
||||||
|
|
||||||
|
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
|
||||||
|
[_QW] = { /* Qwerty */
|
||||||
|
{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_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_ENT},
|
||||||
|
{KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_QUOT },
|
||||||
|
{KC_TAB, M(M_LED), KC_LALT, KC_LGUI, MO(_LW), KC_SPC, KC_SPC, MO(_RS), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
|
||||||
|
},
|
||||||
|
[_RS] = { /* RAISE */
|
||||||
|
{KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
|
||||||
|
{KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
|
||||||
|
{KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, DF(_QW), DF(_KP), DF(_KP), RESET, KC_TRNS},
|
||||||
|
{KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
|
||||||
|
},
|
||||||
|
[_LW] = { /* LOWER */
|
||||||
|
{KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_BSPC},
|
||||||
|
{KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
|
||||||
|
{KC_TRNS, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, DF(_QW), DF(_KP), DF(_KP), RESET, KC_TRNS},
|
||||||
|
{KC_TRNS, DF(_KP), KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
|
||||||
|
},
|
||||||
|
[_KP] = { /* Key Pad */
|
||||||
|
{KC_ESC, M(M_USERNAME), KC_W, KC_E, KC_R, KC_T, KC_Y, KC_KP_ENTER, KC_KP_PLUS, KC_KP_PLUS, KC_KP_ENTER, KC_BSPC},
|
||||||
|
{KC_LCTL, M(M_RANDDIGIT), KC_S, KC_D, KC_F, KC_G, KC_H, KC_KP_MINUS, KC_7, KC_8, KC_9, KC_ENT},
|
||||||
|
{KC_LSFT, M(M_RANDLETTER), KC_X, KC_C, KC_V, KC_B, KC_N, KC_KP_PLUS, KC_4, KC_5, KC_6, KC_DOT},
|
||||||
|
{BL_STEP, M(M_LED), KC_LALT, KC_LGUI, KC_NO, KC_SPC, KC_SPC, DF(_QW), KC_1, KC_2, KC_3, KC_0}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const uint16_t PROGMEM fn_actions[] = {
|
||||||
|
};
|
||||||
|
|
||||||
|
/* This bit of logic seeds a wee linear congruential random number generator */
|
||||||
|
|
||||||
|
static uint16_t random_value = 157;
|
||||||
|
#define randadd 53
|
||||||
|
#define randmul 181
|
||||||
|
#define randmod 167
|
||||||
|
|
||||||
|
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
|
||||||
|
{
|
||||||
|
// MACRODOWN only works in this function
|
||||||
|
switch(id) {
|
||||||
|
case M_LED:
|
||||||
|
if (record->event.pressed) {
|
||||||
|
register_code(KC_RSFT);
|
||||||
|
#ifdef BACKLIGHT_ENABLE
|
||||||
|
backlight_step();
|
||||||
|
#endif
|
||||||
|
} else {
|
||||||
|
unregister_code(KC_RSFT);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case M_USERNAME:
|
||||||
|
if (record->event.pressed) {
|
||||||
|
return MACRO( I(1), T(C), T(B), T(B), T(R), T(O), T(W), T(N), T(E));
|
||||||
|
} else {
|
||||||
|
return MACRO_NONE ;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case M_RANDDIGIT:
|
||||||
|
/* Generate, based on random number generator, a keystroke for
|
||||||
|
a numeric digit chosen at random */
|
||||||
|
random_value = ((random_value + randadd) * randmul) % randmod;
|
||||||
|
if (record->event.pressed)
|
||||||
|
switch(random_value % 10) {
|
||||||
|
case 0:
|
||||||
|
register_code (KC_0);
|
||||||
|
unregister_code (KC_0);
|
||||||
|
break;
|
||||||
|
case 1:
|
||||||
|
register_code (KC_1);
|
||||||
|
unregister_code (KC_1);
|
||||||
|
break;
|
||||||
|
case 2:
|
||||||
|
register_code (KC_2);
|
||||||
|
unregister_code (KC_2);
|
||||||
|
break;
|
||||||
|
case 3:
|
||||||
|
register_code (KC_3);
|
||||||
|
unregister_code (KC_3);
|
||||||
|
break;
|
||||||
|
case 4:
|
||||||
|
register_code (KC_4);
|
||||||
|
unregister_code (KC_4);
|
||||||
|
break;
|
||||||
|
case 5:
|
||||||
|
register_code (KC_5);
|
||||||
|
unregister_code (KC_5);
|
||||||
|
break;
|
||||||
|
case 6:
|
||||||
|
register_code (KC_6);
|
||||||
|
unregister_code (KC_6);
|
||||||
|
break;
|
||||||
|
case 7:
|
||||||
|
register_code (KC_7);
|
||||||
|
unregister_code (KC_7);
|
||||||
|
break;
|
||||||
|
case 8:
|
||||||
|
register_code (KC_8);
|
||||||
|
unregister_code (KC_8);
|
||||||
|
break;
|
||||||
|
case 9:
|
||||||
|
register_code (KC_9);
|
||||||
|
unregister_code (KC_9);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case M_RANDLETTER:
|
||||||
|
/* Generate, based on random number generator, a keystroke for
|
||||||
|
a letter chosen at random */
|
||||||
|
random_value = ((random_value + randadd) * randmul) % randmod;
|
||||||
|
if (record->event.pressed)
|
||||||
|
switch(random_value % 26) {
|
||||||
|
case 0:
|
||||||
|
register_code(KC_A);
|
||||||
|
unregister_code(KC_A);
|
||||||
|
break;
|
||||||
|
case 1:
|
||||||
|
register_code(KC_B);
|
||||||
|
unregister_code(KC_B);
|
||||||
|
break;
|
||||||
|
case 2:
|
||||||
|
register_code(KC_C);
|
||||||
|
unregister_code(KC_C);
|
||||||
|
break;
|
||||||
|
case 3:
|
||||||
|
register_code(KC_D);
|
||||||
|
unregister_code(KC_D);
|
||||||
|
break;
|
||||||
|
case 4:
|
||||||
|
register_code(KC_E);
|
||||||
|
unregister_code(KC_E);
|
||||||
|
break;
|
||||||
|
case 5:
|
||||||
|
register_code(KC_F);
|
||||||
|
unregister_code(KC_F);
|
||||||
|
break;
|
||||||
|
case 6:
|
||||||
|
register_code(KC_G);
|
||||||
|
unregister_code(KC_G);
|
||||||
|
break;
|
||||||
|
case 7:
|
||||||
|
register_code(KC_H);
|
||||||
|
unregister_code(KC_H);
|
||||||
|
break;
|
||||||
|
case 8:
|
||||||
|
register_code(KC_I);
|
||||||
|
unregister_code(KC_I);
|
||||||
|
break;
|
||||||
|
case 9:
|
||||||
|
register_code(KC_J);
|
||||||
|
unregister_code(KC_J);
|
||||||
|
break;
|
||||||
|
case 10:
|
||||||
|
register_code(KC_K);
|
||||||
|
unregister_code(KC_K);
|
||||||
|
break;
|
||||||
|
case 11:
|
||||||
|
register_code(KC_L);
|
||||||
|
unregister_code(KC_L);
|
||||||
|
break;
|
||||||
|
case 12:
|
||||||
|
register_code(KC_M);
|
||||||
|
unregister_code(KC_M);
|
||||||
|
break;
|
||||||
|
case 13:
|
||||||
|
register_code(KC_N);
|
||||||
|
unregister_code(KC_N);
|
||||||
|
break;
|
||||||
|
case 14:
|
||||||
|
register_code(KC_O);
|
||||||
|
unregister_code(KC_O);
|
||||||
|
break;
|
||||||
|
case 15:
|
||||||
|
register_code(KC_P);
|
||||||
|
unregister_code(KC_P);
|
||||||
|
break;
|
||||||
|
case 16:
|
||||||
|
register_code(KC_Q);
|
||||||
|
unregister_code(KC_Q);
|
||||||
|
break;
|
||||||
|
case 17:
|
||||||
|
register_code(KC_R);
|
||||||
|
unregister_code(KC_R);
|
||||||
|
break;
|
||||||
|
case 18:
|
||||||
|
register_code(KC_S);
|
||||||
|
unregister_code(KC_S);
|
||||||
|
break;
|
||||||
|
case 19:
|
||||||
|
register_code(KC_T);
|
||||||
|
unregister_code(KC_T);
|
||||||
|
break;
|
||||||
|
case 20:
|
||||||
|
register_code(KC_U);
|
||||||
|
unregister_code(KC_U);
|
||||||
|
break;
|
||||||
|
case 21:
|
||||||
|
register_code(KC_V);
|
||||||
|
unregister_code(KC_V);
|
||||||
|
break;
|
||||||
|
case 22:
|
||||||
|
register_code(KC_W);
|
||||||
|
unregister_code(KC_W);
|
||||||
|
break;
|
||||||
|
case 23:
|
||||||
|
register_code(KC_X);
|
||||||
|
unregister_code(KC_X);
|
||||||
|
break;
|
||||||
|
case 24:
|
||||||
|
register_code(KC_Y);
|
||||||
|
unregister_code(KC_Y);
|
||||||
|
break;
|
||||||
|
case 25:
|
||||||
|
register_code(KC_Z);
|
||||||
|
unregister_code(KC_Z);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
return MACRO_NONE;
|
||||||
|
};
|
||||||
Loading…
Reference in new issue