Improve SPI dependency (#24)

RobTillaart · Jan 19, 2024 · 6c3cf1b · 6c3cf1b
1 parent 0a7e4a6
commit 6c3cf1b
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 16 deletions.
diff --git a/AD520X.cpp b/AD520X.cpp
@@ -2,7 +2,7 @@
 //    FILE: AD520X.cpp
 //  AUTHOR: Rob Tillaart
 //    DATE: 2020-07-24
-// VERSION: 0.4.0
+// VERSION: 0.5.0
 // PURPOSE: Arduino library for AD5204 and AD5206 digital potentiometers
 //          (+ AD8400, AD8402, AD8403)
 //     URL: https://github.com/RobTillaart/AD520X
@@ -52,9 +52,9 @@ void AD520X::begin(uint8_t value)
 
   if(_hwSPI)
   {
-    _mySPI->end();
-    _mySPI->begin();
-    delay(1);
+    //  _mySPI->end();
+    //  _mySPI->begin();
+    //  delay(1);
   }
   else
   {

diff --git a/AD520X.h b/AD520X.h
@@ -3,7 +3,7 @@
 //    FILE: AD520X.h
 //  AUTHOR: Rob Tillaart
 //    DATE: 2020-07-24
-// VERSION: 0.4.0
+// VERSION: 0.5.0
 // PURPOSE: Arduino library for AD5204 and AD5206 digital potentiometers
 //          (+ AD8400, AD8402, AD8403)
 //     URL: https://github.com/RobTillaart/AD520X
@@ -13,20 +13,20 @@
 #include "SPI.h"
 
 
-#define AD520X_LIB_VERSION              (F("0.4.0"))
+#define AD520X_LIB_VERSION              (F("0.5.0"))
 
 #ifndef AD520X_MIDDLE_VALUE
 #define AD520X_MIDDLE_VALUE             128
 #endif
 
-
-#if defined(ARDUINO_ARCH_RP2040)
-#define __SPI_CLASS__   SPIClassRP2040
-#else
-#define __SPI_CLASS__   SPIClass
+#ifndef __SPI_CLASS__
+  #if defined(ARDUINO_ARCH_RP2040)
+  #define __SPI_CLASS__   SPIClassRP2040
+  #else
+  #define __SPI_CLASS__   SPIClass
+  #endif
 #endif
 
-
 class AD520X
 {
 public:

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.5.0] - 2024-01-19
+- Fix #23, improve handling SPI dependency.
+- add SPIClass guard
+
+
 ## [0.4.0] - 2023-11-26
 - refactor constructor interface - breaking changes.
   - minimize conditional code. -- create SPI_CLASS macro to solve it.

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Rob Tillaart
+Copyright (c) 2020-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/README.md b/README.md
@@ -36,6 +36,14 @@ The interface is straightforward, one can set a value per channels between 0..25
 The library is not yet confirmed to work for **AD8402** (2 channels).
 This device has  a very similar interface (datasheet comparison) so it should work. If you can confirm the AD8402 works, please let me know.
 
+
+#### 0.5.0 Breaking change
+
+Version 0.5.0 introduced a breaking change to improve handling the SPI dependency.
+The user has to call **SPI.begin()** or equivalent before calling **AD520X.begin()**.
+Optionally the user can provide parameters to the **SPI.begin(...)**
+
+
 #### 0.4.0 breaking change
 
 The version 0.4.0 has breaking changes in the interface. 

diff --git a/examples/AD5204_demo/AD5204_demo.ino b/examples/AD5204_demo/AD5204_demo.ino
@@ -12,7 +12,7 @@ uint32_t start, stop;
 
 
 //  select, reset, shutdown, data, clock == SOFTWARE SPI
-// AD5206 pot(10, 255, 255, 8, 9);
+//  AD5206 pot(10, 255, 255, 8, 9);
 
 //  select, reset, shutdown, &SPI === HW SPI UNO clock = 13, data = 11
 AD5206 pot = AD5206(5, 6, 7, &SPI);
@@ -23,6 +23,7 @@ void setup()
   Serial.begin(115200);
   Serial.println(__FILE__);
 
+  SPI.begin();
   pot.begin(4);
 
   //  test_extremes();

diff --git a/examples/AD5204_demo_HWSPI/AD5204_demo_HWSPI.ino b/examples/AD5204_demo_HWSPI/AD5204_demo_HWSPI.ino
@@ -25,6 +25,7 @@ void setup()
   Serial.print("AD520X_LIB_VERSION:\t");
   Serial.println(AD520X_LIB_VERSION);
 
+  SPI.begin();
   pot.begin(4);
 
   Serial.print("\tusesHWSPI:\t");

diff --git a/examples/AD5204_demo_stereo/AD5204_demo_stereo.ino b/examples/AD5204_demo_stereo/AD5204_demo_stereo.ino
@@ -23,6 +23,7 @@ void setup()
   Serial.println(AD520X_LIB_VERSION);
   Serial.println();
 
+  SPI.begin();
   pot.begin(4);
 
   //  test_sinus();

diff --git a/examples/AD5204_setPercentage/AD5204_setPercentage.ino b/examples/AD5204_setPercentage/AD5204_setPercentage.ino
@@ -21,6 +21,7 @@ void setup()
   Serial.begin(115200);
   Serial.println(__FILE__);
 
+  SPI.begin();
   pot.begin(4);
 
   for (int p = 0; p <= 100; p++)

diff --git a/library.json b/library.json
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/AD520X.git"
   },
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=AD520X
-version=0.4.0
+version=0.5.0
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for SPI AD5204 and AD5206 digital potentiometers