Fix URL examples + minor edits (#13)

RobTillaart · Jan 5, 2024 · e30bdd4 · e30bdd4
1 parent 9b8e47b
commit e30bdd4
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.1] - 2024-01-05
+- Fix URL in examples
+- minor edits
+
+
 ## [0.4.0] - 2023-12-01
 - Fix #30, support for Arduino ESP32 S3 - breaking change
 - update readme.md

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Rob Tillaart
+Copyright (c) 2022-2024 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/MCP23S08.cpp b/MCP23S08.cpp
@@ -1,7 +1,7 @@
 //
 //    FILE: MCP23S08.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 // PURPOSE: Arduino library for SPI MCP23S08 8 channel port expander
 //    DATE: 2022-01-10
 //     URL: https://github.com/RobTillaart/MCP23S08

diff --git a/MCP23S08.h b/MCP23S08.h
@@ -2,7 +2,7 @@
 //
 //    FILE: MCP23S08.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.4.0
+// VERSION: 0.4.1
 // PURPOSE: Arduino library for SPI MCP23S08 8 channel port expander
 //    DATE: 2022-01-10
 //     URL: https://github.com/RobTillaart/MCP23S08
@@ -13,7 +13,7 @@
 #include "MCP23S08_registers.h"
 
 
-#define MCP23S08_LIB_VERSION              (F("0.4.0"))
+#define MCP23S08_LIB_VERSION              (F("0.4.1"))
 
 //  ERROR CODES
 #define MCP23S08_OK                       0x00

diff --git a/examples/MCP23S08_digitalRead/MCP23S08_digitalRead.ino b/examples/MCP23S08_digitalRead/MCP23S08_digitalRead.ino
@@ -2,11 +2,11 @@
 //    FILE: MCP23S08_digitalRead.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-12-30
-// PUPROSE: test MCP23017 library
+// PURPOSE: test MCP23S08 library
+//     URL: https://github.com/RobTillaart/MCP23S08
 
 
 #include "MCP23S08.h"
-#include "SPI.h"
 
 
 MCP23S08 MCP(10);
@@ -26,7 +26,7 @@ void setup()
   rv = MCP.begin();
   Serial.println(rv);
 
-  rv = MCP.pinMode8(0xFF);   // CHECK
+  rv = MCP.pinMode8(0xFF);   //  CHECK
   Serial.println(rv);
 
 

diff --git a/examples/MCP23S08_digitalWrite/MCP23S08_digitalWrite.ino b/examples/MCP23S08_digitalWrite/MCP23S08_digitalWrite.ino
@@ -2,11 +2,12 @@
 //    FILE: MCP23S08_digitalWrite.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-12-30
-// PUPROSE: test MCP23017 library
+// PURPOSE: test MCP23S08 library
+//     URL: https://github.com/RobTillaart/MCP23S08
 
 
 #include "MCP23S08.h"
-#include "SPI.h"
+
 
 MCP23S08 MCP(10, 5, 6, 7);   //  SW SPI   address 0x00
 

diff --git a/examples/MCP23S08_performance/MCP23S08_performance.ino b/examples/MCP23S08_performance/MCP23S08_performance.ino
@@ -2,11 +2,12 @@
 //    FILE: MCP23S08_performance.ino
 //  AUTHOR: Rob Tillaart
 //    DATE: 2021-12-30
-// PUPROSE: test MCP23017 library
+// PURPOSE: test MCP23S08 library
+//     URL: https://github.com/RobTillaart/MCP23S08
 
 
 #include "MCP23S08.h"
-#include "SPI.h"
+
 
 // MCP23S08 MCP(10, 12, 11, 13);  //  SW SPI address 0x00
 MCP23S08 MCP(10);           //  HW SPI address 0x00
@@ -42,7 +43,7 @@ void setup()
   start = micros();
   for (int i = 0; i < 8; i++)
   {
-    MCP.write1(0, i & 0x01);  // alternating HIGH/LOW
+    MCP.write1(0, i & 0x01);  //  alternating HIGH/LOW
   }
   stop = micros();
   Serial.println((stop - start) / 8.0);
@@ -103,4 +104,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
diff --git a/examples/MCP23S08_performance/performance_0.4.1.md b/examples/MCP23S08_performance/performance_0.4.1.md
@@ -0,0 +1,32 @@
+
+
+# Performance test  
+
+Test sketch  MCP23S08_performance.ino
+
+Max clock frequency 10 MHz, for an UNO this is 8 MHz (divider of CPU clock)
+
+### Library version: 0.4.1
+
+
+|  Action                  |  SW SPI | HW 1 MHz | HW 2 MHz | HW 4 MHz | HW 8 MHz |
+|:-------------------------|--------:|---------:|---------:|---------:|---------:|
+| TEST write1(0, value)    |  xx.xx  |   xx.xx  |  xx.xx   |  xx.xx   |  35.50   |
+| TEST write1(pin, value)  |  xx.xx  |   xx.xx  |  xx.xx   |  xx.xx   |  35.50   |
+| TEST read1(pin)          |  xx.xx  |   xx.xx  |  xx.xx   |  xx.xx   |  24.50   |
+|                          |         |          |          |          |          |
+| TEST write8(port, mask)  |  xx.xx  |   xx.xx  |  xx.xx   |  xx.xx   |  28.00   |
+| TEST read8(port)         |  xx.xx  |   xx.xx  |  xx.xx   |  xx.xx   |  24.00   |
+
+
+### Notes
+
+Performance as expected, no showstoppers.
+
+
+### Future
+
+- test ESP32 and other platforms
+- register based IO version for the SW SPI on AVR ?
+
+
diff --git a/library.json b/library.json
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/MCP23S08.git"
   },
-  "version": "0.4.0",
+  "version": "0.4.1",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=MCP23S08
-version=0.4.0
+version=0.4.1
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for SPI MCP23S08 8 channel port expander  8 IO-lines