API Documentation

Overview

The Dashboards application is part of the Opal One software suite developed by OPAL-RT. This software suite comes with a REST API (HTTP protocol) to ensure communication between the UI (User Interface) and the backend server.

The Extended Python API for Dashboards is a wrapper on top of that REST API. It allows interaction with the backend server using a Python script. This Python script takes the role of “yet another client”, just like the Dashboards UI.

The main goal of having a Python client is to automate interactions with the backend server. This allows the user to rapidly and programmatically create panels, widgets, connections and so on.

The Python API Documentation is available with Dashboards via the Help menu. It will open a browser page that would access to all documented APIs and onboarding examples that are up-to-date with your current Opal One software.

Documentation for older versions

Opal One software released before 2025.2 included doesn’t embeds Python API Documentation. So, we provide here the documentation for Opal One software released from 2024.1 to 2025.2.

Download the documentation here:
Unzip the folder and open the index.html file to view it.

Installation

The installation of Dashboards includes a set of Python wheels that can be installed in the Python environment of your choice. The details are in the usage page of the attached documentation.

Example scripts

Example can be found in the example page of the documentation.