Controllio

Controllio is a web app which lets Control Systems engineers design & experiment with LTI (linear time-invariant) dynamical systems.

So far, functionality has been implemented for:

• the analytical computation of the overall transfer function (tf) of a system modeled by interconnected elements in the s-domain
• the generation of its Bode and Nyquist plots
• the numerical computation of its time response plot
• the numerical computation of its zeros/poles & some characteristic numbers, ex. bandwidth
• the numerical computation of its stability

This is a web GUI tool. For a command-line one, check the lti-freq-domain-toolbox

Motivation

The motivation behind Controllio is to create an open-source tool for studying Control Systems, which:

• runs in the browser without any installation, is fast and mobile-friendly
• is written in a widely-used programming language (vanilla Javascript), and can be easily extended

Technical details

Circuit simplification

• A set of 6 simplication algorithms to compute analytically its overall transfer function

Numerical algorithms

• Polynomial complex roots: Weierstrass / Durand-Kerner algorithm
• Laplace inversion: Talbot algorithm

Topology optimization

• A stochastic algorithm to simplify the circuit's topology

Ready-made components

• Utilities: integrator / step, exponential decay, sine, phase delay
• Filters: Butterworth
• Controllers: PI, PD, PID

User Guide

A User Guide is included in the web app, and can be launched from the main menu

Try it out

Online

• The app is deployed here

Locally with CDN (default)

1. Download the repo

2. Load the app using a development server

Locally with NPM

1. Install Node.js® if you don't have it

2. Download the repo

3. Search the codebase for the string to run with NPM (4 occurences excluding this one). Follow the respective guideline in each occurence to slightly modify the code, so that it uses NPM dependencies

4. Open your terminal at the main project directory, and run npm install to download the dependencies locally

5. Run npm start to load the app via Parcel (stop via Ctrl+C)

Tests

Run without a framework (default)

1. Open the browser's console, and run await runAllTests()

Run with Jest

1. Install Node.js® if you don't have it

2. If you have previously run the app locally with NPM, make sure all NPM-related code changes (4 occurences) are reverted (see above)

3. Open your terminal at the main project directory, and run npm install to download the dependencies locally, if you haven't done it already

4. Run npm test to execute the tests via Jest

Current test coverage according to Jest: 66% (statements)

Code Structure

The project uses a simplified variation of the MVC pattern, organizing code into model and view parts:

• /model/ contains all code modeling the circuit elements, state & functionality:
  • the definitions of the main circuit elements (tf, adder, block), as JS classes
  • the circuit/block simplification algorithms' logic
  • the services related to the circuit state & core functionality (ex. elementConnectionService)
• /view/ contains all code related to the visual part of the app & its UI:
  • the views of the main circuit elements (ex. tfView) & all other UI components (ex. navbarView)
  • the core rendering & UI services (ex. elementRenderingService, elementSelectingAndDraggingService)
  • the app features' services (ex. optimizeTopologyService)
  • the animations' rendering code
  • the plot computations & rendering code
  • the CSS styles

In addition:

• /assets/ contains any other resources used (ex. libraries, images)
• /math/ contains the math services (ex. complexAnalysisService)
• /test/ contains the app's tests
• /util/ contains any general-purpose utility code & services (ex. loggingService)

License

Controllio is distributed under the MIT License, included in the 'LICENSE.TXT' file. Copyright (C) 2023-2024 Ioannis Stefanis