0.1.3 PulseDivider

Author: RobTillaart

libraries/PulseDivider/CHANGELOG.md

@@ -6,13 +6,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.3] - 2025-04-11
+- fix invert flag in constructor
+- add getInCount() and getOutCount() for debugging.
+- add example frequencyMultiplier.ino
+- update readme.md
+- minor edits
+
 ## [0.1.2] - 2023-09-16
 - add getCounter()
 - update readme.md
 - made private read() inline
 - minor edits
 
-
 ## [0.1.1] - 2023-09-14
 - fix initial state output (setters).
 - optimized checking

libraries/PulseDivider/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Rob Tillaart
+Copyright (c) 2023-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/PulseDivider/PulseDivider.h

@@ -2,15 +2,15 @@
 //
 //    FILE: PulseDivider.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 //    DATE: 2023-09-13
 // PURPOSE: Arduino library to divide a pulse stream with a float factor.
 //     URL: https://github.com/RobTillaart/PulseDivider
 
 
 #include "Arduino.h"
 
-#define PULSEDIVIDER_LIB_VERSION        (F("0.1.2"))
+#define PULSEDIVIDER_LIB_VERSION        (F("0.1.3"))
 
 
 class PulseDivider
@@ -20,13 +20,12 @@ class PulseDivider
   PulseDivider(uint8_t inPin, uint8_t outPin, uint16_t inCount, uint16_t outCount,
                 uint32_t duration = 1, uint8_t edge = RISING, bool invert = false)
   {
+    setInvert(invert);  //  must be done before setOutPin() !
     setInPin(inPin);
     setOutPin(outPin);
     setRatio(inCount, outCount);
     setDuration(duration);
     setEdge(edge);
-    setInvert(invert);
-
     _prevState = _read();
     stop();
   }
@@ -116,18 +115,16 @@ class PulseDivider
   void start()
   {
     _prevState = _read();
-    _counter   = _inCount / 2;
+    _counter   = _inCount / 2;  //  reasonable start position.
     _running   = true;
   }
 
-
   void stop()
   {
     _running  = false;
     _write(_invert ? HIGH : LOW);
   }
 
-
   bool isRunning()
   {
     return _running;
@@ -161,7 +158,6 @@ class PulseDivider
     }
   }
 
