diff --git a/Example_Keyboards/Lenovo_Y480_LC/Lenovo_Y480_LC.ino b/Example_Keyboards/Lenovo_Y480_LC/Lenovo_Y480_LC.ino new file mode 100644 index 0000000..f4efb47 --- /dev/null +++ b/Example_Keyboards/Lenovo_Y480_LC/Lenovo_Y480_LC.ino @@ -0,0 +1,433 @@ +/* Copyright 2020 Frank Adams + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ +// This software implements a Lenovo Y480 Laptop Keyboard Controller using a Teensy LC on +// a daughterboard with a 24 pin FPC connector. The keyboard part number is V-133020AK1-IT. +// This routine uses the Teensyduino "Micro-Manager Method" to send Normal and Modifier +// keys over USB. Multi-media keys are sent with keyboard press and release functions. +// Description of Teensyduino keyboard functions is at www.pjrc.com/teensy/td_keyboard.html +// +// Revision History +// Luigi Caradonna modified the code for the Y480 with Italian key layout - Aug 18th 2020 +// Compile with tools --> keyboared layout: Italian +#define MODIFIERKEY_FN 0x8f // give Fn key a HID code Lock +// +const byte rows_max = 16; // sets the number of rows in the matrix +const byte cols_max = 8; // sets the number of columns in the matrix + +// Data to manage the backlight +const byte blpin = 23; // PWM pin to use +byte blight = 0; // initial state + +// +// Load the normal key matrix with the Teensyduino key names described at www.pjrc.com/teensy/td_keyboard.html +// A zero indicates no normal key at that location. +// The Italian vowel grave keys are listed in the LAYOUT_ITALIAN section of the keylayouts.h file located at: +// C:\Program Files (x86)\Arduino\hardware\teensy\avr\cores\teensy3 +// +/* Notes from Luigi Caradonna +For a non-US keyboard, look at the file keylayouts.h under the desired language and find the desired key, then use the corresponding US key name. +Example for the quote ' character on the Italian keyboard, you will find the quote in the comment +#define ASCII_27 KEY_MINUS // 39 ' +thus, into the normal keys array, where the quote would go, you insert KEY_MINUS +Example for the + key on the Italian keyboard, you will find the + in the comment +#define ASCII_2B KEY_RIGHT_BRACE // 43 + +thus you must use KEY_RIGHT_BRACE where + would go. Do this for all other special keys. +The backslash is not listed because it seems it is a unique character but once you know the ASCII code is 92, +you can use the US key with the same ASCII code. The tilde key has ASCII code 92. +#define ASCII_5C KEY_TILDE // 92. +The "less than key" < also known as "angular braces key" doesn't work like the other keys. Using KEY_NON_US_100 did not have any effect on the output. +To make it work, this key is intercepted in the code and the correct literal is sent using Keyboard.press(). +Look at lines 375 to 387 for < and > key coding. +*/ +// +int normal[rows_max][cols_max] = { +// 0 1 2 3 4 5 6 7 + {0, 0, 0, 0, 0, 0, 0, 0}, // 0 + {KEY_TAB, 0, KEY_Z, KEY_A, KEY_1, KEY_Q, KEY_TILDE, KEY_ESC}, // 1 + {KEY_Y, KEY_N, KEY_M, KEY_J, KEY_7, KEY_U, KEY_6, KEY_H}, // 2 + {KEY_F3, 0, KEY_C, KEY_D, KEY_3, KEY_E, KEY_F2, KEY_F4}, // 3 + {KEY_CAPS_LOCK, 0, KEY_X, KEY_S, KEY_2, KEY_W, KEY_F1, KEY_NON_US_100},// 4 + {KEY_T, KEY_B, KEY_V, KEY_F, KEY_4, KEY_R, KEY_5, KEY_G}, // 5 + {KEY_F7, 0, KEY_PERIOD, KEY_L, KEY_9, KEY_O, KEY_F8, 0}, // 6 + {ISO_8859_1_E8, KEY_SLASH, ISO_8859_1_F9, ISO_8859_1_F2, KEY_0, KEY_P, KEY_MINUS, ISO_8859_1_E0}, // 7 + {KEY_RIGHT_BRACE, 0, KEY_COMMA, KEY_K, KEY_8, KEY_I, ISO_8859_1_EC, KEY_F6}, // 8 + {0, 0, 0, 0, 0, 0, 0, 0}, // 9 + {0, 0, 0, 0, KEY_PRINTSCREEN, 0, 0, 0}, // 10 + {0, KEY_RIGHT, 0, 0, KEY_F12, 0, 0, 0}, // 11 + {0, KEY_LEFT, KEY_DELETE, 0, KEY_PAGE_DOWN, 0, KEY_HOME, KEY_UP}, // 12 + {0, KEY_DOWN, 0, 0, KEY_F11, 0, 0, 0}, // 13 + {KEY_BACKSPACE, KEY_SPACE, KEY_ENTER, 0, KEY_F10, 0, KEY_F9, KEY_F5}, // 14 + {0, 0, 0, KEY_MENU, KEY_PAGE_UP, 0, KEY_END, 0} // 15 +}; +// Load the modifier key matrix with key names at the correct row-column location. +// A zero indicates no modifier key at that location. +int modifier[rows_max][cols_max] = { + {MODIFIERKEY_LEFT_SHIFT,0,MODIFIERKEY_RIGHT_SHIFT,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,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,0,0,0}, + {0,0,MODIFIERKEY_RIGHT_CTRL,0,0,0,MODIFIERKEY_LEFT_CTRL,0}, + {0,MODIFIERKEY_RIGHT_ALT,0,0,0,0,0,MODIFIERKEY_LEFT_ALT}, + {0,0,0,0,0,0,0,0}, + {0,0,0,MODIFIERKEY_FN,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,MODIFIERKEY_GUI,0,0} +}; +// Load the media key matrix with Fn key names at the correct row-column location. +// A zero indicates no media key at that location. +int media[rows_max][cols_max] = { + {0,0,0,0,0,0,0,0}, // 0 + {0,0,0,0,0,0,0,0}, // 1 + {0,0,KEYPAD_0,KEYPAD_1,KEYPAD_7,KEYPAD_4,0,0}, // 2 + {0,0,0,0,0,0,0,0}, // 3 + {0,0,0,0,0,0,0,0}, // 4 + {0,0,0,0,0,0,0,0}, // 5 + {0,0,KEYPAD_PERIOD,KEYPAD_3,KEYPAD_9,KEYPAD_6,0,0}, // 6 + {0,KEYPAD_PLUS,0,KEYPAD_MINUS,KEYPAD_SLASH,KEYPAD_ASTERIX,0,0}, // 7 + {0,0,0,KEYPAD_2,KEYPAD_8,KEYPAD_5,0,0}, // 8 + {0,0,0,0,0,0,0,0}, // 9 + {0,0,0,0,0,0,0,0}, // 10 + {0,KEY_MEDIA_VOLUME_INC,0,0,KEY_MEDIA_NEXT_TRACK,0,0,0}, // 11 + {0,0,0,0,0,0,0,0}, // 12 + {0,KEY_MEDIA_VOLUME_DEC,0,0,KEY_MEDIA_PREV_TRACK,0,0,0}, // 13 + {0,KEY_SPACE,0,0,KEY_MEDIA_STOP,0,KEY_MEDIA_PLAY_PAUSE,0}, // 14 + {0,0,0,0,0,0,0,0} // 15 +}; +// Initialize the old_key matrix with one's. +// 1 = key not pressed, 0 = key is pressed +boolean old_key[rows_max][cols_max] = { + {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,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,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,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,1,1,1,1}, + {1,1,1,1,1,1,1,1} +}; +// +// Define the Teensy LC I/O numbers (translated from the FPC pin #) +// Row FPC pin # 01,02,03,04,05,06,07,08,09,10,11,12,13,14,15,16,17 + +int Row_IO[rows_max] = {2,25,5,19,18,7,17,8,16,9,15,10,14,11,26,12}; // Teensy LC I/O numbers for rows +// +// Column FPC pin # 18,19,20,21,22,23,24,25 + +int Col_IO[cols_max] = {22,1,24,21,3,4,20,6}; // Teensy LC I/O numbers for columns + +// Declare variables that will be used by functions +boolean slots_full = LOW; // Goes high when slots 1 thru 6 contain normal keys +// slot 1 thru slot 6 hold the normal key values to be sent over USB. +int slot1 = 0; //value of 0 means the slot is empty and can be used. +int slot2 = 0; +int slot3 = 0; +int slot4 = 0; +int slot5 = 0; +int slot6 = 0; +// +int mod_shift_l = 0; // These variables are sent over USB as modifier keys. +int mod_shift_r = 0; // Each is either set to 0 or MODIFIER_ ... +int mod_ctrl_l = 0; +int mod_ctrl_r = 0; +int mod_alt_l = 0; +int mod_alt_r = 0; +int mod_gui = 0; +// +// Function to load the key name into the first available slot +void load_slot(int key) { + if (!slot1) { + slot1 = key; + } + else if (!slot2) { + slot2 = key; + } + else if (!slot3) { + slot3 = key; + } + else if (!slot4) { + slot4 = key; + } + else if (!slot5) { + slot5 = key; + } + else if (!slot6) { + slot6 = key; + } + if (!slot1 || !slot2 || !slot3 || !slot4 || !slot5 || !slot6) { + slots_full = LOW; // slots are not full + } + else { + slots_full = HIGH; // slots are full + } +} +// +// Function to clear the slot that contains the key name +void clear_slot(int key) { + if (slot1 == key) { + slot1 = 0; + } + else if (slot2 == key) { + slot2 = 0; + } + else if (slot3 == key) { + slot3 = 0; + } + else if (slot4 == key) { + slot4 = 0; + } + else if (slot5 == key) { + slot5 = 0; + } + else if (slot6 == key) { + slot6 = 0; + } + if (!slot1 || !slot2 || !slot3 || !slot4 || !slot5 || !slot6) { + slots_full = LOW; // slots are not full + } + else { + slots_full = HIGH; // slots are full + } +} +// +// Function to load the modifier key name into the appropriate mod variable +void load_mod(int m_key) { + if (m_key == MODIFIERKEY_LEFT_SHIFT) { + mod_shift_l = m_key; + } + else if (m_key == MODIFIERKEY_RIGHT_SHIFT) { + mod_shift_r = m_key; + } + else if (m_key == MODIFIERKEY_LEFT_CTRL) { + mod_ctrl_l = m_key; + } + else if (m_key == MODIFIERKEY_RIGHT_CTRL) { + mod_ctrl_r = m_key; + } + else if (m_key == MODIFIERKEY_LEFT_ALT) { + mod_alt_l = m_key; + } + else if (m_key == MODIFIERKEY_RIGHT_ALT) { + mod_alt_r = m_key; + } + else if (m_key == MODIFIERKEY_GUI) { + mod_gui = m_key; + } +} +// +// Function to load 0 into the appropriate mod variable +void clear_mod(int m_key) { + if (m_key == MODIFIERKEY_LEFT_SHIFT) { + mod_shift_l = 0; + } + else if (m_key == MODIFIERKEY_RIGHT_SHIFT) { + mod_shift_r = 0; + } + else if (m_key == MODIFIERKEY_LEFT_CTRL) { + mod_ctrl_l = 0; + } + else if (m_key == MODIFIERKEY_RIGHT_CTRL) { + mod_ctrl_r = 0; + } + else if (m_key == MODIFIERKEY_LEFT_ALT) { + mod_alt_l = 0; + } + else if (m_key == MODIFIERKEY_RIGHT_ALT) { + mod_alt_r = 0; + } + else if (m_key == MODIFIERKEY_GUI) { + mod_gui = 0; + } +} +// +// Function to send the modifier keys over usb +void send_mod() { + Keyboard.set_modifier(mod_shift_l | mod_shift_r | mod_ctrl_l | mod_ctrl_r | mod_alt_l | mod_alt_r | mod_gui); + Keyboard.send_now(); +} +// +// Function to send the normal keys in the 6 slots over usb +void send_normals() { + Keyboard.set_key1(slot1); + Keyboard.set_key2(slot2); + Keyboard.set_key3(slot3); + Keyboard.set_key4(slot4); + Keyboard.set_key5(slot5); + Keyboard.set_key6(slot6); + Keyboard.send_now(); +} +// +// Function to set a pin to high impedance (acts like open drain output) +void go_z(int pin) +{ + pinMode(pin, INPUT); + digitalWrite(pin, HIGH); +} +// +// Function to set a pin as an input with a pullup +void go_pu(int pin) +{ + pinMode(pin, INPUT_PULLUP); + digitalWrite(pin, HIGH); +} +// +// Function to send a pin to a logic low +void go_0(int pin) +{ + pinMode(pin, OUTPUT); + digitalWrite(pin, LOW); +} +// +// Function to send a pin to a logic high +void go_1(int pin) +{ + pinMode(pin, OUTPUT); + digitalWrite(pin, HIGH); +} +// +//----------------------------------Setup------------------------------------------- +void setup() { + // Backlight initial state is off + pinMode(blpin, OUTPUT); + analogWriteFrequency(blpin, 400); // sets blpin to 400Hz PWM frequency + analogWrite(blpin, 0); // off + + for (int a = 0; a < cols_max; a++) { // loop thru all column pins + go_pu(Col_IO[a]); // set each column pin as an input with a pullup + } +// + for (int b = 0; b < rows_max; b++) { // loop thru all row pins + go_z(Row_IO[b]); // set each row pin as a floating output + } +} +// +boolean Fn_pressed = HIGH; // Initialize Fn key to HIGH = "not pressed" +// extern volatile uint8_t keyboard_leds; // 8 bits sent from Pi to Teensy that give keyboard LED status. Caps lock is bit D1. +// +//---------------------------------Main Loop--------------------------------------------- +// +void loop() { + // Scan keyboard matrix with an outer loop that drives each row low and an inner loop that reads every column (with pull ups). + // The routine looks at each key's present state (by reading the column input pin) and also the previous state from the last scan + // that was 30msec ago. The status of a key that was just pressed or just released is sent over USB and the state is saved in the old_key matrix. + // The keyboard keys will read as logic low if they are pressed (negative logic). + // The old_key matrix also uses negative logic (low=pressed). + // + for (int x = 0; x < rows_max; x++) { // loop thru the rows + go_0(Row_IO[x]); // Activate Row (send it low) + delayMicroseconds(10); // give the row time to go low and settle out + for (int y = 0; y < cols_max; y++) { // loop thru the columns + // **********Modifier keys including the Fn special case + if (modifier[x][y] != 0) { // check if modifier key exists at this location in the array (a non-zero value) + if (!digitalRead(Col_IO[y]) && (old_key[x][y])) { // Read column to see if key is low (pressed) and was previously not pressed + if (modifier[x][y] != MODIFIERKEY_FN) { // Exclude Fn modifier key + load_mod(modifier[x][y]); // function reads which modifier key is pressed and loads it into the appropriate mod_... variable + send_mod(); // function sends the state of all modifier keys over usb including the one that just got pressed + old_key[x][y] = LOW; // Save state of key as "pressed" + } + else { + Fn_pressed = LOW; // Fn status variable is active low + old_key[x][y] = LOW; // old_key state is "pressed" (active low) + } + } + else if (digitalRead(Col_IO[y]) && (!old_key[x][y])) { //check if key is not pressed and was previously pressed + if (modifier[x][y] != MODIFIERKEY_FN) { // Exclude Fn modifier key + clear_mod(modifier[x][y]); // function reads which modifier key was released and loads 0 into the appropriate mod_... variable + send_mod(); // function sends all mod's over usb including the one that just released + old_key[x][y] = HIGH; // Save state of key as "not pressed" + } + else { + Fn_pressed = HIGH; // Fn is no longer active + old_key[x][y] = HIGH; // old_key state is "not pressed" + } + } + } + // ***********end of modifier section + // + // ***********Normal keys and media keys in this section + else if ((normal[x][y] != 0) || (media[x][y] != 0)) { // check if normal or media key exists at this location in the array + if (!digitalRead(Col_IO[y]) && (old_key[x][y]) && (!slots_full)) { // check if key is pressed and was not previously pressed and slots not full + old_key[x][y] = LOW; // Save state of key as "pressed" + if (Fn_pressed) { // Fn_pressed is active low so it is not pressed and normal key needs to be sent + // **** SPECIAL for < and > which are not supported **** + // If the < key is pressed and also one between left or right shift is pressed + if(normal[x][y] == KEY_NON_US_100 && (mod_shift_l == MODIFIERKEY_LEFT_SHIFT || mod_shift_r == MODIFIERKEY_RIGHT_SHIFT)) { + Keyboard.press('>'); // > literal is sent using keyboard press function + delay(5); // delay 5 milliseconds before releasing to make sure it gets sent over USB + Keyboard.release('>'); // send key release + } + // If only < is pressed + else if (normal[x][y] == KEY_NON_US_100) { + Keyboard.press('<'); // < literal is sent using keyboard press function + delay(5); // delay 5 milliseconds before releasing to make sure it gets sent over USB + Keyboard.release('<'); // send key release + } + // All the other normal keys + else { + load_slot(normal[x][y]); //update first available slot with normal key name + send_normals(); // send all slots over USB including the key that just got pressed + } + } + else if (media[x][y] != 0) { // Fn is pressed so send media if a key exists in the matrix + if(media[x][y] != KEY_SPACE) { + Keyboard.press(media[x][y]); // media key is sent using keyboard press function per PJRC + delay(5); // delay 5 milliseconds before releasing to make sure it gets sent over USB + Keyboard.release(media[x][y]); // send media key release + } + else { // Fn+Space are pressed, set the backlight + switch(blight) { + case 0: // backlight off, turn on + analogWrite(blpin, 250); // sets blpin to a PWM duty cycle of 250/256=97% + blight = 1; // update the blight state + break; + case 1: // backlight on, turn off + analogWrite(blpin, 0); // off + blight = 0; // update the blight state + break; + default: + break; + } + // Keyboard.press(media[x][y]); // media key is sent using keyboard press function per PJRC + delay(5); // delay 5 milliseconds before releasing to make sure it gets sent over USB + Keyboard.release(media[x][y]); // send media key release + } + } + } + else if (digitalRead(Col_IO[y]) && (!old_key[x][y])) { //check if key is not pressed, but was previously pressed + old_key[x][y] = HIGH; // Save state of key as "not pressed" + if (Fn_pressed) { // Fn is not pressed + clear_slot(normal[x][y]); //clear the slot that contains the normal key name + send_normals(); // send all slots over USB including the key that was just released + } + } + } + // **************end of normal and media key section + } + go_z(Row_IO[x]); // De-activate Row (send it to hi-z) + } + // + // **********keyboard scan complete + delay(25); // The overall keyboard scanning rate is about 30ms +} diff --git a/Example_Keyboards/Lenovo_Y480_LC/y480_matrix.xlsx b/Example_Keyboards/Lenovo_Y480_LC/y480_matrix.xlsx new file mode 100644 index 0000000..533320c Binary files /dev/null and b/Example_Keyboards/Lenovo_Y480_LC/y480_matrix.xlsx differ