Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

9 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

synoptic-studio-spec

The specifications of Synoptic Studio, the open source desktop application to create and edit synoptics (animated process views of an industrial installation).

Status: the Metadata part is validated by the Product Owner (2026-11-11). The other parts are not written yet.

What Synoptic Studio is

Synoptic Studio lets a company model its installation and build synoptics animated in JavaScript, without a SCADA. It replaces only the visual part of a SCADA: creating a view and displaying it. The company wires its own controllers to the displayed view.

It is also a tool to specify an installation and to help the people who simulate a whole circuit: the signals of a type define in advance what simulation models connect to.

flowchart LR
    PLC["Controllers and boards (the company's own)"] -->|"signals"| SS
    subgraph SS["Synoptic Studio"]
        ED["Editor: model the installation, build views"]
        RT["Runtime: displays the views (open question)"]
        ED -->|"view file format"| RT
    end
    SS --> U["Operators see the animated view"]
Loading

Read the full story in the introduction.

The three parts of the application

The Product Owner splits the application in three parts. Only the first one is specified so far.

flowchart TD
    APP["Synoptic Studio (open source application)"]
    APP --> MD["Part 1: Metadata, specified and validated"]
    APP --> P2["Part 2: to describe"]
    APP --> P3["Part 3: to describe"]
    APP --> ST["Storage: how every part reads and writes its files"]
    MD --> MD1["Types, icons, documentation"]
    MD --> MD2["Signals, units, enums"]
    MD --> MD3["Commands, faceplates, presets, libraries"]
Loading

Where to read

Folder What it holds Start with
overview/ The general presentation of the software. Introduction
metadata/ Part 1 of the application: the data and documentation a symbol can be attached to. Metadata overview
storage/ The folder the application points to, the generated files, and how conflicts between people are avoided. Files and conflicts

Metadata pages, in reading order:

  1. What a type is: Types, Icons, Documentation.
  2. The model side: Signals, Units, Enums.
  3. The front side: Commands, Faceplates, Presets.
  4. How it is used: Libraries, Who changes what.
  5. What is left to decide: Open questions.

What it does not contain

  • No application code.
  • Nothing beyond the open source application.

Folder rule

Every folder created here has its own README.md that says what it contains.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors