add changelog.md (#8)

Author: RobTillaart

.arduino-ci.yml

@@ -1,3 +1,18 @@
+platforms:
+  rpipico:
+    board: rp2040:rp2040:rpipico
+    package: rp2040:rp2040
+    gcc:
+      features:
+      defines:
+        - ARDUINO_ARCH_RP2040
+      warnings:
+      flags:
+
+packages:
+  rp2040:rp2040:
+    url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+
 compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
@@ -8,5 +23,6 @@ compile:
     - m4
     - esp32
     # - esp8266
-    - mega2560
+    # - mega2560
+    - rpipico
 

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change Log FastShiftOut
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+
+## [0.2.5] - 2022-11-05
+- add changelog.md
+- add rp2040 to build-CI
+- update readme.md
+
+
+## [0.2.4] - 2021-12-17
+- license
+
+## [0.2.3] - 2021-05-27
+
+----
+
+## no history ...
+
+
+## [0.1.0] - 2013-08-22
+- initial version

FastShiftOut.cpp

@@ -1,10 +1,12 @@
 //
 //    FILE: FastShiftOut.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.4
+// VERSION: 0.2.5
 // PURPOSE: ShiftOut that implements the Print interface
 //    DATE: 2013-08-22
 //     URL: https://github.com/RobTillaart/FastShiftOut
+//
+// HISTORY: see changelog.md
 
 
 #include "FastShiftOut.h"
@@ -15,26 +17,26 @@ FastShiftOut::FastShiftOut(const uint8_t datapin, const uint8_t clockpin, const
   _bitorder = bitOrder;
   pinMode(datapin, OUTPUT);
   pinMode(clockpin, OUTPUT);
-  // https://www.arduino.cc/reference/en/language/functions/advanced-io/shiftout/
-  digitalWrite(clockpin, LOW);  // assume rising pulses from clock 
+  //  https://www.arduino.cc/reference/en/language/functions/advanced-io/shiftout/
+  digitalWrite(clockpin, LOW);  // assume rising pulses from clock
 
 #if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
 
-  // uint8_t _datatimer  = digitalPinToTimer(datapin);
-  // if (_datatimer != NOT_ON_TIMER) turnOffPWM(_datatimer); TODO
+  //  uint8_t _datatimer  = digitalPinToTimer(datapin);
+  //  if (_datatimer != NOT_ON_TIMER) turnOffPWM(_datatimer); TODO
   uint8_t _dataport   = digitalPinToPort(datapin);
   _dataout = portOutputRegister(_dataport);
   _databit = digitalPinToBitMask(datapin);
 
-  // uint8_t _clocktimer = digitalPinToTimer(clockpin);
-  // if (_clocktimer != NOT_ON_TIMER) turnOffPWM(_clocktimer);
+  //  uint8_t _clocktimer = digitalPinToTimer(clockpin);
+  //  if (_clocktimer != NOT_ON_TIMER) turnOffPWM(_clocktimer);
   uint8_t _clockport  = digitalPinToPort(clockpin);
   _clockout = portOutputRegister(_clockport);
   _clockbit = digitalPinToBitMask(clockpin);
 
-#else   // reference implementation
+#else   //  reference implementation
 
-  // reuse these vars as pin to save some space
+  //  reuse these variables as pin to save some space
   _databit = datapin;
   _clockbit = clockpin;
 
@@ -100,7 +102,7 @@ size_t FastShiftOut::writeMSBFIRST(const uint8_t data)
     n >>= 1;
   }
   return 1;
-#else  // reference implementation  // note this has no cli()
+#else  //  reference implementation  // note this has no cli()
   shiftOut(_databit, _clockbit, MSBFIRST, data);
   return 1;
 #endif
@@ -111,7 +113,7 @@ bool FastShiftOut::setBitOrder(const uint8_t bitOrder)
 {
   if ((bitOrder == LSBFIRST) || (bitOrder == MSBFIRST))
   {
-    _bitorder = bitOrder; 
+    _bitorder = bitOrder;
     return true;
   };
   return false;

FastShiftOut.h

@@ -2,7 +2,7 @@
 //
 //    FILE: FastShiftOut.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.4
+// VERSION: 0.2.5
 // PURPOSE: shiftOut class that implements the Print interface
 //    DATE: 2013-08-22
 //     URL: https://github.com/RobTillaart/FastShiftOut
@@ -11,7 +11,7 @@
 #include "Arduino.h"
 #include "Print.h"
 
-#define FASTSHIFTOUT_LIB_VERSION        (F("0.2.4"))
+#define FASTSHIFTOUT_LIB_VERSION        (F("0.2.5"))
 
 
 class FastShiftOut : public Print

README.md

@@ -10,7 +10,8 @@
 
 Arduino library for (AVR) optimized shiftOut - e.g. 74HC595.
 
-A library for FastShiftIn also exist - https://github.com/RobTillaart/FastShiftIn
+- library for FastShiftIn - https://github.com/RobTillaart/FastShiftIn
+- library for FastShiftInOut - https://github.com/RobTillaart/FastShiftInOut
 
 
 ## Description
@@ -31,6 +32,15 @@ The performance of **write()** is substantially faster than the default Arduino
 Exact how big the performance gain is can be seen with the example sketch.
 It does a comparison and shows how the class is to be used.
 
+test 0.2.4  Arduino UNO
+
+|  function             | time (us) |
+|:----------------------|----------:|
+|  write()              |    21.66  |
+|  writeLSBFIRST()      |    22.94  |
+|  writeMSBFIRST()      |    20.30  |
+|  reference shiftOut() |    89.74  |
+
 
 ## Interface
 

examples/FastShiftOut_test/FastShiftOut_test.ino

@@ -22,6 +22,8 @@ void setup()
   test1();
   test2();
   test3();
+  test4();
+  test5();
 
   Serial.println("\ndone ...\n");
 }
@@ -35,7 +37,7 @@ void test1()
     FSO.write(0x55);
   }
   duration1 = micros() - start;
