0.1.1 DS1804

Author: RobTillaart

libraries/DS1804/.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/DS1804/.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/DS1804/.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/DS1804/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.1] - 2025-12-10
+- add **bool selected()** to get status.
+- add example **DS1804_array.ino**
+- update GitHub actions
+- minor edits
+
 ## [0.1.0] - 2024-11-11
 - initial version
 

libraries/DS1804/DS1804.h

@@ -2,14 +2,15 @@
 //
 //    FILE: DS1804.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
+// VERSION: 0.1.1
+//    DATE: 24-11-11
 // PURPOSE: Arduino library for DS1804 Nonvolatile Trimmer Potentiometer.
 //     URL: https://github.com/RobTillaart/DS1804
 
 
 #include "Arduino.h"
 
-#define DS1804_LIB_VERSION               (F("0.1.0"))
+#define DS1804_LIB_VERSION               (F("0.1.1"))
 
 
 class DS1804
@@ -42,6 +43,12 @@ class DS1804
   };
 
 
+  inline bool selected()
+  {
+    return (digitalRead(_csPin) != LOW);
+  };
+
+
   void moveUp(uint8_t n = 1)
   {
     if (n > 100) n = 100;

libraries/DS1804/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/DS1804/PARALLEL.MD

@@ -0,0 +1,71 @@
+
+## Parallel control of multiple DS1804
+
+It is easy to control N DS1804 with N+2 lines.
+Design wise it is very much like the SPI bus.
+
+- all share GND (including processor).
+- all share U/D pin
+- all share INC pin
+- all have **unique CS** pins
+
+Note that the DS1804's need a **separate** power source.
+
+
+### Schema
+
+```
+              +----------+                           +----------+
+              |      INC |-----------------------+---| INC      |
+              |          |                       |   |          |
+              |      U/D |--------------------+------| U/D      |
+              |          |                    |  |   |          |
+              |       CS |-----+  +------------------| CS       |
+              |          |     |  |           |  |   |          |
+              |  DS1804  |     |  |           |  |   |  DS1804  |
+              +----------+     |  |           |  |   +----------+
+                               |  |           |  |
+                               |  |           |  |
+              +----------+     |  |           |  |   +----------+
+              |      INC |-----------------------+---| INC      |
+              |          |     |  |           |  |   |          |
+              |      U/D |--------------------+------| U/D      |
+              |          |     |  |           |  |   |          |
+              |       CS |--+  |  |  +---------------| CS       |
+              |          |  |  |  |  |        |  |   |          |
+              |  DS1804  |  |  |  |  |        |  |   |  DS1804  |
+              +----------+  |  |  |  |        |  |   +----------+
+                            |  |  |  |        |  |
+                            |  |  |  |        |  |
+                            |  |  |  |        |  |
+                            |  |  |  |        |  |
+              +-------------------------------------------------+
+              |             0  1  2  3        u  i              |
+              |                                                 |
+              |                                                 |
+              |                                                 |
+              |                                                 |
+              |                     processor                   |
+              +-------------------------------------------------+
+
+              Note common GND is not in the schema.
+```
+
+
+### Code
+
+in the code
+- select the Up or DOWN mode with pin u.
+- select the device with pin 0, 1, 2, 3, .... n
+- set a HIGH LOW pulse train on pin i to move the number of steps.
+
+
+### Parallelism
+
+It is possible to select multiple devices and give them a number of pulses so they go up/down in parallel.
+- left and right channel in stereo.
+- set all (or subset) to zero.
+- more complex patterns to increase parallelism (performance) but this is more difficult coding wise.
+
+
+

libraries/DS1804/README.md

@@ -21,29 +21,42 @@ Arduino library for DS1804 Nonvolatile Trimmer Potentiometer.
 The library implements a class for the DS1804 potentiometer.
 These devices come in 10K, 50K and 100K and allows control in 100 steps.
 
-The DS1804 has a simple pulse interface and cannot be read back
-so the library cannot provide the current position of the wiper.
+The DS1804 has a simple pulse interface and can **not** be read back
+so the library can not provide the current position of the wiper.
 
 The DS1804 has an EEPROM to save the current position (writeable for 50000 times)
-and uses that as start position at power up.
+and uses that value as start position at power up.
+
+Feedback as always is welcome.
+
 
 ### Power up / down
 
 (from datasheet)  
-On power-up, wiper position will be loaded within a maximum time
-period of 500µs once the power-supply is stable. 
-Additionally, the three-terminal interface port will be active after 50 ms. 
+On **power-up**, wiper position will be loaded within a maximum time
+period of **500 µs** once the power-supply is stable.
+Additionally, the three-terminal interface port will be active after **50 ms**. 
 
-On power-down, the wiper position register data will be **lost**. 
+On **power-down**, the wiper position register data will be **lost**. 
 On the next device power-up, the value of
 EEPROM memory will be loaded into the wiper position register.
 
 There is no defined factory default, expect the value to be random.
+As the device has no feedback, one must send 100 pulses to move the trimmer to the begin or end point.
+
+
+### Alternative use
 
+One could use the UP/ DOWN pins of the device to read signals from an 
+external system. The microprocessor could monitor the state by means of an
+ADC measurement (and optional act upon it).
+
+This is not implemented in the library, just worth to mention.
+ 
 
 ### Related
 
-Other digipots
+Other digipots (not all)
 
 - https://github.com/RobTillaart/AD520x
 - https://github.com/RobTillaart/AD524X
@@ -67,13 +80,18 @@ Other digipots
 - **void begin(bool b = false)** initializes pins, 
 default the device is not selected.
 
+
 ### Base
 
 - **void select(bool b)** enable / disable device.
-- **void moveUp(uint8_t n = 1)** if enabled move position n steps up (n is clipped to 0..100)
-- **void moveDown(uint8_t n = 1)** if enabled move position n steps down (n is clipped to 0..100)
+- **bool selected()** returns current status (csPin).
+- **void moveUp(uint8_t steps = 1)** if enabled move position n steps up (steps is clipped to 0..100)
+- **void moveDown(uint8_t steps = 1)** if enabled move position n steps down (steps is clipped to 0..100)
+
+Duration of moveUp/Down depends linearly on the parameter steps, expect less than half a millisecond.
+
+Note: One must send 100 pulses to move the trimmer to the begin or end point. (no feedback).
 
-Duration of moveUp/Down depends linearly on n, expect less than half a millisecond.
 
 ### EEPROM power up value
 
@@ -95,15 +113,14 @@ See **DS1804_save_EEPROM.ino**
 
 #### Should
 
-- array example  (sharing UD, INC pins, unique CS)
-- stereo example, (sharing all pins).
 
 #### Could
 
 - default true for select() / begin()?
 
 #### Wont
 
+- void mute();  (depends on 3 pins if up or down is mute)
 
 ## Support
 

libraries/DS1804/examples/DS1804_array/DS1804_array.ino

@@ -0,0 +1,85 @@
+//    FILE: DS1804_array.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: demo
+//     URL: https://github.com/RobTillaart/DS1804
+//
+//  not tested yet
+
+#include "DS1804.h"
+
+
+//  adjust pins if needed
+const uint8_t CSPIN1 = 3;
+const uint8_t CSPIN2 = 4;
+const uint8_t CSPIN3 = 5;
+const uint8_t INCPIN = 6;
+const uint8_t UDPIN  = 7;
+
+
+DS1804 ds[3] =
+{
+  DS1804(CSPIN1, INCPIN, UDPIN),
+  DS1804(CSPIN2, INCPIN, UDPIN),
+  DS1804(CSPIN3, INCPIN, UDPIN)
+};
+
+int idx = 0;
+
+
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial);
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("DS1804_LIB_VERSION: ");
+  Serial.println(DS1804_LIB_VERSION);
+  Serial.println();
+
+  //  all deselected by default
+  for (int i = 0; i < 3; i++)
+  {
+    ds[i].begin();
+  }
+}
+
+
+void loop()
+{
+  if (Serial.available())
+  {
+    int c = Serial.read();
+    //  SELECT MODULE
+    if (c == '0') {
+      idx = 0;
+      ds[0].select(true);
+      ds[1].select(false);
+      ds[2].select(false);
+    };
+    if (c == '1') {
+      idx = 1;
+      ds[0].select(false);
+      ds[1].select(true);
+      ds[2].select(false);
+    };
+    if (c == '2') {
+      idx = 2;
+      ds[0].select(false);
+      ds[1].select(false);
+      ds[2].select(true);
+    };
+    //  DESELECT ALL
+    if (c == '3') {
+      idx = 0;
+      ds[0].select(false);
+      ds[1].select(false);
+      ds[2].select(false);
+    };
+    //  UP DOWN
+    if (c == 'U') ds[idx].moveUp();
+    if (c == 'D') ds[idx].moveDown();
+  }
+}
+
+
+//  -- END OF FILE --

libraries/DS1804/examples/DS1804_demo/DS1804_demo.ino

@@ -8,9 +8,9 @@
 
 
 //  adjust pins if needed
-const uint8_t CSPIN = 5;
+const uint8_t CSPIN  = 5;
 const uint8_t INCPIN = 6;
-const uint8_t UDPIN = 7;
+const uint8_t UDPIN  = 7;
 
 DS1804 ds(CSPIN, INCPIN, UDPIN);
 
@@ -19,9 +19,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("DS1804_LIB_VERSION: ");
   Serial.println(DS1804_LIB_VERSION);
+  Serial.println();
 
   ds.begin();
   ds.select(true);