Ontime Companion Module

This module gives control over Ontime leveraging its WebSockets API

Requirements

• Ontime v4.0.0 or greater

Connecting to Ontime

To connect companion to Ontime you will need to provide the module with an address to Ontime's server.
This can be a IP address in your local network, localhost (if you are running everything in the same machine) or a URL for Ontime Cloud.

Ontime provides an interface to generate these links:

1. Navigate to Editor -> Settings -> Sharing and reporting -> Share link

2. Select Companion as Ontime view

3. If your stage is behind a password, activate the Authenticate toggle

4. Click the Create share link button which adds the address to your clipboard

5. Back to Companion, you can now insert the copied address in the Ontime server address field

Links

Download ontime or try our cloud service from the website www.getontime.no
View full release notes for the module on GitHub
Read the docs at http://docs.getontime.no
Follow Ontime's development on GitHub
Join the discord community

New for module version 5.3.1

• Targets Companion 4.3+ and Module API 2.0 (Node 22 runtime)
• Stored actions and feedbacks are migrated automatically when you upgrade; recheck buttons
• Fixed some action/feedback issues

New for module version 5.3.0

• Variables as input to add time action
• Variables as input to aux timer values

New for module version 5.2.0

• Better message feedback
• Variables for flag, group and rundown offsets
• Variables as input to change action on custom fields and title
• A playback toggle action