Add files via upload

Author: bitcode-tech

README.md

@@ -0,0 +1,46 @@
+# UART Keyboard Library For Arduino
+
+---
+
+## Overview
+
+BC6xxx and BC759x series chips share a unified single line UART keyboard interface. This library can be used for the following chips:
+
+- BC6301 -- 30-key key matrix interface
+
+- BC6040 -- 40-key key matrix interface
+
+- BC6561 -- 56-key key matrix interface
+
+- BC6088 -- 88-key key matrix interface
+
+- BC7595 -- 6 digits 7-segment LED display with 48-key key matrix driver
+
+- BC7591 -- 32 digits 7-segment LED display with 96-key key matrix driver
+
+This library is available for all Arduino devices, and can be used for both hardware and software serial ports.
+By using this library, in addition to easily handling common single-key events, complex keyboard functions such as key combinations and long-press keys can be implemented with just a few lines of code.
+In the UART single line keyboard interface, a keyboard event is represented by a single byte each time. Value 0-0x7F represents the key number value, the highest bit is used as a key release flag, that is, value 0-0x7F means the key is pressed, 0x80-0xFF means the key is released, so theoretically the maximum number of keys is 128. In reality the BC7591 can support up to 96 keys. This library uses the unused key number space to allow users to assign combination keys and long-press keys a custom key number, so that in the user program, handling of combination keys and long-press keys is as simple as the handling of ordinary keys, everything else is handled by the library.
+The library is very simple to use, requiring only 3 steps.
+
+1. In loop(), call the checkChanges() function.
+
+2. query isKeyChanged()
+
+3. If the result of isKeyChanged() is true, use getKeyValue() to get the key value
+
+For detailed information about the UART keyboard interface, please refer to the datasheet of the BC6xxx or BC759x series chips.
+
+## Library Installation
+
+This library is available in Arduino Library Manager, can be also installed using the zip file downloaded, just goto "Sketch-->Include Library-->Add .ZIP Libaray..."
+
+## Hardware Connection
+
+The BC6xxx and BC759x series chips both use UART serial communication, and the UART uses 2 pins TX and RX on the chip, where TX is the output of the chip's keyboard interface. The BC6xxx chip does not have RX pins, they are only available on the BC759x, which is used for the LED driver. When connected, the TX/RX pins of the chip are cross-connected with the RX/TX pins of the Arduino serial port.
+
+![](./extras/img/serial_port_connection.png)
+
+More detailed information about this library please see : [usage](./extras/docs/usage.md)
+
+Or for the PDF version of complete user manual in [简体中文](./extras/docs/BC6xxx_BC759x_UART_Keyboard_Arduino_Library_cn.pdf) or [English](./extras/docs/BC6xxx_BC759x_UART_Keyboard_Arduino_Library.pdf)

examples/basic_key_press/basic_key_press.ino

@@ -0,0 +1,52 @@
+/******************************************************************************
+*  longpress.ino
+*  BC6xxx & BC759x Key Scan Interface Library Example Code
+*
+*  This code uses Serial1 to connect a BC6xxx or BC759x chip. it can
+*  detect key presses.
+*  Serial is also used to communicate with computer. When a key is
+*  pressed, the key value is printed to the Serial port so can be
+*  seen with the Arduino Serial Monitor
+*  This code runs on any Arduino compatible boards.
+*
+*  Dependencies:
+*     This code depends on the following libraries:
+*        Arduino Software Serial Library
+*        UART_Keyboard_Driver Library
+*
+*  Author:
+*     This software is written by BitCode. https://bitcode.com.cn
+*
+*  Version:
+*     V1.0 March 2021
+*     V2.0 May 2021.  Changed to use Serial to print key value
+*     V3.0 October 2024. Changed default keyboard port to Serial1
+*
+*  License:
+*     MIT license. It can be used for both open source and commercial projects.
+******************************************************************************/
+#include <UART_Keyboard.h>
+
+#define KEYBOARD_SERIAL Serial1		// By default this code uses Serial1 as keyboard port
+// If you are using Arduino with only 1 Serial (such as UNO), you may want to disable 
+// the above line and use the following setting:
+// #include <SoftwareSerial.h>
+// #define KEYBOARD_SERIAL	swSerial
+// SoftwareSerial swSerial(11, 12);          // creating SoftwareSerial instance, using pin 11 as Rx, 12 as Tx (Tx not used in this example)
+
+UartKeyboard      Keypad(KEYBOARD_SERIAL);        // creating UartKeyboard instance
+
+
+void setup() {
+  Serial.begin(115200);               // Initialize Serial for monitoring
+  KEYBOARD_SERIAL.begin(9600);        // Initialize keyboard serial port
+}
+
+void loop() {
+    Keypad.checkChanges();            // let the key scan library to update key status
+    if (Keypad.isKeyChanged() == true) {       // if there is any detectable key change
+      Serial.println(Keypad.getKeyValue());   // print key value on Serial (use Serial Monitor to see it!)
+    }
+    // put your main code here, to run repeatedly:
+    delay(50);                     // delay 50ms
+}

