NicoHood/HID

Modifier Keys in Matrix Code

Oreo456 opened this issue · 4 comments

I'm working on building a keyboard using my arduino pro micro using this library. There is one major problem though. When I use the modifier keys, such as shift, it works fine if I use Keyboard.press(KEY_LEFT_SHIFT), however when I call shift from an array like Keyboard.press(keys[][]) it doesn't work. Space has a similar problem, it's fine when I do Keyboard.press(KEY_SPACE) but when I call it from an array it outputs , for some reason. All the other keys work fine with the array, it's just specifically the keys I can't call by putting parentheses around the character. I tried going back to arduino's keyboard.h library, and all the modifier keys work with that fine, so it's something about this library
Sorry, I'm not great at explaining things so sorry if this doesn't make sense.
Here's the code:
Thanks

#include <HID-Settings.h>



#include <Adafruit_MCP23017.h>

Adafruit_MCP23017 mcp;
byte inputs[] = {4,5,6,7,8,9};
const int inCount = sizeof(inputs)/sizeof(inputs[0]);
byte outputs[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14};
const int outCount = sizeof(outputs)/sizeof(outputs[0]);

char keys[2][2] = {
  {KEY_LEFT_SHIFT,'j'},
  {'k','w'}
  };

bool keysDown[2][2] = {
  {false, false},
  {false, false}
};

void setup() {
  // put your setup code here, to run once:
  
  mcp.begin();
  for(int i=0; i<outCount; i++){    //declaring all the outputs and setting them high
    mcp.pinMode(outputs[i],OUTPUT);
    mcp.digitalWrite(outputs[i],LOW);
  }
  for(int i=0; i<inCount; i++){     //declaring all the inputs and activating the internal pullup resistor
    pinMode(inputs[i],INPUT_PULLUP);
  }
  Serial.begin(9600);
  Keyboard.begin();
}


  
void loop() {
  // put your main code here, to run repeatedly:
  keyCheck();
  

}

void keyCheck()
{
  for (int i=0; i<2; i++){
    mcp.digitalWrite(outputs[i],LOW);
    for (int j=0; j<2; j++)
    {
      if(digitalRead(inputs[j]) == LOW && keysDown[i][j] == false)
      {      
        Serial.print("Row: ");
        Serial.print(i);
        Serial.println();
        Serial.print("Col: ");
        Serial.print(j);
        Serial.println();
        Serial.print(keys[i][j]);
        Serial.println();
        if(keys[i][j] == KEY_LEFT_SHIFT)
        {
          Serial.print("Shift Key");
          Serial.println();
        }
        Keyboard.press(keys[i][j]);
        Serial.println();
        keysDown[i][j] = true;
        Serial.print("KeysDown set to true");
        Serial.println();
      }else if(digitalRead(inputs[j]) == HIGH && keysDown[i][j] == true)
      {
        Serial.print("keysdown set to false");
        Serial.println();
        Keyboard.release(keys[i][j]);
        keysDown[i][j] = false;
      }
      delay(1);
    }
    mcp.digitalWrite(outputs[i], HIGH);
  }
}

The problem here is a mismatch between ASCII and USB HID keycodes. KEY_SPACE == 44 == ',' != ' '; likewise, 'j' == 0x6A == KEY_F15 != KEY_J. When you call Serial.print(), it interprets the argument as an ASCII character, but when you call Keyboard.press(), it's a USB HID keycode. So, your keys array should be defined like this:

char keys[2][2] = {
  {KEY_LEFT_SHIFT, KEY_J},
  {KEY_K, KEY_W}
};

…and when you call Serial.println(keys[i][j]), you shouldn't expect the output to contain the corresponding ASCII character.

The problem here is a mismatch between ASCII and USB HID keycodes. KEY_SPACE == 44 == ',' != ' '; likewise, 'j' == 0x6A == KEY_F15 != KEY_J. When you call Serial.print(), it interprets the argument as an ASCII character, but when you call Keyboard.press(), it's a USB HID keycode. So, your keys array should be defined like this:

char keys[2][2] = {
  {KEY_LEFT_SHIFT, KEY_J},
  {KEY_K, KEY_W}
};

…and when you call Serial.println(keys[i][j]), you shouldn't expect the output to contain the corresponding ASCII character.

When I set up the array like that though, it doesn't do anything. The only way I can get a normal output is when I have the characters that have the '' around them, which I now know are the ASCII codes. The thing that confuses me the most is how come it works when I use Keyboard.press(KEY_LEFT_SHIFT), but not when I call KEY_LEFT_SHIFT from an array with Keyboard.press(keys[0][0]). Is there something I need to do with the array to make it compatible with the USB HID keycodes?
Thanks for your help

Experiencing the same problem, doesn't matter if my matrix is using byte or char, the KEY_F1 to KEY_F6 is translated to :;<=>? with shift and ctrl modifiers on and off.
I have used the original Keyboard library before and it worked correctly.

I couldn't find a solution, but I found another way to do it, using a switch statement instead. Here's my code. Feel free to use it however you like Riisko

#include <HID-Project.h>
#include <HID-Settings.h>


//
#include <Adafruit_MCP23017.h>

Adafruit_MCP23017 mcp;
byte inputs[] = {4,5,6,7,8,9};
const int inCount = sizeof(inputs)/sizeof(inputs[0]);
byte outputs[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14};
const int outCount = sizeof(outputs)/sizeof(outputs[0]);
bool done = false;


int keys[6][14] = {
  {1,2,3,4,5,6,7,8,9,10,11,12,13},
  {14,15,16,17,18,19,20,21,22,23,24,25,26,27},
  {28,29,30,31,32,33,34,35,36,37,38,39,40,41},
  {42,43,44,45,46,47,48,49,50,51,52,53,54},
  {55,56,57,58,59,60,61,62,63,64,65,66},
  {67,68,69,70,71,72,73,74,75,76,77,78,79,80}
  };

bool keysDown[6][14] = {
  {false,false,false,false,false,false,false,false,false,false,false,false,false},
  {false,false,false,false,false,false,false,false,false,false,false,false,false,false},
  {false,false,false,false,false,false,false,false,false,false,false,false,false,false},
  {false,false,false,false,false,false,false,false,false,false,false,false,false},
  {false,false,false,false,false,false,false,false,false,false,false,false},
  {false,false,false,false,false,false,false,false,false,false,false,false,false,false}
};

int key[2][2] = {
  {1,2},
  {3,4}
};

bool keyisdown[2][2] = {
  {false,false},
  {false,false}
};

void setup() {
  // put your setup code here, to run once:
  
  mcp.begin();
  for(int i=0; i<outCount; i++){    //declaring all the outputs and setting them high
    mcp.pinMode(outputs[i],OUTPUT);
    mcp.digitalWrite(outputs[i],HIGH);
  }
  for(int i=0; i<inCount; i++){     //declaring all the inputs and activating the internal pullup resistor
    pinMode(inputs[i],INPUT_PULLUP);
  }
  Serial.begin(9600);
  Keyboard.begin();
}


  
void loop() {
  // put your main code here, to run repeatedly:
  keyCheck();

}

void keyCheck()
{
  for (int i=0; i<14; i++){
    mcp.digitalWrite(outputs[i],LOW);
    for (int j=0; j<6; j++)
    {
      if(digitalRead(inputs[j]) == LOW && keysDown[j][i] == false)
      {      
        Serial.print("Row: ");
        Serial.print(j);
        Serial.println();
        Serial.print("Col: ");
        Serial.print(i);
        Serial.println();
        Serial.print(keys[j][i]);
        Serial.println();
        keyDown(keys[j][i]);
        keysDown[j][i] = true;
        Serial.print("KeysDown set to true");
        Serial.println();
      }else if(digitalRead(inputs[j]) == HIGH && keysDown[j][i] == true)
      {
        keyUp(keys[j][i]);
        keysDown[j][i] = false;
        Serial.print("KeysDown set to false");
        Serial.println();
        Serial.println();
      }
    }
    mcp.digitalWrite(outputs[i], HIGH);
  }
}

