Skip to content

Commit d10b09c

Browse files
committed
update of README, user guide, examples & ready-made tfs
1 parent 0c7f068 commit d10b09c

File tree

4 files changed

+25
-15
lines changed

4 files changed

+25
-15
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ So far, functionality has been implemented for:
88

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

1214
_Predefined circuits are also included, ex. PI, PD and PID controllers_
1315

1416
## Motivation
1517

16-
The motivation behind Controllio is to provide a fast web-based open-source drafting table for studying control systems, which:
18+
The motivation behind Controllio is to create an open-source drafting table for studying control systems, which:
1719

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

2123
## Try it out
@@ -24,7 +26,7 @@ The app is deployed here: https://istefanis.github.io/controllio
2426

2527
## User Guide
2628

27-
It is included in the web app
29+
A user guide is included in the web app
2830

2931
## License
3032

model/tests/circuitExamples.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export const circuit1 = (block1) => {
100100
new Ratio(new Polynomial("s", [2]), new Polynomial("s", [1, 1])),
101101
block1
102102
);
103-
const tf2 = tf([1, 2, 5], [8], block1);
103+
const tf2 = tf([10, 2, 5], [8, -1, 1], block1);
104104
const tf2p = tf([1], [8], block1);
105105
const tf3 = tf([1, 2, 5], [8], block1);
106106
const tf4 = tf([1], [4], block1);

view/services/feature/readyMadeTfCreationService.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,13 @@ export const openNewReadyMadeTfPopupWindow = async function (
6666
// Init
6767
//
6868
const init = function () {
69-
readyMadeTfsArray.push(["Integrator", [1], [1, 0]]);
70-
readyMadeTfsArray.push(["Sine", [1], [1, 0, 0]]);
69+
readyMadeTfsArray.push(["Integrator / step", [1], [1, 0]]);
70+
readyMadeTfsArray.push(["Exponential decay", [1], [1, 0.2]]);
71+
readyMadeTfsArray.push(["Sine", [1], [1, 0, 1]]);
7172
readyMadeTfsArray.push(["Phase delay", [5, 1], [8, 1]]);
72-
readyMadeTfsArray.push(["PI Controller", ["kp", "ki"], [1, 0]]);
73-
readyMadeTfsArray.push(["PD Controller", ["kd", "kp"], [1]]);
74-
readyMadeTfsArray.push(["PID Controller", ["kd", "kp", "ki"], [1, 0]]);
73+
readyMadeTfsArray.push(["PI controller", ["kp", "ki"], [1, 0]]);
74+
readyMadeTfsArray.push(["PD controller", ["kd", "kp"], [1]]);
75+
readyMadeTfsArray.push(["PID controller", ["kd", "kp", "ki"], [1, 0]]);
7576
};
7677

7778
init();

view/services/feature/userGuideService.js

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,20 @@ const init = function () {
3535
<div class="popup-window-tab-contents tab-contents">
3636
<section class="tab-content" id="popup-window-tab-content-1">
3737
<h3>General</h3>
38-
<p>Controllio is an open-source web app, which lets Control Systems engineers design & study LTI (linear time-invariant) dynamical systems - from PID controllers to complex multipart systems.</p>
39-
<p>It can perform tasks such as:</p>
38+
<p>Controllio is an open-source web app which lets Control Systems engineers design & experiment with LTI (linear time-invariant) dynamical systems online.</p>
39+
<p>So far, functionality has been implemented for:</p>
4040
<ul>
4141
<li>the analytical computation of the overall transfer function (tf) of a system modeled by interconnected elements in the s-domain</li>
42-
<li>the generation of its Bode and Nyquist plot</li>
42+
<li>the generation of its Bode and Nyquist plots</li>
43+
<li>the numerical computation of its time response plot</li>
44+
<li>the numerical computation of its zeros/poles & some characteristic numbers, ex. bandwidth</li>
4345
</ul>
4446
<h3>Motivation</h3>
45-
<p>The motivation behind Controllio is to provide a fast web-based app for experimenting with control systems using either a desktop or a mobile device, which is also open-source and written in a widely-used programming language.</p>
47+
<p>The motivation behind Controllio is to create an open-source drafting table for studying control systems, which:</p>
48+
<ul>
49+
<li>runs on the browser without any installation, is fast and mobile-friendly</li>
50+
<li>is written in a widely-used programming language (vanilla Javascript), and can be easily extended</li>
51+
</ul>
4652
<h3>License</h3>
4753
<p>Controllio is distributed under the MIT License, included in the 'LICENCE.TXT' file.</p>
4854
</section>
@@ -64,9 +70,10 @@ const init = function () {
6470
<h3>Ready-made tfs</h3>
6571
<h4>Simple components</h4>
6672
<ul>
67-
<li>Integrator</li>
73+
<li>Integrator / step</li>
74+
<li>Exponential decay</li>
6875
<li>Sine</li>
69-
<li>Phase delay circuit</li>
76+
<li>Phase delay</li>
7077
</ul>
7178
<h4>Controllers</h4>
7279
<ul>

0 commit comments

Comments
 (0)