0.2.3 DAC8554

Author: RobTillaart

libraries/DAC8554/.github/workflows/arduino_test_runner.yml

@@ -4,10 +4,14 @@ name: Arduino CI
 on: [push, pull_request]
 
 jobs:
-  arduino_ci:
+  runTest:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - uses: Arduino-CI/action@master
-          #   Arduino-CI/[email protected]
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/DAC8554/DAC8554.cpp

@@ -2,18 +2,20 @@
 //    FILE: DAC8554.cpp
 //  AUTHOR: Rob Tillaart
 // PURPOSE: Arduino library for DAC8554 SPI Digital Analog Convertor
-// VERSION: 0.2.2
+// VERSION: 0.2.3
 //     URL: https://github.com/RobTillaart/DAC8554
 //
 //  HISTORY:
-//  0.1.0: 2017-12-19  initial version
-//  0.1.2  2020-04-06  minor refactor, readme.md
-//  0.1.3  2020-06-07  fix library.json
-//  0.1.4  2020-07-20  fix URL's in demo's; MIT license; minor edits
-//  0.2.0  2020-12-18  add arduino-ci + unit test
-//  0.2.1  2021-01-10  fix slave select hardware SPI + getValue() + getPowerDownMode().
-//                     fix unit test.
-//  0.2.2  2021-06-02  compile ESP32
+//  0.1.0:  2017-12-19  initial version
+//  0.1.2   2020-04-06  minor refactor, readme.md
+//  0.1.3   2020-06-07  fix library.json
+//  0.1.4   2020-07-20  fix URL's in demo's; MIT license; minor edits
+//  0.2.0   2020-12-18  add arduino-ci + unit test
+//  0.2.1   2021-01-10  fix slave select hardware SPI + getValue() + getPowerDownMode().
+//                      fix unit test.
+//  0.2.2   2021-06-02  compile ESP32
+//  0.2.3   2021-08-29  add support for HSPI / VSPI ESP32 ++
+
 
 #include "DAC8554.h"
 
@@ -27,18 +29,18 @@
 DAC8554::DAC8554(uint8_t slaveSelect, uint8_t address)
 {
   _hwSPI = true;
-  _slaveSelect = slaveSelect;
+  _select = slaveSelect;
   _address = (address & 0x03) << 6;
 }
 
 
 // 0,1,2,4 resp 8550 8551 8552 8554
 DAC8554::DAC8554(uint8_t spiData, uint8_t spiClock, uint8_t slaveSelect, uint8_t address)
 {
-  _hwSPI = false;
-  _spiData = spiData;
-  _spiClock = spiClock;
-  _slaveSelect = slaveSelect;
+  _hwSPI   = false;
+  _dataOut = spiData;
+  _clock   = spiClock;
+  _select  = slaveSelect;
   _address = (address & 0x03) << 6;
 }
 
@@ -47,20 +49,39 @@ DAC8554::DAC8554(uint8_t spiData, uint8_t spiClock, uint8_t slaveSelect, uint8_t
 // and sets internal state
 void DAC8554::begin()
 {
-  pinMode(_slaveSelect, OUTPUT);
-  digitalWrite(_slaveSelect, HIGH);
+  pinMode(_select, OUTPUT);
+  digitalWrite(_select, HIGH);
+
+  _spi_settings = SPISettings(_SPIspeed, MSBFIRST, SPI_MODE1);
 
   if(_hwSPI)
   {
-    SPI.begin();
+    #if defined(ESP32)
+    if (_useHSPI)      // HSPI
+    {
+      mySPI = new SPIClass(HSPI);
+      mySPI->end();
+      mySPI->begin(14, 12, 13, _select);   // CLK=14 MISO=12 MOSI=13
+    }
+    else               // VSPI
+    {
+      mySPI = new SPIClass(VSPI);
+      mySPI->end();
+      mySPI->begin(18, 19, 23, _select);   // CLK=18 MISO=19 MOSI=23
+    }
+    #else              // generic hardware SPI
+    mySPI = &SPI;
+    mySPI->end();
+    mySPI->begin();
+    #endif
     delay(1);
   }
-  else
+  else                 // software SPI
   {
-    pinMode(_spiData, OUTPUT);
-    pinMode(_spiClock, OUTPUT);
-    digitalWrite(_spiData, LOW);
-    digitalWrite(_spiClock, LOW);
+    pinMode(_dataOut, OUTPUT);
+    pinMode(_clock, OUTPUT);
+    digitalWrite(_dataOut, LOW);
+    digitalWrite(_clock, LOW);
   }
 
   for (uint8_t i = 0; i < 4; i++)
@@ -71,6 +92,22 @@ void DAC8554::begin()
 }
 
 
+#if defined(ESP32)
+void DAC8554::setGPIOpins(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t select)
+{
+  _clock   = clk;
+  _dataOut = mosi;
+  _select  = select;
+  pinMode(_select, OUTPUT);
+  digitalWrite(_select, HIGH);
+
+  mySPI->end();  // disable SPI 
+  mySPI->begin(clk, miso, mosi, select);
+}
+#endif
+
+
+
 //////////////////////////////////////////////////////////////////////
 //
 // SETVALUE
@@ -195,37 +232,49 @@ void DAC8554::broadcastPowerDown(uint8_t powerDownMode)
 }
 
 
+void DAC8554::setSPIspeed(uint32_t speed)
+{
+  _SPIspeed = speed;
+  _spi_settings = SPISettings(_SPIspeed, MSBFIRST, SPI_MODE1);
+};
+
+
+//////////////////////////////////////////////////////////////////
+//
+// PRIVATE
+//
+
 void DAC8554::writeDevice(uint8_t configRegister, uint16_t value)
 {
+  digitalWrite(_select, LOW);
   if (_hwSPI)
   {
-    SPI.beginTransaction(SPISettings(16000000, MSBFIRST, SPI_MODE1));
-    digitalWrite(_slaveSelect, LOW);
-    SPI.transfer(configRegister);
-    SPI.transfer(value >> 8);
-    SPI.transfer(value & 0xFF);
-    digitalWrite(_slaveSelect, HIGH);
-    SPI.endTransaction();
+    mySPI->beginTransaction(_spi_settings);
+    mySPI->transfer(configRegister);
+    mySPI->transfer(value >> 8);
+    mySPI->transfer(value & 0xFF);
+    mySPI->endTransaction();;
   }
   else // Software SPI
   {
-    digitalWrite(_slaveSelect, LOW);
     swSPI_transfer(configRegister);
     swSPI_transfer(value >> 8);
     swSPI_transfer(value & 0xFF);
-    digitalWrite(_slaveSelect, HIGH);
   }
+  digitalWrite(_select, HIGH);
 }
 
 
 // simple one mode version
 void DAC8554::swSPI_transfer(uint8_t value)
 {
+  uint8_t clk = _clock;
+  uint8_t dao = _dataOut;
   for (uint8_t mask = 0x80; mask; mask >>= 1)
   {
-    digitalWrite(_spiData,(value & mask) != 0);
-    digitalWrite(_spiClock, HIGH);
-    digitalWrite(_spiClock, LOW);
+    digitalWrite(dao,(value & mask));
+    digitalWrite(clk, HIGH);
+    digitalWrite(clk, LOW);
   }
 }
 

libraries/DAC8554/DAC8554.h

@@ -3,15 +3,15 @@
 //    FILE: DAC8554.h
 //  AUTHOR: Rob Tillaart
 // PURPOSE: Arduino library for DAC8554 SPI Digital Analog Convertor  
-// VERSION: 0.2.2
+// VERSION: 0.2.3
 // HISTORY: See DAC8554.cpp
 //     URL: https://github.com/RobTillaart/DAC8554
 //
 
 #include "Arduino.h"
 #include "SPI.h"
 
-#define DAC8554_LIB_VERSION           (F("0.2.2"))
+#define DAC8554_LIB_VERSION           (F("0.2.3"))
 
 
 #define DAC8554_POWERDOWN_NORMAL     0x00
@@ -49,18 +49,46 @@ class DAC8554
   // write powerDownMode to all 8554's channel's
   void     broadcastPowerDown(uint8_t powerDownMode);
 
+  //       speed in Hz
+  void     setSPIspeed(uint32_t speed);
+  uint32_t getSPIspeed() { return _SPIspeed; };
+
+  bool     usesHWSPI() { return _hwSPI; };
+
+  // ESP32 specific
+  #if defined(ESP32)
+  void     selectHSPI() { _useHSPI = true;  };
+  void     selectVSPI() { _useHSPI = false; };
+  bool     usesHSPI()   { return _useHSPI;  };
+  bool     usesVSPI()   { return !_useHSPI; };
+
+  // to overrule ESP32 default hardware pins
+  void     setGPIOpins(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t select);
+  #endif
+
+
 private:
-  uint8_t  _spiData;
-  uint8_t  _spiClock;
-  uint8_t  _slaveSelect;
-  bool     _hwSPI;
+  uint8_t  _dataOut     = 255;
+  uint8_t  _clock       = 255;
+  uint8_t  _select      = 255;
+
+  bool     _hwSPI       = false;
   uint8_t  _address;
 
   uint16_t _value[4];     // holdes last written / buffered value per channel
   uint8_t  _register[4];  // holds powerDownMode per channel
 
+  uint32_t _SPIspeed    = 16000000;
+
   void     writeDevice(uint8_t configRegister, uint16_t value);
   void     swSPI_transfer(uint8_t value);
+
+  SPIClass    * mySPI;
+  SPISettings _spi_settings;
+
+  #if defined(ESP32)
+  bool        _useHSPI = true;
+  #endif
 };
 
 // -- END OF FILE --

libraries/DAC8554/README.md

@@ -1,5 +1,7 @@
 
 [![Arduino CI](https://github.com/RobTillaart/DAC8554/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/DAC8554/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/DAC8554/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/DAC8554/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/DAC8554/actions/workflows/jsoncheck.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/DAC8554/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/DAC8554.svg?maxAge=3600)](https://github.com/RobTillaart/DAC8554/releases)
 
@@ -12,7 +14,7 @@ Arduino library for DAC8554 SPI Digital Analog Convertor
 
 The DAC8554 is a SPI based 16 bit DAC with four channels.
 
-**Warning** the library is not tested extensively.
+**Warning** This library is not tested extensively
 
 
 ## Interface
@@ -28,20 +30,46 @@ since 0.2.0 the slaveSelect pin needs to be defined.
 - **uint16_t getValue(uint8_t channel)** returns the last value written.
 
 
+### Hardware SPI
+
+To be used only if one needs a specific speed.
+
+- **void setSPIspeed(uint32_t speed)** set SPI transfer rate.
+- **uint32_t getSPIspeed()** returns SPI transfer rate.
+- **bool usesHWSPI()** returns true if HW SPI is used.
+
+
+### ESP32 specific
+
+- **void selectHSPI()** in case hardware SPI, the ESP32 has two options HSPI and VSPI.
+- **void selectVSPI()** see above.
+- **bool usesHSPI()** returns true if HSPI is used.
+- **bool usesVSPI()** returns true if VSPI is used.
+
+The **selectVSPI()** or the **selectHSPI()** needs to be called 
+BEFORE the **begin()** function.
+
+
+#### experimental
+
+- **void setGPIOpins(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t select)** overrule GPIO pins of ESP32 for hardware SPI. needs to be called 
+AFTER the **begin()** function.
+
+
 ### Power down
 
-check datasheet for details.
+Check datasheet for details.
 
 - **void setPowerDown(uint8_t powerDownMode)** sets power down mode. 0 - 3.
 - **uint8_t getPowerDownMode()** returns last written mode.
 - **void setSinglePowerDown(uint8_t channel, uint8_t powerDownMode)** does not affect other channels.
 
-| Power down mode         | Value |
-|:------------------------|:-----:|
-| DAC8554_POWERDOWN_NORMAL    | 0x00 |
-| DAC8554_POWERDOWN_1K        | 0x40 |
-| DAC8554_POWERDOWN_100K      | 0x80 |
-| DAC8554_POWERDOWN_HIGH_IMP  | 0xC0 |
+| Power down mode             | Value |
+|:----------------------------|:-----:|
+| DAC8554_POWERDOWN_NORMAL    |  0x00 |
+| DAC8554_POWERDOWN_1K        |  0x40 |
+| DAC8554_POWERDOWN_100K      |  0x80 |
+| DAC8554_POWERDOWN_HIGH_IMP  |  0xC0 |
 
 
 ### Broadcast
@@ -51,6 +79,10 @@ check datasheet for details.
 - **void broadcastValue(uint16_t value)** write value to all(up to 4) 8554's channel's
 - **void broadcastPowerDown(uint8_t powerDownMode)** write powerDownMode to all 8554's channel's
 
+## Future
+
+- testing
+
 
 ## Operation
 
@@ -73,6 +105,3 @@ See examples
 **demo_powerdown.ino**
 - idem
 
-## TODO
-
-more testing