Configure for latest Arduino Library Manager versions

Tidy up conditionals for adding platforms
Simplify examples

Author: techpaul

README.md

@@ -1,7 +1,7 @@
 # PS2KeyAdvanced
 ## Arduino PS2 Keyboard FULL keyboard protocol support and full keys to integer coding
 **V1.0.6** January 2020 - Fix typos, correct keyboard reset status improve library.properties 
-		   and additional platform handling
+		   and additional reduction for easier platform handling
 
 V1.0.4 August 2018 - Minor reduction in available() method to remove redundant extra safety checks on buffers
 

examples/KeyToLCD/KeyToLCD.ino

@@ -122,7 +122,7 @@ int8_t rows = 0;
 /*  messages constants */
 /* Key codes and strings for keys producing a string */
 /* three arrays in same order ( keycode, string to display, length of string ) */
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
 const uint8_t codes[] PROGMEM = { PS2_KEY_SPACE, PS2_KEY_TAB, PS2_KEY_ESC, PS2_KEY_DELETE,
                                    PS2_KEY_F1, PS2_KEY_F2, PS2_KEY_F3, PS2_KEY_F4,
                                    PS2_KEY_F5, PS2_KEY_F6, PS2_KEY_F7, PS2_KEY_F8,
@@ -152,7 +152,7 @@ const char *const keys[] PROGMEM =  {
 const int8_t sizes[] PROGMEM = { 1, 5, 5, 5, 4, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5 };
 char buffer[ 8 ];
 
-#elif defined(ARDUINO_ARCH_SAM)
+#else
 const uint8_t codes[] = { PS2_KEY_SPACE, PS2_KEY_TAB, PS2_KEY_ESC,
                           PS2_KEY_DELETE, PS2_KEY_F1, PS2_KEY_F2, PS2_KEY_F3,
                           PS2_KEY_F4, PS2_KEY_F5, PS2_KEY_F6, PS2_KEY_F7,
@@ -162,9 +162,6 @@ const char *const keys[]  =  { " ", "[Tab]", "[ESC]", "[Del]", "[F1]", "[F2]", "
                                "[F4]", "[F5]", "[F6]", "[F7]", "[F8]",
                                "[F9]", "[F10]", "[F11]", "[F12]" };
 const int8_t sizes[]  = { 1, 5, 5, 5, 4, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5 };
-
-#else
-  #error “This library only supports boards with an AVR or SAM processor.”
 #endif
 
 // initialize the keyboard library with the numbers of the interface pins
@@ -187,15 +184,9 @@ lcd.begin( MAX_COL, MAX_ROW );
 lcd.clear();                      // clear the screen
 lcd.cursor();                     // Enable Cursor
 lcd.blink();                      // Blinking cursor
-#if defined(ARDUINO_ARCH_AVR)
-lcd.print( F( "PC Services" ) );  // Display sign-on text
-lcd.setCursor( 0,1 );
-lcd.print( F( "Keyboard to LCD" ) );
-#elif defined(ARDUINO_ARCH_SAM)
 lcd.print( "PC Services" );       // Display sign-on text
 lcd.setCursor( 0,1 );
 lcd.print( "Keyboard to LCD" );
-#endif
 lcd.setCursor( 12,0 );
 cols = 12;                        // update cursor position
 rows = 0;
@@ -312,27 +303,27 @@ if( keyboard.available() )
         if( c != PS2_KEY_EUROPE2 && ( c < PS2_KEY_KP0 || c >= PS2_KEY_F1 ) )
           {  // Non printable sort which ones we can print
           for( idx = 0; idx < sizeof( codes ); idx++ )
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
           if( c == pgm_read_byte( codes + idx ) )
-#elif defined(ARDUINO_ARCH_SAM)
+#else
           if( c == codes[ idx ] )
 #endif
             {  /* String outputs */
             mode = 1;
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
             c = pgm_read_byte( sizes + idx );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
             c = sizes[ idx ];
 #endif
             cols += c - 1;
             check_cursor( );
             /* when cursor reset keep track */
             if( cols == 0 )
               cols = c;
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
             strcpy_P( buffer, (char*)pgm_read_word( &( keys[ idx ] ) ) );
             lcd.print( buffer );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
             lcd.print( keys[ idx ] );
 #endif
             cols++;

examples/SimpleTest/SimpleTest.ino

@@ -144,11 +144,7 @@ void setup()
 // Configure the keyboard library
 keyboard.begin( DATAPIN, IRQPIN );
 Serial.begin( 115200 );
-#if defined(ARDUINO_ARCH_AVR)
-Serial.println( F( "PS2 Advanced Key Simple Test:" ) );
-#elif defined(ARDUINO_ARCH_SAM)
 Serial.println( "PS2 Advanced Key Simple Test:" );
-#endif
 }
 
 
@@ -160,19 +156,11 @@ if( keyboard.available() )
   c = keyboard.read();
   if( c > 0 )
     {
-#if defined(ARDUINO_ARCH_AVR)
-    Serial.print( F( "Value " ) );
-    Serial.print( c, HEX );
-    Serial.print( F( " - Status Bits " ) );
-    Serial.print( c >> 8, HEX );
-    Serial.print( F( "  Code " ) );
-#elif defined(ARDUINO_ARCH_SAM)
     Serial.print( "Value " );
     Serial.print( c, HEX );
     Serial.print( " - Status Bits " );
     Serial.print( c >> 8, HEX );
     Serial.print( "  Code " );
-#endif
     Serial.println( c & 0xFF, HEX );
     }
   }

examples/advcodetest/advcodetest.ino

@@ -154,23 +154,15 @@ PS2KeyAdvanced keyboard;
 void setup()
 {
 Serial.begin( 115200 );
-#if defined(ARDUINO_ARCH_AVR)
-  Serial.println( F( "PS2 Advanced Key - Advanced Test:" ) );
-#elif defined(ARDUINO_ARCH_SAM)
-  Serial.println( "PS2 Advanced Key - Advanced Test:" );
-#endif
+Serial.println( "PS2 Advanced Key - Advanced Test:" );
 
 // Configure the keyboard library
 keyboard.begin( DATAPIN, IRQPIN );
 keyboard.echo();              // ping keyboard to see if there
 delay( 6 );
 c = keyboard.read();
 if( (c & 0xFF) == PS2_KEY_ECHO )
-#if defined(ARDUINO_ARCH_AVR)
-  Serial.println( F( "Keyboard OK.." ) );
-#elif defined(ARDUINO_ARCH_SAM)
   Serial.println( "Keyboard OK.." );
-#endif
 }
 
 
@@ -187,70 +179,38 @@ if( keyboard.available() )
     switch( c & 0xFF )
       {
       case PS2_KEY_R:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.println( F( "Reset" ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.println( "Reset" );
-#endif
                    keyboard.resetKey();  // Reset keyboard
                    break;
       case PS2_KEY_S:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.println( F( "Get Scancode set in use" ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.println( "Get Scancode set in use" );
-#endif
                    keyboard.getScanCodeSet();  // Get which scan code set
                    break;
       case PS2_KEY_G:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.print( F( "Get current lock status = " ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.print( "Get current lock status = " );
-#endif
                    c = keyboard.getLock();  // Get current lock status
                    Serial.println( c, HEX );
                    break;
       case PS2_KEY_I:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.println( F( "Read ID code" ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.println( "Read ID code" );
-#endif
                    keyboard.readID();  // Get which scan code set
                    break;
       case PS2_KEY_E:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.println( F( "Echo" ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.println( "Echo" );
-#endif
                    keyboard.echo();  // Get which scan code set
                    break;
       case PS2_KEY_T:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.println( F( "Typematic Rate" ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.println( "Typematic Rate" );
-#endif
                    keyboard.typematic( 31, 3);  // Get slowest
                    break;
       case PS2_KEY_B:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.print( F( "No Break Codes " ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.print( "No Break Codes " );
-#endif
                    breaks ^= 1;;
                    Serial.println( breaks );
                    keyboard.setNoBreak( breaks );  // set break mode
                    break;
       case PS2_KEY_N:
-#if defined(ARDUINO_ARCH_AVR)
-                   Serial.print( F( "No Repeat Makes for CTRL... " ) );
-#elif defined(ARDUINO_ARCH_SAM)
                    Serial.print( "No Repeat Makes for CTRL... " );
-#endif
                    repeats ^= 1;
                    Serial.println( repeats );
                    keyboard.setNoRepeat( repeats );  // Set repeat modet

library.properties

@@ -1,9 +1,11 @@
 name=PS2KeyAdvanced
-version=1.0.5
+version=1.0.6
 author=Paul Carpenter <[email protected]>
 maintainer=Paul Carpenter <[email protected]>
 sentence=PS2 keyboard FULL control and ALL keys processing, as well as LED control.
 paragraph=Provides ability to convert long key stroke code sequences to a single integer, for all keys ANY Latin keyboard, even multimedia and 24 Function key keyboards.
 category=Other
 url=https://github.com/techpaul/PS2KeyAdvanced.git
 architectures=avr,sam
+includes=PS2KeyAdvanced.h
+

src/PS2KeyAdvanced.cpp

@@ -144,9 +144,9 @@ void set_lock( );
 
 /* Constant control functions to flags array
    in translated key code value order  */
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
 const uint8_t PROGMEM control_flags[] = {
-#elif defined(ARDUINO_ARCH_SAM)
+#else
 const uint8_t control_flags[] = {
 #endif
                 _SHIFT, _SHIFT, _CTRL, _CTRL,
@@ -291,8 +291,9 @@ else
                   _ps2mode &= ~_PS2_BUSY;
                   send_next();              // Check for more to send
                   }
-             }
-             // fall through to default
+              }
+            _bitcount = 0;	            // end of byte
+            break;
     default: // in case of weird error and end of byte reception resync
             _bitcount = 0;
     }
@@ -439,7 +440,8 @@ switch( _bitcount )
             _tx_ready &= ~_COMMAND;
           if( !( _ps2mode & _WAIT_RESPONSE ) )   //  if not wait response
             send_next();                    // check anything else to queue up
-          // fall through to default
+          _bitcount = 0;	            // end of byte
+          break;
   default: // in case of weird error and end of byte reception re-sync
           _bitcount = 0;
   }
@@ -669,11 +671,11 @@ if( index & _E0_MODE )
   {
   length = sizeof( extended_key ) / sizeof( extended_key[ 0 ] );
   for( index = 0; index < length; index++ )
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
      if( data == pgm_read_byte( &extended_key[ index ][ 0 ] ) )
        {
        retdata = pgm_read_byte( &extended_key[ index ][ 1 ] );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
      if( data == extended_key[ index ][ 0 ] )
        {
        retdata = extended_key[ index ][ 1 ];
@@ -685,11 +687,11 @@ else
   {
   length = sizeof( single_key ) / sizeof( single_key[ 0 ] );
   for( index = 0; index < length; index++ )
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
      if( data == pgm_read_byte( &single_key[ index ][ 0 ] ) )
        {
        retdata = pgm_read_byte( &single_key[ index ][ 1 ] );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
      if( data == single_key[ index ][ 0 ] )
        {
        retdata = single_key[ index ][ 1 ];
@@ -746,9 +748,9 @@ if( retdata > 0 )
   else
     if( retdata >= PS2_KEY_L_SHIFT && retdata <= PS2_KEY_R_GUI )
       { // Update bits for _SHIFT, _CTRL, _ALT, _ALT GR, _GUI in status
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
       index = pgm_read_byte( &control_flags[ retdata - PS2_KEY_L_SHIFT ] );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
       index = control_flags[ retdata - PS2_KEY_L_SHIFT ];
 #endif
       if( PS2_keystatus & _BREAK )
@@ -764,9 +766,9 @@ if( retdata > 0 )
       // Numeric keypad ONLY works in numlock state or when _SHIFT status
       if( retdata >= PS2_KEY_KP0 && retdata <=  PS2_KEY_KP_DOT )
         if( !( PS2_led_lock & PS2_LOCK_NUM ) || ( PS2_keystatus & _SHIFT ) )
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
           retdata = pgm_read_byte( &scroll_remap[ retdata - PS2_KEY_KP0 ] );
-#elif defined(ARDUINO_ARCH_SAM)
+#else
           retdata = scroll_remap[ retdata - PS2_KEY_KP0 ];
 #endif
   // Sort break code handling or ignore for all having processed the _SHIFT etc status

src/PS2KeyAdvanced.h

@@ -135,6 +135,19 @@
 #define PS2KeyAdvanced_h
 #include "Arduino.h"
 
+// Platform specific areas
+// Harvard architecture settings for PROGMEM
+// Add separate for EACH architecture as easier to maintain
+// AVR
+#if defined(ARDUINO_ARCH_AVR)
+#define PS2_REQUIRES_PROGMEM    1
+#endif
+
+// Invalid architecture
+#if !( defined( ARDUINO_ARCH_AVR ) || defined( ARDUINO_ARCH_SAM ) )
+#warning Library is not supported on this board Use at own risk
+#endif
+
 /* Flags/bit masks for status bits in returned unsigned int value */
 #define PS2_BREAK   0x8000
 #define PS2_SHIFT   0x4000

src/PS2KeyTable.h

@@ -64,9 +64,9 @@
     In codes can only be 1 - 0x9F, plus 0xF2 and 0xF1
     Out Codes in range 1 to 0x9F
 */
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
 const uint8_t PROGMEM single_key[][ 2 ] = {
-#elif defined(ARDUINO_ARCH_SAM)
+#else
 const uint8_t single_key[][ 2 ] = {
 #endif
                 { PS2_KC_NUM, PS2_KEY_NUM },
@@ -183,9 +183,9 @@ const uint8_t single_key[][ 2 ] = {
                 };
 
 /* Two byte Key  table after an E0 byte received */
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
 const uint8_t PROGMEM extended_key[][ 2 ] = {
-#elif defined(ARDUINO_ARCH_SAM)
+#else
 const uint8_t extended_key[][ 2 ] = {
 #endif
                 { PS2_KC_IGNORE, PS2_KEY_IGNORE },
@@ -233,9 +233,9 @@ const uint8_t extended_key[][ 2 ] = {
 
 /* Scroll lock numeric keypad re-mappings for NOT NUMLOCK */
 /* in translated code order order is important */
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(PS2_REQUIRES_PROGMEM)
 const uint8_t PROGMEM scroll_remap[] = {
-#elif defined(ARDUINO_ARCH_SAM)
+#else
 const uint8_t scroll_remap[] = {
 #endif
                 PS2_KEY_INSERT,     // PS2_KEY_KP0