update library.json, license, readme, minor edits (#4)

RobTillaart · web-flow · commit 4434a3d50623 · 2021-12-27T21:01:45.000+01:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2021 Rob Tillaart
+Copyright (c) 2021-2022 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 # rotaryDecoder
 
-Arduino library for a PCF8574 based rotary decoder - supports 4 RE.
+Arduino library for a PCF8574 based rotary decoder - supports 4 rotary encoders.
 
 
 ## Description
diff --git a/examples/rotaryDecoder_demo_interrupt/rotaryDecoder_demo_interrupt.ino b/examples/rotaryDecoder_demo_interrupt/rotaryDecoder_demo_interrupt.ino
@@ -2,9 +2,8 @@
 //    FILE: rotaryDecoder_demo_interrupt.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-05-08
-//
 // PUPROSE: demo interrupt controlled rotary decoder
-
+//
 // connect up to 4 rotary encoders to 1 PCF8574.
 //
 //  RotaryEncoder    PCF8574      UNO
@@ -72,3 +71,4 @@ void loop()
 
 
 // -- END OF FILE --
+
diff --git a/examples/rotaryDecoder_demo_polling/rotaryDecoder_demo_polling.ino b/examples/rotaryDecoder_demo_polling/rotaryDecoder_demo_polling.ino
@@ -2,9 +2,8 @@
 //    FILE: rotaryDecoder_demo_polling.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-05-08
-//
 // PUPROSE: demo
-
+//
 // connect up to 4 rotary encoders to 1 PCF8574.
 //
 //  RotaryEncoder    PCF8574      UNO
@@ -38,7 +37,6 @@ void setup()
 }
 
 
-
 void loop()
 {
   if (decoder.checkChange())
diff --git a/examples/rotaryDecoder_demo_simple/rotaryDecoder_demo_simple.ino b/examples/rotaryDecoder_demo_simple/rotaryDecoder_demo_simple.ino
@@ -2,9 +2,8 @@
 //    FILE: rotaryDecoder_demo_simple.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-05-08
-//
 // PUPROSE: demo
-
+//
 // connect up to 4 rotary encoders to 1 PCF8574.
 //
 //  RotaryEncoder    PCF8574      UNO
diff --git a/examples/rotaryDecoder_demo_single/rotaryDecoder_demo_single.ino b/examples/rotaryDecoder_demo_single/rotaryDecoder_demo_single.ino
@@ -2,12 +2,11 @@
 //    FILE: rotaryDecoder_demo_single.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-05-08
-//
 // PUPROSE: demo single direction rotary decoder.
-
+//
 // note this is used for e.g. RPM counters that are unidirectional.
 //      all moves are interpreted as same direction.
-
+//
 // connect up to 4 rotary encoders to 1 PCF8574.
 //
 //  RotaryEncoder    PCF8574      UNO
diff --git a/examples/rotaryDecoder_performance/rotaryDecoder_performance.ino b/examples/rotaryDecoder_performance/rotaryDecoder_performance.ino
@@ -2,9 +2,8 @@
 //    FILE: rotaryDecoder_performance.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-05-08
-//
 // PUPROSE: demo
-
+//
 // connect up to 4 rotary encoders to 1 PCF8574.
 //
 //  RotaryEncoder    PCF8574      UNO
@@ -59,3 +58,4 @@ void loop()
 
 
 // -- END OF FILE --
+
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "rotaryDecoder",
-  "keywords": "rotary encoder PCF8574",
+  "keywords": "rotary,encoder,PCF8574",
   "description": "Arduino library to rotary decoder with a PCF8574\nSupports up to 4 RE's",
   "authors":
   [
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/rotaryDecoder.git"
   },
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=rotaryDecoder
-version=0.1.1
+version=0.1.2
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library to rotary decoder with a PCF8574
diff --git a/rotaryDecoder.cpp b/rotaryDecoder.cpp
@@ -10,7 +10,7 @@
 //  0.1.0   2021-05-08  initial version
 //  0.1.1   2021-11-15  update build-CI, readme.md
 //                      improve readability of code
-//
+//  0.1.2   2021-12-27  update library.json, license, minor edits
 
 
 #include "rotaryDecoder.h"
@@ -158,3 +158,4 @@ uint8_t rotaryDecoder::_read8()
 
 
 // -- END OF FILE --
+
diff --git a/rotaryDecoder.h b/rotaryDecoder.h
@@ -2,7 +2,7 @@
 //
 //    FILE: rotaryDecoder.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.1
+// VERSION: 0.1.2
 //    DATE: 2021-05-08
 // PURPOSE: rotary decoder library for Arduino
 //     URL: https://github.com/RobTillaart/rotaryDecoder
@@ -11,7 +11,7 @@
 #include "Arduino.h"
 #include "Wire.h"
 
-#define ROTARY_DECODER_LIB_VERSION         (F("0.1.1"))
+#define ROTARY_DECODER_LIB_VERSION         (F("0.1.2"))
 
 
 class rotaryDecoder
@@ -28,14 +28,14 @@ class rotaryDecoder
 
   void    readInitialState();
 
-  // for polling version, 
+  // for polling version,
   // checkChange is bit faster than a call to update
-  // so useful if there are only a few updates 
+  // so useful if there are only a few updates
   bool    checkChange();
 
   // read and update the counters
   bool    update();         // assumes two directions   => +1 and -1
-  bool    updateSingle();   // assumes single direction => + ++ +++ 
+  bool    updateSingle();   // assumes single direction => + ++ +++
 
   // re = rotary encoder
   int32_t getValue(uint8_t re) { return _encoder[re]; };
@@ -44,6 +44,7 @@ class rotaryDecoder
   // DEBUG
   uint8_t getLastPosition(uint8_t re) { return _lastPos[re]; };
 
+
 private:
   uint8_t   _count = 0;
   uint8_t   _lastValue = 0;
@@ -55,4 +56,6 @@ class rotaryDecoder
   TwoWire * _wire;
 };
 
+
 // -- END OF FILE --
+
diff --git a/test/unit_test_001.cpp b/test/unit_test_001.cpp
@@ -38,6 +38,7 @@
 
 unittest_setup()
 {
+  fprintf(stderr, "ROTARY_DECODER_LIB_VERSION: %s\n", (char *) ROTARY_DECODER_LIB_VERSION);
 }
 
 unittest_teardown()
@@ -47,8 +48,6 @@ unittest_teardown()
 
 unittest(test_constructor)
 {
-  fprintf(stderr, "ROTARY_DECODER_LIB_VERSION: %s\n", (char *) ROTARY_DECODER_LIB_VERSION);
-
   rotaryDecoder(0x20);
 
   fprintf(stderr, "no tests yet");

-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 name=rotaryDecoder
 -version=0.1.1
 +version=0.1.2
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library to rotary decoder with a PCF8574