Moves features to their own files (process_*), adds tap dance feature (#460)
* non-working commit
* working
* subprojects implemented for planck
* pass a subproject variable through to c
* consolidates clueboard revisions
* thanks for letting me know about conflicts..
* turn off audio for yang's
* corrects starting paths for subprojects
* messing around with travis
* semicolon
* travis script
* travis script
* script for travis
* correct directory (probably), amend files to commit
* remove origin before adding
* git pull, correct syntax
* git checkout
* git pull origin branch
* where are we?
* where are we?
* merging
* force things to happen
* adds commit message, adds add
* rebase, no commit message
* rebase branch
* idk!
* try just pull
* fetch - merge
* specify repo branch
* checkout
* goddammit
* merge? idk
* pls
* after all
* don't split up keyboards
* syntax
* adds quick for all-keyboards
* trying out new script
* script update
* lowercase
* all keyboards
* stop replacing compiled.hex automatically
* adds if statement
* skip automated build branches
* forces push to automated build branch
* throw an add in there
* upstream?
* adds AUTOGEN
* ignore all .hex files again
* testing out new repo
* global ident
* generate script, keyboard_keymap.hex
* skip generation for now, print pandoc info, submodule update
* try trusty
* and sudo
* try generate
* updates subprojects to keyboards
* no idea
* updates to keyboards
* cleans up clueboard stuff
* setup to use local readme
* updates cluepad, planck experimental
* remove extra led.c [ci skip]
* audio and midi moved over to separate files
* chording, leader, unicode separated
* consolidate each [skip ci]
* correct include
* quantum: Add a tap dance feature (#451)
* quantum: Add a tap dance feature
With this feature one can specify keys that behave differently, based on
the amount of times they have been tapped, and when interrupted, they
get handled before the interrupter.
To make it clear how this is different from `ACTION_FUNCTION_TAP`, lets
explore a certain setup! We want one key to send `Space` on single tap,
but `Enter` on double-tap.
With `ACTION_FUNCTION_TAP`, it is quite a rain-dance to set this up, and
has the problem that when the sequence is interrupted, the interrupting
key will be send first. Thus, `SPC a` will result in `a SPC` being sent,
if they are typed within `TAPPING_TERM`. With the tap dance feature,
that'll come out as `SPC a`, correctly.
The implementation hooks into two parts of the system, to achieve this:
into `process_record_quantum()`, and the matrix scan. We need the latter
to be able to time out a tap sequence even when a key is not being
pressed, so `SPC` alone will time out and register after `TAPPING_TERM`
time.
But lets start with how to use it, first!
First, you will need `TAP_DANCE_ENABLE=yes` in your `Makefile`, because
the feature is disabled by default. This adds a little less than 1k to
the firmware size. Next, you will want to define some tap-dance keys,
which is easiest to do with the `TD()` macro, that - similar to `F()`,
takes a number, which will later be used as an index into the
`tap_dance_actions` array.
This array specifies what actions shall be taken when a tap-dance key is
in action. Currently, there are two possible options:
* `ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when
tapped once, `kc2` otherwise.
* `ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in
the user keymap - with the current state of the tap-dance action.
The first option is enough for a lot of cases, that just want dual
roles. For example, `ACTION_TAP_DANCE(KC_SPC, KC_ENT)` will result in
`Space` being sent on single-tap, `Enter` otherwise.
And that's the bulk of it!
Do note, however, that this implementation does have some consequences:
keys do not register until either they reach the tapping ceiling, or
they time out. This means that if you hold the key, nothing happens, no
repeat, no nothing. It is possible to detect held state, and register an
action then too, but that's not implemented yet. Keys also unregister
immediately after being registered, so you can't even hold the second
tap. This is intentional, to be consistent.
And now, on to the explanation of how it works!
The main entry point is `process_tap_dance()`, called from
`process_record_quantum()`, which is run for every keypress, and our
handler gets to run early. This function checks whether the key pressed
is a tap-dance key. If it is not, and a tap-dance was in action, we
handle that first, and enqueue the newly pressed key. If it is a
tap-dance key, then we check if it is the same as the already active
one (if there's one active, that is). If it is not, we fire off the old
one first, then register the new one. If it was the same, we increment
the counter and the timer.
This means that you have `TAPPING_TERM` time to tap the key again, you
do not have to input all the taps within that timeframe. This allows for
longer tap counts, with minimal impact on responsiveness.
Our next stop is `matrix_scan_tap_dance()`. This handles the timeout of
tap-dance keys.
For the sake of flexibility, tap-dance actions can be either a pair of
keycodes, or a user function. The latter allows one to handle higher tap
counts, or do extra things, like blink the LEDs, fiddle with the
backlighting, and so on. This is accomplished by using an union, and
some clever macros.
In the end, lets see a full example!
```c
enum {
CT_SE = 0,
CT_CLN,
CT_EGG
};
/* Have the above three on the keymap, TD(CT_SE), etc... */
void dance_cln (qk_tap_dance_state_t *state) {
if (state->count == 1) {
register_code (KC_RSFT);
register_code (KC_SCLN);
unregister_code (KC_SCLN);
unregister_code (KC_RSFT);
} else {
register_code (KC_SCLN);
unregister_code (KC_SCLN);
reset_tap_dance (state);
}
}
void dance_egg (qk_tap_dance_state_t *state) {
if (state->count >= 100) {
SEND_STRING ("Safety dance!");
reset_tap_dance (state);
}
}
const qk_tap_dance_action_t tap_dance_actions[] = {
[CT_SE] = ACTION_TAP_DANCE_DOUBLE (KC_SPC, KC_ENT)
,[CT_CLN] = ACTION_TAP_DANCE_FN (dance_cln)
,[CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
};
```
This addresses #426.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* hhkb: Fix the build with the new tap-dance feature
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Move process_tap_dance further down
Process the tap dance stuff after midi and audio, because those don't
process keycodes, but row/col positions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* tap_dance: Use conditionals instead of dummy functions
To be consistent with how the rest of the quantum features are
implemented, use ifdefs instead of dummy functions.
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
* Merge branch 'master' into quantum-keypress-process
# Conflicts:
# Makefile
# keyboards/planck/rev3/config.h
# keyboards/planck/rev4/config.h
* update build script
2016-06-29 21:49:41 +00:00
|
|
|
#----------------------------------------------------------------------------
|
|
|
|
|
# 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".
|
|
|
|
|
#----------------------------------------------------------------------------
|
2016-06-21 14:21:43 +00:00
|
|
|
|
2016-06-29 20:21:41 +00:00
|
|
|
SUBPROJECT_DEFAULT = rev2
|
2016-03-27 23:17:40 +00:00
|
|
|
|
|
|
|
|
# MCU name
|
|
|
|
|
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
|
2016-08-08 20:43:24 +00:00
|
|
|
# change to no to disable the options.
|
2016-03-27 23:17:40 +00:00
|
|
|
#
|
Makefile redo & other features (#395)
* .build containment implemented
* no destructive variable setting - builds in either folder
* make from 3 places
* cleans before each build
* make from root with keyboard=keyboard, keymap=keymap
* make from keyboard/keyboard with keymap=keymap
* make from keymaps/keymap
* only implemented on planck
* adds color diag to avr-gcc
* makefiles for all plancks, clean-up
* quick build-all makefile for plancks
* reformatting of make output (colors)
* color toggle, tmk path corrections
* correct if statement for color
* move config.h to main makefile, updates preonic, atomic
* format update, all keyboards targets
* makefile optional for build all target, alps and arrow_pad updated
* alps updated
* make planck default, trying out travis recipe for all-keyboards
* all-keymaps target, different travis recipe
* updates alps64
* updates keyboards to new format
* updates clue* projects
* all projects updated, specialise EZ .hex, let .hex through
* updates travis
* automatically find root, keyboard, keymap
* silent echo, cleaned-up mass make output
* updates all keyboards' .hex files except EZ
* Rename Bantam44.c to bantam44.c
* Rename Bantam44.h to bantam44.h
* nananana
* adds six key keyboard
* does same to ez as rest
* updates send_string example
* brings ergodox_ez up to date
* updates template/new project script
* adds sixkeyboard
* adds readme for sixkeyboard
* adds sixkeyboard to travis
* filenames, gitignore mess
* define clock prescaler stuff manually
* make quick, size test example
* documentation and dfu-no-build
2016-06-11 17:31:31 +00:00
|
|
|
BOOTMAGIC_ENABLE ?= yes # Virtual DIP switch configuration(+1000)
|
|
|
|
|
MOUSEKEY_ENABLE ?= no # 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
|
|
|
|
|
NKRO_ENABLE ?= yes # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
|
|
|
|
AUDIO_ENABLE ?= no
|
|
|
|
|
RGBLIGHT_ENABLE ?= no # Enable keyboard underlight functionality
|
|
|
|
|
MIDI_ENABLE ?= no # MIDI controls
|
|
|
|
|
UNICODE_ENABLE ?= no # Unicode
|
|
|
|
|
BLUETOOTH_ENABLE ?= no # Enable Bluetooth with the Adafruit EZ-Key HID
|
|
|
|
|
|
|
|
|
|
ifndef QUANTUM_DIR
|
|
|
|
|
include ../../Makefile
|
|
|
|
|
endif
|
