Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.94 KB

Clock.md

File metadata and controls

95 lines (68 loc) · 3.94 KB
Raw

Clock

The clock plugin contains a collection of time related tiles.

DigitalClockTile

Shows the current time and/or date in digital format on a key. Time format can be customized. The update interval can be adjusted to fit the chosen time format.

Settings

Setting Default Description
Format HH\\:mm Format string.
Interval 1000 ms Update interval.

Example Config

{
    "Plugin": "Clock",
    "Tile": "DigitalClockTile",
    "Settings": {
        "Format": "HH\\:mm\ndddd",
        "Interval": "60000"
    }
}

Format

Format string as documented here.

Notice! Some characters like : must be escaped using \. The \-character itself must also be escaped in JSON.

Interval

Adjust the update interval to the desired resolution. If you include seconds in the time format you probably want to set the interval to <= 1000 ms. If your time format only includes hours an minutes, the interval might only need to be ~ 60000 ms.

StopWatchTile

A stopwatch with customizable format. The update interval can be adjusted to fit the chosen time format.

Usage

Press the key once to start the stopwatch, press the key again to stop it. Hold the key for 500 ms (configurable using HoldToResetTime) to reset the stopwatch. The activity indicator is shown while the stopwatch is running.

Settings

Setting Default Description
Format \\⏱'\n'mm\\:ss Format string.
Interval 100 ms Update interval.
HoldToResetTime 500 ms Minimum time to hold the key down to reset the stopwatch.

Example Config

A stopwatch configured with a format and interval allowing for higher resolution.

{
    "Plugin": "Clock",
    "Tile": "StopWatchTile",
    "Settings": {
        "Format": "\\⏱'\n'mm\\:ss\\.ff",
        "Interval": "10",
        "HoldToResetTime": "500"
    }
}

Format

Format string as documented here.

Notice! Some characters like : must be escaped using \. The \-character itself must also be escaped in JSON.

Interval

Adjust the update interval to the desired resolution. If you include seconds in the time format you probably want to set the interval to <= 1000 ms. If your time format includes milliseconds, the interval must be at the most < 100 ms, depending how high resolution you want.

HoldResetTime

The minimum amount of time in milliseconds to hold the associated key for before the stopwatch is reset.