-  Serial.print("FastShiftOut1: ");
+  Serial.print("        write: ");
   Serial.println(duration1 * 0.001);
 
   start = micros();
@@ -45,7 +47,7 @@ void test1()
     FSO.write(0x55);
   }
   duration2 = micros() - start;
-  Serial.print("FastShiftOut2: ");
+  Serial.print("        write: ");
   Serial.println(duration2 * 0.001);
   Serial.print("        Delta: ");
   Serial.println((duration2 - duration1) * 0.001);
@@ -55,6 +57,60 @@ void test1()
 
 
 void test2()
+{
+  start = micros();
+  for (int i = 0; i < 1000; i++)
+  {
+    FSO.writeLSBFIRST(0x55);
+  }
+  duration1 = micros() - start;
+  Serial.print("writeLSBFIRST: ");
+  Serial.println(duration1 * 0.001);
+
+  start = micros();
+  for (int i = 0; i < 1000; i++)
+  {
+    FSO.write(0x55);
+    FSO.write(0x55);
+  }
+  duration2 = micros() - start;
+  Serial.print("writeLSBFIRST: ");
+  Serial.println(duration2 * 0.001);
+  Serial.print("        Delta: ");
+  Serial.println((duration2 - duration1) * 0.001);
+  Serial.println();
+  delay(100);
+}
+
+
+void test3()
+{
+  start = micros();
+  for (int i = 0; i < 1000; i++)
+  {
+    FSO.write(0x55);
+  }
+  duration1 = micros() - start;
+  Serial.print("writeMSBFIRST: ");
+  Serial.println(duration1 * 0.001);
+
+  start = micros();
+  for (int i = 0; i < 1000; i++)
+  {
+    FSO.writeMSBFIRST(0x55);
+    FSO.writeMSBFIRST(0x55);
+  }
+  duration2 = micros() - start;
+  Serial.print("writeMSBFIRST: ");
+  Serial.println(duration2 * 0.001);
+  Serial.print("        Delta: ");
+  Serial.println((duration2 - duration1) * 0.001);
+  Serial.println();
+  delay(100);
+}
+
+
+void test4()
 {
   start = micros();
   for (int i = 0; i < 1000; i++)
@@ -81,7 +137,7 @@ void test2()
 }
 
 
-void test3()
+void test5()
 {
   Serial.println("\nTest print interface");
   start = micros();
@@ -120,4 +176,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+// -- END OF FILE --

library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/FastShiftOut.git"
   },
-  "version": "0.2.4",
+  "version": "0.2.5",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",

library.properties

@@ -1,5 +1,5 @@
 name=FastShiftOut
-version=0.2.4
+version=0.2.5
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for (AVR) optimized shiftOut - e.g. 74HC595