v1.3.0 to fix accuracy bug

### Releases v1.3.0

1. Fix `poor-timer-accuracy` bug. Check [Poor accuracy on timer interrupt frequency or interval. #4](khoih-prog/MBED_RPI_PICO_TimerInterrupt#4)

Author: khoih-prog

CONTRIBUTING.md

@@ -15,8 +15,8 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
-* `RP2040` Core Version (e.g. Arduino-mbed RP2040 v2.7.2)
-* `RP2040` Board type (e.g. NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
+* `Arduino mbed_rp2040` Core Version (e.g. Arduino mbed_rp2040 core v3.3.0)
+* `RP2040` Board type (e.g. Nano_RP2040_Connect, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -28,13 +28,13 @@ Please ensure to specify the following:
 
 ```
 Arduino IDE version: 1.8.19
-Arduino-mbed mbed_nano v2.7.2
-NANO_RP2040_CONNECT Module
+Arduino mbed_rp2040 core v3.3.0
+RASPBERRY_PI_PICO board
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-100-generic #113-Ubuntu SMP Thu Feb 3 18:43:29 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.15.0-48-generic #54~20.04.1-Ubuntu SMP Thu Sep 1 16:17:26 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
-I encountered a crash while using TimerInterrupt.
+I encountered a crash while using this library
 
 Steps to reproduce:
 1. ...

README.md

@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.3.0](#releases-v130)
   * [Releases v1.2.1](#releases-v121)
   * [Releases v1.2.0](#releases-v120)
   * [Releases v1.1.0](#releases-v110)
@@ -23,6 +24,10 @@
 
 ## Changelog
 
+### Releases v1.3.0
+
+1. Fix `poor-timer-accuracy` bug. Check [Poor accuracy on timer interrupt frequency or interval. #4](https://github.com/khoih-prog/MBED_RPI_PICO_TimerInterrupt/issues/4)
+
 ### Releases v1.2.1
 
 1. Fix `New Period` display bug. Check [random dropouts #4](https://github.com/khoih-prog/SAMD_Slow_PWM/issues/4)

changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "MBED_RP2040_Slow_PWM",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "keywords": "timing, device, control, hardware-timer, pwm, ISR-based-pwm, multi-channel-pwm, low-frequency-pwm, mission-critical, accuracy, non-blocking, mbed, mbed-nano, mbed-rp2040, rpi-pico, rp2040, nano-rp2040-connect, precise, arduino-mbed",
   "description": "This library enables you to use ISR-based PWM channels on RP2040-based boards, such as Nano_RP2040_Connect, RASPBERRY_PI_PICO, with Arduino-mbed (mbed_nano or mbed_rp2040) core to create and output PWM any GPIO pin. The most important feature is they're ISR-based PWM channels, supporting lower PWM frequencies with suitable accuracy. Their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These ISR-based PWMs, still work even if other software functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software-based PWM using millis() or micros(). That's necessary if you need to control devices requiring high precision. Now you can change the PWM settings on-the-fly",
   "authors":

library.json

@@ -1,12 +1,12 @@
 name=MBED_RP2040_Slow_PWM
-version=1.2.1
+version=1.3.0
 author=Khoi Hoang <[email protected]>
 maintainer=Khoi Hoang <[email protected]>
 sentence=This library enables you to use ISR-based PWM channels on RP2040-based boards, such as Nano_RP2040_Connect, RASPBERRY_PI_PICO, with Arduino-mbed (mbed_nano or mbed_rp2040) core to create and output PWM any GPIO pin. 
 paragraph=The most important feature is they are ISR-based PWM channels, supporting lower PWM frequencies with suitable accuracy. Their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These ISR-based PWMs, still work even if other software functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software-based PWM using millis() or micros(). That is necessary if you need to control devices requiring high precision. Now you can change the PWM settings on-the-fly
 category=Device Control
 url=https://github.com/khoih-prog/MBED_RP2040_Slow_PWM
-architectures=mbed,mbed_nano,ArduinoCore-mbed,mbed_rp2040
+architectures=mbed,mbed_nano,mbed_rp2040
 repository=https://github.com/khoih-prog/MBED_RP2040_Slow_PWM
 license=MIT
 includes=MBED_RP2040_Slow_PWM.h,MBED_RP2040_Slow_PWM.hpp

library.properties

@@ -38,7 +38,10 @@ upload_speed = 921600
 ;monitor_port = COM11
 
 ; Checks for the compatibility with frameworks and dev/platforms
+; To adjust as necessary
 lib_compat_mode = strict
+lib_ldf_mode = chain+
+;lib_ldf_mode = deep+
 
 lib_deps =  
 

platformio/platformio.ini

@@ -12,7 +12,7 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.1
+  Version: 1.3.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -21,6 +21,7 @@
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      02/02/2022 Fix multiple-definitions linker error. Improve accuracy. Optimize code
   1.2.1   K Hoang      03/03/2022 Fix `DutyCycle` and `New Period` display bugs. Display warning only when debug level > 3
+  1.3.0   K.Hoang      12/10/2022 Fix poor timer accuracy bug
 *****************************************************************************************************************************/
 
 #pragma once

src/MBED_RP2040_Slow_PWM.h

@@ -12,7 +12,7 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.1
+  Version: 1.3.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -21,13 +21,16 @@
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      02/02/2022 Fix multiple-definitions linker error. Improve accuracy. Optimize code
   1.2.1   K Hoang      03/03/2022 Fix `DutyCycle` and `New Period` display bugs. Display warning only when debug level > 3
+  1.3.0   K.Hoang      12/10/2022 Fix poor timer accuracy bug
 *****************************************************************************************************************************/
 
 #pragma once
 
 #ifndef MBED_RP2040_SLOW_PWM_HPP
 #define MBED_RP2040_SLOW_PWM_HPP
 
+////////////////////////////////////////////
+
 #if ( defined(ARDUINO_NANO_RP2040_CONNECT) || defined(ARDUINO_RASPBERRY_PI_PICO) || defined(ARDUINO_ADAFRUIT_FEATHER_RP2040) || \
       defined(ARDUINO_GENERIC_RP2040) ) && defined(ARDUINO_ARCH_MBED)
 
@@ -39,16 +42,20 @@
   #error This code is intended to run on the MBED RASPBERRY_PI_PICO platform! Please check your Tools->Board setting.
 #endif
 
+////////////////////////////////////////////
+
 #ifndef MBED_RP2040_SLOW_PWM_VERSION
-  #define MBED_RP2040_SLOW_PWM_VERSION           "MBED_RP2040_Slow_PWM v1.2.1"
+  #define MBED_RP2040_SLOW_PWM_VERSION           "MBED_RP2040_Slow_PWM v1.3.0"
 
   #define MBED_RP2040_SLOW_PWM_VERSION_MAJOR     1
-  #define MBED_RP2040_SLOW_PWM_VERSION_MINOR     2
-  #define MBED_RP2040_SLOW_PWM_VERSION_PATCH     1
+  #define MBED_RP2040_SLOW_PWM_VERSION_MINOR     3
+  #define MBED_RP2040_SLOW_PWM_VERSION_PATCH     0
 
-  #define MBED_RP2040_SLOW_PWM_VERSION_INT       1002001
+  #define MBED_RP2040_SLOW_PWM_VERSION_INT       1003000
 #endif
 
+////////////////////////////////////////////
+
 #if defined(ARDUINO)
   #if ARDUINO >= 100
     #include <Arduino.h>
@@ -57,10 +64,14 @@
   #endif
 #endif
 
+////////////////////////////////////////////
+
 #ifndef _PWM_LOGLEVEL_
   #define _PWM_LOGLEVEL_      1
 #endif
 
+////////////////////////////////////////////
+
 #include "PWM_Generic_Debug.h"
 
 /*
@@ -93,6 +104,8 @@ void TIMER_ISR_END(uint alarm_num);
 class MBED_RP2040_TimerInterrupt;
 
 typedef MBED_RP2040_TimerInterrupt MBED_RP2040_Timer;
+
+////////////////////////////////////////////
 
 class MBED_RP2040_TimerInterrupt
 {
@@ -104,14 +117,20 @@ class MBED_RP2040_TimerInterrupt
 
   public:
 
+    ////////////////////////////////////////////
+
     MBED_RP2040_TimerInterrupt(uint8_t timerNo)
     {     
       _timerNo = timerNo;
       _callback = NULL;
     };
+
+    ////////////////////////////////////////////
 
     #define TIM_CLOCK_FREQ      ( (float) 1000000.0f )
 
+    ////////////////////////////////////////////
+
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
     // No params and duration now. To be added in the future by adding similar functions here
     bool setFrequency(const float& frequency, hardware_alarm_callback_t callback)
@@ -127,10 +146,13 @@ class MBED_RP2040_TimerInterrupt
 
         // Hardware timer is preset in RP2040 at 1MHz / 1uS
         _frequency  = frequency;
-        _timerCount[_timerNo] = (uint64_t) TIM_CLOCK_FREQ / frequency;
+        
+        //_timerCount[_timerNo] = (uint64_t) TIM_CLOCK_FREQ / frequency;
+        // Ref: https://github.com/khoih-prog/MBED_RPI_PICO_TimerInterrupt/issues/4
+        _timerCount[_timerNo] = (uint64_t) ( ( float) TIM_CLOCK_FREQ / frequency ) - 1;
 
         PWM_LOGWARN5(F("_timerNo = "), _timerNo, F(", Clock (Hz) = "), TIM_CLOCK_FREQ, F(", _fre (Hz) = "), _frequency);
-        PWM_LOGWARN3(F("_count = "), (uint32_t) (_timerCount[_timerNo] >> 32) , F("-"), (uint32_t) (_timerCount[_timerNo]));
+        PWM_LOGWARN3(F("_count = "), (uint32_t) (_timerCount[_timerNo] >> 32) , F("-"), (uint32_t) (_timerCount[_timerNo]) + 1);
 
         _callback  =  callback;
 
@@ -143,7 +165,7 @@ class MBED_RP2040_TimerInterrupt
         //bool hardware_alarm_set_target(uint alarm_num, absolute_time_t t);
         hardware_alarm_set_target(_timerNo, absAlarmTime[_timerNo]);
 
-        PWM_LOGWARN1(F("hardware_alarm_set_target, uS = "), _timerCount[_timerNo]);
+        PWM_LOGWARN1(F("hardware_alarm_set_target, uS = "), _timerCount[_timerNo] + 1);
 
         return true;
       }
@@ -157,66 +179,89 @@ class MBED_RP2040_TimerInterrupt
       TIMER_ISR_END(_timerNo);
     }
 
+    ////////////////////////////////////////////
+
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
     // No params and duration now. To be added in the future by adding similar functions here
     bool setInterval(const unsigned long& interval, hardware_alarm_callback_t callback)
     {
       return setFrequency((float) (1000000.0f / interval), callback);
     }
 
+    ////////////////////////////////////////////
+
     bool attachInterrupt(const float& frequency, hardware_alarm_callback_t callback)
     {
       return setFrequency(frequency, callback);
     }
 
+    ////////////////////////////////////////////
+
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
     // No params and duration now. To be added in the future by adding similar functions here
     bool attachInterruptInterval(const unsigned long& interval, hardware_alarm_callback_t callback)
     {
       return setFrequency( (float) ( 1000000.0f / interval), callback);
     }
 
+    ////////////////////////////////////////////
+
     void detachInterrupt()
     {
       hardware_alarm_set_callback(_timerNo, NULL);
     }
 
+    ////////////////////////////////////////////
+
     void disableTimer()
     {
       hardware_alarm_set_callback(_timerNo, NULL);
     }
 
+    ////////////////////////////////////////////
+
     // Duration (in milliseconds). Duration = 0 or not specified => run indefinitely
     void reattachInterrupt()
     {
       TIMER_ISR_START(_timerNo);
       hardware_alarm_set_callback(_timerNo, _callback);
     }
 
+    ////////////////////////////////////////////
+
     // Duration (in milliseconds). Duration = 0 or not specified => run indefinitely
     void enableTimer()
     {
       TIMER_ISR_START(_timerNo);
       hardware_alarm_set_callback(_timerNo, _callback);
     }
 
+    ////////////////////////////////////////////
+
     // Just stop clock source, clear the count
     void stopTimer()
     {
       hardware_alarm_set_callback(_timerNo, NULL);
     }
 
+    ////////////////////////////////////////////
+
     // Just reconnect clock source, start current count from 0
     void restartTimer()
     {
       TIMER_ISR_START(_timerNo);
       hardware_alarm_set_callback(_timerNo, _callback);
     }
 
+    ////////////////////////////////////////////
+
     int8_t getTimer() __attribute__((always_inline))
     {
       return _timerNo;
     }
+
+    ////////////////////////////////////////////
+    
 }; // class MBED_RP2040_TimerInterrupt
 
 

src/MBED_RP2040_Slow_PWM.hpp

@@ -12,7 +12,7 @@
   Therefore, their executions are not blocked by bad-behaving functions / tasks.
   This important feature is absolutely necessary for mission-critical tasks.
 
-  Version: 1.2.1
+  Version: 1.3.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -21,6 +21,7 @@
   1.1.0   K Hoang      10/11/2021 Add functions to modify PWM settings on-the-fly
   1.2.0   K Hoang      02/02/2022 Fix multiple-definitions linker error. Improve accuracy. Optimize code
   1.2.1   K Hoang      03/03/2022 Fix `DutyCycle` and `New Period` display bugs. Display warning only when debug level > 3
+  1.3.0   K.Hoang      12/10/2022 Fix poor timer accuracy bug
 *****************************************************************************************************************************/
 
 #pragma once