Designer Plugins

Overview

The Designer Plugin system provides a flexible framework that allows users to create HTML frontends that interact seamlessly with the Designer software. With this system, developers can extend the core functionality of Designer by integrating customized workflows, real-time data visualization, and interactive controls. Plugins are powered by Python scripts that execute within a controlled environment, enabling communication between Designer and external services or devices. This integration empowers developers to enhance the user experience and add unique features to their projects.

Plugin Types

Designer plugins can be categorized into two main types:

Local: Plugins found locally in the Plugins folder within the project folder (internal plugins)

Remote: Plugins discovered through DNS-SD (network-based plugins)

Discovery

Designer Plugins served remotely are discovered using DNS Service Discovery (DNS-SD). The expected service name format is: ._d3plugin._tcp., where instance is the name of the service and domain is usually local Disguise plugins are distinguished from other services based on the service type of the SRV record: _d3plugin._tcp

Metadata

Plugins must specify their type (“python” or “web”) through metadata by adding a TXT record to the DNS service registration:

pluginType=web

Remote plugins of type web can be opened. Disguise will open the resolved hostname:port in a web browser widget.

Window size

For web plugins, window size metadata is supported.

<meta name="disguise-plugin-window-size" content="512,512">
<meta name="disguise-plugin-window-min-size" content="200,200">
<meta name="disguise-plugin-window-resizable" content="true">

Plugin Backend Emphasis

The plugin architecture follows a frontend-backend separation principle, ensuring that different responsibilities are clearly delineated:

• Frontend Responsibilities: The HTML interface handles user interactions, displays real-time data, and sends commands to the backend. All UI elements and animations should be implemented using JavaScript frameworks such as Vue.js or React.
• Backend Responsibilities: The backend processes data, executes long-running tasks, and provides APIs for communication. This can be implemented in any language, as long as it can exchange data with the frontend effectively.
• Communication Methods: To maintain an interactive experience, data exchange between the frontend and backend can be performed using:
  • WebSockets for real-time bi-directional communication.
  • Server-Sent Events (SSE) for streaming updates efficiently.
  • REST APIs for standard request-response operations.
  • MQTT or OSC for low-latency event propagation in specialized use cases.

Control of your own device

Since plugins are running and hosted outside of Designer, they can use any of the device’s capabilities via APIs. The power of plugins is to link these functions to Designer in a user interface widget that users can interact with as part of their Designer workflow. An imagined, a device manufacturer will design and host their own Designer plugin within their device, publishing it via DNS-SD to Disguise users.

Designer Control

It is envisaged that for the majority of applications, plugins will interface with Designer via the regular API. This provides fully crafted APIs which can be used to control and monitor Designer. Please see working with sessions for more details on how to work with sessions and directors.

Function Calling

For specific functionality, functions can be called within Designer using a python console, via a web API. Details can be found in the Function Calling page.

Support for Designer Plugins can be found by contacting support@disguise.one for general Disguise support.