Arduino ci (#5)

* initial arduino-ci
* added unit tests (fails for due and zero) ==> Arduino-CI/arduino_ci#252

Author: RobTillaart

.arduino-ci.yml

@@ -0,0 +1,7 @@
+compile:
+  # Choosing to run compilation tests on 2 different Arduino platforms
+  platforms:
+    - uno
+    - leonardo
+    - due
+    - zero

.github/workflows/arduino_test_runner.yml

@@ -0,0 +1,13 @@
+---
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  arduino_ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: Arduino-CI/action@master
+          #   Arduino-CI/[email protected]

FastShiftIn.cpp

@@ -1,20 +1,23 @@
 //
 //    FILE: FastShiftIn.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.1
+// VERSION: 0.2.2
 // PURPOSE: Fast ShiftIn for 74HC165 register, AVR optimized
 //    DATE: 2013-09-29
 //     URL: https://github.com/RobTillaart/FastShiftIn
 //
 
 #include "FastShiftIn.h"
 
+
 FastShiftIn::FastShiftIn(const uint8_t datapin, const uint8_t clockpin, const uint8_t bitOrder)
 {
   _bitorder = bitOrder;
-
+  _value    = 0;
   pinMode(datapin, INPUT);
   pinMode(clockpin, OUTPUT);
+  // https://www.arduino.cc/reference/en/language/functions/advanced-io/shiftin/
+  digitalWrite(clockpin, LOW);  // assume rising pulses from clock 
 
 #if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
 
@@ -32,7 +35,7 @@ FastShiftIn::FastShiftIn(const uint8_t datapin, const uint8_t clockpin, const ui
 
 #else   // reference implementation
 
-  // reuse these vars as pin to save some space
+  // reuse these local vars as pin to save some space
   _databit = datapin;
   _clockbit = clockpin;
 
@@ -48,19 +51,18 @@ int FastShiftIn::read()
   return readMSBFIRST();
 }
 
-#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
-
 int FastShiftIn::readLSBFIRST()
 {
-  uint8_t value = 0;
+#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
+  uint8_t value   = 0;
   uint8_t cbmask1 = _clockbit;
   uint8_t cbmask2 = ~_clockbit;
-  uint8_t dbmask = _databit;
+  uint8_t dbmask  = _databit;
 
   for (uint8_t m = 1; m > 0; m <<= 1)
   {
     uint8_t oldSREG = SREG;
-    cli();
+    noInterrupts();
     *_clockin |= cbmask1;
     if ((*_datain & dbmask) > 0)
     {
@@ -71,19 +73,26 @@ int FastShiftIn::readLSBFIRST()
   }
   _value = value;
   return _value;
+  
+#else   // reference implementation
+
+  _value = shiftIn(_databit, _clockbit, LSBFIRST);
+   return _value;
+#endif
 }
 
 int FastShiftIn::readMSBFIRST()
 {
-  uint8_t value = 0;
+#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
+  uint8_t value   = 0;
   uint8_t cbmask1 = _clockbit;
   uint8_t cbmask2 = ~cbmask1;
-  uint8_t dbmask = _databit;
+  uint8_t dbmask  = _databit;
 
   for (uint8_t n = 128; n > 0; n >>= 1)
   {
     uint8_t oldSREG = SREG;
-    cli();
+    noInterrupts();
     *_clockin |= cbmask1;
     if ((*_datain & dbmask) > 0)
     {
@@ -94,20 +103,22 @@ int FastShiftIn::readMSBFIRST()
   }
   _value = value;
   return _value;
-}
-
-#else  // reference implementation - note this has no cli()
+  
+#else   // reference implementation
 
-int FastShiftIn::readLSBFIRST()
-{
-  return shiftIn(_databit, _clockbit, LSBFIRST);
+  _value = shiftIn(_databit, _clockbit, MSBFIRST);
+   return _value;
+#endif
 }
 
-int FastShiftIn::readMSBFIRST()
+bool FastShiftIn::setBitOrder(const uint8_t bitOrder)
 {
-  return shiftIn(_databit, _clockbit, MSBFIRST);
+  if ((bitOrder == LSBFIRST) || (bitOrder == MSBFIRST))
+  {
+    _bitorder = bitOrder; 
+    return true;
+  };
+  return false;
 }
 
-#endif
-
 // -- END OF FILE --

FastShiftIn.h

@@ -2,30 +2,35 @@
 //
 //    FILE: FastShiftIn.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.1
+// VERSION: 0.2.2
 // PURPOSE: Fast ShiftIn for 74HC165 register, AVR optimized
 //    DATE: 2013-09-29
 //     URL: https://github.com/RobTillaart/FastShiftIn
 //
 
 #include "Arduino.h"
 
-#define FASTSHIFTIN_LIB_VERSION (F("0.2.1"))
+#define FASTSHIFTIN_LIB_VERSION (F("0.2.2"))
 
 class FastShiftIn
 {
 public:
   // bitorder = { LSBFIRST, MSBFIRST };
   FastShiftIn(const uint8_t datapin, const uint8_t clockpin, const uint8_t bitOrder = LSBFIRST);
-  int read(void);
+
+  int     read(void);
+  int     lastRead(void)    { return _value; };
+
+  bool    setBitOrder(const uint8_t bitOrder);
+  uint8_t getBitOrder(void) { return _bitorder; };
 
   // overrule bitorder (most optimized).
-  int readLSBFIRST(void);
-  int readMSBFIRST(void);
+  int     readLSBFIRST(void);
+  int     readMSBFIRST(void);
 
 private:
   uint8_t _bitorder;
-  int _value;
+  int     _value;
 
   uint8_t _databit;
   volatile uint8_t *_datain;

README.md

@@ -1,3 +1,8 @@
+
+[![Arduino CI](https://github.com/RobTillaart/FastShiftIn/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/FastShiftIn/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/RobTillaart/FastShiftIn.svg?maxAge=3600)](https://github.com/RobTillaart/FastShiftIn/releases)
+
 # FastShiftIn
 
 Arduino library for (AVR) optimized shiftIn - e.g. for 74HC165
@@ -25,9 +30,12 @@ It does a comparison and shows how the class is to be used.
 
 The interface exists of the following functions:
 
-- **int read(void);**
-- **int readLSBFIRST(void);**  most optimized
-- **int readMSBFIRST(void);**  most optimized
+- **int read(void)** reads a new value
+- **int lastRead()** returns last value read
+- **bool setBitOrder(bitOrder)** set LSBFIRST or MSBFIRST. Returns false for other values.
+- **uint8_t getBitOrder(void)** returns LSBFIRST or MSBFIRST
+- **int readLSBFIRST(void)**  optimized LSB read()
+- **int readMSBFIRST(void)**  optimized MSB read()
 
 ## Notes
 

examples/fastShiftIn/fastShiftIn.ino

@@ -1,11 +1,9 @@
 //
 //    FILE: fastShiftIn.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.01
+// VERSION: 0.1.2
 // PURPOSE: test sketch
-//     URL:
-//
-// Released to the public domain
+//     URL: https://github.com/RobTillaart/FastShiftIn
 //
 
 #include "FastShiftIn.h"
@@ -17,15 +15,15 @@ volatile int x = 0;
 void setup()
 {
   Serial.begin(115200);
-  Serial.print("example fastShiftIn: "); 
+  Serial.println(__FILE__); 
   Serial.println(FASTSHIFTIN_LIB_VERSION);
 
   digitalWrite(12, HIGH);
   Serial.println("\n 8 bits HIGH\n"); 
 
   Serial.println("\nPerformance - time in us"); 
   uint32_t start = micros();
-  for (int i=0; i<1000; i++)
+  for (int i = 0; i < 1000; i++)
   {
     x = FSI.read();
   }
@@ -34,7 +32,7 @@ void setup()
   Serial.println(duration1 * 0.001);
 
   start = micros();
-  for (int i=0; i<1000; i++)
+  for (int i = 0; i < 1000; i++)
   {
     x = FSI.read();
     x = FSI.read();
@@ -43,12 +41,12 @@ void setup()
   Serial.print("FastShiftIn2: ");
   Serial.println(duration2 * 0.001);
   Serial.print("       Delta: ");
-  Serial.println((duration2-duration1)* 0.001);
+  Serial.println((duration2 - duration1)* 0.001);
   Serial.println();
 
 
   start = micros();
-  for (int i=0; i<1000; i++)
+  for (int i = 0; i < 1000; i++)
   {
     x = shiftIn(12, 13, LSBFIRST);
   }
@@ -57,7 +55,7 @@ void setup()
   Serial.println(duration1* 0.001);
 
   start = micros();
-  for (int i=0; i<1000; i++)
+  for (int i = 0; i < 1000; i++)
   {
     x = shiftIn(12, 13, LSBFIRST);
     x = shiftIn(12, 13, LSBFIRST);
@@ -66,7 +64,7 @@ void setup()
   Serial.print("Standard shiftIn2: ");
   Serial.println(duration2 * 0.001);
   Serial.print("            Delta: ");
-  Serial.println((duration2-duration1) * 0.001);
+  Serial.println((duration2 - duration1) * 0.001);
   Serial.println();
 
   Serial.println("done...");

examples/fastShiftIn_readLSBFIRST/fastShiftIn_readLSBFIRST.ino

@@ -1,7 +1,7 @@
 //
 //    FILE: fastShiftIn_readLSBFIRST.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
+// VERSION: 0.1.1
 // PURPOSE: test sketch
 //     URL: https://github.com/RobTillaart/FastShiftIn
 //
@@ -15,7 +15,7 @@ volatile int x = 0;
 void setup()
 {
   Serial.begin(115200);
-  Serial.print("example fastShiftIn: ");
+  Serial.println(__FILE__);
   Serial.println(FASTSHIFTIN_LIB_VERSION);
 
   digitalWrite(12, HIGH);

examples/fastShiftIn_test/fastShiftIn_test.ino

@@ -1,7 +1,7 @@
 //
 //    FILE: fastShiftIn_test.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
+// VERSION: 0.1.1
 // PURPOSE: test sketch
 //     URL: https://github.com/RobTillaart/FastShiftIn
 //
@@ -17,7 +17,7 @@ uint32_t start, duration1, duration2;
 void setup()
 {
   Serial.begin(115200);
-  Serial.print("example fastShiftIn: ");
+  Serial.println(__FILE__);
   Serial.println(FASTSHIFTIN_LIB_VERSION);
 
   digitalWrite(12, HIGH);
@@ -139,7 +139,7 @@ void test_reference()
   Serial.print("            Delta: ");
   Serial.println((duration2 - duration1) * 0.001);
   Serial.println();
-
+  delay(100);
 }
 
 void loop()

library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/FastShiftIn.git"
   },
-  "version":"0.2.1",
+  "version":"0.2.2",
   "frameworks": "arduino",
-  "platforms": "AVR"
+  "platforms": "*"
 }

library.properties

@@ -1,5 +1,5 @@
 name=FastShiftIn
-version=0.2.1
+version=0.2.2
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library for (AVR) optimized shiftIn - e.g. for 74HC165

test/.arduino-ci.yml

@@ -0,0 +1,6 @@
+compile:
+  # Choosing to run compilation tests on 2 different Arduino platforms
+  platforms:
+    - uno
+    - leonardo
+