OmniCal API

The OmniCal Application Programming Interface (API) provides programmable control of the OmniCal feature within Designer, accessible via d3Net.

Designer version r32.4 introduced the ability to perform OmniCal RigCheck directly from the API. RigCheck allows remote re-calibration of proven OmniCal Plans that were set up and calibrated earlier. This new API offers endpoints to trigger a new RigCheck, query the OmniCal result and take further action based on this information.

To access the OmniCal API, navigate to the base URL localhost/docs/.

For more in-depth information on the available API calls, please visit the Disguise Developer docs.

General OmniCal API endpoints

These currently include endpoints to:

• Query or request OmniCal camera discovery state.
• Query basic information about OmniCal Plans in Designer.

RigCheck API endpoints

These currently include endpoints to control most of the RigCheck workflow, except for making alignment adjustments.

• Query basic information about RigCheck Results in Designer.
• Execute a new RigCheck.
• Monitor progress of ongoing RigCheck via WebSockets stream.
• Query the status and success of the current RigCheck.
• Accept or revert the current RigCheck Result.
• Clean up old RigCheck Results.

RigCheck API Endpoints