Improved usability with Arduino IDE

.gitignore

@@ -0,0 +1,29 @@
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app

README.md

@@ -1,4 +1,5 @@
-sainsmartkeypad
+SainsmartKeypad
 ===============
 
-More usable Version of the DFR_Key library for Sainsmart 1602 LCD Keypad. It's also usable for all other resistor based keypads. Make sure that you distribute your changes (GPLv3).
+More usable Version of the DFR_Key library for Sainsmart 1602 LCD Keypad.
+It's also usable for all other resistor based keypads.

sainsmartkeypad_example_sketch/sainsmartkeypad_example_sketch.ino → examples/BasicSainsmartKeypad/BasicSainsmartKeypad.ino

@@ -1,9 +1,6 @@
+#include <Arduino.h>
 #include <LiquidCrystal.h>
-
-#include "Arduino.h"
-
-// github.com/Phaiax/sainsmartkeypad
-#include "sainsmartkeypad.h"
+#include <SainsmartKeypad.h>
 
 LiquidCrystal lcd(8, 9, 4, 5, 6, 7);
 SainsmartKeypad keypad(0);
@@ -14,20 +11,23 @@ void setup() {
   lcd.begin(16, 2);
   lcd.setCursor(0,0);
   lcd.print("Keypad Example");
+
+  // set your own values, if necessary
+  //keypad.setAnalogReadValues(721, 482, 132, 309, 0, 1023);
 }
 
 void loop() {
   key = keypad.getKey_fastscroll();
-  
+
   // Try the other possibilities:
   // (Only one at a time.
   //  fastscroll, waitrelease and periodic
   //  won't work next to each other.)
-  
+
   //key = keypad.getKey_waitrelease(); // without fastscroll but usable
   //key = keypad.getKey_periodic(); // not quite usable
   //key = keypad.getKey_instant(); // not quite usable
-  
+
   if(key != SAMPLE_WAIT) // Do not refresh screen every loop
   {
      switch(key)
@@ -44,4 +44,3 @@ void loop() {
      lcd.print("        ");
   }
 }
-

keywords.txt

@@ -0,0 +1,30 @@
+#######################################
+# Syntax Coloring Map For ExampleLibrary
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+SainsmartKeypad	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+getKey_fastscroll	KEYWORD2
+getKey_waitrelease	KEYWORD2
+getKey_periodic	KEYWORD2
+getKey_instant	KEYWORD2
+setAnalogReadValues	KEYWORD2
+setRefreshRate	KEYWORD2
+setMsToActivateFastScroll	KEYWORD2
+setFastScrollTriggerRate	KEYWORD2
+
+#######################################
+# Instances (KEYWORD2)
+#######################################
+
+#######################################
+# Constants (LITERAL1)
+#######################################

library.properties

@@ -0,0 +1,9 @@
+name=SainsmartKeypad
+version=1.0.0-alpha
+author=Simon Hitzenberger
+maintainer=Simon Hitzenberger
+sentence=More usable Version of the DFR_Key library for Sainsmart 1602 LCD Keypad.
+paragraph=It's also usable for all other resistor based keypads.
+category=Device Control
+url=https://github.com/slh24/arduino-sainsmartkeypad
+architectures=*