Konstruktor pro periodic autostart

README.md

@@ -1,10 +1,36 @@
-# Intrval - Arduino knihovna pro časování pomocí intervalů
+# Interval - Arduino knihovna pro časování pomocí intervalů
 
 Koncepce programové konstrukce aplikace pro Arduino spočívá ve dvou hlavních metodách – **setup()** a **loop()**, ve které program neustále běží.
-Pro pohodlnější práci s obsluhou periodických procesů jsem napsal jednoduchou knihovnu, která tyto úkoly umožňuje napsat velmi elegantním způsobem.
+Pro pohodlnější práci s obsluhou periodických procesů jsem napsal jednoduchou knihovnu, která tyto úkoly umožňuje realizovat velmi elegantním způsobem.
 
-Knihovna **Interval** vytváří časovací objekty a zpřístupňuje dvě metody – metodu **set** a metodu **expired**.
+Knihovna **Interval** vytváří časovací objekty a umožňuje jejich ovládání pomocí následujících metod.
 
-Metoda **set** se používá k nastavení timeoutu a definici začátku časování, metoda **expired** pak slouží k ověření, zda nastavený interval již vypršel.
+## **set**
+
+Metoda **set** se používá k nastavení timeoutu a definici začátku časování.
+
+## **expired**
+
+Metoda **expired** pak slouží k ověření, zda nastavený interval již vypršel.
+
+## **setOneshot**
+
+Metoda **setOneshot** nastaví jednorázový běh časovače. Po jeho vypršení je časovač zastavený.
+
+## **setPeriodic**
+
+Metoda **setPeriodic** nastaví opakovaný běh časovače. Po jeho vypršení je časovač automaticky nastavený na zadaný čas.
+
+## **reload**
+
+Metoda **reload** způsobí nový start časovače s poslední zadanou časovou konstantou.
+
+## **elapsed**
+
+Metoda **elapsed** vrátí čas, který už uplynul od začátku běhu časovače.
+
+## **remains**
+
+Metoda **remains** vrátí čas, který ještě zbývá do konce běhu časovače, nebo do startu nového cyklu.
 
 Zajímavostí je, že knihovna korektně ošetřuje přetečení vnitřního milisekundového čítače, takže nehrozí nebezpečí špatného časování i při velmi dlouhé době chodu zařízení.

library.json

@@ -12,7 +12,7 @@
     "type": "git",
     "url": "http://git.xpablo.cz/pablo2048/Interval.git"
   },
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",

library.properties

@@ -1,5 +1,5 @@
 name=Interval
-version=0.0.3
+version=0.0.4
 author=Pavel Brychta
 maintainer=Pavel Brychta
 sentence=Make timing by using intervals instead of delay()

src/interval.cpp

@@ -1,9 +1,3 @@
-extern "C" {
-  #include <stdlib.h>
-  #include <string.h>
-  #include <inttypes.h>
-}
-#include <Arduino.h>
 #include "interval.h"
 
 // Public Methods //////////////////////////////////////////////////////////////
@@ -22,26 +16,22 @@ uint32_t Interval::elapsed(void)
 bool Interval::expired(void)
 {
     bool result = false;
-  if (_done)
+
-  {
+    if (_done) {
-    if (1 == _mode)
+        if (1 == _mode) {
-    { // oneshot mode
+            // oneshot mode
-      if ((millis() - _timefrom) >= _timeout)
+            if ((millis() - _timefrom) >= _timeout) {
-      {
                 _done = 0;
                 result = true;
             }
-    }
+        } else if (2 == _mode) {
-    else if (2 == _mode)
+            // periodic mode
-    { // periodic mode
+            if ((millis() - _timefrom) >= _timeout) {
-      if ((millis() - _timefrom) >= _timeout)
-      {
                 result = true;
                 _timefrom = millis();
             }
-    }
+        } else {
-    else
+            // compatibility mode
-    { // compatibility mode
             if ((millis() - _timefrom) >= _timeout)
                 result = true;
         }

src/interval.h

@@ -1,14 +1,13 @@
-
+#ifndef _INTERVAL_H_
-#ifndef interval_h
+#define _INTERVAL_H_
-#define interval_h
 
 /* Interval
- * Copyright (C) 2014, 2016, 2018  Pavel Brychta http://www.xpablo.cz
+ * Copyright (C) 2014, 2016, 2018, 2019  Pavel Brychta http://www.xpablo.cz
  *
  * This program is free software: you can redistribute it and/or modify it under the terms of the MIT License
  */
 
-#include <inttypes.h>
+#include <Arduino.h>
 
 class Interval
 {
@@ -18,7 +17,8 @@ class Interval
     uint8_t _mode; // mode of actual operation (compatibility, oneshot, periodic)
     uint8_t _done;
 public:
-  Interval(): _mode(0), _done(0xff) {}
+    Interval(): _mode(0), _done(0xff) {} // compatibility mode autostart
+    Interval(uint32_t tmout): _timeout(tmout), _mode(2), _done(0xff) {} // periodic mode autostart
     bool expired(void);
     void set(uint32_t tmout);
     void setOneshot(uint32_t tmout);