examples/longpress/longpress.ino

@@ -0,0 +1,61 @@
+/******************************************************************************
+*  longpress.ino
+*  BC6xxx & BC759x Key Scan Interface Library Example Code
+*
+*  This code uses Serial1 to connect a BC6xxx or BC759x chip. Besides
+*  normal single key pressing, it can also detect the long-press of particular
+*  keys.
+*  Serial port is used to print the keypad detection results.
+*  This software monitors keypad actions and print key values on Serial. When key 
+*  1 or key 5 is pressed for more than 3s, a new key event with user defined key 
+*  value of 120(0x78) or 121(0x79) is generated.
+*  This code runs on any Arduino compatible boards.
+*
+*  Dependencies:
+*     This code depends on the following libraries:
+*        Arduino Software Serial Library
+*        UART_Keyboard_Driver Library
+*
+*  Author:
+*     This software is written by BitCode. https://bitcode.com.cn
+*
+*  Version:
+*     V1.0 March 2021
+*     V2.0 May 2021, changed to use hardware Serial to print key values.
+*     V3.0 October 2024. Changed default keyboard port to Serial1
+*
+*  License:
+*     MIT license. It can be used for both open source and commercial projects.
+******************************************************************************/
+#include <UART_Keyboard.h>
+
+#define KEYBOARD_SERIAL Serial1		// By default this code uses Serial1 as keyboard port
+// If you are using Arduino with only 1 Serial (such as UNO), you may want to disable 
+// the above line and use the following setting:
+// #include <SoftwareSerial.h>
+// #define KEYBOARD_SERIAL	swSerial
+// SoftwareSerial swSerial(11, 12);          // creating SoftwareSerial instance, using pin 11 as Rx, 12 as Tx (Tx not used in this example)
+
+UartKeyboard      Keypad(KEYBOARD_SERIAL);        // creating UartKeyboard instance
+
+// Definition of long-press keys
+const unsigned char  lp1[2]    = { 1, 120 };          // Longpress key 1, detecting long-pressing of key 1 and use 120 as the user defined key value
+const unsigned char  lp2[2]    = { 5, 121 };          // Longpress key 2, detecting long-pressing of key 5 and use 121 as the user defined key value
+const unsigned char* LPList[2] = { lp1, lp2 };        // Longpress key list
+
+void setup() {
+  Serial.begin(115200);                     // Initialize Serial for monitoring
+  KEYBOARD_SERIAL.begin(9600);              // Initialize keyboard serial port
+  Keypad.defLongpressKey(LPList, 2);        // Define long-press keys
+  Keypad.setLongpressCount(60);             // Set long-press time to 3s (50ms * 60)
+}
+
+void loop() {
+    Keypad.checkChanges();                // let the key scan library to update key status
+    if (Keypad.isKeyChanged() == true) {  // if there is any detectable key change
+      Serial.println(Keypad.getKeyValue());   // print key value on Serial (use Serial Monitor to see it!)
+    }
+    Keypad.longpressTick();        // Tick the long-press detector in BC_key_scan library
+    // put your main code here, to run repeatedly:
+    delay(50);                     // delay 50ms
+}

