From 99fbb6a73d02f7dd8ae9339235ea21e5f395ec53 Mon Sep 17 00:00:00 2001 From: Alan-Lomax <87946633+Alan-Lomax@users.noreply.github.com> Date: Mon, 26 Jul 2021 18:12:47 -0400 Subject: [PATCH] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0d46c6d..459b6d7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # DblDelay This class defines a timer that has individually configurable on delay and off delay intervals. -Very handy if using LDR's to activate signals as the signal can be configured to change a few seconds after the LDR is triggered +This is very handy if using LDR's to activate signals as each signal can be configured to change a few seconds after the LDR is triggered and stay activated for some period of time after the LDR has been cleared. ### Files: DblDelay.h, DblDelay.CPP @@ -13,7 +13,7 @@ Include the header file near the top of your code. (After this is done the compi Then create a new member of this class as follows: - DblDelay(outputOnDelay, outputOffDelay, blipfilter); + DblDelay myTimer(outputOnDelay, outputOffDelay, blipfilter); Where outputOnDelay, outputOffDelay, blipfilter are all in milliseconds. @@ -22,9 +22,8 @@ Where outputOnDelay, outputOffDelay, blipfilter are all in milliseconds. ### Methods void Update(); // Update things based on elapsed time (call this in your loop code as often as possible) - bool State(); // Return the current state of the DblDelay Timer - - -### Properties: void Start(); // Start the Timer running void Stop(); // Stop the Timer ready for next time. + +### Properties: + bool State(); // Return the current state of the DblDelay Timer