0.3.1 ADC081S

Author: RobTillaart

libraries/ADC081S/.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

libraries/ADC081S/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/ADC081S/.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

libraries/ADC081S/ADC081S.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: ADC081S.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 //    DATE: 2024-01-10
 // PURPOSE: Arduino library for ADC081S 8 bit ADC (SPI)
 //     URL: https://github.com/RobTillaart/ADC081S
@@ -74,7 +74,7 @@ uint32_t ADC081S::count()
 
 uint16_t ADC081S::read()
 {
-  return readADC() >> 4;  //  remove 4 trailing zero's
+  return readADC() >> 4;  //  remove 4 trailing zero bits
 }
 
 
@@ -197,7 +197,7 @@ ADC101S::ADC101S(uint8_t data, uint8_t clock) : ADC081S(data, clock)
 
 uint16_t ADC101S::read()
 {
-  return readADC() >> 2;  //  remove 2 trailing zero's
+  return readADC() >> 2;  //  remove 2 trailing zero bits
 }
 
 

libraries/ADC081S/ADC081S.h

@@ -2,7 +2,7 @@
 //
 //    FILE: ADC081S.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 //    DATE: 2024-01-10
 // PURPOSE: Arduino library for ADC081S 8 bit ADC (SPI)
 //     URL: https://github.com/RobTillaart/ADC081S
@@ -13,7 +13,7 @@
 #include "SPI.h"
 
 
-#define ADC081S_LIB_VERSION       (F("0.3.0"))
+#define ADC081S_LIB_VERSION       (F("0.3.1"))
 
 
 #ifndef __SPI_CLASS__
@@ -45,9 +45,9 @@ class ADC081S
   //       speed in Hz
   void     setSPIspeed(uint32_t speed);
   uint32_t getSPIspeed();
+  bool     usesHWSPI();
 
   //       debugging
-  bool     usesHWSPI();
   uint32_t count();  //  number of channels read.
 
   void     lowPower();

libraries/ADC081S/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.3.1] - 2025-12-09
+- update GitHub actions
+- update examples
+- minor edits
+
 ## [0.3.0] - 2024-11-06
 - fix #9, sync with ADC08XS
 - redo low level SPI_MODE3

libraries/ADC081S/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-2024 Rob Tillaart
+Copyright (c) 2024-2025 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

libraries/ADC081S/README.md

@@ -29,37 +29,42 @@ This library only supports the single channel versions.
 The library does not support the I2C versions of these devices.
 These can be recognized from the C as ADCxxxC
 
-The library can put the device in **lowPower()** and needs a call to
-**wakeUp()** to wake up. Alternative way to wake up the device is to
-do a dummy **read()**.
+The library can put the device in **lowPower()** mode and needs a call to
+**wakeUp()** to wake up the device. 
+Alternative way to wake up the device is to execute a dummy **read()**.
 
 The library is not tested with hardware yet.
 
 Feedback is as always welcome.
 
 
-#### 0.2.0 Breaking change
+### 0.2.0 Breaking change
 
 Version 0.2.0 introduced a breaking change to improve handling the SPI dependency.
 The user has to call **SPI.begin()** or equivalent before calling **ADC.begin()**.
 Optionally the user can provide parameters to the **SPI.begin(...)**
 
 
-#### Performance
+### Performance
 
 Although the ADC081S021 is rated at 200 KSPS, an Arduino UNO will not
 be able to fetch that much samples from the device. 
 The reason is that an UNO cannot fetch the bits fast enough from the device.
-At maximum SPI speed of 8 MHz one will get at most 50 KSPS. 
+At maximum SPI speed of 8 MHz one will get at most 50 KSPS.
+Furthermore the UNO has only 2KB RAM so it would fill up quite fast.
 
 For the faster ones, see below, at 1 MSPS one need a clock of at least 16 MHz
 + time to process the incoming data. 
 A faster processor like an ESP32 or Teensy might do the job.
 
+Investigations should be made for a sort of continuous mode.
+This would have the CS line constantly LOW and be able to read from the same
+address over and over. Note this is not in the library!
+
 To be tested, feedback welcome.
 
 
-#### Compatibles
+### Compatibles
 
 Texas instruments has 9 devices in this series, which can be used with the
 three classes of this library.
@@ -81,14 +86,16 @@ e.g ADC081S021 = 8 bits 1 channel SPI 200000
 S == SPI.C == I2C.
 
 
-#### Related
+### Related
 
 - https://github.com/RobTillaart/ADC08XS  2 + 4 channel library
+- https://github.com/RobTillaart/ADC081S  single channel version of this series.
 - https://gammon.com.au/adc  tutorial about ADC's (UNO specific)
 - https://github.com/RobTillaart/MCP_ADC
 - https://github.com/RobTillaart/ADS1x15  (12 & 16 bit ADC, I2C, slow)
 - https://github.com/RobTillaart/PCF8591  (8 bit ADC + 1 bit DAC)
 - https://github.com/RobTillaart/MCP_DAC
+- https://www.mikroe.com/adc-19-click
 
 
 ## Interface
@@ -97,7 +104,7 @@ S == SPI.C == I2C.
 #include "ADC081S.h"
 ```
 
-#### Constructors
+### Constructors
 
 The ADC101S and ADC121S have an identical interface as the ADC081S.
 
@@ -109,27 +116,30 @@ The ADC101S and ADC121S have an identical interface as the ADC081S.
 depending on number of bits of the actual ADC.
 
 
-#### Base
+### Read
+
+- **uint16_t read()** reads a value from the device.
+
+
+### SPI
 
-- **uint16_t read()** reads the value of the device.
 - **void setSPIspeed(uint32_t speed)** sets SPI clock in **Hz**, 
 please read datasheet of the ADC first to get optimal speed.
 - **uint32_t getSPIspeed()** returns current speed in **Hz**.
+- **bool usesHWSPI()** returns true if hardware SPI is used.
 
 
-#### Low power
+### Low power
 
 - **void lowPower()** put device in low power mode.
 - **void wakeUp()** put device in normal power mode.
 - **bool isLowPower()** returns true if in low power mode, so wakeUp needed().
 
-Alternative way to wake up the device is to
-do a dummy **read()**.
+Alternative way to wake up the device is to do a dummy **read()** call.
 
 
-#### Debug
+### Debug
 
-- **bool usesHWSPI()** returns true if hardware SPI is used.
 - **uint32_t count()** returns number of reads since start.
 
 
@@ -139,7 +149,7 @@ do a dummy **read()**.
 
 - improve documentation
 - get hardware to test / verify working
-- align with ADC08XS where possible
+- align with ADC081S/ADC08XS where possible
 
 #### Should
 

libraries/ADC081S/examples/ADC081S_low_power/ADC081S_low_power.ino

@@ -14,9 +14,11 @@ ADC081S adc01;        //  use HWSPI
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ADC081S_LIB_VERSION: ");
   Serial.println(ADC081S_LIB_VERSION);
+  Serial.println();
 
   SPI.begin();
   adc01.begin(10);
@@ -30,7 +32,7 @@ void loop()
   delay(15000);
 
   Serial.println("wake up for 15 seconds.");
-  if (adc01.isLowPower()) 
+  if (adc01.isLowPower())
   {
     adc01.wakeUp();
   }

libraries/ADC081S/examples/ADC081S_performance/ADC081S_performance.ino

@@ -19,6 +19,7 @@ uint32_t start, stop, read_time;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ADC081S_LIB_VERSION: ");
   Serial.println(ADC081S_LIB_VERSION);