1
0
Fork 0

Improved documentation

master
David Peer 2022-02-25 18:07:09 +01:00
parent b8215908a6
commit 6cfd764916
5 changed files with 26 additions and 5 deletions

View File

@ -6,16 +6,37 @@ less interaction. Additionally, it exposes some functions
that can be used by other apps or clocks to easily
implement a timer. It is used e.g. by lcars or notanalog.
# Overview
If you open the app, you can simply control the timer
by clicking on top, bottom, left or right of the screen.
If you tab at the middle of the screen, the timer is
started / stopped.
![](description.png)
# Lib
Different functions are exposed to integrate a timer
into your own app.
Example:
The following functions are available:
- isStarted() -> boolean
- setStarted(boolean) -> void
- increaseTimer(int) -> void
- decreaseTimer(int) -> void
- getRemainingMinutes() -> int
Example to increase the timer by 5 and ensure that its started:
```Javascript
WIDGETS["widtmr"].isStarted();
WIDGETS["widtmr"].reload();
WIDGETS["widtmr"].getRemainingMinutes();
WIDGETS["widtmr"].increaseTimer(5);
WIDGETS["widtmr"].setStarted(true);
```
Example to decrease the timer. This also disables the timer if time <= 0.:
```Javascript
WIDGETS["widtmr"].decreaseTimer(5);
```
# Creator
[David Peer](https://github.com/peerdavid)

BIN
apps/widtmr/description.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

View File

@ -7,7 +7,7 @@
"icon": "app.png",
"tags": "tool,widget",
"supports": ["BANGLEJS","BANGLEJS2"],
"screenshots": [{"url":"screenshot.png"}],
"screenshots": [{"url":"screenshot.png"}, {"url": "screenshot_2.png"}],
"readme": "README.md",
"storage": [
{"name":"widtmr.wid.js","url":"widget.js"},

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB