DOCSEARCHbyAlgolia
Submit Docs

Ctrl Suite

website·Indexed 32 days ago

https://docs.onlx.ltd/

A comprehensive control system featuring Ctrl Engine, the main processing core, and Ctrl Designer for building user interfaces and visual processes. The suite includes support for various parsers (MQTT, JSON, MIDI, OSC, HTTP), module management for device control, and integration with Ctrl for iPad.

Tokens
109.8K
Snippets
354
Records
1.2K
Agent score
50%

What's inside Ctrl Suite

  1. Overview of the Ctrl Engine HTTP API

    The Ctrl Engine HTTP API (introduced in version 0.8.0) enables remote polling, triggering, and management of Ctrl Engine. It allows developers to manage Workspaces and trigger outputs without manual input trigger configuration, facilitating the creation of custom platforms or 3rd party service integrations using Ctrl Suite's built-in protocols and device integrations. Using the API does not impact the licensed entity count for the Engine.

  2. Overview of the disguise Service API Module

    The disguise Service API module provides HTTP-based control over the d3service runtime for disguise media servers (compatible with release r23.0 and later). This module is used for general server functionality. To control a specific open d3 session, use the disguise session API module instead.

    Important: In Main & Understudy server configurations, commands must be sent to both the main and understudy servers to ensure synchronization.

  4. Overview of LED Strip Studio LEC3 Module

    The LED Strip Studio LEC3 module enables control of the LED Ethernet Controller 3 SPI pixel player using its HTTP API. The LEC3 is a stand-alone controller that plays shows from an SD card. By default, the controller communicates over HTTP on Port 80. The module allows for the control of show selection, playback speed, brightness, and color.

  5. Overview of CommsKit for system integration

    CommsKit is a tool designed for control system integrators, technicians, and musicians to integrate and test various control protocols when building custom control systems. It allows users to start sending or receiving a wide range of protocols shortly after installation to simplify the system integration and testing process.

  6. Overview of Open Sound Control (OSC) in Ctrl for iPad

    Ctrl for iPad utilizes Open Sound Control (OSC), a protocol for real-time communication between computers, sound synthesizers, and multimedia devices. It supports sending multiple simultaneous commands with high accuracy and flexibility. In Ctrl for iPad, OSC messages can be triggered by buttons with fixed messages or by control types that provide variable values. Additionally, the app provides an OSC API that allows remote control of the interface's theme, state, and labels.

  7. Overview of the Madrix 5 Module

    The Madrix 5 module enables control of Madrix 5 LED mapping software through its HTTP API. It allows developers to manage the live state of Deck A, Deck B, and the Master Output. The module can be integrated into process flows via the Process Editor and can be linked to the Madrix 5 Colour Picker interface component for real-time user interaction.

  8. Overview of Ctrl Engine functionality

    Ctrl Engine is the central processing core of the Ctrl Suite. It is designed to run on macOS and Windows as a lightweight service for high stability and reliability. Its primary responsibilities include:

    • Running workspaces created in Ctrl Designer 24/7.
    • Processing all system I/O and data.
    • Coordinating user interfaces running on Ctrl Player.
    • Providing a web UI to trigger actions for testing purposes.

    Key features include an inbuilt watchdog for automatic process restarts in fault situations and the ability to be configured to run at computer startup.

  9. Overview of Ctrl Designer capabilities

    Ctrl Designer is a free authoring tool used to build workspaces that are synced to a licensed Ctrl Engine. It allows developers to:

    • Define input and output protocols.
    • Select device modules from the Ctrl Suite pre-defined modules library.
    • Create visual and code-based Processes to trigger 3rd party devices.
    • Define monitors to detect network connectivity of devices.
    • Design and configure customizable user interfaces.

  10. Overview of CommsKit protocol testing

    CommsKit is a protocol testing and monitoring application available for macOS and Windows, specifically designed for the entertainment and installation industries. It provides a single interface to test and monitor multiple protocols, including MIDI, OSC, HTTP, UDP, TCP, Art-Net, and sACN.

  11. Overview of CTRL Designer Code Process API components

    The CTRL Designer Code Processes API provides a structured set of classes and enumerations for building process logic. The API is organized into the following categories:

    • Enumerations: Core constants such as ConnectivityProtocol, OperatorType, and ProcessBlockType.
    • Root Controller Classes: Top-level management classes like EngineInstance and ProcessController.
    • Controller Classes: Engine-specific components including EngineAction, EngineChannel, EngineContext, and EngineProcess.
    • Control Classes: Functional blocks for state and timing, such as Counter, Delay, Interval, Latch, and Toggle.
    • Event Classes: Trigger mechanisms including Cron, SolarEvent, Time, and WorkspaceStart.
    • Logic Classes: Boolean and logical operators such as AND, OR, XOR, NAND, and NOR.
    • Math Classes: Arithmetic operations including Addition, Subtraction, Multiplier, Divider, and rounding functions.
    • Parser Classes: Data transformation blocks for various protocols and formats, including JSONParser, HTTPParser, MQTTParser, TCPParser, UDPParser, and StringParser.
    • Render Classes: Interface and control rendering components like RenderBlock and RenderInterface.
    • Type Aliases: Configuration options and type definitions such as CounterOpts, CronOpts, and ProcessType.

  12. Overview of Ctrl for iPad output protocols and modules

    Ctrl for iPad allows users to assign output commands to controls in edit mode. Multiple commands can be assigned to a single control to be fired or modulated simultaneously. The application supports user-defined strings via several network and hardware protocols, as well as integrated Modules for advanced 3rd party hardware/software integration (such as media server thumbnails, media pickers, and audio playlist selection).