You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
619 lines
14 KiB
619 lines
14 KiB
// Do not remove the include below
|
|
#include "ArduinoKeyboard.h"
|
|
// Copyright 2013 Jesse Vincent <jesse@fsck.com>
|
|
// All Rights Reserved. (To be licensed under an opensource license
|
|
// before the release of the keyboard.io model 01
|
|
|
|
|
|
/**
|
|
* TODO:
|
|
|
|
add mouse acceleration/deceleration
|
|
add mouse inertia
|
|
add series-of-character macros
|
|
add series of keystroke macros
|
|
use a lower-level USB API
|
|
*
|
|
**/
|
|
|
|
|
|
#include <stdio.h>
|
|
#include <math.h>
|
|
|
|
#include "KeyboardConfig.h"
|
|
#include "keymaps_generated.h"
|
|
#include <EEPROM.h> // Don't need this for CLI compilation, but do need it in the IDE
|
|
|
|
//extern int usbMaxPower;
|
|
|
|
|
|
|
|
byte matrixState[ROWS][COLS];
|
|
|
|
|
|
byte charsBeingReported[KEYS_HELD_BUFFER]; // A bit vector for the 256 keys we might conceivably be holding down
|
|
byte charsReportedLastTime[KEYS_HELD_BUFFER]; // A bit vector for the 256 keys we might conceivably be holding down
|
|
|
|
|
|
long reporting_counter = 0;
|
|
byte primary_keymap = 0;
|
|
byte active_keymap = 0;
|
|
|
|
double mouseActiveForCycles = 0;
|
|
float carriedOverX = 0;
|
|
float carriedOverY = 0;
|
|
|
|
|
|
void setup_matrix()
|
|
{
|
|
//blank out the matrix.
|
|
for (byte col = 0; col < COLS; col++) {
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
matrixState[row][col] = 0;
|
|
}
|
|
}
|
|
}
|
|
void reset_matrix()
|
|
{
|
|
for (byte col = 0; col < COLS; col++) {
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
matrixState[row][col] <<= 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
void set_keymap(Key keymapEntry, byte matrixStateEntry) {
|
|
if (keymapEntry.flags & SWITCH_TO_KEYMAP) {
|
|
// this logic sucks. there is a better way TODO this
|
|
if (! (keymapEntry.flags ^ ( MOMENTARY | SWITCH_TO_KEYMAP))) {
|
|
if (key_is_pressed(matrixStateEntry)) {
|
|
if ( keymapEntry.rawKey == KEYMAP_NEXT) {
|
|
active_keymap++;
|
|
} else if ( keymapEntry.rawKey == KEYMAP_PREVIOUS) {
|
|
active_keymap--;
|
|
} else {
|
|
active_keymap = keymapEntry.rawKey;
|
|
}
|
|
}
|
|
} else if (! (keymapEntry.flags ^ ( SWITCH_TO_KEYMAP))) {
|
|
// switch keymap and stay there
|
|
if (key_toggled_on(matrixStateEntry)) {
|
|
active_keymap = primary_keymap = keymapEntry.rawKey;
|
|
save_primary_keymap(primary_keymap);
|
|
Serial.print("keymap is now:");
|
|
Serial.print(active_keymap);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void scan_matrix()
|
|
{
|
|
//scan the Keyboard matrix looking for connections
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
digitalWrite(rowPins[row], LOW);
|
|
for (byte col = 0; col < COLS; col++) {
|
|
//If we see an electrical connection on I->J,
|
|
|
|
if (digitalRead(colPins[col])) {
|
|
matrixState[row][col] |= 0; // noop. just here for clarity
|
|
} else {
|
|
matrixState[row][col] |= 1; // noop. just here for clarity
|
|
}
|
|
// while we're inspecting the electrical matrix, we look
|
|
// to see if the Key being held is a firmware level
|
|
// metakey, so we can act on it, lest we only discover
|
|
// that we should be looking at a seconary Keymap halfway
|
|
// through the matrix scan
|
|
|
|
|
|
set_keymap(keymaps[active_keymap][row][col], matrixState[row][col]);
|
|
|
|
}
|
|
digitalWrite(rowPins[row], HIGH);
|
|
}
|
|
}
|
|
|
|
|
|
void setup()
|
|
{
|
|
//usbMaxPower = 100;
|
|
Serial.begin(115200);
|
|
Keyboard.begin();
|
|
Mouse.begin();
|
|
setup_matrix();
|
|
setup_pins();
|
|
primary_keymap = load_primary_keymap();
|
|
}
|
|
|
|
void loop()
|
|
{
|
|
active_keymap = primary_keymap;
|
|
scan_matrix();
|
|
send_key_events();
|
|
reset_matrix();
|
|
reset_key_report();
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// switch debouncing and status
|
|
//
|
|
//
|
|
|
|
|
|
boolean key_was_pressed (byte keyState)
|
|
{
|
|
if ( byte((keyState >> 4)) ^ B00001111 ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|
|
boolean key_was_not_pressed (byte keyState)
|
|
{
|
|
if ( byte((keyState >> 4)) ^ B00000000 ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|
|
boolean key_is_pressed (byte keyState)
|
|
{
|
|
|
|
if ( byte((keyState << 4)) ^ B11110000 ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
boolean key_is_not_pressed (byte keyState)
|
|
{
|
|
|
|
if ( byte((keyState << 4)) ^ B00000000 ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
boolean key_toggled_on(byte keyState)
|
|
{
|
|
if (key_is_pressed(keyState) && key_was_not_pressed(keyState)) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
boolean key_toggled_off(byte keyState)
|
|
{
|
|
if (key_was_pressed(keyState) && key_is_not_pressed(keyState)) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
|
|
void save_primary_keymap(byte keymap)
|
|
{
|
|
EEPROM.write(EEPROM_KEYMAP_LOCATION, keymap);
|
|
}
|
|
|
|
byte load_primary_keymap()
|
|
{
|
|
byte keymap = EEPROM.read(EEPROM_KEYMAP_LOCATION);
|
|
if (keymap >= KEYMAPS ) {
|
|
return 0; // undefined positions get saved as 255
|
|
}
|
|
return keymap;
|
|
}
|
|
|
|
|
|
|
|
|
|
// Debugging Reporting
|
|
//
|
|
|
|
void report_matrix()
|
|
{
|
|
#ifdef DEBUG_SERIAL
|
|
if (reporting_counter++ % 100 == 0 ) {
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
for (byte col = 0; col < COLS; col++) {
|
|
Serial.print(matrixState[row][col], HEX);
|
|
Serial.print(", ");
|
|
|
|
}
|
|
Serial.println("");
|
|
}
|
|
Serial.println("");
|
|
}
|
|
#endif
|
|
}
|
|
|
|
void report(byte row, byte col, boolean value)
|
|
{
|
|
#ifdef DEBUG_SERIAL
|
|
Serial.print("Detected a change on ");
|
|
Serial.print(col);
|
|
Serial.print(" ");
|
|
Serial.print(row);
|
|
Serial.print(" to ");
|
|
Serial.print(value);
|
|
Serial.println(".");
|
|
#endif
|
|
}
|
|
|
|
|
|
// Mouse-related methods
|
|
//
|
|
//
|
|
|
|
|
|
|
|
int last_x;
|
|
int last_y;
|
|
|
|
// apparently, the mac discards 15% of the value space for mouse movement.
|
|
// need to test this on other platforms
|
|
//
|
|
|
|
int abs_left = -27852; //-32767;
|
|
int abs_right = 27852;//32767;
|
|
int abs_bottom = 27852; //32767;
|
|
int abs_top = -27852; //-32767;
|
|
|
|
long section_top;
|
|
long section_bottom;
|
|
long section_left;
|
|
long section_right;
|
|
boolean is_warping = false;
|
|
|
|
void begin_warping() {
|
|
section_left = abs_left;
|
|
section_right = abs_right;
|
|
section_top = abs_top;
|
|
section_bottom = abs_bottom;
|
|
Serial.print ("just reset the warp");
|
|
is_warping = true;
|
|
|
|
|
|
}
|
|
|
|
void warp_mouse(Key ninth) {
|
|
|
|
// 1 2 3
|
|
// 4 5 6
|
|
// 7 8 9
|
|
|
|
|
|
if (!is_warping) {
|
|
begin_warping();
|
|
}
|
|
|
|
long next_width = (section_right - section_left) / 3;
|
|
long next_height = (section_bottom - section_top) / 3;
|
|
|
|
|
|
if (next_width <=1 || ninth.rawKey & MOUSE_END_WARP) {
|
|
Serial.print ("done warping");
|
|
is_warping = false;
|
|
return;
|
|
}
|
|
|
|
|
|
Serial.print("Left: ");
|
|
Serial.print(section_left);
|
|
Serial.print("Right: ");
|
|
Serial.print(section_right);
|
|
Serial.print("top: ");
|
|
Serial.print(section_top);
|
|
Serial.print("bottom: ");
|
|
Serial.print(section_bottom);
|
|
Serial.print("\nwarping - the next width is ");
|
|
Serial.print(next_width);
|
|
Serial.print("\nwarping - the next height is ");
|
|
Serial.print(next_height);
|
|
|
|
|
|
if (ninth.rawKey & MOUSE_UP) {
|
|
Serial.print(" - up ");
|
|
section_bottom = section_top + next_height;
|
|
} else if (ninth.rawKey & MOUSE_DN) {
|
|
Serial.print(" - down ");
|
|
section_top = section_bottom - next_height;
|
|
} else {
|
|
Serial.print(" - vcenter ");
|
|
section_top = section_top + next_height;
|
|
section_bottom = section_bottom - next_height;
|
|
}
|
|
|
|
if (ninth.rawKey & MOUSE_L) {
|
|
section_right = section_left + next_width;
|
|
Serial.print(" - left ");
|
|
|
|
} else if (ninth.rawKey & MOUSE_R) {
|
|
section_left = section_right - next_width;
|
|
Serial.print(" - right ");
|
|
} else {
|
|
section_left = section_left + next_width;
|
|
section_right = section_right - next_width;
|
|
Serial.print(" - center horizontal ");
|
|
}
|
|
|
|
Serial.print("\nMoving to ");
|
|
Serial.print(section_left + next_width/ 2);
|
|
Serial.print(",");
|
|
Serial.print(section_top + next_height / 2);
|
|
Serial.print("That should be half way between ");
|
|
Serial.print(section_left);
|
|
Serial.print(",");
|
|
Serial.print(section_top);
|
|
Serial.print(" and ");
|
|
Serial.print(section_right);
|
|
Serial.print(",");
|
|
Serial.print(section_bottom);
|
|
Serial.print("\n");
|
|
Mouse.moveAbs(section_left, section_top,0);
|
|
delay(150);
|
|
Mouse.moveAbs(section_right, section_top,0);
|
|
delay(150);
|
|
Mouse.moveAbs(section_right, section_bottom,0);
|
|
delay(150);
|
|
Mouse.moveAbs(section_left, section_bottom,0);
|
|
delay(150);
|
|
int16_t gotox = section_left + next_width / 2;
|
|
int16_t gotoy = section_top + next_height / 2;
|
|
Serial.print("Going to ");
|
|
Serial.print(gotox);
|
|
Serial.print(", ");
|
|
Serial.print(gotoy);
|
|
Serial.print("\n");
|
|
Mouse.moveAbs(gotox,gotoy,0);
|
|
Mouse.moveAbs(gotox,gotoy,0);
|
|
}
|
|
|
|
double mouse_accel (double cycles)
|
|
{
|
|
double accel = atan((cycles / 50) - 5);
|
|
accel += 1.5707963267944; // we want the whole s curve, not just the bit that's usually above the x and y axes;
|
|
accel = accel * 0.85;
|
|
if (accel < 0.25) {
|
|
accel = 0.25;
|
|
}
|
|
return accel;
|
|
}
|
|
|
|
void handle_mouse_movement( char x, char y)
|
|
{
|
|
|
|
if (x != 0 || y != 0) {
|
|
mouseActiveForCycles++;
|
|
double accel = (double) mouse_accel(mouseActiveForCycles);
|
|
float moveX = 0;
|
|
float moveY = 0;
|
|
if (x > 0) {
|
|
moveX = (x * accel) + carriedOverX;
|
|
carriedOverX = moveX - floor(moveX);
|
|
} else if (x < 0) {
|
|
moveX = (x * accel) - carriedOverX;
|
|
carriedOverX = ceil(moveX) - moveX;
|
|
}
|
|
|
|
if (y > 0) {
|
|
moveY = (y * accel) + carriedOverY;
|
|
carriedOverY = moveY - floor(moveY);
|
|
} else if (y < 0) {
|
|
moveY = (y * accel) - carriedOverY;
|
|
carriedOverY = ceil(moveY) - moveY;
|
|
}
|
|
#ifdef DEBUG_SERIAL
|
|
Serial.println();
|
|
Serial.print("cycles: ");
|
|
Serial.println(mouseActiveForCycles);
|
|
Serial.print("Accel: ");
|
|
Serial.print(accel);
|
|
Serial.print(" moveX is ");
|
|
Serial.print(moveX);
|
|
Serial.print(" moveY is ");
|
|
Serial.print(moveY);
|
|
Serial.print(" carriedoverx is ");
|
|
Serial.print(carriedOverX);
|
|
Serial.print(" carriedOverY is ");
|
|
Serial.println(carriedOverY);
|
|
#endif
|
|
Mouse.move(moveX, moveY, 0);
|
|
} else {
|
|
mouseActiveForCycles = 0;
|
|
}
|
|
|
|
}
|
|
|
|
|
|
//
|
|
// Key Reports
|
|
//
|
|
void release_keys_not_being_pressed()
|
|
{
|
|
// we use charsReportedLastTime to figure out what we might
|
|
// not be holding anymore and can now release. this is
|
|
// destructive to charsReportedLastTime
|
|
|
|
for (byte i = 0; i < KEYS_HELD_BUFFER; i++) {
|
|
// for each key we were holding as of the end of the last cycle
|
|
// see if we're still holding it
|
|
// if we're not, call an explicit Release
|
|
|
|
if (charsReportedLastTime[i] != 0x00) {
|
|
// if there _was_ a character in this slot, go check the
|
|
// currently held characters
|
|
for (byte j = 0; j < KEYS_HELD_BUFFER; j++) {
|
|
if (charsReportedLastTime[i] == charsBeingReported[j]) {
|
|
// if's still held, we don't need to do anything.
|
|
charsReportedLastTime[i] = 0x00;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
for (byte i = 0; i < KEYS_HELD_BUFFER; i++) {
|
|
if (charsReportedLastTime[i] != 0x00) {
|
|
Keyboard.release(charsReportedLastTime[i]);
|
|
}
|
|
}
|
|
}
|
|
|
|
void record_key_being_pressed(byte character)
|
|
{
|
|
for (byte i = 0; i < KEYS_HELD_BUFFER; i++) {
|
|
// todo - deal with overflowing the 12 key buffer here
|
|
if (charsBeingReported[i] == 0x00) {
|
|
charsBeingReported[i] = character;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
void reset_key_report()
|
|
{
|
|
for (byte i = 0; i < KEYS_HELD_BUFFER; i++) {
|
|
charsReportedLastTime[i] = charsBeingReported[i];
|
|
charsBeingReported[i] = 0x00;
|
|
}
|
|
}
|
|
|
|
|
|
// Sending events to the usb host
|
|
|
|
void handle_synthetic_key_press(byte switchState, Key mappedKey) {
|
|
if (mappedKey.flags & IS_CONSUMER) {
|
|
if (key_toggled_on (switchState)) {
|
|
Keyboard.consumerControl(mappedKey.rawKey);
|
|
}
|
|
}
|
|
else if (mappedKey.flags & IS_SYSCTL) {
|
|
if (key_toggled_on (switchState)) {
|
|
Keyboard.systemControl(mappedKey.rawKey);
|
|
}
|
|
}
|
|
else if (mappedKey.flags & IS_MACRO) {
|
|
if (key_toggled_on (switchState)) {
|
|
if (mappedKey.rawKey == 1) {
|
|
Serial.print("Keyboard.IO keyboard driver v0.00");
|
|
}
|
|
}
|
|
} else if (mappedKey.rawKey == KEY_MOUSE_BTN_L
|
|
|| mappedKey.rawKey == KEY_MOUSE_BTN_M
|
|
|| mappedKey.rawKey == KEY_MOUSE_BTN_R) {
|
|
if (key_toggled_on (switchState)) {
|
|
Mouse.press(mappedKey.rawKey);
|
|
} else if (key_is_pressed(switchState)) {
|
|
} else if (Mouse.isPressed(mappedKey.rawKey) ) {
|
|
Mouse.release(mappedKey.rawKey);
|
|
}
|
|
}
|
|
}
|
|
void handle_mouse_key_press(byte switchState, Key mappedKey, char &x, char &y) {
|
|
|
|
if (key_is_pressed(switchState)) {
|
|
if (mappedKey.rawKey & MOUSE_UP) {
|
|
y -= 1;
|
|
}
|
|
if (mappedKey.rawKey & MOUSE_DN) {
|
|
y += 1;
|
|
}
|
|
if (mappedKey.rawKey & MOUSE_L) {
|
|
x -= 1;
|
|
}
|
|
|
|
if (mappedKey.rawKey & MOUSE_R) {
|
|
x += 1 ;
|
|
}
|
|
}
|
|
}
|
|
|
|
void send_key_events()
|
|
{
|
|
//for every newly pressed button, figure out what logical key it is and send a key down event
|
|
// for every newly released button, figure out what logical key it is and send a key up event
|
|
|
|
|
|
// TODO:switch to sending raw HID packets
|
|
|
|
// really, these are signed small ints
|
|
char x = 0;
|
|
char y = 0;
|
|
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
|
|
for (byte col = 0; col < COLS; col++) {
|
|
byte switchState = matrixState[row][col];
|
|
Key mappedKey = keymaps[active_keymap][row][col];
|
|
|
|
if (mappedKey.flags & MOUSE_KEY ) {
|
|
if (mappedKey.rawKey & MOUSE_WARP) {
|
|
if (key_toggled_on(switchState)) {
|
|
warp_mouse(mappedKey);
|
|
}
|
|
} else {
|
|
handle_mouse_key_press(switchState, mappedKey, x, y);
|
|
}
|
|
|
|
} else if (mappedKey.flags & SYNTHETIC_KEY) {
|
|
handle_synthetic_key_press(switchState, mappedKey);
|
|
}
|
|
else {
|
|
if (key_is_pressed(switchState)) {
|
|
record_key_being_pressed(mappedKey.rawKey);
|
|
if (key_toggled_on (switchState)) {
|
|
Keyboard.press(mappedKey.rawKey);
|
|
}
|
|
} else if (key_toggled_off (switchState)) {
|
|
Keyboard.release(mappedKey.rawKey);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
handle_mouse_movement(x, y);
|
|
release_keys_not_being_pressed();
|
|
}
|
|
|
|
|
|
// Hardware initialization
|
|
void setup_pins()
|
|
{
|
|
//set up the row pins as outputs
|
|
for (byte row = 0; row < ROWS; row++) {
|
|
pinMode(rowPins[row], OUTPUT);
|
|
digitalWrite(rowPins[row], HIGH);
|
|
}
|
|
|
|
for (byte col = 0; col < COLS; col++) {
|
|
pinMode(colPins[col], INPUT);
|
|
digitalWrite(colPins[col], HIGH);
|
|
//drive em high by default s it seems to be more reliable than driving em low
|
|
|
|
}
|
|
}
|
|
|