diff --git a/README.md b/README.md index d9e0415..dcbc101 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,38 @@ -# Interval - Arduino knihovna pro časování pomocí intervalů +# Interval - Arduino Library for Interval Timing ![Build](https://git.xpablo.cz/pablo2048/Interval/actions/workflows/pio_tests.yml/badge.svg) -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 realizovat velmi elegantním způsobem. +The design concept of an Arduino application is based on two main methods – **setup()** and **loop()**, in which the program runs continuously. +For more convenient handling of periodic processes, I have written a simple library that allows these tasks to be executed in a very elegant way. -Knihovna **Interval** vytváří časovací objekty a umožňuje jejich ovládání pomocí následujících metod. +The **Interval** library creates timer objects and allows you to control them using the following methods. ## **set** -Metoda **set** se používá k nastavení timeoutu a definici začátku časování. +The **set** method is used to set the timeout and define the start of the timing. ## **expired** -Metoda **expired** pak slouží k ověření, zda nastavený interval již vypršel. +The **expired** method is used to check whether the set interval has already elapsed. ## **setOneshot** -Metoda **setOneshot** nastaví jednorázový běh časovače. Po jeho vypršení je časovač zastavený. +The **setOneshot** method configures the timer for a one-shot run. After it expires, the timer is stopped. ## **setPeriodic** -Metoda **setPeriodic** nastaví opakovaný běh časovače. Po jeho vypršení je časovač automaticky nastavený na zadaný čas. +The **setPeriodic** method configures the timer for a periodic run. After expiration, the timer is automatically reset to the specified time. ## **reload** -Metoda **reload** způsobí nový start časovače s poslední zadanou časovou konstantou. +The **reload** method restarts the timer with the last specified time constant. ## **elapsed** -Metoda **elapsed** vrátí čas, který už uplynul od začátku běhu časovače. +The **elapsed** method returns the time that has elapsed since the timer started. ## **remains** -Metoda **remains** vrátí čas, který ještě zbývá do konce běhu časovače, nebo do startu nového cyklu. +The **remains** method returns the time remaining until the timer finishes, or until a new cycle begins. -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í. +An interesting feature is that the library correctly handles the overflow of the internal millisecond counter, so there is no risk of incorrect timing even during very long operation periods. diff --git a/library.json b/library.json index 059e969..c049c17 100644 --- a/library.json +++ b/library.json @@ -10,9 +10,9 @@ "repository": { "type": "git", - "url": "http://git.xpablo.cz/pablo2048/Interval.git" + "url": "https://git.xpablo.cz/pablo2048/Interval.git" }, - "version": "0.0.4", + "version": "2.0.0", "license": "MIT", "frameworks": "arduino", "platforms": "*", diff --git a/library.properties b/library.properties index 27d820d..331f7fa 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Interval -version=0.0.4 +version=2.0.0 author=Pavel Brychta maintainer=Pavel Brychta sentence=Make timing by using intervals instead of delay()