From acffaeef870f994e80bcc8778ec506199916f7ee Mon Sep 17 00:00:00 2001 From: Pavel Brychta Date: Mon, 26 Aug 2019 16:52:04 +0200 Subject: [PATCH] Dokumentace --- README.md | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index de275f8..f7a5fc6 100644 --- a/README.md +++ b/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í.