Kaleidoscope module for proper shifting technique.
Clone or download
Latest commit 2ac8291 Jan 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Make member functions static Jan 22, 2019
COPYING Initial commit. Jun 13, 2018
Makefile Reset sketchbook directory to default. Jun 13, 2018
README.md Update documentation Jan 12, 2019
library.properties Bump version to 1.0. Fix line formatting in legacy plugin API. Jan 13, 2019

README.md

Kaleidoscope-ProperShifting

A plugin for the Keyboardio Model 01 to ensure proper shifting technique.

Purpose

Force the user to use both hands while shifting. Typing a capital A, for instance, requires using the right shift. Capital M, meanwhile, necessitates the left shift.

Motivation

Proper typing technique helps to reduce RSI and other discomforts while spending many hours at the keyboard.

Holding both shift keys behaves like a shift-lock for as long as they're both held. This allows you to type IN ALL CAPS without giving your thumbs an obnoxious workout.

Extra Behavior

The plugin ignores the shifting rules if other modifiers (Control, Alt, or GUI) are also being held. Additionally, the user may enter a pseudo-shiftlock mode by holding both shifts.

Using the plugin

To use the plugin, simply include the header and add it to the list of used plugins.

#include <Kaleidoscope.h>
#include <Kaleidoscope-ProperShifting.h>

KALEIDOSCOPE_INIT_PLUGINS(ProperShifting);

void setup() {
  Kaleidoscope.setup();
}

Plugin Methods

The plugin provides the ProperShifting object, with the following methods:

.enable()

Enable the ProperShifting plugin.

The default behavior is enabled.

.disable()

Disable the ProperShifting plugin.

.active()

This method returns true if ProperShifting is enabled and false if ProperShifting is disabled.

Conflicts and Limitations

ProperShifting will not work correctly with a plugin that injects shifts, such as SpaceCadet and Qukeys. This is because ProperShifting can only detect if shift has been pressed, not if it's been injected.

Additionally, ProperShifting is only active on layer zero. This is because momentary toggling of an alternate layer in order to input a shifted character (such as a curly brace in the default keymap) will sometimes result in the keyboard becoming locked in that alternate layer.