krombel/companion-module-toggl-track
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

version 1.0.0

Browse Source
This commit is contained in:
peter
2022-02-26 10:41:21 +00:00
parent a6ac275037
commit 88d3c3fd2d
2 changed files with 279 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
HELP.md
View File

@@ -2,9 +2,33 @@
This module allows you to start and stop [Toggl Track](https://track.toggl.com/) timers.
Before using this module you must create a Toggl Track account. Then go to your Toggl profile settings page and copy the API token. Paste this token into the config page of this module and click save. If all is well the module status will turn green.
## Configuration
Look for this section on your toggl profile.
Before using this module you must create a Toggl Track account. Then go to your Toggl profile settings page and copy the API token. Look for this section on your toggl profile.
![api token](api_token.png)
Paste this token into the config page of this module and click save. If all is well the module status will turn green.
## Actions
**Start New Timer**
Start a new timer running with the description set in the action and store the ID
**Get Current Timer**
Companion only knows the ID of timers it has started, if a timer is started from another application or the toggle website then this action will get the ID so Companion knows about it.
**Stop Current Timer**
Attempt to stop the current timer. This will fail if Companion doesn't know the ID of the currently running timer.
## Presets
Presets are available for **Start Timer** and **Stop Timer**. The **Stop Timer** preset also includes both the **Get Current Timer** and **Stop Current Timer** actions to ensure reliable operation.
## History
### Version 1.0.0
First release