diff --git a/doc/classuTimerLib-members.html b/doc/classuTimerLib-members.html index 41cf70e..f31da26 100644 --- a/doc/classuTimerLib-members.html +++ b/doc/classuTimerLib-members.html @@ -70,8 +70,8 @@ clearTimer()uTimerLib setInterval_s(void(*)(), unsigned long int)uTimerLib setInterval_us(void(*)(), unsigned long int)uTimerLib - setTimeout_s(void(*)(), unsigned long int)uTimerLib - setTimeout_us(void(*)(), unsigned long int)uTimerLib + setTimeout_s(void(*)(), unsigned long int)uTimerLib + setTimeout_us(void(*)(), unsigned long int)uTimerLib uTimerLib()uTimerLib diff --git a/doc/classuTimerLib.html b/doc/classuTimerLib.html index 9611062..db3fee0 100644 --- a/doc/classuTimerLib.html +++ b/doc/classuTimerLib.html @@ -82,12 +82,12 @@ void setInterval_s (void(*)(), unsigned long int)  Attaches a callback function to be executed each s seconds. More...
  -int setTimeout_us (void(*)(), unsigned long int) - Attaches a callback function to be executed once when us microseconds have passed. More...
-  -int setTimeout_s (void(*)(), unsigned long int) - Attaches a callback function to be executed once when s seconds have passed. More...
-  +void setTimeout_us (void(*)(), unsigned long int) + Attaches a callback function to be executed once when us microseconds have passed. More...
+  +void setTimeout_s (void(*)(), unsigned long int) + Attaches a callback function to be executed once when s seconds have passed. More...
+  void clearTimer ()  Clear timer interrupts. More...
  @@ -229,14 +229,14 @@

-

◆ setTimeout_s()

+ +

◆ setTimeout_s()

- + @@ -266,14 +266,14 @@

-

◆ setTimeout_us()

+ +

◆ setTimeout_us()

