Skip to content

v0.1.0

Choose a tag to compare

@andrewmitchell-automations andrewmitchell-automations released this 14 Aug 22:14
· 4 commits to main since this release
743fe0c

First release. A generic, configurable Stream Deck plugin for Kimai time tracking — four key types, all configured through the Stream Deck app UI, no code changes needed.

Install

Download co.alphaomegateam.kimai.streamDeckPlugin below and double-click it. Requires the Stream Deck app 7.1 or newer.

Then drag any Kimai key onto your deck, select it, and enter your Kimai URL and an API token (Kimai: profile → API access — the token value is shown only once). The connection is shared by every key; press Test connection to confirm it before configuring anything else.

The four actions

  • Start Timer — starts a chosen project + activity. Optionally stops whatever is running first (on by default). The key highlights while its own timer is the one running.
  • Stop Timer — stops whatever is currently running.
  • Current Timer — a read-only display of the running timer: client, project, activity, elapsed. Elapsed ticks live.
  • Toggle Timer — one key that starts its timer, or stops it if it is already the one running.

Known limitations in v0.1.0

  • Keys only. No Stream Deck+ dials or touchscreens.
  • One Kimai connection, shared by all keys.
  • Changing the poll interval needs a plugin restart. URL and token changes apply immediately.
  • "Stop running timer first" stops the first running timesheet, so on a Kimai configured to allow concurrent timers it stops one of several.
  • Elapsed time is never wrapped or shortened, so a timer running past 99 hours can overflow a narrow key.
  • Icons are a functional placeholder set; branded artwork comes before any Marketplace listing.

Settings, including the API token, are stored by Stream Deck in plaintext on the local disk. See the README for the full disclosure.

Verification

127 unit tests, streamdeck validate clean. The packaged archive was extracted to a bare directory and booted the way Stream Deck launches it, and installation plus startup were confirmed on real hardware on macOS. Windows is untested. docs/QA-CHECKLIST.md records what has and has not been exercised on a device.

MIT licensed. Third-party notices for all bundled dependencies ship inside the plugin bundle.