#51 improved support for keyboards. More testing.

Author: davetcc

examples/dynamicMenuItems/dynamicMenuItems.ino

@@ -4,7 +4,7 @@
  *
  * Test environment: Seeed MG126 - Adafruit 128x128 display, encoder on device pins.
  *
- * Although it's set up to run on SAMD/MKR there is no reason it could not be easily reconfigured for any
+ * Although it's set up to run on SAMD there is no reason it could not be easily reconfigured for any
  * other board.
  */
 

examples/keyboardEthernetShield/keyboardEthernetShield.emf

@@ -433,7 +433,7 @@
   "codeOptions": {
     "embeddedPlatform": "ARDUINO",
     "lastDisplayUuid": "61f370f4-0294-41cf-8988-1458f242914a",
-    "lastInputUuid": "6dd87e7d-e751-4912-a70d-91793b1d3d87",
+    "lastInputUuid": "71DAF854-DF8D-4F0B-9039-23C5583C85B1",
     "lastRemoteUuid": "0877131c-e03e-426b-8eaf-228e01f5e7f1",
     "lastRemoteUuids": [
       "0877131c-e03e-426b-8eaf-228e01f5e7f1"
@@ -508,50 +508,135 @@
         "subsystem": "DISPLAY"
       },
       {
-        "name": "SW_POLLING_MODE",
-        "latestValue": "SWITCHES_POLL_EVERYTHING",
+        "name": "MK_KEYBOARD_NEXT",
+        "latestValue": "B",
         "subsystem": "INPUT"
       },
       {
-        "name": "SWITCH_IODEVICE",
-        "latestValue": "io23017",
+        "name": "MK_KEYBOARD_BACK",
+        "latestValue": "A",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_PIN_A",
-        "latestValue": "6",
+        "name": "MK_KEYBOARD_ENTER",
+        "latestValue": "*",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_PIN_B",
-        "latestValue": "7",
+        "name": "MK_KEYBOARD_DEL",
+        "latestValue": "#",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_PIN_OK",
-        "latestValue": "5",
+        "name": "MK_KEYBOARD_LAYOUT",
+        "latestValue": "LAYOUT_3X4",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_BACK_PIN",
-        "latestValue": "-1",
+        "name": "MK_ROW_PIN_0",
+        "latestValue": "22",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ROW_PIN_1",
+        "latestValue": "23",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ROW_PIN_2",
+        "latestValue": "24",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ROW_PIN_3",
+        "latestValue": "25",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_COL_PIN_0",
+        "latestValue": "26",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_COL_PIN_1",
+        "latestValue": "27",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_NEXT_PIN",
+        "name": "MK_COL_PIN_2",
+        "latestValue": "28",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_COL_PIN_3",
         "latestValue": "-1",
         "subsystem": "INPUT"
       },
       {
-        "name": "PULLUP_LOGIC",
-        "latestValue": "true",
+        "name": "MK_REPEAT_START",
+        "latestValue": "850",
         "subsystem": "INPUT"
       },
       {
-        "name": "ENCODER_IS_QUARTER_CYCLE",
+        "name": "MK_REPEAT_INTERVAL",
+        "latestValue": "350",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_KEYBOARD_DEVICE",
+        "latestValue": "devicePins",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_KEYBOARD_INTERRUPTS",
         "latestValue": "false",
         "subsystem": "INPUT"
       },
+      {
+        "name": "SEPARATOR",
+        "latestValue": "",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_NEED_ENCODER",
+        "latestValue": "true",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_USE_PULL_UP",
+        "latestValue": "true",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ENCODER_A",
+        "latestValue": "6",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ENCODER_B",
+        "latestValue": "7",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ENCODER_SEL",
+        "latestValue": "5",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ENCODER_DEVICE",
+        "latestValue": "io23017",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_POLLING_MODE",
+        "latestValue": "SWITCHES_NO_POLLING",
+        "subsystem": "INPUT"
+      },
+      {
+        "name": "MK_ENCODER_TYPE",
+        "latestValue": "FULL_CYCLE",
+        "subsystem": "INPUT"
+      },
       {
         "name": "ETH_CONCURRENT_CONNECTIONS",
         "latestValue": "2",
@@ -620,6 +705,7 @@
     "menuInMenuCollection": {
       "menuDefinitions": []
     },
-    "packageNamespace": ""
+    "packageNamespace": "",
+    "appIsModular": false
   }
 }

examples/keyboardEthernetShield/keyboardEthernetShield.ino

@@ -1,3 +1,13 @@
+/**
+ * This script demonstrates the use of a matrix keyboard with a rotary encoder also attached, this allows for the
+ * best of both worlds where the encoder is used for rotational type editing, and the keyboard where it is appropriate.
+ * This sketch is setup for MEGA2560 AVR with a 20x4 LCD on I2C and also an encoder on I2C. It also assumes an I2C ROM.
+ * However, you can take the ideas from this sketch and apply them in your own designs.
+ *
+ * More information about matrix keyboard support:
+ * https://www.thecoderscorner.com/products/arduino-libraries/io-abstraction/matrix-keyboard-keypad-manager/
+
+ */
 #include "keyboardEthernetShield_menu.h"
 #include <IoAbstractionWire.h>
 #include <RemoteAuthentication.h>
@@ -21,44 +31,6 @@ const char pgmListPressed[] PROGMEM = "List Item Pressed";
 const char pgmHeaderSavedItem[] PROGMEM = "Saved Item";
 const char * romSpaceNames = "item 01item 02item 03item 04item 05item 06item 07item 08item 09item 10 ";
 
-//
-// Here we add the keyboard components to the menu. For more general documentation of keyboards
-// https://www.thecoderscorner.com/products/arduino-libraries/io-abstraction/matrix-keyboard-keypad-manager/
-//
-
-// First we create a standard layout, in this case the 3x4 layout but there's also a 4x4 one
-// You can also generate your own layouts for this. The class is KeyboardLayout.
-MAKE_KEYBOARD_LAYOUT_3X4(keyboardLayout)
-//MAKE_KEYBOARD_LAYOUT_4X4(keyboardLayout)
-
-// The matrix keyboard manager itself, looks after the keyboard, notifies of changes etc.
-MatrixKeyboardManager keyboard;
-
-// This is the tcMenu standard keyboard listener. It allows control of the menu by keyboard
-// You could also write your own keyboard interface if this didn't work as expected for you.
-MenuEditingKeyListener menuKeyListener;
-
-// end keyboard components
-
-//
-// This function is called by setup() further down to initialise the keyboard.
-//
-void setupKeyboard() {
-	// set up the pin mappings.
-	keyboardLayout.setRowPin(0, 22);
-	keyboardLayout.setRowPin(1, 23);
-	keyboardLayout.setRowPin(2, 24);
-	keyboardLayout.setRowPin(3, 25);
-	keyboardLayout.setColPin(0, 26);
-	keyboardLayout.setColPin(1, 27);
-	keyboardLayout.setColPin(2, 28);
-
-	// initialise and set the repeat key intervals.
-	keyboard.initialise(ioUsingArduino(), &keyboardLayout, &menuKeyListener);
-	keyboard.setRepeatKeyMillis(850, 350);
-
-}
-
 //
 // Creating a grid layout just for a specific menu item. The flags menu under additional is laid out in a grid format,
 // where the menu items are presented two per row.
@@ -104,8 +76,6 @@ void setup() {
         authenticator->resetAllKeys();
     }
 
-    setupKeyboard();
-
 	// here we use the EEPROM to load back the last set of values.
 	menuMgr.load(0xf8f3);