/** * @file Keyboard_ESP32C3.ino * @author Koby Hale * @license MIT * @copyright Copyright (c) 2023 Shenzhen Xin Yuan Electronic Technology Co., Ltd * @date 2023-04-11 * @Revision : * * 2024-12-16 : Fixed issue https://github.com/Xinyuan-LilyGO/T-Deck/issues/69 * * 2024-12-24 : Fixed issue https://github.com/Xinyuan-LilyGO/T-Deck/issues/70 * * 2024-12-25 : Added keyboard backlight control * * 2025-06-12 : Add new commands to allow reading raw key states by @kilrah */ #include #include #ifdef CONFIG_IDF_TARGET_ESP32C3 #define I2C_DEV_ADDR 0x55 #define keyboard_BL_PIN 9 #define SDA 2 #define SCL 10 #define KB_BRIGHTNESS_CH 0 #define KB_BRIGHTNESS_FREQ 1000 #define KB_BRIGHTNESS_RES 8 //Resolution_bits #define KB_BRIGHTNESS_BOOT_DUTY 0 #define KB_BRIGHTNESS_DEFAULT_DUTY 127 //Alt+B default duty , is duty is zero , use setting duty #define LILYGO_KB_BRIGHTNESS_CMD 0x01 #define LILYGO_KB_ALT_B_BRIGHTNESS_CMD 0x02 #define LILYGO_KB_MODE_RAW_CMD 0x03 #define LILYGO_KB_MODE_KEY_CMD 0x04 uint8_t rows[] = {0, 3, 19, 12, 18, 6, 7 }; const int rowCount = sizeof(rows) / sizeof(rows[0]); uint8_t cols[] = {1, 4, 5, 11, 13}; const int colCount = sizeof(cols) / sizeof(cols[0]); bool keys[colCount][rowCount]; bool lastValue[colCount][rowCount]; bool changedValue[colCount][rowCount]; char keyboard[colCount][rowCount]; char keyboard_symbol[colCount][rowCount]; bool rawMode = 0; bool BL_state = false; bool comdata_flag = false; char comdata; /* * Dynamically modify backlight brightness at runtime * Brightness Range: 0 ~ 255 * */ uint8_t kb_brightness_duty = KB_BRIGHTNESS_BOOT_DUTY; /* * Set the default backlight brightness level. If the user sets the backlight to 0 * via setKeyboardBrightness, the default brightness is used when pressing ALT+B, * rather than the backlight brightness level set by the user. This ensures that * pressing ALT+B can respond to the backlight being turned on and off normally. * Brightness Range: 30 ~ 255 * */ uint8_t kb_brightness_setting_duty = KB_BRIGHTNESS_DEFAULT_DUTY; //Alt+B default duty , is duty is zero , use setting duty void onRequest(); void readMatrix(); bool keyPressed(int colIndex, int rowIndex); bool keyActive(int colIndex, int rowIndex); bool isPrintableKey(int colIndex, int rowIndex); void printMatrix(); void set_keyboard_BL(bool state); void onReceive(int len) { // Serial.printf("onReceive[%d]: ", len); while (Wire.available()) { int cmd = Wire.read(); switch (cmd) { case LILYGO_KB_BRIGHTNESS_CMD: { int duty = Wire.read(); if (duty >= 0) { kb_brightness_duty = duty; // Serial.printf("B:%d", duty); ledcWrite(KB_BRIGHTNESS_CH, duty); if (duty > 0) { BL_state = true; } else if (duty == 0) { BL_state = false; } } } case LILYGO_KB_ALT_B_BRIGHTNESS_CMD: { int duty = Wire.read(); if (duty > 30) { kb_brightness_setting_duty = duty; } } break; case LILYGO_KB_MODE_RAW_CMD: { rawMode = true; Serial.println("Switched to raw mode"); } break; case LILYGO_KB_MODE_KEY_CMD: { rawMode = false; Serial.println("Switched to key mode"); } break; default: break; } } // Serial.println(); } void setup() { // Reduce operating power consumption arduino esp32 core version must >= 2.0.17 /* * 10MHZ can also run normally, but for stable operation, change the frequency to 80MHZ to prevent it from failing to run due to crystal oscillator problems * setCpuFrequencyMhz(10); * */ setCpuFrequencyMhz(80); // put your setup code here, to run once: keyboard[0][0] = 'q'; keyboard[0][1] = 'w'; keyboard[0][2] = NULL; // symbol keyboard[0][3] = 'a'; keyboard[0][4] = NULL; // ALT keyboard[0][5] = ' '; keyboard[0][6] = NULL; // Mic keyboard[1][0] = 'e'; keyboard[1][1] = 's'; keyboard[1][2] = 'd'; keyboard[1][3] = 'p'; keyboard[1][4] = 'x'; keyboard[1][5] = 'z'; keyboard[1][6] = NULL; // Left Shift keyboard[2][0] = 'r'; keyboard[2][1] = 'g'; keyboard[2][2] = 't'; keyboard[2][3] = NULL; // Right Shit keyboard[2][4] = 'v'; keyboard[2][5] = 'c'; keyboard[2][6] = 'f'; keyboard[3][0] = 'u'; keyboard[3][1] = 'h'; keyboard[3][2] = 'y'; keyboard[3][3] = NULL; // Enter keyboard[3][4] = 'b'; keyboard[3][5] = 'n'; keyboard[3][6] = 'j'; keyboard[4][0] = 'o'; keyboard[4][1] = 'l'; keyboard[4][2] = 'i'; keyboard[4][3] = NULL; // Backspace keyboard[4][4] = '$'; keyboard[4][5] = 'm'; keyboard[4][6] = 'k'; keyboard_symbol[0][0] = '#'; keyboard_symbol[0][1] = '1'; keyboard_symbol[0][2] = NULL; keyboard_symbol[0][3] = '*'; keyboard_symbol[0][4] = NULL; keyboard_symbol[0][5] = NULL; keyboard_symbol[0][6] = '0'; keyboard_symbol[1][0] = '2'; keyboard_symbol[1][1] = '4'; keyboard_symbol[1][2] = '5'; keyboard_symbol[1][3] = '@'; keyboard_symbol[1][4] = '8'; keyboard_symbol[1][5] = '7'; keyboard_symbol[1][6] = NULL; keyboard_symbol[2][0] = '3'; keyboard_symbol[2][1] = '/'; keyboard_symbol[2][2] = '('; keyboard_symbol[2][3] = NULL; keyboard_symbol[2][4] = '?'; keyboard_symbol[2][5] = '9'; keyboard_symbol[2][6] = '6'; keyboard_symbol[3][0] = '_'; keyboard_symbol[3][1] = ':'; keyboard_symbol[3][2] = ')'; keyboard_symbol[3][3] = NULL; keyboard_symbol[3][4] = '!'; keyboard_symbol[3][5] = ','; keyboard_symbol[3][6] = ';'; keyboard_symbol[4][0] = '+'; keyboard_symbol[4][1] = '"'; keyboard_symbol[4][2] = '-'; keyboard_symbol[4][3] = NULL; keyboard_symbol[4][4] = NULL; keyboard_symbol[4][5] = '.'; keyboard_symbol[4][6] = '\''; Serial.begin(115200); Serial.setDebugOutput(true); Wire.onRequest(onRequest); Wire.onReceive(onReceive); Wire.begin((uint8_t)I2C_DEV_ADDR, SDA, SCL, 100000UL); Serial.println("Starting keyboard work!"); ledcSetup(KB_BRIGHTNESS_CH, KB_BRIGHTNESS_FREQ, KB_BRIGHTNESS_RES); ledcAttachPin(keyboard_BL_PIN, KB_BRIGHTNESS_CH); ledcWrite(KB_BRIGHTNESS_CH, KB_BRIGHTNESS_BOOT_DUTY); Serial.println("4"); for (int x = 0; x < rowCount; x++) { Serial.print(rows[x]); Serial.println(" as input"); pinMode(rows[x], INPUT); } for (int x = 0; x < colCount; x++) { Serial.print(cols[x]); Serial.println(" as input-pullup"); pinMode(cols[x], INPUT_PULLUP); } } void loop() { readMatrix(); printMatrix(); // key 3,3 is the enter key if (keyPressed(3, 3)) { Serial.println(); comdata = (char)0x0D; comdata_flag = true; } if (keyPressed(4, 3)) { Serial.println("backspace"); comdata = (char)0x08; comdata_flag = true; } if (keyActive(0, 4) && keyPressed(3, 4)) { //Alt+B Serial.println("Alt+B"); // If the software sets the duty cycle to 0, then the value set // by the ATL+B register is used to ensure that ALT+B can normally light up the backlight. if (BL_state) { BL_state = false; ledcWrite(KB_BRIGHTNESS_CH, 0); //turn off } else { BL_state = true; if (kb_brightness_duty == 0) { Serial.println("User set bl duty is zero,use setting duty"); ledcWrite(KB_BRIGHTNESS_CH, kb_brightness_setting_duty); } else { Serial.println("Duty is not zero ,use user setting bl value"); ledcWrite(KB_BRIGHTNESS_CH, kb_brightness_duty); } } comdata_flag = false; //Don't send char } if (keyActive(0, 4) && keyPressed(2, 5)) { //Alt+C Serial.println("Alt+C"); comdata = (char)0x0C; comdata_flag = true; } } void onRequest() { if(rawMode) { for(uint8_t col = 0; col < colCount; col++) { uint8_t val = 0; for(uint8_t row = 0; row < rowCount; row++) { val |= (lastValue[col][row] << row); } Wire.write(val); //Serial.print(val, HEX); //Serial.print(" "); } //Serial.println(); } else { if (comdata_flag) { Wire.print(comdata); comdata_flag = false; Serial.print("comdata :"); Serial.println(comdata); } else { Wire.print((char)0x00); } } } void readMatrix() { int delayTime = 0; // iterate the columns for (int colIndex = 0; colIndex < colCount; colIndex++) { // col: set to output to low uint8_t curCol = cols[colIndex]; pinMode(curCol, OUTPUT); digitalWrite(curCol, LOW); // row: interate through the rows for (int rowIndex = 0; rowIndex < rowCount; rowIndex++) { uint8_t rowCol = rows[rowIndex]; pinMode(rowCol, INPUT_PULLUP); delay(1); // arduino is not fast enought to switch input/output modes so wait 1 ms bool buttonPressed = (digitalRead(rowCol) == LOW); keys[colIndex][rowIndex] = buttonPressed; if ((lastValue[colIndex][rowIndex] != buttonPressed)) { changedValue[colIndex][rowIndex] = true; } else { changedValue[colIndex][rowIndex] = false; } lastValue[colIndex][rowIndex] = buttonPressed; pinMode(rowCol, INPUT); } // disable the column pinMode(curCol, INPUT); } } bool keyPressed(int colIndex, int rowIndex) { return changedValue[colIndex][rowIndex] && keys[colIndex][rowIndex] == true; } bool keyActive(int colIndex, int rowIndex) { return keys[colIndex][rowIndex] == true; } bool isPrintableKey(int colIndex, int rowIndex) { return keyboard_symbol[colIndex][rowIndex] != NULL || keyboard[colIndex][rowIndex] != NULL; } void printMatrix() { for (int rowIndex = 0; rowIndex < rowCount; rowIndex++) { for (int colIndex = 0; colIndex < colCount; colIndex++) { // we only want to print if the key is pressed and it is a printable character if (keyPressed(colIndex, rowIndex) && isPrintableKey(colIndex, rowIndex)) { char toPrint; if (keyActive(0, 2)) { toPrint = char(keyboard_symbol[colIndex][rowIndex]); } else { toPrint = char(keyboard[colIndex][rowIndex]); } // keys 1,6 and 2,3 are Shift keys, so we want to upper case if (keyActive(1, 6) || keyActive(2, 3)) { toPrint = (char)((int)toPrint - 32); } Serial.print(toPrint); comdata = toPrint; comdata_flag = true; } } } } #else #include void setup() { Serial.begin(115200); } void loop() { Serial.println("SKETCH ONLY FOR LILYGO-KEYBOARD"); delay(1000); } #endif