From 792d2787af33b52a4406ee7a69742f6c7e7c0bbb Mon Sep 17 00:00:00 2001 From: Peter Daniel Date: Tue, 27 Jun 2023 14:17:59 +0100 Subject: [PATCH] v2 help --- companion/HELP.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 companion/HELP.md diff --git a/companion/HELP.md b/companion/HELP.md new file mode 100644 index 0000000..ad88884 --- /dev/null +++ b/companion/HELP.md @@ -0,0 +1,55 @@ +# Companion Module Toggl Track + +This module allows you to start and stop [Toggl Track](https://track.toggl.com/) timers. + +## Configuration + +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. If a list of projects has been retrieved on startup you can choose a project. By default a new timer can't be started if one is already running. This behaviour can be changed by ticking the 'Always Start' option in the module configuration. + +**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. + +**Refresh Project List** + +Retrives the current list of projects from the toggl server. This action runs automatically when Companion starts and when the module is enabled. + +## Presets + +Presets are available for **Start Timer** and **Stop Timer**. + +## History + +### Version 1.0.0 +First release + +### Version 1.0.1 +Fix broken link + +### Version 1.0.2 +Allow a project to be specified when starting a new timer button + +Add an action to refresh the project list + +Add 'Always start' configuration option + +### Version 1.0.3 +Add variables for timerId and timerDescription + +### Version 2.0 +Updated for Companion version 3 +