Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation of interval attribute #48

Merged
merged 2 commits into from
Aug 24, 2021
Merged

Fix documentation of interval attribute #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a7223d
Fix documentation of interval attribute
HoodedDeath Aug 12, 2021
3c429e1
Fix typo and statement about the default interval
muesli Aug 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,24 @@ Any widget is build up the following way:
```toml
[[keys]]
index = 0
interval = 500 # optional
```

`index` needs to be present in every widget and describes the position of the
widget on the streamdeck. `index` is 0-indexed and counted from top to bottom
and left to right. The attribute `interval` defines the time in `ms` between two
consecutive updates of the widget.
and left to right.

#### Update interval for widgets

Optionally, you can configure an update `interval` for each widget:

```toml
[keys.widget]
id = "button"
interval = 500 # optional
```

The attribute `interval` defines the time in `ms` between two consecutive
updates of a widget.

#### Button

Expand Down