-
   inline void doPulse()
   {
     _counter += _outCount;
@@ -178,7 +174,7 @@ class PulseDivider
 private:
 
   //  default reference
-  void _write(uint8_t value)
+  inline void _write(uint8_t value)
   {
     digitalWrite(_outPin, value);
   }

libraries/PulseDivider/README.md

@@ -108,9 +108,10 @@ generated when there is an input pulse and an output pulse is "lagging".
 In the first tests the library seems to work well, however more testing is needed. 
 
 
-#### Related
+### Related
 
 - https://github.com/RobTillaart/PulsePattern
+- https://github.com/RobTillaart/OutPin
 
 
 ## Interface
@@ -120,7 +121,7 @@ In the first tests the library seems to work well, however more testing is neede
 ```
 
 
-#### Constructor
+### Constructor
 
 - **PulseDivider(uint8_t inPin, uint8_t outPin, uint16_t inCount, uint16_t outCount, uint32_t duration = 1, uint8_t edge = RISING, bool invert = false)**
   - Define input pin and output pin.
@@ -137,14 +138,17 @@ In the first tests the library seems to work well, however more testing is neede
 The PulseDivider can do an 65534 to 1 reduction. 
 
 
-#### Getters / Setters
+### Getters / Setters
 
 See description Constructor.
 
 - **void setInPin(uint8_t inPin)** set or change the input pin (runtime).
 - **uint8_t getInPin()** returns the set input pin.
 - **void setOutPin(uint8_t outPin)** set or change the output pin (runtime).
 - **uint8_t getOutPin()** returns the set output pin.
+
+### Ratio and duration
+
 - **void setRatio(uint16_t inCount, uint16_t outCount = 1)** set the ratio between
 input pulses and the output pulses. inCount >= outCount > 0.
 The range for inCount can be 1..65534 max, the sum of inCount and outCount should not exceed 65535, 
@@ -153,14 +157,22 @@ Typically both are less than 1000.
 - **void setDuration(uint32_t duration)** set the duration of the pulse.
 Note the unit is microseconds.
 - **uint32_t getDuration()** returns the set duration.
+
+### Edge and invert
+
 - **void setEdge(uint8_t edge)** sets the "trigger" edge, RISING or FALLING.
 - **uint8_t getEdge()** returns the set trigger.
 - **void setInvert(bool invert)** inverts the output pulse with respect to the input pulse.
 - **bool getInvert()** returns the set flag.
+
+### Debugging
+
 - **uint16_t getCounter()** returns the internal counter (for debugging).
+- **uint16_t getInCount()** idem (for debugging).
+- **uint16_t getOutCount()** idem (for debugging).
 
 
-#### Control
+### Control
 
 The pulseDivider can be started or stopped in software,
 and the state can be requested.
@@ -174,7 +186,7 @@ output to "default" state LOW (unless inverted).
 - **bool isRunning()** returns true if running .
 
 
-#### Worker
+### Worker
 
 - **void check()** Call as often as possible as this worker does the
 polling, math and calls **doPulse()** when an output pulse is needed. 
@@ -193,9 +205,11 @@ polling, math and calls **doPulse()** when an output pulse is needed.
 - performance measurements
 - test different platforms, configurations, ratios etc.
 - optimize math possible? (16 bit instead of 32 bit for UNO).
-- for many pulses - **PulseDivider(32 bit counters)**
+  - add now = micros() in check()
+- for many pulses - **PulseDivider32(32 bit counters)**
   - allow e.g. 100000 to 1 or even 1000000 to 1 or more.
-  - separate PulseDivider32 class?
+  - separate PulseDivider32 class?  ==> pulseDivider32.h? 
+  - derived class?
 
 #### Could
 
@@ -210,9 +224,14 @@ polling, math and calls **doPulse()** when an output pulse is needed.
 - make inCount and outCount 32 bit? even finer fractions.
   - would slow it down
   - would 8 bit make it faster?
+- improve read() for AVR
+
 
 #### Won't (unless requested)
 
+- investigate **frequencyMultiplier.ino** as new core code.
+  - drawback output does not stop immediately when input stops.
+
 
 ## Support
 

libraries/PulseDivider/examples/frequencyMultiplier/frequencyMultiplier.ino

@@ -0,0 +1,75 @@
+//    FILE: frequencyMultiplier.ino
+//  AUTHOR: Rob Tillaart
+//    DATE: 2024-10-26
+// PURPOSE: demo
+//     URL: https://forum.arduino.cc/t/tacho-inlezen-en-puls-regelen/1315467/6
+
+#include "Arduino.h"
+
+const int inputPin = 9;
+const int outputPin = 13;
+
+//  INPUT VARS
+int currentSignal;
+int lastSignal = HIGH;
+uint32_t lastHigh = 0;
+
+float multiplier = 0.15;        //  0.25, 2, 3, etc
+
+//  OUTPUT VARS
+uint32_t lastPulse = 0;
+uint32_t outputInterval = 0;
+
+//  time it takes before output stops after input stops.
+//  depends on input frequency 
+const uint32_t STOPDELAY = 1000;
+
+
+void setup ()
+{
+  Serial.begin(115200);
+  pinMode (outputPin, OUTPUT);
+  pinMode (inputPin, INPUT);
+}
+
+void loop()
+{
+  //  take timestamp for this loop
+  uint32_t now = millis();
+
+  //  determine input frequency by measuring between
+  //  RISING edge of HIGH pulses
+  currentSignal = digitalRead(inputPin);
+  if ((currentSignal == HIGH) && (lastSignal == LOW))
+  {
+    uint32_t inputInterval = now - lastHigh;
+    outputInterval = inputInterval / multiplier / 2;
+    lastHigh = now;  //  remember begin of last pulse
+
+    Serial.println(inputInterval);
+    Serial.println(outputInterval);
+    Serial.println();
+  }
+  lastSignal = currentSignal;
+
+  //  generate output pulse
+  if (outputInterval > 0)
+  {
+    if ((now - lastPulse) >= outputInterval)
+    {
+      //  remember last invert output
+      lastPulse = now;
+      //  invert output
+      digitalWrite(outputPin, !digitalRead(outputPin));
+    }
+  }
+
+  //  switch to zero if no input pulse for STOPDELAY milliseconds
+  if (now - lastHigh > STOPDELAY)
+  {
+    outputInterval = 0;
+  }
+}
+
+
+//  -- END OF FILE --

libraries/PulseDivider/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/PulseDivider.git"
   },
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/PulseDivider/library.properties

@@ -1,5 +1,5 @@
 name=PulseDivider
-version=0.1.2
+version=0.1.3
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library to divide a pulse stream with a float factor.