1.2.1 to to not update DutyCycle immediately

khoih-prog · web-flow · commit 7698bc40d501 · 2022-01-30T18:00:07.000-05:00
### Releases v1.2.1 1. DutyCycle to be optionally updated at the end current PWM period instead of immediately. Check [DutyCycle to be updated at the end current PWM period #2](khoih-prog/ESP8266_PWM#2)
diff --git a/README.md b/README.md
@@ -408,6 +408,9 @@ void setup()
 #define _PWM_LOGLEVEL_      4
 
 #define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
   
 #define MAX_STM32_PWM_FREQ            1000
 
@@ -982,7 +985,7 @@ The following is the sample terminal output when running example [ISR_16_PWMs_Ar
 
 ```
 Starting ISR_16_PWMs_Array_Complex on NUCLEO_H743ZI2
-STM32_SLOW_PWM v1.2.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 240000000
 [PWM] Frequency = 1000000.00 , _count = 20
 Starting ITimer OK, micros() = 2015843
@@ -1047,7 +1050,7 @@ The following is the sample terminal output when running example [ISR_16_PWMs_Ar
 
 ```
 Starting ISR_16_PWMs_Array_Complex on NUCLEO_F767ZI
-STM32_SLOW_PWM v1.2.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 216000000 , Timer Clock Frequency = 1000000.00
 [PWM] Timer Frequency = 50000.00 , _count = 20
 Starting ITimer OK, micros() = 2016553
@@ -1112,7 +1115,7 @@ The following is the sample terminal output when running example [ISR_16_PWMs_Ar
 
 ```
 Starting ISR_16_PWMs_Array_Complex on NUCLEO_L552ZE_Q
-STM32_SLOW_PWM v1.1.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 110000000
 [PWM] Frequency = 1000000.00 , _count = 20
 Starting ITimer OK, micros() = 2016141
@@ -1177,7 +1180,7 @@ The following is the sample terminal output when running example [ISR_16_PWMs_Ar
 
 ```
 Starting ISR_16_PWMs_Array_Complex on BLUEPILL_F103CB
-STM32_SLOW_PWM v1.1.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 72000000
 [PWM] Frequency = 1000000.00 , _count = 20
 Starting ITimer OK, micros() = 3390333
@@ -1241,7 +1244,7 @@ The following is the sample terminal output when running example [ISR_Modify_PWM
 
 ```
 Starting ISR_Modify_PWM on NUCLEO_F767ZI
-STM32_SLOW_PWM v1.2.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 216000000 , Timer Clock Frequency = 1000000.00
 [PWM] Timer Frequency = 50000.00 , _count = 20
 Starting ITimer OK, micros() = 2016545
@@ -1264,7 +1267,7 @@ The following is the sample terminal output when running example [ISR_Changing_P
 
 ```
 Starting ISR_Changing_PWM on NUCLEO_F767ZI
-STM32_SLOW_PWM v1.2.0
+STM32_SLOW_PWM v1.2.1
 [PWM] STM32TimerInterrupt: Timer Input Freq (Hz) = 216000000 , Timer Clock Frequency = 1000000.00
 [PWM] Timer Frequency = 50000.00 , _count = 20
 Starting ITimer OK, micros() = 2016547
@@ -1334,7 +1337,7 @@ Submit issues to: [STM32_Slow_PWM issues](https://github.com/khoih-prog/STM32_Sl
 6. Improve accuracy by using `double`, instead of `uint32_t` for `dutycycle`, `period`. Check [Change Duty Cycle #1](https://github.com/khoih-prog/ESP8266_PWM/issues/1#issuecomment-1024969658)
 7. Optimize library code by using `reference-passing` instead of `value-passing`
 8. Fix reattachInterrupt() bug. Check [bugfix: reattachInterrupt() pass wrong frequency value to setFrequency() #19](https://github.com/khoih-prog/ESP8266TimerInterrupt/pull/19)
- 
+9. DutyCycle to be optionally updated at the end current PWM period instead of immediately
  
 ---
 ---
diff --git a/changelog.md b/changelog.md
@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.2.1](#releases-v121)
   * [Releases v1.2.0](#releases-v120)
   * [Releases v1.1.0](#releases-v110)
   * [Initial Releases v1.0.0](#Initial-Releases-v100)
@@ -21,6 +22,10 @@
 
 ## Changelog
 
+### Releases v1.2.1
+
+1. DutyCycle to be optionally updated at the end current PWM period instead of immediately. Check [DutyCycle to be updated at the end current PWM period #2](https://github.com/khoih-prog/ESP8266_PWM/issues/2)
+
 ### Releases v1.2.0
 
 1. Fix `multiple-definitions` linker error. Drop `src_cpp` and `src_h` directories
diff --git a/examples/ISR_16_PWMs_Array/ISR_16_PWMs_Array.ino b/examples/ISR_16_PWMs_Array/ISR_16_PWMs_Array.ino
@@ -24,7 +24,10 @@
 // Don't define _PWM_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
 #define _PWM_LOGLEVEL_                4
 
-#define USING_MICROS_RESOLUTION       true    //false 
+#define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
 
 #define MAX_STM32_PWM_FREQ            1000
 
diff --git a/examples/ISR_16_PWMs_Array_Complex/ISR_16_PWMs_Array_Complex.ino b/examples/ISR_16_PWMs_Array_Complex/ISR_16_PWMs_Array_Complex.ino
@@ -25,6 +25,9 @@
 #define _PWM_LOGLEVEL_      4
 
 #define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
   
 #define MAX_STM32_PWM_FREQ            1000
 
diff --git a/examples/ISR_16_PWMs_Array_Simple/ISR_16_PWMs_Array_Simple.ino b/examples/ISR_16_PWMs_Array_Simple/ISR_16_PWMs_Array_Simple.ino
@@ -24,7 +24,10 @@
 // Don't define _PWM_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
 #define _PWM_LOGLEVEL_                4
 
-#define USING_MICROS_RESOLUTION       true    //false 
+#define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
 
 #define MAX_STM32_PWM_FREQ            1000
 
diff --git a/examples/ISR_Changing_PWM/ISR_Changing_PWM.ino b/examples/ISR_Changing_PWM/ISR_Changing_PWM.ino
@@ -24,7 +24,10 @@
 // Don't define _PWM_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
 #define _PWM_LOGLEVEL_                4
 
-#define USING_MICROS_RESOLUTION       true    //false 
+#define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
 
 #define MAX_STM32_PWM_FREQ            1000
 
diff --git a/examples/ISR_Modify_PWM/ISR_Modify_PWM.ino b/examples/ISR_Modify_PWM/ISR_Modify_PWM.ino
@@ -24,7 +24,10 @@
 // Don't define _PWM_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
 #define _PWM_LOGLEVEL_                4
 
-#define USING_MICROS_RESOLUTION       true    //false 
+#define USING_MICROS_RESOLUTION       true    //false
+
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
 
 #define MAX_STM32_PWM_FREQ            1000
 
diff --git a/examples/multiFileProject/multiFileProject.h b/examples/multiFileProject/multiFileProject.h
@@ -14,5 +14,8 @@
 
 #define USING_MICROS_RESOLUTION       true    //false
 
+// Default is true, uncomment to false
+//#define CHANGING_PWM_END_OF_CYCLE     false
+
 // Can be included as many times as necessary, without `Multiple Definitions` Linker Error
 #include "STM32_Slow_PWM.hpp"
diff --git a/keywords.txt b/keywords.txt
@@ -59,3 +59,6 @@ STM32_SLOW_PWM_VERSION_INT  LITERAL1
 
 INVALID_STM32_PIN   LITERAL1
 
+USING_MICROS_RESOLUTION LITERAL1
+CHANGING_PWM_END_OF_CYCLE LITERAL1
+
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "STM32_Slow_PWM",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "keywords": "timing, device, control, timer, pwm, interrupt, isr, isr-based, hardware-timer, mission-critical, accuracy, non-blocking, stm32, stm32h7, stm32l5, stm32f1, stm32f4, stm32f7, stm32g4, precise, hardware",
   "description": "This library enables you to use Hardware Timers on STM32F/L/H/G/WB/MP1 boards to create and output PWM to pins. The most important feature is they're purely hardware-based PWM channels. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These hardware timers, using interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's necessary if you need to measure some data requiring better accuracy. PWM feature can now be used. Max PWM frequency is limited at 1000Hz. Now you can change the PWM settings on-the-fly",
   "authors":
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=STM32_Slow_PWM
-version=1.2.0
+version=1.2.1
 author=Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=This library enables you to use Hardware Timers on STM32F/L/H/G/WB/MP1 boards to create and output PWM to pins.
diff --git a/src/PWM_Generic_Debug.h b/src/PWM_Generic_Debug.h
@@ -12,13 +12,14 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.0
+  Version: 1.2.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      22/09/2021 Initial coding for STM32F/L/H/G/WB/MP1
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      29/01/2022 Fix multiple-definitions linker error. Improve accuracy
+  1.2.1   K Hoang      30/01/2022 DutyCycle to be updated at the end current PWM period
  *****************************************************************************************************************************/
 
 #pragma once
diff --git a/src/STM32_Slow_PWM.h b/src/STM32_Slow_PWM.h
@@ -12,13 +12,14 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.0
+  Version: 1.2.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      22/09/2021 Initial coding for STM32F/L/H/G/WB/MP1
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      29/01/2022 Fix multiple-definitions linker error. Improve accuracy
+  1.2.1   K Hoang      30/01/2022 DutyCycle to be updated at the end current PWM period
 *****************************************************************************************************************************/
 
 #pragma once
diff --git a/src/STM32_Slow_PWM.hpp b/src/STM32_Slow_PWM.hpp
@@ -12,13 +12,14 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.0
+  Version: 1.2.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      22/09/2021 Initial coding for STM32F/L/H/G/WB/MP1
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      29/01/2022 Fix multiple-definitions linker error. Improve accuracy
+  1.2.1   K Hoang      30/01/2022 DutyCycle to be updated at the end current PWM period
 *****************************************************************************************************************************/
 
 #pragma once
@@ -41,13 +42,13 @@
 #endif
 
 #ifndef STM32_SLOW_PWM_VERSION
-  #define STM32_SLOW_PWM_VERSION           "STM32_SLOW_PWM v1.2.0"
+  #define STM32_SLOW_PWM_VERSION           "STM32_SLOW_PWM v1.2.1"
   
   #define STM32_SLOW_PWM_VERSION_MAJOR     1
   #define STM32_SLOW_PWM_VERSION_MINOR     2
-  #define STM32_SLOW_PWM_VERSION_PATCH     0
+  #define STM32_SLOW_PWM_VERSION_PATCH     1
 
-  #define STM32_SLOW_PWM_VERSION_INT       1002000
+  #define STM32_SLOW_PWM_VERSION_INT       1002001
 #endif
 
 ///////////////////////////////////////////
diff --git a/src/STM32_Slow_PWM_ISR.h b/src/STM32_Slow_PWM_ISR.h
@@ -12,13 +12,14 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.0
+  Version: 1.2.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      22/09/2021 Initial coding for STM32F/L/H/G/WB/MP1
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      29/01/2022 Fix multiple-definitions linker error. Improve accuracy
+  1.2.1   K Hoang      30/01/2022 DutyCycle to be updated at the end current PWM period
 *****************************************************************************************************************************/
 
 #pragma once
diff --git a/src/STM32_Slow_PWM_ISR.hpp b/src/STM32_Slow_PWM_ISR.hpp
@@ -12,13 +12,14 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.0
+  Version: 1.2.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      22/09/2021 Initial coding for STM32F/L/H/G/WB/MP1
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      29/01/2022 Fix multiple-definitions linker error. Improve accuracy
+  1.2.1   K Hoang      30/01/2022 DutyCycle to be updated at the end current PWM period
 *****************************************************************************************************************************/
 
 #pragma once
@@ -41,13 +42,13 @@
 #endif
 
 #ifndef STM32_SLOW_PWM_VERSION
-  #define STM32_SLOW_PWM_VERSION           "STM32_SLOW_PWM v1.2.0"
+  #define STM32_SLOW_PWM_VERSION           "STM32_SLOW_PWM v1.2.1"
   
   #define STM32_SLOW_PWM_VERSION_MAJOR     1
   #define STM32_SLOW_PWM_VERSION_MINOR     2
-  #define STM32_SLOW_PWM_VERSION_PATCH     0
+  #define STM32_SLOW_PWM_VERSION_PATCH     1
 
-  #define STM32_SLOW_PWM_VERSION_INT       1002000
+  #define STM32_SLOW_PWM_VERSION_INT       1002001
 #endif
 
 #ifndef _PWM_LOGLEVEL_
@@ -70,6 +71,11 @@ typedef void (*timer_callback_p)(void *);
   #define USING_MICROS_RESOLUTION       false
 #endif
 
+#if !defined(CHANGING_PWM_END_OF_CYCLE)
+  #warning Using default CHANGING_PWM_END_OF_CYCLE == true
+  #define CHANGING_PWM_END_OF_CYCLE     true
+#endif
+
 #define INVALID_STM32_PIN         255
 
 
@@ -225,6 +231,11 @@ class STM32_SLOW_PWM_ISR
       ////////////////////////////////////////////////////////////
       
       bool          enabled;            // true if enabled
+      
+      // New from v1.2.1    
+      double        newPeriod;          // period value, in us / ms
+      double        newDutyCycle;       // from 0.00 to 100.00, double precision
+      //////
     } PWM_t;
 
     volatile PWM_t PWM[MAX_NUMBER_CHANNELS];
diff --git a/src/STM32_Slow_PWM_ISR_Impl.h b/src/STM32_Slow_PWM_ISR_Impl.h

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "STM32_Slow_PWM",`
`3`		`- "version": "1.2.0",`
	`3`	`+ "version": "1.2.1",`
`4`	`4`	`"keywords": "timing, device, control, timer, pwm, interrupt, isr, isr-based, hardware-timer, mission-critical, accuracy, non-blocking, stm32, stm32h7, stm32l5, stm32f1, stm32f4, stm32f7, stm32g4, precise, hardware",`
`5`	`5`	"description": "This library enables you to use Hardware Timers on STM32F/L/H/G/WB/MP1 boards to create and output PWM to pins. The most important feature is they're purely hardware-based PWM channels. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These hardware timers, using interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's necessary if you need to measure some data requiring better accuracy. PWM feature can now be used. Max PWM frequency is limited at 1000Hz. Now you can change the PWM settings on-the-fly",
`6`	`6`	`"authors":`