update GitHub actions + examples

.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@v6
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
-          # compliance: strict
+          compliance: strict

.github/workflows/arduino_test_runner.yml

@@ -6,9 +6,8 @@ jobs:
   runTest:
     runs-on: ubuntu-latest
     timeout-minutes: 20
-
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.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@v6
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

LICENSE

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

README.md

@@ -88,6 +88,7 @@ It is advised to reset **t** after a number (e.g. 100) full periods
 
 Needs further investigations.
 
+
 ### Related
 
 - https://github.com/RobTillaart/AD9833 hardware waveform generator.
@@ -209,6 +210,7 @@ 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
 
 The other functions need to be investigated what duty cycle means.
@@ -224,6 +226,7 @@ Think of it as the halve of the triangle wave.
 - **float sinusRectified(float t)**
 - **float freeWave(float t, int16_t arr, int16_t N)**
 
+
 ## Future
 
 #### Must
@@ -240,6 +243,7 @@ Think of it as the halve of the triangle wave.
 - stand-alone functions in separate .h
 - clean up code
 
+
 #### Could
 
 - ASDR wave 
@@ -254,6 +258,7 @@ Think of it as the halve of the triangle wave.
   - improve performance sin() lookup table.
   - add float variable for ```_perDC = _period * _dutyCycle```
   - do we need **freq4** ? not since DC.
+  - check **FastTrig** library for faster sinus (interpolated lookup).
 - heartBeat
   - small noise/variation parameter on amplitude and frequency.
   - reduce footprint ==> wrapper around freeWave()
@@ -266,15 +271,16 @@ Think of it as the halve of the triangle wave.
 - create an example program to sample an arbitrary wave form
   - output in the right format.
   - slow sampling vs real time.
-
+- functionGenerator as (derived?) class name
 
 #### Examples
 
-  - Amplitude modulation ?
-  - heartbeat curve?
-  - example ESP32 version as separate task.
-  - example with DAC. 8 12 16 bit.
-  - example with potentiometers for 4 parameters
+- Amplitude modulation ?
+- heartbeat curve?
+- example ESP32 version as separate task.
+- example with DAC. 8 12 16 bit.
+- example with potentiometers for 4 parameters
+
 
 #### Wont
 

examples/funcGenFreeWavePlotter/funcGenFreeWavePlotter.ino

@@ -67,8 +67,9 @@ int16_t arr_two_sin[101] =
 void setup()
 {
   Serial.begin(115200);
+  //  Serial.println();
   //  Serial.println(__FILE__);
-  //  Serial.print("FUNCTIONGENERATOR_LIB_VERSION: ");
+  //  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
   //  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
   //  Serial.println();
 

examples/functionGenerator/functionGenerator.ino

@@ -18,7 +18,11 @@ char choice = '0';
 void setup()
 {
   Serial.begin(500000);
+  Serial.println();
   Serial.println(__FILE__);
+  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
+  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
+  Serial.println();
   Serial.println("Start ");
 
   gen.setFrequency(4);

examples/functionGeneratorDuoPlot/functionGeneratorDuoPlot.ino

@@ -17,10 +17,11 @@ funcgen gen2;
 void setup()
 {
   Serial.begin(115200);
-  // Serial.println();
-  // Serial.println(__FILE__);
-  // Serial.print("FUNCTIONGENERATOR_LIB_VERSION: ");
-  // Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
+  //  Serial.println();
+  //  Serial.println(__FILE__);
+  //  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
+  //  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
+  //  Serial.println();
 
   gen1.setFrequency(13);
   gen1.setAmplitude(50);

examples/functionGeneratorPerformance/functionGeneratorPerformance.ino

@@ -46,8 +46,9 @@ int16_t arr_two_sin[101] =
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
-  Serial.print("FUNCTIONGENERATOR_LIB_VERSION: ");
+  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
   Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
   Serial.println();
 

examples/functionGeneratorPlotter/functionGeneratorPlotter.ino

@@ -17,18 +17,19 @@ funcgen gen2;
 void setup()
 {
   Serial.begin(115200);
+  //  Serial.println();
   //  Serial.println(__FILE__);
   //  Serial.print("FUNCTIONGENERATOR_LIB_VERSION: ");
   //  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
   //  Serial.println();
 
   gen.setAmplitude(80);
-  gen.setFrequency(65.0 / 60.0); //  HB = BPM/60.0
+  gen.setFrequency(65.0 / 60.0);  //  HB = BPM/60.0
   gen.setDutyCycle(40);
   gen2.setYShift(+20);
 
   gen2.setAmplitude(80);
-  gen2.setFrequency(120.0 / 60.0); //  HB = BPM/60.0
+  gen2.setFrequency(120.0 / 60.0);  //  HB = BPM/60.0
   gen2.setDutyCycle(80);
   gen2.setYShift(-80);
 }

examples/functionGenerator_MCP4725/functionGenerator_MCP4725.ino

@@ -8,6 +8,8 @@
 //  depending on the platform, the range of "smooth" sinus is limited.
 //  other signals are less difficult so have a slightly larger range.
 //  see readme.md for mac frequency table.
+//
+//  uses an MCP4725 as output device
 
 
 #include "functionGenerator.h"
@@ -37,6 +39,12 @@ uint32_t lastTime = 0;
 void setup()
 {
   Serial.begin(230400);
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
+  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
+  Serial.println();
+
   gen.setAmplitude(1);
   gen.setYShift(1);
   gen.setFrequency(frequency);

examples/functionGenerator_double_MCP4725/functionGenerator_double_MCP4725.ino

@@ -31,6 +31,8 @@ void setup()
   Serial.begin(230400);
   Serial.println();
   Serial.println(__FILE__);
+  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
+  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
   Serial.println();
 
   Wire.begin();

examples/generateFreeWave/generateFreeWave.ino

@@ -5,11 +5,16 @@
 //     URL: https://github.com/RobTillaart/FunctionGenerator
 
 
+#include "functionGenerator.h"
+
+
 void setup()
 {
   Serial.begin(115200);
-  Serial.println(__FILE__);
   Serial.println();
+  Serial.println(__FILE__);
+  Serial.println("FUNCTIONGENERATOR_LIB_VERSION: ");
+  Serial.println(FUNCTIONGENERATOR_LIB_VERSION);
   Serial.println();
 
   Serial.println("int16_t arr[101] =\n{");

functionGenerator.cpp

@@ -1,7 +1,8 @@
 //
 //    FILE: functionGenerator.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
+//    DATE: 2015-01-01
 // PURPOSE: wave form generating functions (use with care)
 //     URL: https://github.com/RobTillaart/FunctionGenerator
 

functionGenerator.h

@@ -2,14 +2,15 @@
 //
 //    FILE: functionGenerator.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
+//    DATE: 2015-01-01
 // PURPOSE: wave form generating functions (use with care)
 //     URL: https://github.com/RobTillaart/FunctionGenerator
 
 
 #include "Arduino.h"
 
-#define FUNCTIONGENERATOR_LIB_VERSION           (F("0.3.0"))
+#define FUNCTIONGENERATOR_LIB_VERSION           (F("0.3.1"))
 
 
 class funcgen

library.json

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

library.properties

@@ -1,5 +1,5 @@
 name=FunctionGenerator
-version=0.3.0
+version=0.3.1
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library to generate wave forms (nummeric) for a DAC