Upravy na zaklade clang-tidy

README.md

@@ -1,7 +1,36 @@
-# Interval
-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.
-Knihovna **Interval** vytváří časovací objekty a zpřístupňuje dvě metody – metodu **set** a metodu **expired**.
-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.
+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 umožňuje jejich ovládání pomocí následujících metod.
+
+## **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

@@ -10,9 +10,9 @@
   "repository":
   {
     "type": "git",
-    "url": "https://github.com/Pablo2048/Interval.git"
+    "url": "http://git.xpablo.cz/pablo2048/Interval.git"
   },
-  "version": "0.0.2",
+  "version": "0.0.4",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",

library.properties

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

src/interval.cpp

@@ -1,44 +1,74 @@
-extern "C" {
-  #include <stdlib.h>
-  #include <string.h>
-  #include <inttypes.h>
-}
-#include <Arduino.h>
 #include "interval.h"
 
 // Public Methods //////////////////////////////////////////////////////////////
-uint32_t Interval::remains(void)
+uint32_t Interval::remains() const
 {
 
-	return _timeout - (millis() - _timefrom);
+    return _timeout - (millis() - _timefrom);
 }
 
-uint32_t Interval::elapsed(void)
+uint32_t Interval::elapsed() const
 {
 
-	return millis() - _timefrom;
+    return millis() - _timefrom;
 }
 
-bool Interval::expired(void)
+bool Interval::expired()
 {
+    bool result = false;
 
-	if ((millis() - _timefrom) >= _timeout)
-		return true;
-	else
-		return false;
+    if (_done) {
+        if (1 == _mode) {
+            // oneshot mode
+            if ((millis() - _timefrom) >= _timeout) {
+                _done = 0;
+                result = true;
+            }
+        } else if (2 == _mode) {
+            // periodic mode
+            if ((millis() - _timefrom) >= _timeout) {
+                result = true;
+                _timefrom = millis();
+            }
+        } else {
+            // compatibility mode
+            if ((millis() - _timefrom) >= _timeout)
+                result = true;
+        }
+    }
+    return result;
 }
 
 void Interval::set(uint32_t tmout)
 {
 
-  _reload = tmout;
-	_timefrom = millis();
-	_timeout = _reload;
+    _timefrom = millis();
+    _timeout = tmout;
+    _mode = 0;
+    _done = 0xff;
 }
 
-void Interval::reload(void)
+void Interval::setOneshot(uint32_t tmout)
 {
 
-  _timefrom = millis();
-  _timeout = _reload;
+    _timefrom = millis();
+    _timeout = tmout;
+    _mode = 1;
+    _done = 0xff;
+}
+
+void Interval::setPeriodic(uint32_t tmout)
+{
+
+    _timefrom = millis();
+    _timeout = tmout;
+    _mode = 2;
+    _done = 0xff;
+}
+
+void Interval::reload()
+{
+
+    _timefrom = millis();
+    _done = 0xff;
 }

src/interval.h

@@ -1,28 +1,31 @@
-
-#ifndef interval_h
-#define interval_h
+#pragma once
 
 /* Interval
- * Copyright (C) 2014, 2016, 2018  Pavel Brychta http://www.xpablo.cz
+ * Copyright (C) 2014, 2016, 2018, 2019, 2023  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
 {
-  protected:
-	uint32_t _timefrom;
-	uint32_t _timeout;
-  uint32_t _reload;
-  public:
-	bool expired(void);
-	void set(uint32_t tmout);
-  void reload(void);
-	uint32_t elapsed(void);
-	uint32_t remains(void);
+protected:
+    uint32_t _timefrom = 0;
+    uint32_t _timeout = 0;
+    uint8_t _mode = 0; // mode of actual operation (compatibility, oneshot, periodic)
+    uint8_t _done = 0xff; // compatibility mode autostart
+public:
+    Interval() = default;
+    explicit Interval(uint32_t tmout)
+        : _timeout(tmout)
+        , _mode(2) // periodic mode autostart
+    {}
+    bool expired();
+    void set(uint32_t tmout);
+    void setOneshot(uint32_t tmout);
+    void setPeriodic(uint32_t tmout);
+    void reload();
+    [[nodiscard]] uint32_t elapsed() const;
+    [[nodiscard]] uint32_t remains() const;
 };
-
-#endif
-// EOF