void keyDown(int keyNum){
  switch(keyNum){
    case 1: Keyboard.press(KEY_ESC); break;
    case 2: Keyboard.press(KEY_F1); break;
    case 3: Keyboard.press(KEY_F2); break;
    case 4: Keyboard.press(KEY_F3); break;
    case 5: Keyboard.press(KEY_F4); break;
    case 6: Keyboard.press(KEY_F5); break;
    case 7: Keyboard.press(KEY_F6); break;
    case 8: Keyboard.press(KEY_F7); break;
    case 9: Keyboard.press(KEY_F8); break;
    case 10: Keyboard.press(KEY_F9); break;
    case 11: Keyboard.press(KEY_F10); break;
    case 12: Keyboard.press(KEY_F11); break;
    case 13: Keyboard.press(KEY_F12); break;
    case 14: Keyboard.press('`'); break;
    case 15: Keyboard.press('1'); break;
    case 16: Keyboard.press('2'); break;
    case 17: Keyboard.press('3'); break;
    case 18: Keyboard.press('4'); break;
    case 19: Keyboard.press('5'); break;
    case 20: Keyboard.press('6'); break;
    case 21: Keyboard.press('7'); break;
    case 22: Keyboard.press('8'); break;
    case 23: Keyboard.press('9'); break;
    case 24: Keyboard.press('0'); break;
    case 25: Keyboard.press('-'); break;
    case 26: Keyboard.press('='); break;
    case 27: Keyboard.press(KEY_BACKSPACE); break;
    case 28: Keyboard.press(KEY_TAB); break;
    case 29: Keyboard.press('q'); break;
    case 30: Keyboard.press('w'); break;
    case 31: Keyboard.press('e'); break;
    case 32: Keyboard.press('r'); break;
    case 33: Keyboard.press('t'); break;
    case 34: Keyboard.press('y'); break;
    case 35: Keyboard.press('u'); break;
    case 36: Keyboard.press('i'); break;
    case 37: Keyboard.press('o'); break;
    case 38: Keyboard.press('p'); break;
    case 39: Keyboard.press('['); break;
    case 40: Keyboard.press(']'); break;
    case 41: Keyboard.press('\\'); break;
    case 42: Keyboard.press(KEY_CAPS_LOCK); break;
    case 43: Keyboard.press('a'); break;
    case 44: Keyboard.press('s'); break;
    case 45: Keyboard.press('d'); break;
    case 46: Keyboard.press('f'); break;
    case 47: Keyboard.press('g'); break;
    case 48: Keyboard.press('h'); break;
    case 49: Keyboard.press('j'); break;
    case 50: Keyboard.press('k'); break;
    case 51: Keyboard.press('l'); break;
    case 52: Keyboard.press(';'); break;
    case 53: Keyboard.press('\''); break;
    case 54: Keyboard.press(KEY_ENTER); break;
    case 55: Keyboard.press(KEY_LEFT_SHIFT); break;
    case 56: Keyboard.press('z'); break;
    case 57: Keyboard.press('x'); break;
    case 58: Keyboard.press('c'); break;
    case 59: Keyboard.press('v'); break;
    case 60: Keyboard.press('b'); break;
    case 61: Keyboard.press('n'); break;
    case 62: Keyboard.press('m'); break;
    case 63: Keyboard.press(','); break;
    case 64: Keyboard.press('.'); break;
    case 65: Keyboard.press('/'); break;
    case 66: Keyboard.press(KEY_RIGHT_SHIFT); break;
    case 67: Keyboard.press(KEY_LEFT_CTRL); break;
    case 68: Keyboard.press(KEY_LEFT_GUI); break;
    case 69: Keyboard.press(KEY_LEFT_ALT); break;
    case 70: Keyboard.press(KEY_SPACE); break;
    case 71: Keyboard.press(KEY_RIGHT_ALT); break;
    case 72: Keyboard.press(KEY_RIGHT_CTRL); break;
    case 73: Keyboard.press(KEY_RIGHT_GUI); break;
    case 74: Keyboard.press(KEY_LEFT_ARROW); break;
    case 75: Keyboard.press(KEY_DOWN_ARROW); break;
    case 76: Keyboard.press(KEY_RIGHT_ARROW); break;
    case 77: Keyboard.press(KEY_UP_ARROW); break;
    case 78: Keyboard.press(KEY_END); break;
    case 79: Keyboard.press(KEY_HOME); break;
    case 80: Keyboard.press(KEY_DELETE); break;
  }
}

