0.2.5 FunctionGenerator

Author: RobTillaart

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

@@ -6,7 +6,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: arduino/arduino-lint-action@v1
         with:
           library-manager: update

libraries/FunctionGenerator/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/FunctionGenerator/.github/workflows/jsoncheck.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v1
         with:

libraries/FunctionGenerator/CHANGELOG.md

@@ -6,12 +6,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.2.5] - 2023-03-25
+- add **setDutyCycle()**, **getDutyCycle()**
+- implement duty cycle for square(), triangle() and random()
+- add **seedRandom(a, b)**
+- add some optimizations
+- move code from .h to .cpp
+- update readme.md
+- update GitHub actions
+- update license 2023
+- minor edits
+
+
 ## [0.2.4] - 2022-11-07
 - add changelog.md
 - add rp2040 to build-CI
 - update readme.md
 
-
 ## [0.2.3] - 2021-12-18
 - update library.json, license, minor edits
 

libraries/FunctionGenerator/FunctionGenerator.h

@@ -2,47 +2,66 @@
 //
 //    FILE: functionGenerator.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.4
+// VERSION: 0.2.5
 // PURPOSE: wave form generating functions (use with care)
 //     URL: https://github.com/RobTillaart/FunctionGenerator
-//
 
 
 #include "Arduino.h"
 
-#define FUNCTIONGENERATOR_LIB_VERSION           (F("0.2.4"))
+#define FUNCTIONGENERATOR_LIB_VERSION           (F("0.2.5"))
 
 
 class funcgen
 {
 public:
   funcgen(float period = 1.0, float amplitude = 1.0, float phase = 0.0, float yShift = 0.0);
 
-  // configuration
+
+  /////////////////////////////////////////////////////////////
+  //
+  //  CONFIGURATION
+  //
   void  setPeriod(float period = 1.0);
-  float getPeriod() { return _period; };
-  void  setFrequency(float freq = 1.0) { setPeriod(1/freq); };
-  float getFrequency() { return _freq1; };
-
-  void  setAmplitude(float ampl = 1.0) { _amplitude = ampl; };
-  float getAmplitude() { return _amplitude; };
-  void  setPhase(float phase = 0.0) { _phase = phase; };
-  float getPhase() { return _phase; };
-  void  setYShift(float yShift = 0.0) { _yShift = yShift; };
-  float getYShift() { return _yShift; };
-  
-  // constant amplitude
+  float getPeriod();
+
+  void  setFrequency(float freq = 1.0);
+  float getFrequency();
+
+  void  setAmplitude(float ampl = 1.0);
+  float getAmplitude();
+
+  void  setPhase(float phase = 0.0);
+  float getPhase();
+
+  void  setYShift(float yShift = 0.0);
+  float getYShift();
+
+  void  setDutyCycle(float dutyCycle);
+  float getDutyCycle();
+
+  void  setRandomSeed(uint32_t a, uint32_t b = 314159265);
+
+
+  /////////////////////////////////////////////////////////////
+  //
+  //  FUNCTIONS
+  //
+  //  constant amplitude
   float line();
-  // constant zero for calibration
+  //  constant zero for calibration.
   float zero();
-  
-  // standard wave forms
-  float sawtooth(float t, uint8_t mode = 0);
+
+  //  standard wave forms
+  float sawtooth(float t, uint8_t mode = 0);   //  0 ==>  /|.   1 ==> sawtooth |\.
   float triangle(float t);
   float square(float t);
   float sinus(float t);
   float stair(float t, uint16_t steps = 8, uint8_t mode = 0);
+
   float random();
+  float random_DC();  //  duty cycle variant. Experimental.
+
 
 private:
   float _period;
@@ -53,12 +72,14 @@ class funcgen
   float _amplitude;
   float _phase;
   float _yShift;
-  // Marsaglia 'constants'
+  float _dutyCycle;
+
+  //  Marsaglia 'constants'
   uint32_t _m_w = 1;
-  uint32_t _m_z = 2; 
+  uint32_t _m_z = 2;
   uint32_t _random();
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/FunctionGenerator/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2022 Rob Tillaart
+Copyright (c) 2015-2023 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/FunctionGenerator/examples/functionGenerator/functionGenerator.ino

@@ -4,7 +4,6 @@
 // PURPOSE: demo function generators
 //    DATE: 2015-01-03
 //     URL: https://github.com/RobTillaart/FunctionGenerator
-//
 
 
 #include "functionGenerator.h"
@@ -33,11 +32,11 @@ void loop()
   {
     choice = Serial.read();
   }
-  // wave selection by potMeter
+  //  wave selection by potMeter
   // int choice = analogRead(A0) / 200;
 
   float value;
-  // wait for next millisecond;
+  //  wait for next millisecond;
   if (millis() - lastTime > 0)
   {
     lastTime = millis();
@@ -58,5 +57,5 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/FunctionGenerator/examples/functionGeneratorDuoPlot/functionGeneratorDuoPlot.ino

@@ -5,7 +5,7 @@
 //    DATE: 2020-06-10
 //     URL: https://github.com/RobTillaart/FunctionGenerator
 //
-// use a Serial plotter to show the data
+//  use a Serial plotter to show the data
 
 
 #include "functionGenerator.h"
@@ -17,7 +17,9 @@ funcgen gen2;
 void setup()
 {
   Serial.begin(115200);
-  // Serial.print("Start functionGeneratorPerformance - LIB VERSION: ");
+  // Serial.println();
+  // Serial.println(__FILE__);
+  // Serial.print("FUNCTIONGENERATOR_LIB_VERSION: ");
   // Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
 
   gen1.setFrequency(13);
@@ -46,5 +48,5 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/FunctionGenerator/examples/functionGeneratorPerformance/functionGeneratorPerformance.ino

@@ -4,7 +4,6 @@
 // PURPOSE: demo function generators
 //    DATE: 2015-01-01
 //     URL: https://github.com/RobTillaart/FunctionGenerator
-//
 
 
 #include "functionGenerator.h"
@@ -38,6 +37,8 @@ void setup()
   delay(10);
   test_random();
   delay(10);
+  test_random_DC();
+  delay(10);
   test_line();
   delay(10);
   test_zero();
@@ -169,6 +170,22 @@ void test_random()
 }
 
 
+void test_random_DC()
+{
+  start = micros();
+  for (int i = 0; i < 10000; i++)
+  {
+    t = gen.random_DC();
+  }
+  stop = micros();
+  Serial.print(__FUNCTION__);
+  Serial.print(":\t");
+  Serial.print((stop - start) / 10000.0);
+  Serial.print("\t");
+  Serial.println(1000000.0 / ((stop - start) / 10000.0));
+}
+
+
 void test_line()
 {
   start = micros();
@@ -206,5 +223,5 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --