bump 0.3.0

Author: RobTillaart

CHANGELOG.md

@@ -6,18 +6,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.2.7] - 2024-07-05
+## [0.3.0] - 2024-07-05
 - add **float sinusDiode(float t)**
 - add **float sinusRectified(float t)**
 - add **float trapezium1(float t)** with duty cycle.
 - add **float trapezium2(float t)** with duty cycle.
 - add **float heartBeat(float t)**
 - add **float freeWave(float t, int16_t arr)** arbitrary wave generator.
+- add **float freeWaveN(float t, int16_t arr, int N)** arbitrary wave generator.
 - update **functionGeneratorPerformance.ino**
 - add examples for **freeWave()**
 - fix Arduino-lint.yml (long library name error)
+- update readme.md
 - minor edits
 
+----
+
 ## [0.2.6] - 2023-11-02
 - update readme.md
 - update keywords.txt (align)

README.md

@@ -35,7 +35,7 @@ As always, feedback and ideas are welcome.
 You always have to verify your own performance measurements to see if 
 your requirements are met by this library.
 
-Indication of what performance can be expected (based upon 0.2.1 version).  
+**Indication** of what performance can be expected (based upon 0.2.1 version).  
 Note that the values need to be transported to a DAC or serial port too.  
 Numbers based on performance example, for one single signal.
 
@@ -174,8 +174,8 @@ DutyCycle changes duration HIGH vs LOW, wave stays trapezium like.
 Note at 50% DC the two trapezium functions are identical.
 - **float heartBeat(float t)** simplified heartbeat wave.
 To get a regular BPM heartbeat one should **setFrequency(BPM/60.0)** e.g 72/60 = 1.2.
-- **float freeWave(float t, int16_t arr)** define a free wave form.
-It uses an array of **101** values, dividing a full period in **100** equidistant steps.
+- **float freeWave(float t, int16_t arr, int16_t N)** define a free wave form.
+It uses an array of **N+1** values, dividing a full period in **N** equidistant steps.
 The last value should equal the first value to have a smooth transition.
 The values of the array normally vary between -10000 and +10000 to manage
 the set the relative amplitude in small steps. 
@@ -206,6 +206,8 @@ The length of the HIGH LOW level go from 0 to half a period.
 - **float trapezium2(float t)** The duty cycle determines the length of the HIGH level,
 which is 0 for 0% DC and half a period for 100% DC. 
 The rising and falling edges stay same.
+- **float heartBeat(float t)** The duty cycle determines the part of the period
+that the signal ~zero.
 
 ### No duty cycle
 
@@ -220,23 +222,23 @@ Think of it as the halve of the triangle wave.
 - **zero()** has no period so does not make sense (yet).
 - **float sinusDiode(float t)**
 - **float sinusRectified(float t)**
-- **float heartBeat(float t)** 
-- **float freeWave(float t, int16_t arr)**
-
+- **float freeWave(float t, int16_t arr, int16_t N)**
 
 ## Future
 
 #### Must
 
 - improve documentation
   - reorganize
+  - section per function might be better.
 
 #### Should
 
 - smart reseed needed for random().
   - initialize random generator with compile file + date + time.
   - use function values for seed bits.
 - stand-alone functions in separate .h
+- clean up code
 
 #### Could
 
@@ -255,14 +257,16 @@ Think of it as the halve of the triangle wave.
 - heartBeat
   - small noise/variation parameter on amplitude and frequency.
   - reduce footprint ==> wrapper around freeWave()
-- add **freeWaveN(t, arr, N)** ==> arbitrary array size
 - waves
   - white noise, pink noise (better done with hardware)
   - min() + max() => return +-amplitude + yshift?
   - RC function curve.
   - Gamma curve.
-  - freeWave allows a lot.
-- create a function table
+- create a function table? with what?
+- create an example program to sample an arbitrary wave form
+  - output in the right format.
+  - slow sampling vs real time.
+
 
 #### Examples
 

examples/funcGenFreeWavePlotter/funcGenFreeWavePlotter.ino

@@ -86,7 +86,7 @@ void loop()
   Serial.print("\t");
   Serial.print(-80);
   Serial.print("\t");
-  Serial.print(gen.freeWave(t, arr_two_sin));
+  Serial.print(gen.freeWave(t, arr_two_sin, 100));
   Serial.println();
   delay(10);
 }

examples/functionGeneratorPerformance/functionGeneratorPerformance.ino

@@ -17,6 +17,32 @@ volatile float y;
 funcgen gen;
 
 
+//  sin(t) + 0.25 * sin(5t)
+int16_t arr_two_sin[101] =
+{
+  0, 1120, 2178, 3117, 3891, 4472,
+  4847, 5024, 5029, 4904, 4702,
+  4481, 4300, 4213, 4261, 4472,
+  4852, 5392, 6063, 6820, 7608,
+  8366, 9033, 9554, 9886, 10000,
+  9886, 9554, 9033, 8366, 7608,
+  6820, 6063, 5392, 4852, 4472,
+  4261, 4213, 4300, 4481, 4702,
+  4904, 5029, 5024, 4847, 4472,
+  3891, 3117, 2178, 1120, 0,
+  -1120, -2178, -3117, -3891, -4472,
+  -4847, -5024, -5029, -4904, -4702,
+  -4481, -4300, -4213, -4261, -4472,
+  -4852, -5392, -6063, -6820, -7608,
+  -8366, -9033, -9554, -9886, -10000,
+  -9886, -9554, -9033, -8366, -7608,
+  -6820, -6063, -5392, -4852, -4472,
+  -4261, -4213, -4300, -4481, -4702,
+  -4904, -5029, -5024, -4847, -4472,
+  -3891, -3117, -2178, -1120, 0,
+};
+
+
 void setup()
 {
   Serial.begin(115200);
@@ -49,8 +75,14 @@ void setup()
   delay(10);
   test_sinusRectified();
   delay(10);
+  test_trapezium1();
+  delay(10);
   test_trapezium2();
   delay(10);
+  test_heartBeat();
+  delay(10);
+  test_freeWave();
+  delay(10);
   Serial.println();
 
   Serial.println("t \t sqr\t saw\t tri\t sin\t str\t rnd\t line\t zero\t sinD\t sinR\t trap");
@@ -264,6 +296,22 @@ void test_sinusRectified()
 }
 
 
+void test_trapezium1()
+{
+  start = micros();
+  for (int i = 0; i < 10000; i++)
+  {
+    t = gen.trapezium1(i);
+  }
+  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_trapezium2()
 {
   start = micros();
@@ -280,6 +328,38 @@ void test_trapezium2()
 }
 
 
+void test_heartBeat()
+{
+  start = micros();
+  for (int i = 0; i < 10000; i++)
+  {
+    t = gen.heartBeat(i);
+  }
+  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_freeWave()
+{
+  start = micros();
+  for (int i = 0; i < 10000; i++)
+  {
+    t = gen.freeWave(i, arr_two_sin);
+  }
+  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 loop()
 {
 }

examples/functionGeneratorPerformance/performance_0.2.7.txt

@@ -2,19 +2,27 @@
 functionGeneratorPerformance.ino
 FUNCTIONGENERATOR_LIB_VERSION: 0.2.7
 
-func 		usec	max calls/sec  (indicative)
-test_square:	55.20	18116.73
-test_sawtooth:	62.32	16047.14
-test_triangle:	80.42	12433.98
-test_sinus:	167.01	5987.72
-test_stair:	81.49	12270.96
-test_random:	43.18	23159.30
-test_random_DC:	67.75	14760.76
-test_line:	0.76	1324152.50
-test_zero:	0.76	1324152.50
-test_sinusDiode:	170.56	5863.09
-test_sinusRectified:	169.55	5897.87
-test_trapezium2:	68.35	14630.15
+indicative output Arduino UNO 1.8.19, 16 MHz.
+
+| wave form name |  usec  |  max calls/sec  |
+|:---------------|-------:|----------------:|
+| square         |  54.57 |       18325.49  |
+| sawtooth       |  61.69 |       16210.61  |
+| triangle       |  79.80 |       12531.96  |
+| sinus          | 166.38 |        6010.37  |
+| stair          |  80.86 |       12366.38  |
+| random         |  42.61 |       23466.69  |
+| random_DC      |  67.18 |       14885.12  |
+| line           |   0.76 |     1322751.37  |
+| zero           |   0.75 |     1324854.25  |
+| sinusDiode     | 169.93 |        5884.79  |
+| sinusRectified | 169.49 |        5900.03  |
+| trapezium1     | 100.98 |        9903.30  |
+| trapezium2     | 143.98 |        6945.58  |
+| heartBeat      | 128.52 |        7780.77  |
+| freeWave       |  75.52 |       13241.31  |
+
+
 
 t 	 sqr	 saw	 tri	 sin	 str	 rnd	 line	 zero	 sinD	 sinR	 trap
 -4.00	-1.00	1.00	-1.00	-0.00	1.00	0.50	1.00	0.00	0.00	0.00	-1.00