void keyUp(int keyNum){
  switch(keyNum){
    case 1: Keyboard.release(KEY_ESC); break;
    case 2: Keyboard.release(KEY_F1); break;
    case 3: Keyboard.release(KEY_F2); break;
    case 4: Keyboard.release(KEY_F3); break;
    case 5: Keyboard.release(KEY_F4); break;
    case 6: Keyboard.release(KEY_F5); break;
    case 7: Keyboard.release(KEY_F6); break;
    case 8: Keyboard.release(KEY_F7); break;
    case 9: Keyboard.release(KEY_F8); break;
    case 10: Keyboard.release(KEY_F9); break;
    case 11: Keyboard.release(KEY_F10); break;
    case 12: Keyboard.release(KEY_F11); break;
    case 13: Keyboard.release(KEY_F12); break;
    case 14: Keyboard.release('`'); break;
    case 15: Keyboard.release('1'); break;
    case 16: Keyboard.release('2'); break;
    case 17: Keyboard.release('3'); break;
    case 18: Keyboard.release('4'); break;
    case 19: Keyboard.release('5'); break;
    case 20: Keyboard.release('6'); break;
    case 21: Keyboard.release('7'); break;
    case 22: Keyboard.release('8'); break;
    case 23: Keyboard.release('9'); break;
    case 24: Keyboard.release('0'); break;
    case 25: Keyboard.release('-'); break;
    case 26: Keyboard.release('='); break;
    case 27: Keyboard.release(KEY_BACKSPACE); break;
    case 28: Keyboard.release(KEY_TAB); break;
    case 29: Keyboard.release('q'); break;
    case 30: Keyboard.release('w'); break;
    case 31: Keyboard.release('e'); break;
    case 32: Keyboard.release('r'); break;
    case 33: Keyboard.release('t'); break;
    case 34: Keyboard.release('y'); break;
    case 35: Keyboard.release('u'); break;
    case 36: Keyboard.release('i'); break;
    case 37: Keyboard.release('o'); break;
    case 38: Keyboard.release('p'); break;
    case 39: Keyboard.release('['); break;
    case 40: Keyboard.release(']'); break;
    case 41: Keyboard.release('\\'); break;
    case 42: Keyboard.release(KEY_CAPS_LOCK); break;
    case 43: Keyboard.release('a'); break;
    case 44: Keyboard.release('s'); break;
    case 45: Keyboard.release('d'); break;
    case 46: Keyboard.release('f'); break;
    case 47: Keyboard.release('g'); break;
    case 48: Keyboard.release('h'); break;
    case 49: Keyboard.release('j'); break;
    case 50: Keyboard.release('k'); break;
    case 51: Keyboard.release('l'); break;
    case 52: Keyboard.release(';'); break;
    case 53: Keyboard.release('\''); break;
    case 54: Keyboard.release(KEY_ENTER); break;
    case 55: Keyboard.release(KEY_LEFT_SHIFT); break;
    case 56: Keyboard.release('z'); break;
    case 57: Keyboard.release('x'); break;
    case 58: Keyboard.release('c'); break;
    case 59: Keyboard.release('v'); break;
    case 60: Keyboard.release('b'); break;
    case 61: Keyboard.release('n'); break;
    case 62: Keyboard.release('m'); break;
    case 63: Keyboard.release(','); break;
    case 64: Keyboard.release('.'); break;
    case 65: Keyboard.release('/'); break;
    case 66: Keyboard.release(KEY_RIGHT_SHIFT); break;
    case 67: Keyboard.release(KEY_LEFT_CTRL); break;
    case 68: Keyboard.release(KEY_LEFT_GUI); break;
    case 69: Keyboard.release(KEY_LEFT_ALT); break;
    case 70: Keyboard.release(KEY_SPACE); break;
    case 71: Keyboard.release(KEY_RIGHT_ALT); break;
    case 72: Keyboard.release(KEY_RIGHT_CTRL); break;
    case 73: Keyboard.release(KEY_RIGHT_GUI); break;
    case 74: Keyboard.release(KEY_LEFT_ARROW); break;
    case 75: Keyboard.release(KEY_DOWN_ARROW); break;
    case 76: Keyboard.release(KEY_RIGHT_ARROW); break;
    case 77: Keyboard.release(KEY_UP_ARROW); break;
    case 78: Keyboard.release(KEY_END); break;
    case 79: Keyboard.release(KEY_HOME); break;
    case 80: Keyboard.release(KEY_DELETE); break;
  }
}