PV4 Documentation

TimeKeeper

The TimeKeeper data integration connects to a TimeKeeper server over WebSocket for live timing data. Setup fields below are configured per Show in the PV4 Portal (Show → Data Integrations); field descriptions are transcribed from the Portal setup screen. Required fields are marked.

Fields

Field

Required

Type

Default

Description

Stats Enabled


Boolean

None

Is the stats provider enabled for the Orchestrator.

Server Address


String

None

The URL or IP of the TimeKeeper server.

Path


String

None

The WebSocket path on the TimeKeeper server.

Remote Port

Required

Number

2089

The port to connect to on the remote server.

Secure Connection

Required

Boolean

None

Use WSS or WS.

Automatic Reconnect

Required

Boolean

None

Automatically reconnect to the service on disconnect.

Heartbeat

Required

Boolean

None

Send heartbeat messages to the server.

Use Relay


Boolean

None

Whether the message is using the relay or local connection.

API Key


String

None

The API Key for accessing the service.

Time Precision

Required

Number

2

The level of precision to request for time updates. 1 = Centiseconds, 2 = Deciseconds, 3 = Seconds, 4 = Minutes, 5 = Important Change, 6 = Hours.

App Name


String

PV4

The app name to register the TimeKeeper subscription under.

Labels


String

None

A comma-delimited string of labels to be inserted into the URL.