bump version

Author: tfeldmann

CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## v2.0.0
 
-- Simplified API
+This is a breaking release! Please have a look at the new API interface.
+Also feel free to open an issue if you have trouble while migrating!
+
+- Changed interface:
+  - Added `void pause()`
+  - Added `void resume()`
+  - Removed constructor `Timeout(unsigned long duration)`
+  - Removed `void prepare(unsigned long duration)`
+  - Removed `void start()` without arguments
+  - Removed `bool periodic()` without arguments
 - Improved tests
-- Add `pause` and `resume`
 - Fixed rollover issues
+
+## v1.x
+
+- Initial release

README.md

@@ -10,23 +10,23 @@ _This is a library I use in almost all of my projects. It is fully unit-tested a
 
 ### Example 1: A simple timeout
 
-The LED will turn on after 2 seconds.
+The LED will turn off after 2 seconds.
 
 ```cpp
-#include <timeout.h>
+#include <Timeout.h>
 
 const int LED_PIN = 13;
-Timeout timeout;
+Timeout timer;
 
 void setup()
 {
-    pinMode(LED_PIN, OUTPUT);
-    timeout.start(2000);
+  pinMode(LED_PIN, OUTPUT);
+  timer.start(2000);
 }
 
 void loop()
 {
-    digitalWrite(LED_PIN, timeout.time_over());
+  digitalWrite(LED_PIN, !timer.time_over());
 }
 ```
 
@@ -37,7 +37,7 @@ Press the button to turn on the LED.
 Failing to press the button for more than one second switches off the LED.
 
 ```cpp
-#include <timeout.h>
+#include <Timeout.h>
 
 const int LED_PIN = 13;
 const int BUTTON_PIN = 12;
@@ -46,20 +46,16 @@ Timeout heartbeat;
 
 void setup()
 {
-    pinMode(LED_PIN, OUTPUT);
-    pinMode(BUTTON_PIN, INPUT);
-
-    heartbeat.prepare(1000);
+  pinMode(LED_PIN, OUTPUT);
+  pinMode(BUTTON_PIN, INPUT);
 }
 
 void loop()
 {
-    if (digitalRead(BUTTON_PIN))
-    {
-        heartbeat.start();
-    }
-
-    digitalWrite(LED_PIN, !heartbeat.time_over());
+  if (digitalRead(BUTTON_PIN)) {
+    heartbeat.start(1000);
+  }
+  digitalWrite(LED_PIN, !heartbeat.time_over());
 }
 ```
 
@@ -68,7 +64,7 @@ void loop()
 Toggles the LED every 200 milliseconds.
 
 ```cpp
-#include <timeout.h>
+#include <Timeout.h>
 
 const int LED_PIN = 13;
 bool led_on = false;
@@ -77,17 +73,15 @@ Timeout timer;
 
 void setup()
 {
-    pinMode(LED_PIN, OUTPUT);
-    timer.start(200);
+  pinMode(LED_PIN, OUTPUT);
 }
 
 void loop()
 {
-    if (timer.periodic())
-    {
-        led_on = !led_on;
-        digitalWrite(LED_PIN, led_on);
-    }
+  if (timer.periodic(200)) {
+    led_on = !led_on;
+    digitalWrite(LED_PIN, led_on);
+  }
 }
 ```
 
@@ -96,23 +90,25 @@ void loop()
 `Timeout` instances have the following methods:
 
 ```cpp
-// setup duration but don't start (time_over() will return true)
-// then call `start()` somewhere else in your code to start the timer.
-void prepare(unsigned long duration);
+// set the timer to `time_ms` and start ticking
+void start(uint32_t time_ms);
+
+// returns a single true when time runs out and then resets to `time_ms`.
+bool periodic(uint32_t time_ms);
 
-// setup duration and start the timer (time_over() is false
-// for the next `duration` milliseconds)
-void start(unsigned long duration);
+// pause and resume the timer
+void pause(void);
+void resume(void);
 
-// returns true if time ran out, false otherwise
-bool time_over();
+// runs out the timer so `time_over()` returns true
+void expire(void);
 
-// winds up the timer to last known duration
-void start();
+// returns whether the time ran out
+bool time_over(void);
 
-// runs out the timer so time_over() is true
-void expire();
+// returns whether the timer is paused
+bool is_paused(void);
 
-// returns a single true when time runs out then automatically resets itself
-bool periodic();
+// returns the milliseconds until the timer runs out
+uint32_t time_left_ms(void);
 ```

keywords.txt

@@ -11,11 +11,14 @@ Timeout	KEYWORD1
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
-prepare	KEYWORD2
 start	KEYWORD2
-time_over	KEYWORD2
-expire	KEYWORD2
 periodic	KEYWORD2
+pause	KEYWORD2
+resume	KEYWORD2
+expire	KEYWORD2
+time_over	KEYWORD2
+is_paused	KEYWORD2
+time_left_ms	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

library.properties

@@ -1,5 +1,5 @@
 name=SimpleTimeout
-version=1.5.0
+version=2.0.0
 author=Thomas Feldmann <mail@tfeldmann.de>
 maintainer=Thomas Feldmann <mail@tfeldmann.de>
 sentence=Minimal, production-ready timeout library for Arduino.