Add getRemaining method by oxo42 · Pull Request #18 · Aasim-A/AsyncTimer

oxo42 · 2022-02-25T16:38:06Z

This addresses feature request #17

I want to be able to report how much time is left to the next interval on a timer. I would like to write code

unsigned long remaining = t.getRemaining(timerId);
Serial.print("Time remaining: ");
Serial.println(remaining);

If you're okay with the code, would you like me to add in a version bump to 2.3.0?

Aasim-A

Hi, thanks for the PR, I've left some comments, as for the version bump, you can bump it to 2.3.0

Aasim-A · 2022-02-27T15:05:58Z

src/AsyncTimer.cpp

+  for (unsigned short i = 0; i < m_maxArrayLength; i++)
+    if (m_callsArray[i].id == id)
+      return m_callsArray[i].timestamp + m_callsArray[i].delayByMs - now;
+  return -1;


return 0 instead of -1 because unsigned long doesn't support negatives

Also beware that now might happen to be after m_callsArray[i].timestamp + m_callsArray[i].delayByMs just because the code so far has been executing synchronously long enough to not allow the library to execute the scheduled callback on time (no callback is guaranteed to be executed at its scheduled time exactly).
Simple example would be if the callback has one more second before it has to execute but the current code takes three seconds before it completes, and at the end of those three seconds .getRemaining() will return -2

Good point, a fix to this problem is to keep the now variable and check if now is bigger than the sum of the timestamp and the delay, if it is bigger, return 0, otherwise subtract now from it and return the result

Thanks for the pointers. I'll update the code

Aasim-A · 2022-02-27T15:06:27Z

README.md

+```c++
+AsyncTimer t;
+
+// This timeout will never run


Remove this comment

Aasim-A · 2022-02-27T15:08:01Z

README.md


+## getRemaining
+
+Gets the number of milliseconds remaining in a timer.  Returns -1 on timer not found.


Returns 0 instead of -1
Change double space after period to single space

Aasim-A · 2022-02-27T15:09:21Z

src/AsyncTimer.cpp

 }

+unsigned long AsyncTimer::getRemaining(unsigned short id) {
+  unsigned long now = millis();


Since now is only used once, it should be omitted and replaced by millis() call

Aasim-A · 2022-02-27T15:10:45Z

src/AsyncTimer.cpp


+unsigned long AsyncTimer::getRemaining(unsigned short id) {
+  unsigned long now = millis();
+  for (unsigned short i = 0; i < m_maxArrayLength; i++)


Add curly braces to for loop for consistency with other code

Aasim-A · 2022-02-27T15:22:15Z

src/AsyncTimer.h

  void reset(unsigned short id);
  void cancel(unsigned short id);
  void cancelAll(bool includeIntervals = true);
+  unsigned long getRemaining(unsigned short id);


Move this line to be under setInterval line

Aasim-A · 2022-02-27T15:22:45Z

src/AsyncTimer.cpp

  }
 }

+unsigned long AsyncTimer::getRemaining(unsigned short id) {


Move this function declaration to be under setInterval function

Aasim-A · 2022-02-27T15:23:27Z

README.md

 t.cancelAll(false);
 ```

+## getRemaining


Move this function to be under setInterval

* Handle the case where `now` is after `m_callsArray[i].timestamp` + `m_callsArray[i].delayByMs` * Re-order `getRemaining` to be after `setInterval` in `README.md`, `AsyncTimer.h`, `AsyncTimer.cpp` * `getRemaining` returns `0` if timer not found

Aasim-A · 2022-03-01T07:38:13Z

LGTM!
Thanks again

Add getRemaining method

82d1f8d

Aasim-A requested changes Feb 27, 2022

View reviewed changes

oxo42 and others added 3 commits February 28, 2022 22:52

Fix branch based on code review

d0dac34

* Handle the case where `now` is after `m_callsArray[i].timestamp` + `m_callsArray[i].delayByMs` * Re-order `getRemaining` to be after `setInterval` in `README.md`, `AsyncTimer.h`, `AsyncTimer.cpp` * `getRemaining` returns `0` if timer not found

Remove unneeded return, break from loop if found

6f2aab1

Added function parameter and more description

d5cac46

Aasim-A merged commit d56fca9 into Aasim-A:master Mar 1, 2022

Aasim-A mentioned this pull request Mar 1, 2022

Feature Request: Add method to return remaining time on the interval #17

Closed


		## getRemaining

		Gets the number of milliseconds remaining in a timer. Returns -1 on timer not found.

Conversation

oxo42 commented Feb 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Aasim-A left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aasim-A commented Mar 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

oxo42 commented Feb 25, 2022 •

edited

Loading