2017-03-29 04:20:36 +06:00
/* Copyright 2016-2017 Jack Humbert
*
* 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/>.
*/
2016-05-15 10:27:32 +06:00
# include "quantum.h"
2017-02-01 21:30:06 +06:00
# ifdef PROTOCOL_LUFA
2017-02-01 14:35:21 +06:00
# include "outputselect.h"
2017-02-01 18:37:52 +06:00
# endif
2016-05-15 10:27:32 +06:00
2016-11-19 23:19:18 +06:00
# ifndef TAPPING_TERM
# define TAPPING_TERM 200
# endif
2018-01-02 04:47:51 +06:00
# ifndef BREATHING_PERIOD
# define BREATHING_PERIOD 6
# endif
2017-02-12 22:29:42 +06:00
# include "backlight.h"
extern backlight_config_t backlight_config ;
2017-02-19 11:11:55 +06:00
2017-02-13 13:55:35 +06:00
# ifdef FAUXCLICKY_ENABLE
# include "fauxclicky.h"
# endif
2017-02-12 22:29:42 +06:00
2017-07-21 09:57:11 +06:00
# ifdef AUDIO_ENABLE
# ifndef GOODBYE_SONG
# define GOODBYE_SONG SONG(GOODBYE_SOUND)
# endif
# ifndef AG_NORM_SONG
# define AG_NORM_SONG SONG(AG_NORM_SOUND)
# endif
# ifndef AG_SWAP_SONG
# define AG_SWAP_SONG SONG(AG_SWAP_SOUND)
# endif
float goodbye_song [ ] [ 2 ] = GOODBYE_SONG ;
float ag_norm_song [ ] [ 2 ] = AG_NORM_SONG ;
float ag_swap_song [ ] [ 2 ] = AG_SWAP_SONG ;
2017-08-11 02:52:24 +06:00
# ifdef DEFAULT_LAYER_SONGS
float default_layer_songs [ ] [ 16 ] [ 2 ] = DEFAULT_LAYER_SONGS ;
# endif
2017-07-21 09:57:11 +06:00
# endif
2016-08-18 15:29:53 +06:00
static void do_code16 ( uint16_t code , void ( * f ) ( uint8_t ) ) {
switch ( code ) {
case QK_MODS . . . QK_MODS_MAX :
break ;
default :
return ;
}
if ( code & QK_LCTL )
f ( KC_LCTL ) ;
if ( code & QK_LSFT )
f ( KC_LSFT ) ;
if ( code & QK_LALT )
f ( KC_LALT ) ;
if ( code & QK_LGUI )
f ( KC_LGUI ) ;
2016-12-24 01:51:11 +06:00
if ( code < QK_RMODS_MIN ) return ;
2016-08-18 15:29:53 +06:00
if ( code & QK_RCTL )
f ( KC_RCTL ) ;
if ( code & QK_RSFT )
f ( KC_RSFT ) ;
if ( code & QK_RALT )
f ( KC_RALT ) ;
if ( code & QK_RGUI )
f ( KC_RGUI ) ;
}
2017-01-29 23:06:24 +06:00
static inline void qk_register_weak_mods ( uint8_t kc ) {
add_weak_mods ( MOD_BIT ( kc ) ) ;
send_keyboard_report ( ) ;
}
static inline void qk_unregister_weak_mods ( uint8_t kc ) {
del_weak_mods ( MOD_BIT ( kc ) ) ;
send_keyboard_report ( ) ;
}
2017-01-21 13:01:55 +06:00
static inline void qk_register_mods ( uint8_t kc ) {
2017-01-29 23:06:24 +06:00
add_weak_mods ( MOD_BIT ( kc ) ) ;
send_keyboard_report ( ) ;
2017-01-21 13:01:55 +06:00
}
static inline void qk_unregister_mods ( uint8_t kc ) {
2017-01-29 23:06:24 +06:00
del_weak_mods ( MOD_BIT ( kc ) ) ;
send_keyboard_report ( ) ;
2017-01-21 13:01:55 +06:00
}
2016-08-18 15:29:53 +06:00
void register_code16 ( uint16_t code ) {
2017-01-29 23:06:24 +06:00
if ( IS_MOD ( code ) | | code = = KC_NO ) {
do_code16 ( code , qk_register_mods ) ;
} else {
do_code16 ( code , qk_register_weak_mods ) ;
}
2016-08-18 15:29:53 +06:00
register_code ( code ) ;
}
void unregister_code16 ( uint16_t code ) {
unregister_code ( code ) ;
2017-01-29 23:06:24 +06:00
if ( IS_MOD ( code ) | | code = = KC_NO ) {
do_code16 ( code , qk_unregister_mods ) ;
} else {
do_code16 ( code , qk_unregister_weak_mods ) ;
}
2016-08-18 15:29:53 +06:00
}
2016-05-15 10:27:32 +06:00
__attribute__ ( ( weak ) )
bool process_action_kb ( keyrecord_t * record ) {
return true ;
}
2016-05-29 01:22:30 +06:00
__attribute__ ( ( weak ) )
bool process_record_kb ( uint16_t keycode , keyrecord_t * record ) {
return process_record_user ( keycode , record ) ;
}
__attribute__ ( ( weak ) )
bool process_record_user ( uint16_t keycode , keyrecord_t * record ) {
return true ;
}
2016-07-13 20:38:02 +06:00
void reset_keyboard ( void ) {
clear_keyboard ( ) ;
2017-12-10 22:54:36 +06:00
# if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
process_midi_all_notes_off ( ) ;
2018-01-19 03:02:32 +06:00
# endif
2017-12-10 22:54:36 +06:00
# if defined(AUDIO_ENABLE)
2017-02-26 10:41:13 +06:00
music_all_notes_off ( ) ;
2017-07-21 09:57:11 +06:00
uint16_t timer_start = timer_read ( ) ;
PLAY_SONG ( goodbye_song ) ;
2016-07-13 20:38:02 +06:00
shutdown_user ( ) ;
2018-01-19 03:02:32 +06:00
while ( timer_elapsed ( timer_start ) < 250 )
2017-07-21 09:57:11 +06:00
wait_ms ( 1 ) ;
stop_all_notes ( ) ;
# else
2016-07-13 20:38:02 +06:00
wait_ms ( 250 ) ;
2017-07-21 09:57:11 +06:00
# endif
2017-11-28 10:08:21 +06:00
// this is also done later in bootloader.c - not sure if it's neccesary here
# ifdef BOOTLOADER_CATERINA
2016-07-13 20:38:02 +06:00
* ( uint16_t * ) 0x0800 = 0x7777 ; // these two are a-star-specific
# endif
bootloader_jump ( ) ;
}
2016-06-18 07:42:59 +06:00
// Shift / paren setup
# ifndef LSPO_KEY
# define LSPO_KEY KC_9
# endif
# ifndef RSPC_KEY
# define RSPC_KEY KC_0
# endif
2017-12-14 11:20:44 +06:00
// Shift / Enter setup
# ifndef SFTENT_KEY
# define SFTENT_KEY KC_ENT
# endif
2016-05-25 09:48:46 +06:00
static bool shift_interrupted [ 2 ] = { 0 , 0 } ;
2017-04-03 22:42:58 +06:00
static uint16_t scs_timer [ 2 ] = { 0 , 0 } ;
2016-05-25 09:27:59 +06:00
2017-08-12 15:57:42 +06:00
/* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
* Used to ensure that the correct keycode is released if the key is released .
*/
static bool grave_esc_was_shifted = false ;
2016-05-15 10:47:25 +06:00
bool process_record_quantum ( keyrecord_t * record ) {
2016-05-15 10:27:32 +06:00
/* This gets the keycode from the key pressed */
keypos_t key = record - > event . key ;
uint16_t keycode ;
# if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
2016-08-18 05:34:05 +06:00
/* TODO: Use store_or_get_action() or a similar function. */
if ( ! disable_action_cache ) {
uint8_t layer ;
2016-05-15 10:27:32 +06:00
2016-08-18 05:34:05 +06:00
if ( record - > event . pressed ) {
layer = layer_switch_get_layer ( key ) ;
update_source_layers_cache ( key , layer ) ;
} else {
layer = read_source_layers_cache ( key ) ;
}
keycode = keymap_key_to_keycode ( layer , key ) ;
} else
2016-05-15 10:27:32 +06:00
# endif
2016-08-18 05:34:05 +06:00
keycode = keymap_key_to_keycode ( layer_switch_get_layer ( key ) , key ) ;
2016-05-15 10:27:32 +06:00
2016-05-15 10:47:25 +06:00
// This is how you use actions here
// if (keycode == KC_LEAD) {
// action_t action;
// action.code = ACTION_DEFAULT_LAYER_SET(0);
// process_action(record, action);
// return false;
// }
2018-02-05 00:45:19 +06:00
# ifdef TAP_DANCE_ENABLE
preprocess_tap_dance ( keycode , record ) ;
# endif
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-30 03:49:41 +06:00
if ( ! (
2017-08-06 14:50:20 +06:00
# if defined(KEY_LOCK_ENABLE)
// Must run first to be able to mask key_up events.
2017-08-07 03:14:27 +06:00
process_key_lock ( & keycode , record ) & &
2017-08-06 14:50:20 +06:00
# endif
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-30 03:49:41 +06:00
process_record_kb ( keycode , record ) & &
2017-02-26 05:02:43 +06:00
# if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
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-30 03:49:41 +06:00
process_midi ( keycode , record ) & &
2016-05-15 10:51:06 +06:00
# endif
2016-05-15 10:27:32 +06:00
# ifdef AUDIO_ENABLE
2017-02-26 09:25:33 +06:00
process_audio ( keycode , record ) & &
# endif
2017-07-27 03:41:39 +06:00
# ifdef STENO_ENABLE
process_steno ( keycode , record ) & &
# endif
2017-02-26 05:02:43 +06:00
# if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
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-30 03:49:41 +06:00
process_music ( keycode , record ) & &
2016-05-15 10:27:32 +06:00
# endif
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-30 03:49:41 +06:00
# ifdef TAP_DANCE_ENABLE
process_tap_dance ( keycode , record ) & &
# endif
# ifndef DISABLE_LEADER
process_leader ( keycode , record ) & &
# endif
# ifndef DISABLE_CHORDING
process_chording ( keycode , record ) & &
# endif
2016-12-17 02:00:29 +06:00
# ifdef COMBO_ENABLE
process_combo ( keycode , record ) & &
# endif
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-30 03:49:41 +06:00
# ifdef UNICODE_ENABLE
process_unicode ( keycode , record ) & &
2016-08-13 15:14:42 +06:00
# endif
# ifdef UCIS_ENABLE
process_ucis ( keycode , record ) & &
2016-10-17 02:03:33 +06:00
# endif
# ifdef PRINTING_ENABLE
process_printer ( keycode , record ) & &
2016-11-14 10:02:38 +06:00
# endif
2017-09-17 11:33:28 +06:00
# ifdef AUTO_SHIFT_ENABLE
process_auto_shift ( keycode , record ) & &
# endif
2016-10-09 23:46:20 +06:00
# ifdef UNICODEMAP_ENABLE
process_unicode_map ( keycode , record ) & &
2017-09-12 10:43:10 +06:00
# endif
# ifdef TERMINAL_ENABLE
process_terminal ( keycode , record ) & &
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-30 03:49:41 +06:00
# endif
true ) ) {
return false ;
2016-05-19 09:47:16 +06:00
}
2016-06-18 07:42:59 +06:00
// Shift / paren setup
2016-05-25 09:27:59 +06:00
switch ( keycode ) {
2016-06-19 00:30:24 +06:00
case RESET :
if ( record - > event . pressed ) {
2016-07-13 20:38:02 +06:00
reset_keyboard ( ) ;
2016-06-19 00:30:24 +06:00
}
2017-09-07 03:49:19 +06:00
return false ;
2016-06-19 00:30:24 +06:00
case DEBUG :
if ( record - > event . pressed ) {
debug_enable = true ;
2017-09-06 22:19:40 +06:00
print ( " DEBUG: enabled. \n " ) ;
2016-06-19 00:30:24 +06:00
}
2017-09-07 03:49:19 +06:00
return false ;
2017-02-13 13:55:35 +06:00
# ifdef FAUXCLICKY_ENABLE
case FC_TOG :
if ( record - > event . pressed ) {
FAUXCLICKY_TOGGLE ;
}
return false ;
case FC_ON :
if ( record - > event . pressed ) {
FAUXCLICKY_ON ;
}
return false ;
case FC_OFF :
if ( record - > event . pressed ) {
FAUXCLICKY_OFF ;
}
return false ;
# endif
2017-09-07 03:49:19 +06:00
# ifdef RGBLIGHT_ENABLE
case RGB_TOG :
if ( record - > event . pressed ) {
rgblight_toggle ( ) ;
}
return false ;
2017-12-05 00:36:24 +06:00
case RGB_MODE_FORWARD :
2017-09-07 03:49:19 +06:00
if ( record - > event . pressed ) {
2017-12-05 00:36:24 +06:00
uint8_t shifted = get_mods ( ) & ( MOD_BIT ( KC_LSHIFT ) | MOD_BIT ( KC_RSHIFT ) ) ;
if ( shifted ) {
rgblight_step_reverse ( ) ;
}
else {
rgblight_step ( ) ;
}
2017-09-07 03:49:19 +06:00
}
return false ;
2017-12-05 00:36:24 +06:00
case RGB_MODE_REVERSE :
2017-10-25 03:17:47 +06:00
if ( record - > event . pressed ) {
uint8_t shifted = get_mods ( ) & ( MOD_BIT ( KC_LSHIFT ) | MOD_BIT ( KC_RSHIFT ) ) ;
if ( shifted ) {
2017-12-05 00:36:24 +06:00
rgblight_step ( ) ;
2017-10-25 03:17:47 +06:00
}
else {
2017-12-05 00:36:24 +06:00
rgblight_step_reverse ( ) ;
2017-10-25 03:17:47 +06:00
}
}
return false ;
2017-09-07 03:49:19 +06:00
case RGB_HUI :
if ( record - > event . pressed ) {
rgblight_increase_hue ( ) ;
}
return false ;
case RGB_HUD :
if ( record - > event . pressed ) {
rgblight_decrease_hue ( ) ;
}
return false ;
case RGB_SAI :
if ( record - > event . pressed ) {
rgblight_increase_sat ( ) ;
}
return false ;
case RGB_SAD :
if ( record - > event . pressed ) {
rgblight_decrease_sat ( ) ;
}
return false ;
case RGB_VAI :
if ( record - > event . pressed ) {
rgblight_increase_val ( ) ;
}
return false ;
case RGB_VAD :
if ( record - > event . pressed ) {
rgblight_decrease_val ( ) ;
}
return false ;
case RGB_MODE_PLAIN :
if ( record - > event . pressed ) {
rgblight_mode ( 1 ) ;
}
return false ;
case RGB_MODE_BREATHE :
if ( record - > event . pressed ) {
if ( ( 2 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 5 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 2 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
case RGB_MODE_RAINBOW :
if ( record - > event . pressed ) {
if ( ( 6 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 8 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 6 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
case RGB_MODE_SWIRL :
if ( record - > event . pressed ) {
if ( ( 9 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 14 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 9 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
case RGB_MODE_SNAKE :
if ( record - > event . pressed ) {
if ( ( 15 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 20 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 15 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
case RGB_MODE_KNIGHT :
if ( record - > event . pressed ) {
if ( ( 21 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 23 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 21 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
case RGB_MODE_XMAS :
if ( record - > event . pressed ) {
rgblight_mode ( 24 ) ;
}
return false ;
case RGB_MODE_GRADIENT :
if ( record - > event . pressed ) {
if ( ( 25 < = rgblight_get_mode ( ) ) & & ( rgblight_get_mode ( ) < 34 ) ) {
rgblight_step ( ) ;
} else {
rgblight_mode ( 25 ) ;
2016-07-08 13:32:28 +06:00
}
2017-09-07 03:49:19 +06:00
}
return false ;
# endif
2017-02-01 21:30:06 +06:00
# ifdef PROTOCOL_LUFA
2017-02-01 14:35:21 +06:00
case OUT_AUTO :
if ( record - > event . pressed ) {
set_output ( OUTPUT_AUTO ) ;
}
return false ;
case OUT_USB :
if ( record - > event . pressed ) {
set_output ( OUTPUT_USB ) ;
}
return false ;
# ifdef BLUETOOTH_ENABLE
case OUT_BT :
if ( record - > event . pressed ) {
set_output ( OUTPUT_BLUETOOTH ) ;
}
return false ;
# endif
2017-02-01 18:37:52 +06:00
# endif
2016-09-07 10:19:01 +06:00
case MAGIC_SWAP_CONTROL_CAPSLOCK . . . MAGIC_TOGGLE_NKRO :
2016-06-19 00:30:24 +06:00
if ( record - > event . pressed ) {
// MAGIC actions (BOOTMAGIC without the boot)
if ( ! eeconfig_is_enabled ( ) ) {
eeconfig_init ( ) ;
}
/* keymap config */
keymap_config . raw = eeconfig_read_keymap ( ) ;
2016-09-07 10:19:01 +06:00
switch ( keycode )
{
case MAGIC_SWAP_CONTROL_CAPSLOCK :
keymap_config . swap_control_capslock = true ;
break ;
case MAGIC_CAPSLOCK_TO_CONTROL :
keymap_config . capslock_to_control = true ;
break ;
case MAGIC_SWAP_LALT_LGUI :
keymap_config . swap_lalt_lgui = true ;
break ;
case MAGIC_SWAP_RALT_RGUI :
keymap_config . swap_ralt_rgui = true ;
break ;
case MAGIC_NO_GUI :
keymap_config . no_gui = true ;
break ;
case MAGIC_SWAP_GRAVE_ESC :
keymap_config . swap_grave_esc = true ;
break ;
case MAGIC_SWAP_BACKSLASH_BACKSPACE :
keymap_config . swap_backslash_backspace = true ;
break ;
case MAGIC_HOST_NKRO :
keymap_config . nkro = true ;
break ;
case MAGIC_SWAP_ALT_GUI :
keymap_config . swap_lalt_lgui = true ;
keymap_config . swap_ralt_rgui = true ;
2017-07-21 09:57:11 +06:00
# ifdef AUDIO_ENABLE
PLAY_SONG ( ag_swap_song ) ;
# endif
2016-09-07 10:19:01 +06:00
break ;
case MAGIC_UNSWAP_CONTROL_CAPSLOCK :
keymap_config . swap_control_capslock = false ;
break ;
case MAGIC_UNCAPSLOCK_TO_CONTROL :
keymap_config . capslock_to_control = false ;
break ;
case MAGIC_UNSWAP_LALT_LGUI :
keymap_config . swap_lalt_lgui = false ;
break ;
case MAGIC_UNSWAP_RALT_RGUI :
keymap_config . swap_ralt_rgui = false ;
break ;
case MAGIC_UNNO_GUI :
keymap_config . no_gui = false ;
break ;
case MAGIC_UNSWAP_GRAVE_ESC :
keymap_config . swap_grave_esc = false ;
break ;
case MAGIC_UNSWAP_BACKSLASH_BACKSPACE :
keymap_config . swap_backslash_backspace = false ;
break ;
case MAGIC_UNHOST_NKRO :
keymap_config . nkro = false ;
break ;
case MAGIC_UNSWAP_ALT_GUI :
keymap_config . swap_lalt_lgui = false ;
keymap_config . swap_ralt_rgui = false ;
2017-07-21 09:57:11 +06:00
# ifdef AUDIO_ENABLE
PLAY_SONG ( ag_norm_song ) ;
# endif
2016-09-07 10:19:01 +06:00
break ;
case MAGIC_TOGGLE_NKRO :
keymap_config . nkro = ! keymap_config . nkro ;
break ;
default :
break ;
2016-06-19 00:30:24 +06:00
}
eeconfig_update_keymap ( keymap_config . raw ) ;
2016-09-07 10:19:01 +06:00
clear_keyboard ( ) ; // clear to prevent stuck keys
2016-06-19 00:30:24 +06:00
return false ;
}
break ;
2016-05-25 09:27:59 +06:00
case KC_LSPO : {
2016-06-19 00:30:24 +06:00
if ( record - > event . pressed ) {
shift_interrupted [ 0 ] = false ;
2017-04-03 22:42:58 +06:00
scs_timer [ 0 ] = timer_read ( ) ;
2016-06-21 08:36:36 +06:00
register_mods ( MOD_BIT ( KC_LSFT ) ) ;
2016-06-19 00:30:24 +06:00
}
else {
2016-07-11 08:04:01 +06:00
# ifdef DISABLE_SPACE_CADET_ROLLOVER
if ( get_mods ( ) & MOD_BIT ( KC_RSFT ) ) {
shift_interrupted [ 0 ] = true ;
shift_interrupted [ 1 ] = true ;
}
# endif
2017-04-03 22:42:58 +06:00
if ( ! shift_interrupted [ 0 ] & & timer_elapsed ( scs_timer [ 0 ] ) < TAPPING_TERM ) {
2016-06-19 00:30:24 +06:00
register_code ( LSPO_KEY ) ;
unregister_code ( LSPO_KEY ) ;
}
2016-06-21 08:36:36 +06:00
unregister_mods ( MOD_BIT ( KC_LSFT ) ) ;
2016-06-19 00:30:24 +06:00
}
return false ;
}
2016-05-25 09:27:59 +06:00
case KC_RSPC : {
2016-06-19 00:30:24 +06:00
if ( record - > event . pressed ) {
shift_interrupted [ 1 ] = false ;
2017-04-03 22:42:58 +06:00
scs_timer [ 1 ] = timer_read ( ) ;
2016-06-21 08:36:36 +06:00
register_mods ( MOD_BIT ( KC_RSFT ) ) ;
2016-06-19 00:30:24 +06:00
}
else {
2016-07-11 08:04:01 +06:00
# ifdef DISABLE_SPACE_CADET_ROLLOVER
if ( get_mods ( ) & MOD_BIT ( KC_LSFT ) ) {
shift_interrupted [ 0 ] = true ;
shift_interrupted [ 1 ] = true ;
}
# endif
2017-04-03 22:42:58 +06:00
if ( ! shift_interrupted [ 1 ] & & timer_elapsed ( scs_timer [ 1 ] ) < TAPPING_TERM ) {
2016-06-19 00:30:24 +06:00
register_code ( RSPC_KEY ) ;
unregister_code ( RSPC_KEY ) ;
}
2016-06-21 08:36:36 +06:00
unregister_mods ( MOD_BIT ( KC_RSFT ) ) ;
2016-06-19 00:30:24 +06:00
}
return false ;
}
2017-12-14 11:20:44 +06:00
case KC_SFTENT : {
if ( record - > event . pressed ) {
shift_interrupted [ 1 ] = false ;
scs_timer [ 1 ] = timer_read ( ) ;
register_mods ( MOD_BIT ( KC_RSFT ) ) ;
}
else if ( ! shift_interrupted [ 1 ] & & timer_elapsed ( scs_timer [ 1 ] ) < TAPPING_TERM ) {
unregister_mods ( MOD_BIT ( KC_RSFT ) ) ;
register_code ( SFTENT_KEY ) ;
unregister_code ( SFTENT_KEY ) ;
}
else {
unregister_mods ( MOD_BIT ( KC_RSFT ) ) ;
}
return false ;
}
2017-06-17 03:56:50 +06:00
case GRAVE_ESC : {
uint8_t shifted = get_mods ( ) & ( ( MOD_BIT ( KC_LSHIFT ) | MOD_BIT ( KC_RSHIFT )
| MOD_BIT ( KC_LGUI ) | MOD_BIT ( KC_RGUI ) ) ) ;
2017-08-12 15:57:42 +06:00
2017-11-29 04:08:32 +06:00
# ifdef GRAVE_ESC_ALT_OVERRIDE
// if ALT is pressed, ESC is always sent
// this is handy for the cmd+opt+esc shortcut on macOS, among other things.
if ( get_mods ( ) & ( MOD_BIT ( KC_LALT ) | MOD_BIT ( KC_RALT ) ) ) {
shifted = 0 ;
}
# endif
2017-08-11 22:53:08 +06:00
# ifdef GRAVE_ESC_CTRL_OVERRIDE
2017-11-29 04:08:32 +06:00
// if CTRL is pressed, ESC is always sent
2017-08-12 01:43:49 +06:00
// this is handy for the ctrl+shift+esc shortcut on windows, among other things.
2017-11-29 04:08:32 +06:00
if ( get_mods ( ) & ( MOD_BIT ( KC_LCTL ) | MOD_BIT ( KC_RCTL ) ) ) {
2017-08-11 22:53:08 +06:00
shifted = 0 ;
2017-11-29 04:08:32 +06:00
}
# endif
# ifdef GRAVE_ESC_GUI_OVERRIDE
// if GUI is pressed, ESC is always sent
if ( get_mods ( ) & ( MOD_BIT ( KC_LGUI ) | MOD_BIT ( KC_RGUI ) ) ) {
shifted = 0 ;
}
# endif
# ifdef GRAVE_ESC_SHIFT_OVERRIDE
// if SHIFT is pressed, ESC is always sent
if ( get_mods ( ) & ( MOD_BIT ( KC_LSHIFT ) | MOD_BIT ( KC_RSHIFT ) ) ) {
shifted = 0 ;
}
2017-08-11 22:53:08 +06:00
# endif
2017-06-17 03:56:50 +06:00
2017-08-12 15:57:42 +06:00
if ( record - > event . pressed ) {
grave_esc_was_shifted = shifted ;
add_key ( shifted ? KC_GRAVE : KC_ESCAPE ) ;
}
else {
del_key ( grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE ) ;
}
send_keyboard_report ( ) ;
2018-01-02 04:47:51 +06:00
return false ;
2017-06-17 03:56:50 +06:00
}
2018-01-02 04:47:51 +06:00
# if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_BREATHING)
case BL_BRTG : {
if ( record - > event . pressed )
breathing_toggle ( ) ;
return false ;
}
# endif
2016-05-25 09:27:59 +06:00
default : {
2016-06-19 00:30:24 +06:00
shift_interrupted [ 0 ] = true ;
shift_interrupted [ 1 ] = true ;
break ;
}
2016-05-25 09:27:59 +06:00
}
2016-05-15 10:27:32 +06:00
return process_action_kb ( record ) ;
}
2017-07-01 01:08:09 +06:00
__attribute__ ( ( weak ) )
2017-06-29 23:02:38 +06:00
const bool ascii_to_shift_lut [ 0x80 ] PROGMEM = {
2016-06-04 01:48:40 +06:00
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 1 , 1 , 1 , 1 , 1 , 1 , 0 ,
1 , 1 , 1 , 1 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 1 , 0 , 1 , 0 , 1 , 1 ,
1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 ,
1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 ,
1 , 1 , 1 , 1 , 1 , 1 , 1 , 1 ,
1 , 1 , 1 , 0 , 0 , 0 , 1 , 1 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 1 , 1 , 1 , 1 , 0
2016-06-02 08:49:55 +06:00
} ;
2017-07-01 01:08:09 +06:00
__attribute__ ( ( weak ) )
2017-06-29 23:02:38 +06:00
const uint8_t ascii_to_keycode_lut [ 0x80 ] PROGMEM = {
2016-06-04 01:48:40 +06:00
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
KC_BSPC , KC_TAB , KC_ENT , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ,
0 , 0 , 0 , KC_ESC , 0 , 0 , 0 , 0 ,
KC_SPC , KC_1 , KC_QUOT , KC_3 , KC_4 , KC_5 , KC_7 , KC_QUOT ,
KC_9 , KC_0 , KC_8 , KC_EQL , KC_COMM , KC_MINS , KC_DOT , KC_SLSH ,
KC_0 , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 ,
KC_8 , KC_9 , KC_SCLN , KC_SCLN , KC_COMM , KC_EQL , KC_DOT , KC_SLSH ,
KC_2 , KC_A , KC_B , KC_C , KC_D , KC_E , KC_F , KC_G ,
KC_H , KC_I , KC_J , KC_K , KC_L , KC_M , KC_N , KC_O ,
KC_P , KC_Q , KC_R , KC_S , KC_T , KC_U , KC_V , KC_W ,
KC_X , KC_Y , KC_Z , KC_LBRC , KC_BSLS , KC_RBRC , KC_6 , KC_MINS ,
KC_GRV , KC_A , KC_B , KC_C , KC_D , KC_E , KC_F , KC_G ,
KC_H , KC_I , KC_J , KC_K , KC_L , KC_M , KC_N , KC_O ,
KC_P , KC_Q , KC_R , KC_S , KC_T , KC_U , KC_V , KC_W ,
KC_X , KC_Y , KC_Z , KC_LBRC , KC_BSLS , KC_RBRC , KC_GRV , KC_DEL
2016-06-02 08:49:55 +06:00
} ;
2017-06-24 15:29:37 +06:00
void send_string ( const char * str ) {
2017-06-29 23:02:38 +06:00
send_string_with_delay ( str , 0 ) ;
}
2017-09-12 10:43:10 +06:00
void send_string_P ( const char * str ) {
send_string_with_delay_P ( str , 0 ) ;
}
2017-06-29 23:02:38 +06:00
void send_string_with_delay ( const char * str , uint8_t interval ) {
2017-06-24 15:29:37 +06:00
while ( 1 ) {
2017-09-12 10:43:10 +06:00
char ascii_code = * str ;
2017-06-24 15:29:37 +06:00
if ( ! ascii_code ) break ;
2017-09-12 10:43:10 +06:00
if ( ascii_code = = 1 ) {
// tap
uint8_t keycode = * ( + + str ) ;
register_code ( keycode ) ;
unregister_code ( keycode ) ;
} else if ( ascii_code = = 2 ) {
// down
uint8_t keycode = * ( + + str ) ;
register_code ( keycode ) ;
} else if ( ascii_code = = 3 ) {
// up
uint8_t keycode = * ( + + str ) ;
unregister_code ( keycode ) ;
} else {
send_char ( ascii_code ) ;
2017-06-24 15:29:37 +06:00
}
2017-09-12 10:43:10 +06:00
+ + str ;
// interval
{ uint8_t ms = interval ; while ( ms - - ) wait_ms ( 1 ) ; }
}
}
void send_string_with_delay_P ( const char * str , uint8_t interval ) {
while ( 1 ) {
char ascii_code = pgm_read_byte ( str ) ;
if ( ! ascii_code ) break ;
if ( ascii_code = = 1 ) {
// tap
uint8_t keycode = pgm_read_byte ( + + str ) ;
register_code ( keycode ) ;
unregister_code ( keycode ) ;
} else if ( ascii_code = = 2 ) {
// down
uint8_t keycode = pgm_read_byte ( + + str ) ;
register_code ( keycode ) ;
} else if ( ascii_code = = 3 ) {
// up
uint8_t keycode = pgm_read_byte ( + + str ) ;
unregister_code ( keycode ) ;
} else {
send_char ( ascii_code ) ;
2017-06-24 15:29:37 +06:00
}
+ + str ;
2017-06-29 23:02:38 +06:00
// interval
{ uint8_t ms = interval ; while ( ms - - ) wait_ms ( 1 ) ; }
2017-06-24 15:29:37 +06:00
}
}
2017-09-12 10:43:10 +06:00
void send_char ( char ascii_code ) {
uint8_t keycode ;
keycode = pgm_read_byte ( & ascii_to_keycode_lut [ ( uint8_t ) ascii_code ] ) ;
if ( pgm_read_byte ( & ascii_to_shift_lut [ ( uint8_t ) ascii_code ] ) ) {
register_code ( KC_LSFT ) ;
register_code ( keycode ) ;
unregister_code ( keycode ) ;
unregister_code ( KC_LSFT ) ;
} else {
register_code ( keycode ) ;
unregister_code ( keycode ) ;
}
}
2017-07-21 09:57:11 +06:00
void set_single_persistent_default_layer ( uint8_t default_layer ) {
2017-08-11 02:52:24 +06:00
# if defined(AUDIO_ENABLE) && defined(DEFAULT_LAYER_SONGS)
2017-07-21 09:57:11 +06:00
PLAY_SONG ( default_layer_songs [ default_layer ] ) ;
# endif
eeconfig_update_default_layer ( 1U < < default_layer ) ;
default_layer_set ( 1U < < default_layer ) ;
}
2016-06-19 00:30:24 +06:00
void update_tri_layer ( uint8_t layer1 , uint8_t layer2 , uint8_t layer3 ) {
if ( IS_LAYER_ON ( layer1 ) & & IS_LAYER_ON ( layer2 ) ) {
layer_on ( layer3 ) ;
} else {
layer_off ( layer3 ) ;
}
}
2016-06-02 08:49:55 +06:00
2016-06-30 04:29:20 +06:00
void tap_random_base64 ( void ) {
2016-06-30 04:35:29 +06:00
# if defined(__AVR_ATmega32U4__)
uint8_t key = ( TCNT0 + TCNT1 + TCNT3 + TCNT4 ) % 64 ;
# else
uint8_t key = rand ( ) % 64 ;
# endif
2016-06-30 04:29:20 +06:00
switch ( key ) {
case 0 . . . 25 :
register_code ( KC_LSFT ) ;
register_code ( key + KC_A ) ;
unregister_code ( key + KC_A ) ;
unregister_code ( KC_LSFT ) ;
break ;
case 26 . . . 51 :
register_code ( key - 26 + KC_A ) ;
unregister_code ( key - 26 + KC_A ) ;
break ;
case 52 :
register_code ( KC_0 ) ;
unregister_code ( KC_0 ) ;
break ;
case 53 . . . 61 :
register_code ( key - 53 + KC_1 ) ;
unregister_code ( key - 53 + KC_1 ) ;
break ;
case 62 :
register_code ( KC_LSFT ) ;
register_code ( KC_EQL ) ;
unregister_code ( KC_EQL ) ;
unregister_code ( KC_LSFT ) ;
break ;
case 63 :
register_code ( KC_SLSH ) ;
unregister_code ( KC_SLSH ) ;
break ;
}
}
2016-05-15 10:27:32 +06:00
void matrix_init_quantum ( ) {
2016-06-24 08:18:20 +06:00
# ifdef BACKLIGHT_ENABLE
backlight_init_ports ( ) ;
# endif
2017-07-21 09:57:11 +06:00
# ifdef AUDIO_ENABLE
audio_init ( ) ;
# endif
2016-05-15 10:27:32 +06:00
matrix_init_kb ( ) ;
}
void matrix_scan_quantum ( ) {
2016-05-15 10:40:59 +06:00
# ifdef AUDIO_ENABLE
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-30 03:49:41 +06:00
matrix_scan_music ( ) ;
2016-05-15 10:40:59 +06:00
# endif
2016-05-15 10:51:06 +06:00
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-30 03:49:41 +06:00
# ifdef TAP_DANCE_ENABLE
matrix_scan_tap_dance ( ) ;
# endif
2016-12-10 20:11:59 +06:00
# ifdef COMBO_ENABLE
matrix_scan_combo ( ) ;
# endif
2017-02-12 22:29:42 +06:00
# if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
backlight_task ( ) ;
# endif
2016-05-15 10:27:32 +06:00
matrix_scan_kb ( ) ;
2016-05-19 09:14:00 +06:00
}
2016-06-24 08:18:20 +06:00
# if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
static const uint8_t backlight_pin = BACKLIGHT_PIN ;
2018-01-02 04:47:51 +06:00
// depending on the pin, we use a different output compare unit
2016-06-24 08:18:20 +06:00
# if BACKLIGHT_PIN == B7
# define COM1x1 COM1C1
# define OCR1x OCR1C
# elif BACKLIGHT_PIN == B6
# define COM1x1 COM1B1
# define OCR1x OCR1B
# elif BACKLIGHT_PIN == B5
# define COM1x1 COM1A1
# define OCR1x OCR1A
# else
2018-01-02 04:47:51 +06:00
# define NO_HARDWARE_PWM
2017-02-08 02:23:56 +06:00
# endif
# ifndef BACKLIGHT_ON_STATE
# define BACKLIGHT_ON_STATE 0
2016-06-24 08:18:20 +06:00
# endif
2018-01-02 04:47:51 +06:00
# ifdef NO_HARDWARE_PWM // pwm through software
2016-06-24 08:18:20 +06:00
__attribute__ ( ( weak ) )
void backlight_init_ports ( void )
{
2017-02-08 02:23:56 +06:00
// Setup backlight pin as output and output to on state.
2016-06-24 08:18:20 +06:00
// DDRx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 1 ) | = _BV ( backlight_pin & 0xF ) ;
2017-02-08 02:23:56 +06:00
# if BACKLIGHT_ON_STATE == 0
// PORTx &= ~n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) & = ~ _BV ( backlight_pin & 0xF ) ;
# else
// PORTx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) | = _BV ( backlight_pin & 0xF ) ;
# endif
2016-06-24 08:18:20 +06:00
}
__attribute__ ( ( weak ) )
2018-01-02 04:47:51 +06:00
void backlight_set ( uint8_t level ) { }
2016-06-24 08:18:20 +06:00
2017-02-12 22:29:42 +06:00
uint8_t backlight_tick = 0 ;
2018-01-19 03:02:32 +06:00
# ifndef BACKLIGHT_CUSTOM_DRIVER
2017-02-12 22:29:42 +06:00
void backlight_task ( void ) {
2018-01-02 04:47:51 +06:00
if ( ( 0xFFFF > > ( ( BACKLIGHT_LEVELS - get_backlight_level ( ) ) * ( ( BACKLIGHT_LEVELS + 1 ) / 2 ) ) ) & ( 1 < < backlight_tick ) ) {
2017-02-12 22:29:42 +06:00
# if BACKLIGHT_ON_STATE == 0
// PORTx &= ~n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) & = ~ _BV ( backlight_pin & 0xF ) ;
# else
// PORTx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) | = _BV ( backlight_pin & 0xF ) ;
# endif
} else {
# if BACKLIGHT_ON_STATE == 0
// PORTx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) | = _BV ( backlight_pin & 0xF ) ;
# else
// PORTx &= ~n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) & = ~ _BV ( backlight_pin & 0xF ) ;
# endif
}
2018-02-02 04:12:23 +06:00
backlight_tick = ( backlight_tick + 1 ) % 16 ;
2017-02-12 22:29:42 +06:00
}
2018-01-19 03:02:32 +06:00
# endif
2016-06-24 08:18:20 +06:00
# ifdef BACKLIGHT_BREATHING
2018-01-19 03:02:32 +06:00
# ifndef BACKLIGHT_CUSTOM_DRIVER
# error "Backlight breathing only available with hardware PWM. Please disable."
# endif
2018-01-02 04:47:51 +06:00
# endif
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
# else // pwm through timer
# define TIMER_TOP 0xFFFFU
// See http://jared.geek.nz/2013/feb/linear-led-pwm
static uint16_t cie_lightness ( uint16_t v ) {
if ( v < = 5243 ) // if below 8% of max
return v / 9 ; // same as dividing by 900%
else {
uint32_t y = ( ( ( uint32_t ) v + 10486 ) < < 8 ) / ( 10486 + 0xFFFFUL ) ; // add 16% of max and compare
// to get a useful result with integer division, we shift left in the expression above
// and revert what we've done again after squaring.
y = y * y * y > > 8 ;
if ( y > 0xFFFFUL ) // prevent overflow
return 0xFFFFU ;
else
return ( uint16_t ) y ;
}
}
// range for val is [0..TIMER_TOP]. PWM pin is high while the timer count is below val.
static inline void set_pwm ( uint16_t val ) {
OCR1x = val ;
}
2018-01-19 03:02:32 +06:00
# ifndef BACKLIGHT_CUSTOM_DRIVER
2018-01-02 04:47:51 +06:00
__attribute__ ( ( weak ) )
void backlight_set ( uint8_t level ) {
if ( level > BACKLIGHT_LEVELS )
level = BACKLIGHT_LEVELS ;
if ( level = = 0 ) {
// Turn off PWM control on backlight pin
TCCR1A & = ~ ( _BV ( COM1x1 ) ) ;
} else {
// Turn on PWM control of backlight pin
TCCR1A | = _BV ( COM1x1 ) ;
}
// Set the brightness
set_pwm ( cie_lightness ( TIMER_TOP * ( uint32_t ) level / BACKLIGHT_LEVELS ) ) ;
}
void backlight_task ( void ) { }
2018-01-19 03:02:32 +06:00
# endif // BACKLIGHT_CUSTOM_DRIVER
2018-01-02 04:47:51 +06:00
# ifdef BACKLIGHT_BREATHING
2017-12-06 03:13:27 +06:00
2016-06-24 08:18:20 +06:00
# define BREATHING_NO_HALT 0
# define BREATHING_HALT_OFF 1
# define BREATHING_HALT_ON 2
2018-01-02 04:47:51 +06:00
# define BREATHING_STEPS 128
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
static uint8_t breathing_period = BREATHING_PERIOD ;
static uint8_t breathing_halt = BREATHING_NO_HALT ;
static uint16_t breathing_counter = 0 ;
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
bool is_breathing ( void ) {
return ! ! ( TIMSK1 & _BV ( TOIE1 ) ) ;
}
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
# define breathing_interrupt_enable() do {TIMSK1 |= _BV(TOIE1);} while (0)
# define breathing_interrupt_disable() do {TIMSK1 &= ~_BV(TOIE1);} while (0)
# define breathing_min() do {breathing_counter = 0;} while (0)
# define breathing_max() do {breathing_counter = breathing_period * 244 / 2;} while (0)
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
void breathing_enable ( void )
{
breathing_counter = 0 ;
breathing_halt = BREATHING_NO_HALT ;
breathing_interrupt_enable ( ) ;
2016-06-24 08:18:20 +06:00
}
void breathing_pulse ( void )
{
if ( get_backlight_level ( ) = = 0 )
2018-01-02 04:47:51 +06:00
breathing_min ( ) ;
2016-06-24 08:18:20 +06:00
else
2018-01-02 04:47:51 +06:00
breathing_max ( ) ;
2016-06-24 08:18:20 +06:00
breathing_halt = BREATHING_HALT_ON ;
2018-01-02 04:47:51 +06:00
breathing_interrupt_enable ( ) ;
2016-06-24 08:18:20 +06:00
}
void breathing_disable ( void )
{
2018-01-02 04:47:51 +06:00
breathing_interrupt_disable ( ) ;
// Restore backlight level
2016-06-24 08:18:20 +06:00
backlight_set ( get_backlight_level ( ) ) ;
}
void breathing_self_disable ( void )
{
2018-01-02 04:47:51 +06:00
if ( get_backlight_level ( ) = = 0 )
breathing_halt = BREATHING_HALT_OFF ;
else
breathing_halt = BREATHING_HALT_ON ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
void breathing_toggle ( void ) {
if ( is_breathing ( ) )
breathing_disable ( ) ;
else
breathing_enable ( ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
void breathing_period_set ( uint8_t value )
2016-06-24 08:18:20 +06:00
{
2018-01-02 04:47:51 +06:00
if ( ! value )
value = 1 ;
breathing_period = value ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
void breathing_period_default ( void ) {
breathing_period_set ( BREATHING_PERIOD ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
void breathing_period_inc ( void )
2016-06-24 08:18:20 +06:00
{
2018-01-02 04:47:51 +06:00
breathing_period_set ( breathing_period + 1 ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
void breathing_period_dec ( void )
2016-06-24 08:18:20 +06:00
{
2018-01-02 04:47:51 +06:00
breathing_period_set ( breathing_period - 1 ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
/* To generate breathing curve in python:
* from math import sin , pi ; [ int ( sin ( x / 128.0 * pi ) * * 4 * 255 ) for x in range ( 128 ) ]
*/
static const uint8_t breathing_table [ BREATHING_STEPS ] PROGMEM = { 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 1 , 1 , 2 , 3 , 4 , 5 , 6 , 8 , 10 , 12 , 15 , 17 , 20 , 24 , 28 , 32 , 36 , 41 , 46 , 51 , 57 , 63 , 70 , 76 , 83 , 91 , 98 , 106 , 113 , 121 , 129 , 138 , 146 , 154 , 162 , 170 , 178 , 185 , 193 , 200 , 207 , 213 , 220 , 225 , 231 , 235 , 240 , 244 , 247 , 250 , 252 , 253 , 254 , 255 , 254 , 253 , 252 , 250 , 247 , 244 , 240 , 235 , 231 , 225 , 220 , 213 , 207 , 200 , 193 , 185 , 178 , 170 , 162 , 154 , 146 , 138 , 129 , 121 , 113 , 106 , 98 , 91 , 83 , 76 , 70 , 63 , 57 , 51 , 46 , 41 , 36 , 32 , 28 , 24 , 20 , 17 , 15 , 12 , 10 , 8 , 6 , 5 , 4 , 3 , 2 , 1 , 1 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 } ;
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
// Use this before the cie_lightness function.
static inline uint16_t scale_backlight ( uint16_t v ) {
return v / BACKLIGHT_LEVELS * get_backlight_level ( ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
/* Assuming a 16MHz CPU clock and a timer that resets at 64k (ICR1), the following interrupt handler will run
* about 244 times per second .
*/
ISR ( TIMER1_OVF_vect )
2016-06-24 08:18:20 +06:00
{
2018-01-02 04:47:51 +06:00
uint16_t interval = ( uint16_t ) breathing_period * 244 / BREATHING_STEPS ;
// resetting after one period to prevent ugly reset at overflow.
breathing_counter = ( breathing_counter + 1 ) % ( breathing_period * 244 ) ;
uint8_t index = breathing_counter / interval % BREATHING_STEPS ;
if ( ( ( breathing_halt = = BREATHING_HALT_ON ) & & ( index = = BREATHING_STEPS / 2 ) ) | |
( ( breathing_halt = = BREATHING_HALT_OFF ) & & ( index = = BREATHING_STEPS - 1 ) ) )
{
breathing_interrupt_disable ( ) ;
}
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
set_pwm ( cie_lightness ( scale_backlight ( ( uint16_t ) pgm_read_byte ( & breathing_table [ index ] ) * 0x0101U ) ) ) ;
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
# endif // BACKLIGHT_BREATHING
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
__attribute__ ( ( weak ) )
void backlight_init_ports ( void )
2016-06-24 08:18:20 +06:00
{
2018-01-02 04:47:51 +06:00
// Setup backlight pin as output and output to on state.
// DDRx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 1 ) | = _BV ( backlight_pin & 0xF ) ;
# if BACKLIGHT_ON_STATE == 0
// PORTx &= ~n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) & = ~ _BV ( backlight_pin & 0xF ) ;
# else
// PORTx |= n
_SFR_IO8 ( ( backlight_pin > > 4 ) + 2 ) | = _BV ( backlight_pin & 0xF ) ;
# endif
// I could write a wall of text here to explain... but TL;DW
// Go read the ATmega32u4 datasheet.
// And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
// Pin PB7 = OCR1C (Timer 1, Channel C)
// Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
// (i.e. start high, go low when counter matches.)
// WGM Mode 14 (Fast PWM) = WGM13=1 WGM12=1 WGM11=1 WGM10=0
// Clock Select = clk/1 (no prescaling) = CS12=0 CS11=0 CS10=1
/*
14.8 .3 :
" In fast PWM mode, the compare units allow generation of PWM waveforms on the OCnx pins. Setting the COMnx1:0 bits to two will produce a non-inverted PWM [..]. "
" In fast PWM mode the counter is incremented until the counter value matches either one of the fixed values 0x00FF, 0x01FF, or 0x03FF (WGMn3:0 = 5, 6, or 7), the value in ICRn (WGMn3:0 = 14), or the value in OCRnA (WGMn3:0 = 15). "
*/
TCCR1A = _BV ( COM1x1 ) | _BV ( WGM11 ) ; // = 0b00001010;
TCCR1B = _BV ( WGM13 ) | _BV ( WGM12 ) | _BV ( CS10 ) ; // = 0b00011001;
// Use full 16-bit resolution. Counter counts to ICR1 before reset to 0.
ICR1 = TIMER_TOP ;
2016-06-24 08:18:20 +06:00
2018-01-02 04:47:51 +06:00
backlight_init ( ) ;
# ifdef BACKLIGHT_BREATHING
breathing_enable ( ) ;
# endif
2016-06-24 08:18:20 +06:00
}
2018-01-02 04:47:51 +06:00
# endif // NO_HARDWARE_PWM
2016-06-24 08:18:20 +06:00
# else // backlight
__attribute__ ( ( weak ) )
2018-01-02 04:47:51 +06:00
void backlight_init_ports ( void ) { }
2016-06-24 08:18:20 +06:00
__attribute__ ( ( weak ) )
2018-01-02 04:47:51 +06:00
void backlight_set ( uint8_t level ) { }
2016-06-24 08:18:20 +06:00
# endif // backlight
2016-11-22 06:50:55 +06:00
// Functions for spitting out values
//
void send_dword ( uint32_t number ) { // this might not actually work
uint16_t word = ( number > > 16 ) ;
send_word ( word ) ;
send_word ( number & 0xFFFFUL ) ;
}
void send_word ( uint16_t number ) {
uint8_t byte = number > > 8 ;
send_byte ( byte ) ;
send_byte ( number & 0xFF ) ;
}
void send_byte ( uint8_t number ) {
uint8_t nibble = number > > 4 ;
send_nibble ( nibble ) ;
send_nibble ( number & 0xF ) ;
}
void send_nibble ( uint8_t number ) {
switch ( number ) {
case 0 :
register_code ( KC_0 ) ;
unregister_code ( KC_0 ) ;
break ;
case 1 . . . 9 :
register_code ( KC_1 + ( number - 1 ) ) ;
unregister_code ( KC_1 + ( number - 1 ) ) ;
break ;
case 0xA . . . 0xF :
register_code ( KC_A + ( number - 0xA ) ) ;
unregister_code ( KC_A + ( number - 0xA ) ) ;
break ;
}
}
2017-02-16 03:36:31 +06:00
__attribute__ ( ( weak ) )
uint16_t hex_to_keycode ( uint8_t hex )
{
2017-11-21 10:25:38 +06:00
hex = hex & 0xF ;
2017-02-16 03:36:31 +06:00
if ( hex = = 0x0 ) {
return KC_0 ;
} else if ( hex < 0xA ) {
return KC_1 + ( hex - 0x1 ) ;
} else {
return KC_A + ( hex - 0xA ) ;
}
}
2016-11-27 02:37:46 +06:00
void api_send_unicode ( uint32_t unicode ) {
# ifdef API_ENABLE
2016-11-24 07:16:38 +06:00
uint8_t chunk [ 4 ] ;
dword_to_bytes ( unicode , chunk ) ;
MT_SEND_DATA ( DT_UNICODE , chunk , 5 ) ;
2016-11-27 02:37:46 +06:00
# endif
2016-11-24 07:16:38 +06:00
}
2016-06-24 08:18:20 +06:00
__attribute__ ( ( weak ) )
void led_set_user ( uint8_t usb_led ) {
}
__attribute__ ( ( weak ) )
void led_set_kb ( uint8_t usb_led ) {
led_set_user ( usb_led ) ;
}
__attribute__ ( ( weak ) )
void led_init_ports ( void )
{
}
__attribute__ ( ( weak ) )
void led_set ( uint8_t usb_led )
{
// Example LED Code
//
// // Using PE6 Caps Lock LED
// if (usb_led & (1<<USB_LED_CAPS_LOCK))
// {
// // Output high.
// DDRE |= (1<<6);
// PORTE |= (1<<6);
// }
// else
// {
// // Output low.
// DDRE &= ~(1<<6);
// PORTE &= ~(1<<6);
// }
led_set_kb ( usb_led ) ;
}
2016-05-24 21:56:53 +06:00
//------------------------------------------------------------------------------
2016-06-04 01:48:40 +06:00
// Override these functions in your keymap file to play different tunes on
2016-05-24 21:56:53 +06:00
// different events such as startup and bootloader jump
__attribute__ ( ( weak ) )
void startup_user ( ) { }
__attribute__ ( ( weak ) )
void shutdown_user ( ) { }
2016-05-25 09:27:59 +06:00
//------------------------------------------------------------------------------