int uTimerLib::setTimeout_s void uTimerLib::setTimeout_s ( void(*)()  cb,
- + diff --git a/doc/functions.html b/doc/functions.html index 7599485..306e759 100644 --- a/doc/functions.html +++ b/doc/functions.html @@ -73,10 +73,10 @@ : uTimerLib
  • setTimeout_s() -: uTimerLib +: uTimerLib
  • setTimeout_us() -: uTimerLib +: uTimerLib
  • uTimerLib() : uTimerLib diff --git a/doc/functions_func.html b/doc/functions_func.html index 628f1de..2a08434 100644 --- a/doc/functions_func.html +++ b/doc/functions_func.html @@ -73,10 +73,10 @@ : uTimerLib
  • setTimeout_s() -: uTimerLib +: uTimerLib
  • setTimeout_us() -: uTimerLib +: uTimerLib
  • uTimerLib() : uTimerLib diff --git a/doc/index.html b/doc/index.html index ebb3086..ed70e00 100644 --- a/doc/index.html +++ b/doc/index.html @@ -87,7 +87,7 @@ https://www.foroelectro.net/librerias-arduino-ide-f29/utimerlib-libreria-arduino-para-eventos-temporizad-t191.html
    naguissa@foroelectro.net
    -
    Version
    1.2.0
    +
    Version
    1.2.2
    diff --git a/doc/search/all_2.js b/doc/search/all_2.js index 97e1a11..5d4bb82 100644 --- a/doc/search/all_2.js +++ b/doc/search/all_2.js @@ -2,6 +2,6 @@ var searchData= [ ['setinterval_5fs',['setInterval_s',['../classuTimerLib.html#a854ecb39b803b72f37ae15b6f2f5881a',1,'uTimerLib']]], ['setinterval_5fus',['setInterval_us',['../classuTimerLib.html#a7def88c35a2326fbccaec9920d2310b5',1,'uTimerLib']]], - ['settimeout_5fs',['setTimeout_s',['../classuTimerLib.html#abea126dca65b571400279ac39c6cc34c',1,'uTimerLib']]], - ['settimeout_5fus',['setTimeout_us',['../classuTimerLib.html#a0401f0f5ffd188616c824c7ba5926558',1,'uTimerLib']]] + ['settimeout_5fs',['setTimeout_s',['../classuTimerLib.html#ac517490c5db52264053b60f36608b524',1,'uTimerLib']]], + ['settimeout_5fus',['setTimeout_us',['../classuTimerLib.html#a21fd5e64f88e73a33ca69233ed0b9bac',1,'uTimerLib']]] ]; diff --git a/doc/search/functions_2.js b/doc/search/functions_2.js index 97e1a11..5d4bb82 100644 --- a/doc/search/functions_2.js +++ b/doc/search/functions_2.js @@ -2,6 +2,6 @@ var searchData= [ ['setinterval_5fs',['setInterval_s',['../classuTimerLib.html#a854ecb39b803b72f37ae15b6f2f5881a',1,'uTimerLib']]], ['setinterval_5fus',['setInterval_us',['../classuTimerLib.html#a7def88c35a2326fbccaec9920d2310b5',1,'uTimerLib']]], - ['settimeout_5fs',['setTimeout_s',['../classuTimerLib.html#abea126dca65b571400279ac39c6cc34c',1,'uTimerLib']]], - ['settimeout_5fus',['setTimeout_us',['../classuTimerLib.html#a0401f0f5ffd188616c824c7ba5926558',1,'uTimerLib']]] + ['settimeout_5fs',['setTimeout_s',['../classuTimerLib.html#ac517490c5db52264053b60f36608b524',1,'uTimerLib']]], + ['settimeout_5fus',['setTimeout_us',['../classuTimerLib.html#a21fd5e64f88e73a33ca69233ed0b9bac',1,'uTimerLib']]] ]; diff --git a/doc/uTimerLib_8cpp.html b/doc/uTimerLib_8cpp.html index 2caf468..7b9d3af 100644 --- a/doc/uTimerLib_8cpp.html +++ b/doc/uTimerLib_8cpp.html @@ -93,7 +93,7 @@ https://www.foroelectro.net/librerias-arduino-ide-f29/utimerlib-libreria-arduino-para-eventos-temporizad-t191.html
    naguissa@foroelectro.net
    -
    Version
    1.2.0
    +
    Version
    1.2.2

    Variable Documentation

    ◆ TimerLib

    diff --git a/doc/uTimerLib_8h_source.html b/doc/uTimerLib_8h_source.html index a452976..35b4099 100644 --- a/doc/uTimerLib_8h_source.html +++ b/doc/uTimerLib_8h_source.html @@ -67,16 +67,16 @@
    uTimerLib.h
    -Go to the documentation of this file.
    1 
    32 #ifndef _uTimerLib_
    33 
    36  #define _uTimerLib_
    37 
    38  #include "Arduino.h"
    39 
    40  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    41  #include <Ticker.h> //Ticker Library
    42  #endif
    43  // Operation modes
    47  #define UTIMERLIB_TYPE_OFF 0
    48 
    51  #define UTIMERLIB_TYPE_TIMEOUT 1
    52 
    55  #define UTIMERLIB_TYPE_INTERVAL 2
    56 
    57  #ifdef _VARIANT_ARDUINO_STM32_
    58  #include "HardwareTimer.h"
    59  extern HardwareTimer Timer3;
    60  #endif
    61 
    62  class uTimerLib {
    63  public:
    64  uTimerLib();
    65  void setInterval_us(void (*) (), unsigned long int);
    66  void setInterval_s(void (*) (), unsigned long int);
    67  int setTimeout_us(void (*) (), unsigned long int);
    68  int setTimeout_s(void (*) (), unsigned long int);
    69  void clearTimer();
    70  void _interrupt();
    71 
    72  #ifdef _VARIANT_ARDUINO_STM32_
    73  static void interrupt();
    74  #endif
    75 
    76  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    77  #pragma message "ESP8266 / ESP32 can only reach a ms resolution so any ms interrupt will be rounded to that"
    78  static void interrupt();
    79  #endif
    80 
    81  #ifdef _SAMD21_
    82  #pragma message "SAMD21 support is still experimental"
    83  TcCount16* _TC = (TcCount16*) TC3;
    84  #endif
    85 
    86  #ifdef __SAMD51__
    87  #pragma message "SAMD51 support is still experimental"
    88  #endif
    89 
    90  private:
    91  static uTimerLib *_instance;
    92 
    93  unsigned long int _overflows = 0;
    94  unsigned long int __overflows = 0;
    95  #ifdef ARDUINO_ARCH_AVR
    96  unsigned char _remaining = 0;
    97  unsigned char __remaining = 0;
    98  #else
    99  unsigned long int _remaining = 0;
    100  unsigned long int __remaining = 0;
    101  #endif
    102  void (*_cb)() = NULL;
    103  unsigned char _type = UTIMERLIB_TYPE_OFF;
    104 
    105  void _loadRemaining();
    106 
    107  void _attachInterrupt_us(unsigned long int);
    108  void _attachInterrupt_s(unsigned long int);
    109 
    110  #ifdef _VARIANT_ARDUINO_STM32_
    111  bool _toInit = true;
    112  #endif
    113 
    114  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    115  Ticker _ticker;
    116  #endif
    117  };
    118 
    119  extern uTimerLib TimerLib;
    120 
    121 #endif
    122 
    uTimerLib::clearTimer
    void clearTimer()
    Clear timer interrupts.
    Definition: uTimerLib.cpp:765
    +Go to the documentation of this file.
    1 
    32 #ifndef _uTimerLib_
    33 
    36  #define _uTimerLib_
    37 
    38  #include "Arduino.h"
    39 
    40  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    41  #include <Ticker.h> //Ticker Library
    42  #endif
    43  // Operation modes
    47  #define UTIMERLIB_TYPE_OFF 0
    48 
    51  #define UTIMERLIB_TYPE_TIMEOUT 1
    52 
    55  #define UTIMERLIB_TYPE_INTERVAL 2
    56 
    57  #ifdef _VARIANT_ARDUINO_STM32_
    58  #include "HardwareTimer.h"
    59  extern HardwareTimer Timer3;
    60  #endif
    61 
    62  class uTimerLib {
    63  public:
    64  uTimerLib();
    65  void setInterval_us(void (*) (), unsigned long int);
    66  void setInterval_s(void (*) (), unsigned long int);
    67  void setTimeout_us(void (*) (), unsigned long int);
    68  void setTimeout_s(void (*) (), unsigned long int);
    69  void clearTimer();
    70  void _interrupt();
    71 
    72  #ifdef _VARIANT_ARDUINO_STM32_
    73  static void interrupt();
    74  #endif
    75 
    76  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    77  #pragma message "ESP8266 / ESP32 can only reach a ms resolution so any ms interrupt will be rounded to that"
    78  static void interrupt();
    79  #endif
    80 
    81  #ifdef _SAMD21_
    82  #pragma message "SAMD21 support is still experimental"
    83  TcCount16* _TC = (TcCount16*) TC3;
    84  #endif
    85 
    86  #ifdef __SAMD51__
    87  #pragma message "SAMD51 support is still experimental"
    88  #endif
    89 
    90  private:
    91  static uTimerLib *_instance;
    92 
    93  unsigned long int _overflows = 0;
    94  unsigned long int __overflows = 0;
    95  #ifdef ARDUINO_ARCH_AVR
    96  unsigned char _remaining = 0;
    97  unsigned char __remaining = 0;
    98  #else
    99  unsigned long int _remaining = 0;
    100  unsigned long int __remaining = 0;
    101  #endif
    102  void (*_cb)() = NULL;
    103  unsigned char _type = UTIMERLIB_TYPE_OFF;
    104 
    105  void _loadRemaining();
    106 
    107  void _attachInterrupt_us(unsigned long int);
    108  void _attachInterrupt_s(unsigned long int);
    109 
    110  #ifdef _VARIANT_ARDUINO_STM32_
    111  bool _toInit = true;
    112  #endif
    113 
    114  #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
    115  Ticker _ticker;
    116  #endif
    117  };
    118 
    119  extern uTimerLib TimerLib;
    120 
    121 #endif
    122 
    uTimerLib::clearTimer
    void clearTimer()
    Clear timer interrupts.
    Definition: uTimerLib.cpp:765
    uTimerLib::setInterval_us
    void setInterval_us(void(*)(), unsigned long int)
    Attaches a callback function to be executed each us microseconds.
    Definition: uTimerLib.cpp:54
    UTIMERLIB_TYPE_OFF
    #define UTIMERLIB_TYPE_OFF
    Internal status.
    Definition: uTimerLib.h:47
    uTimerLib::setInterval_s
    void setInterval_s(void(*)(), unsigned long int)
    Attaches a callback function to be executed each s seconds.
    Definition: uTimerLib.cpp:82
    uTimerLib::_interrupt
    void _interrupt()
    Internal intermediate function to control timer interrupts.
    Definition: uTimerLib.cpp:813
    -
    uTimerLib::setTimeout_s
    int setTimeout_s(void(*)(), unsigned long int)
    Attaches a callback function to be executed once when s seconds have passed.
    Definition: uTimerLib.cpp:96
    uTimerLib
    Arduino tiny and cross-device compatible timer library.
    Definition: uTimerLib.h:62
    uTimerLib::uTimerLib
    uTimerLib()
    Constructor.
    Definition: uTimerLib.cpp:41
    -
    TimerLib
    uTimerLib TimerLib
    Preinstantiate Object.
    Definition: uTimerLib.cpp:909
    -
    uTimerLib::setTimeout_us
    int setTimeout_us(void(*)(), unsigned long int)
    Attaches a callback function to be executed once when us microseconds have passed.
    Definition: uTimerLib.cpp:68
    +
    TimerLib
    uTimerLib TimerLib
    Preinstantiate Object.
    Definition: uTimerLib.cpp:918
    +
    uTimerLib::setTimeout_s
    void setTimeout_s(void(*)(), unsigned long int)
    Attaches a callback function to be executed once when s seconds have passed.
    Definition: uTimerLib.cpp:96
    +
    uTimerLib::setTimeout_us
    void setTimeout_us(void(*)(), unsigned long int)
    Attaches a callback function to be executed once when us microseconds have passed.
    Definition: uTimerLib.cpp:68
    diff --git a/examples/uTimerLib_setInterval_s_example_led/uTimerLib_setInterval_s_example_led.ino b/examples/uTimerLib_setInterval_s_example_led/uTimerLib_setInterval_s_example_led.ino index 165aa27..38cb31f 100644 --- a/examples/uTimerLib_setInterval_s_example_led/uTimerLib_setInterval_s_example_led.ino +++ b/examples/uTimerLib_setInterval_s_example_led/uTimerLib_setInterval_s_example_led.ino @@ -9,22 +9,22 @@ #include "Arduino.h" #include "uTimerLib.h" - +#ifndef LED_BUILTIN + // change to fit your needs + #define LED_BUILTIN 13 +#endif volatile bool status = 0; void timed_function() { status = !status; - digitalWrite(LED_BUILTIN, status); } - void setup() { pinMode(LED_BUILTIN, OUTPUT); TimerLib.setInterval_s(timed_function, 2); } - void loop() { + digitalWrite(LED_BUILTIN, status); } - diff --git a/examples/uTimerLib_setInterval_s_example_serial/uTimerLib_setInterval_s_example_serial.ino b/examples/uTimerLib_setInterval_s_example_serial/uTimerLib_setInterval_s_example_serial.ino index f2224f3..07e1f40 100644 --- a/examples/uTimerLib_setInterval_s_example_serial/uTimerLib_setInterval_s_example_serial.ino +++ b/examples/uTimerLib_setInterval_s_example_serial/uTimerLib_setInterval_s_example_serial.ino @@ -9,25 +9,20 @@ #include "Arduino.h" #include "uTimerLib.h" - - -unsigned long int prevMillis = 0; +volatile unsigned long int prevMillis = 0; +volatile unsigned long int actMillis = 0; void timed_function() { - unsigned long int actMillis = millis(); Serial.println(actMillis - prevMillis); prevMillis = actMillis; } - - void setup() { Serial.begin(57600); TimerLib.setInterval_s(timed_function, 2); prevMillis = millis(); } - void loop() { + actMillis = millis(); } - diff --git a/examples/uTimerLib_setInterval_us_example_led/uTimerLib_setInterval_us_example_led.ino b/examples/uTimerLib_setInterval_us_example_led/uTimerLib_setInterval_us_example_led.ino index 4bc5cc3..7eee948 100644 --- a/examples/uTimerLib_setInterval_us_example_led/uTimerLib_setInterval_us_example_led.ino +++ b/examples/uTimerLib_setInterval_us_example_led/uTimerLib_setInterval_us_example_led.ino @@ -14,23 +14,17 @@ #define LED_BUILTIN 13 #endif - - - volatile bool status = 0; void timed_function() { status = !status; - digitalWrite(LED_BUILTIN, status); } - void setup() { pinMode(LED_BUILTIN, OUTPUT); TimerLib.setInterval_us(timed_function, 1000000); } - void loop() { + digitalWrite(LED_BUILTIN, status); } - diff --git a/examples/uTimerLib_setInterval_us_example_serial/uTimerLib_setInterval_us_example_serial.ino b/examples/uTimerLib_setInterval_us_example_serial/uTimerLib_setInterval_us_example_serial.ino index 1de2bc9..6f93ac4 100644 --- a/examples/uTimerLib_setInterval_us_example_serial/uTimerLib_setInterval_us_example_serial.ino +++ b/examples/uTimerLib_setInterval_us_example_serial/uTimerLib_setInterval_us_example_serial.ino @@ -9,25 +9,20 @@ #include "Arduino.h" #include "uTimerLib.h" - - -unsigned long int prevMillis = 0; +volatile unsigned long int prevMillis = 0; +volatile unsigned long int actMillis = 0; void timed_function() { - unsigned long int actMillis = millis(); Serial.println(actMillis - prevMillis); prevMillis = actMillis; } - - void setup() { Serial.begin(57600); TimerLib.setInterval_us(timed_function, 200000); prevMillis = millis(); } - void loop() { + actMillis = millis(); } - diff --git a/examples/uTimerLib_setTimeout_s_example_led/uTimerLib_setTimeout_s_example_led.ino b/examples/uTimerLib_setTimeout_s_example_led/uTimerLib_setTimeout_s_example_led.ino index 7ce3456..c3943d8 100644 --- a/examples/uTimerLib_setTimeout_s_example_led/uTimerLib_setTimeout_s_example_led.ino +++ b/examples/uTimerLib_setTimeout_s_example_led/uTimerLib_setTimeout_s_example_led.ino @@ -9,13 +9,15 @@ #include "Arduino.h" #include "uTimerLib.h" - +#ifndef LED_BUILTIN + // change to fit your needs + #define LED_BUILTIN 13 +#endif volatile bool status = 0; void timed_function() { status = !status; - digitalWrite(LED_BUILTIN, status); if (status) { TimerLib.setTimeout_s(timed_function, 2); } @@ -29,5 +31,6 @@ void setup() { void loop() { + digitalWrite(LED_BUILTIN, status); } diff --git a/examples/uTimerLib_setTimeout_s_example_serial/uTimerLib_setTimeout_s_example_serial.ino b/examples/uTimerLib_setTimeout_s_example_serial/uTimerLib_setTimeout_s_example_serial.ino index 8e9a245..acf8734 100644 --- a/examples/uTimerLib_setTimeout_s_example_serial/uTimerLib_setTimeout_s_example_serial.ino +++ b/examples/uTimerLib_setTimeout_s_example_serial/uTimerLib_setTimeout_s_example_serial.ino @@ -9,23 +9,19 @@ #include "Arduino.h" #include "uTimerLib.h" - - -unsigned long int prevMillis = 0; +volatile unsigned long int prevMillis = 0; +volatile unsigned long int actMillis = 0; void timed_function() { - Serial.println(millis() - prevMillis); + Serial.println(actMillis - prevMillis); } - - void setup() { Serial.begin(57600); TimerLib.setTimeout_s(timed_function, 2); prevMillis = millis(); } - void loop() { + actMillis = millis(); } - diff --git a/examples/uTimerLib_setTimeout_us_example_led/uTimerLib_setTimeout_us_example_led.ino b/examples/uTimerLib_setTimeout_us_example_led/uTimerLib_setTimeout_us_example_led.ino index 11798f0..13a6042 100644 --- a/examples/uTimerLib_setTimeout_us_example_led/uTimerLib_setTimeout_us_example_led.ino +++ b/examples/uTimerLib_setTimeout_us_example_led/uTimerLib_setTimeout_us_example_led.ino @@ -9,13 +9,15 @@ #include "Arduino.h" #include "uTimerLib.h" - +#ifndef LED_BUILTIN + // change to fit your needs + #define LED_BUILTIN 13 +#endif volatile bool status = 0; void timed_function() { status = !status; - digitalWrite(LED_BUILTIN, status); if (status) { TimerLib.setTimeout_us(timed_function, 1000000); } @@ -29,5 +31,6 @@ void setup() { void loop() { + digitalWrite(LED_BUILTIN, status); } diff --git a/examples/uTimerLib_setTimeout_us_example_serial/uTimerLib_setTimeout_us_example_serial.ino b/examples/uTimerLib_setTimeout_us_example_serial/uTimerLib_setTimeout_us_example_serial.ino index 60cc8f3..204228b 100644 --- a/examples/uTimerLib_setTimeout_us_example_serial/uTimerLib_setTimeout_us_example_serial.ino +++ b/examples/uTimerLib_setTimeout_us_example_serial/uTimerLib_setTimeout_us_example_serial.ino @@ -9,23 +9,20 @@ #include "Arduino.h" #include "uTimerLib.h" - - -unsigned long int prevMillis = 0; +volatile unsigned long int prevMillis = 0; +volatile unsigned long int actMilis = 0; void timed_function() { - Serial.println(millis() - prevMillis); + Serial.println(actMilis - prevMillis); } - - void setup() { Serial.begin(57600); TimerLib.setTimeout_us(timed_function, 200000); prevMillis = millis(); } - void loop() { + actMilis = millis(); } diff --git a/library.properties b/library.properties index 300e1d8..259977d 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=uTimerLib -version=1.2.1 +version=1.2.2 author=Naguissa maintainer=Naguissa sentence=Tiny and cross-device compatible timer library diff --git a/src/uTimerLib.cpp b/src/uTimerLib.cpp index 570ef49..69d5358 100644 --- a/src/uTimerLib.cpp +++ b/src/uTimerLib.cpp @@ -25,7 +25,7 @@ * @see https://github.com/Naguissa/uTimerLib * @see https://www.foroelectro.net/librerias-arduino-ide-f29/utimerlib-libreria-arduino-para-eventos-temporizad-t191.html * @see naguissa@foroelectro.net - * @version 1.2.1 + * @version 1.2.2 */ #include "uTimerLib.h" @@ -815,7 +815,16 @@ void uTimerLib::_interrupt() { return; } #ifdef _VARIANT_ARDUINO_STM32_ - _cb(); + // We are making X overflows, as much as seconds (none on us). So wee compare upper than 1 + if (_overflows > 1) { + _overflows--; + } else { + _overflows = __overflows; + if (_type == UTIMERLIB_TYPE_TIMEOUT) { + clearTimer(); + } + _cb(); + } #else if (_overflows > 0) { _overflows--; diff --git a/src/uTimerLib.h b/src/uTimerLib.h index 70ef1a8..2aedf4d 100644 --- a/src/uTimerLib.h +++ b/src/uTimerLib.h @@ -24,7 +24,7 @@ * @see https://github.com/Naguissa/uTimerLib * @see https://www.foroelectro.net/librerias-arduino-ide-f29/utimerlib-libreria-arduino-para-eventos-temporizad-t191.html * @see naguissa@foroelectro.net - * @version 1.2.1 + * @version 1.2.2 */ /** \file uTimerLib.h * \brief uTimerLib header file
    • int uTimerLib::setTimeout_us void uTimerLib::setTimeout_us ( void(*)()  cb,