Skip to content

Commit b9093da

Browse files
committed
Add HELP.md
1 parent 3f38bd1 commit b9093da

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

HELP.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# LiveTime Companion Module
2+
3+
This module controls the [LiveTime](https://www.workflownetwork.com/products/live-time) software using the [beta API](https://workflownetwork.zendesk.com/hc/en-us/articles/4421381933079) that was added in verison 1.18.
4+
5+
## Requirements
6+
7+
- Must be on server version 1.18 or higher
8+
- Must have a server on and the Presets Engine module enabled (via an In-App Purchase).
9+
- Presets called by the API must exist on the same Mac that the Server is on. If using a Preset built on another LiveTime Mac, please use the export/import Preset functions.
10+
- The server password must be enabled.
11+
- API must be turned on in Live Time preferences.
12+
13+
## Known issues
14+
15+
- There currently isn't a way to set a timer without also starting it (API Limitation)
16+
- The "Reset" action's auto-start option isn't working correctly (API Bug?)
17+
- For now, keep that option disabled.
18+
- Time-of-Day is slow to show up when called (API Bug?)
19+
20+
_(I'm calling those last 2 API bugs because they exhibit the same behaviour when the request is sent from CURL, so it isn't a Companion issue)_
21+
22+
## Available Commands
23+
24+
- Timers (Main and Aux)
25+
- Start
26+
- Stop
27+
- Set
28+
- Reset
29+
- Presets
30+
- Recall by index
31+
- Recall previous
32+
- Recall next
33+
- Overlay
34+
- Show
35+
- Hide

0 commit comments

Comments
 (0)