examples/longpress_combined/longpress_combined.ino

@@ -0,0 +1,73 @@
+/******************************************************************************
+*  longpress_combined.ino
+*  BC6xxx & BC759x Key Scan Interface Library Example Code
+*
+*  This code uses Serial1 to connect a BC6xxx or BC759x chip. Besides
+*  normal single key pressing, it can also detect the long-press of particular
+*  keys or the combination of multiple keys.
+*  Serial is used to print the key detection results. Use the IDE built-in 
+*  Serial Monitor to see outputs.
+*  This software prints the key value on Serial when there is a key event. 
+*  When key 1 or key 5 is pressed for more than 3s, a new key event with user 
+*  defined key value of 120(0x78) and 121(0x79) is generated.
+*  When key 0 and key 1 are pressed simutaneously, a new key event for this 
+*  combined key with key value of 122(0x7a) is generated. Also for a combination 
+*  of key 8 and key 12, with key value of 123(0x79).
+*  This code runs on any Arduino compatible boards.
+*
+*  Dependencies:
+*     This code depends on the following libraries:
+*        Arduino Software Serial Library
+*        UART_Keyboard_Driver Library
+*
+*  Author:
+*     This software is written by BitCode. https://bitcode.com.cn
+*
+*  Version:
+*     V1.0 March 2021
+*     V2.0 May 2021, changed print output to use built-in Serial.
+*     V3.0 October 2024. Changed default keyboard port to Serial1
+*
+*  License:
+*     MIT license. It can be used for both open source and commercial projects.
+******************************************************************************/
+#include <UART_Keyboard.h>
+
+#define KEYBOARD_SERIAL Serial1		// By default this code uses Serial1 as keyboard port
+// If you are using Arduino with only 1 Serial (such as UNO), you may want to disable 
+// the above line and use the following setting:
+// #include <SoftwareSerial.h>
+// #define KEYBOARD_SERIAL	swSerial
+// SoftwareSerial swSerial(11, 12);          // creating SoftwareSerial instance, using pin 11 as Rx, 12 as Tx (Tx not used in this example)
+
+UartKeyboard      Keypad(KEYBOARD_SERIAL);        // creating UartKeyboard instance
+
+
+// Definition of long-press keys
+const unsigned char  lp1[2]    = { 1, 120 };          // Longpress key 1, detecting long-pressing of key 1 and use 120 as the user defined key value
+const unsigned char  lp2[2]    = { 5, 121 };          // Longpress key 2, detecting long-pressing of key 5 and use 121 as the user defined key value
+const unsigned char* LPList[2] = { lp1, lp2 };        // Longpress key list
+
+// Definition of combined keys
+const unsigned char  cb1[4]    = { 2, 122, 0, 1 };         // Combined key 1, combination of 2 keys: key0 and key1, use 122 as user defined key value
+const unsigned char  cb2[4]    = { 2, 123, 8, 12 };        // Combined key 2, combination of 2 keys: key8 and key12, use 123 as user defined key value
+const unsigned char* CBList[2] = { cb1, cb2 };             // Combined key list
+
+void setup() {
+  Serial.begin(115200);            // Initialize Serial for monitoring
+  KEYBOARD_SERIAL.begin(9600);     // Initialize software serial swSerial
+  Keypad.defLongpressKey(LPList, 2);        // Define long-press keys
+  Keypad.setLongpressCount(60);            // Set long-press time to 3s (50ms * 60)
+  Keypad.defCombinedKey(CBList, 2);         // Define combined keys
+}
+
+void loop() {
+    // put your main code here, to run repeatedly:
+    Keypad.checkChanges();            // let the key scan library to update key status
+    if (Keypad.isKeyChanged())        // if there is any detectable key change
+    {
+      Serial.println(Keypad.getKeyValue());   // print key value on Serial (use Serial Monitor to see it!)
+    }
+    Keypad.longpressTick();        // Tick the long-press detector in BC_key_scan library
+    delay(50);                     // delay 50ms
+}