Skip to content

Commit 16f7789

Browse files
darkmattercoderdarkmattercoder
committed
Added usage instructions and some l10n
* Added Help and about dialogs * Added corresponding menu entries for usage as well as for about dialogs
1 parent 99027ba commit 16f7789

15 files changed

+346
-83
lines changed

‎README

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PLC Analyzer 1.0
22
===========
33

44
PLC Analyzer gives you a possibility to display and record values read out from a plc.
5-
Using libnodave you are able to connect to most SIEMENS S5 and S7 PLC.
5+
Using libnodave you are able to connect to most SIEMENS S5 and S7 PLCs.
66

77
Programm is tested on Windows 7 and Linux (Ubuntu 12.04).
88

@@ -18,3 +18,9 @@ Run it by executing either "plcanalyzer.exe" or "./plcanalyzer".
1818
== Usage ==
1919

2020
You can find a small program description in the "USAGE"-File in the Directory as well as by chosing the "Help"-menu entry.
21+
22+
== Additional notes ==
23+
24+
Please note that plc analyzer is a young software project which might have some nasty glitches here and there and therefore
25+
should only be used in a safe environment. If you are using it in a productional environment, you have to have explicit
26+
knowledge of what you are doing.

‎USAGE

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
== Usage instructions ==
2+
3+
On startup you will see a window where you have different elements.
4+
If you ran the program before, you might notice that there are some operand value fields visible in the main window.
5+
Those value fields are saved on any program close event and restored on startup.
6+
7+
You get three buttons at the top of the window:
8+
9+
* "Connection settings" gives you a nice UI where you can make your desired connection settings as well as specify the operands
10+
that you want to read
11+
* "Connect" makes the application try to connect to a physically present PLC. The Button reads "Disconnect" when connected
12+
* "Read slots" triggers the value reading from the PLC when triggered. Once pressed, the graph display in the middle of the
13+
window will start to display a graphical representation of whatever it reads. The current values are displayed as well in the
14+
value fields in the lower right.
15+
16+
Under the graph display you find an auto scale-button to rescale a graph if needed. With the "duration"-field you can specify the
17+
time shown on one bottom axis length.
18+
19+
Right beside you find a button which cleans the graph display.
20+
21+
The Log window at the bottom of the main window shows you some debug information.
22+
23+
The "File"-menu entry allows you to open and save a project as well as create a new one.
24+
The Help entry shows this documentation.
25+
26+
27+
Have Fun!
28+
29+
Added usage instructions and some l10n
30+
* Added corresponding menus for them

‎aboutDialog.ui

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ui version="4.0">
3+
<class>AboutPLCAnalyzer</class>
4+
<widget class="QDialog" name="AboutPLCAnalyzer">
5+
<property name="geometry">
6+
<rect>
7+
<x>0</x>
8+
<y>0</y>
9+
<width>274</width>
10+
<height>264</height>
11+
</rect>
12+
</property>
13+
<property name="windowTitle">
14+
<string>About PLC Analyzer</string>
15+
</property>
16+
<widget class="QLabel" name="label">
17+
<property name="geometry">
18+
<rect>
19+
<x>10</x>
20+
<y>10</y>
21+
<width>231</width>
22+
<height>16</height>
23+
</rect>
24+
</property>
25+
<property name="font">
26+
<font>
27+
<pointsize>16</pointsize>
28+
<weight>75</weight>
29+
<italic>true</italic>
30+
<bold>true</bold>
31+
</font>
32+
</property>
33+
<property name="text">
34+
<string>About PLC Analyzer</string>
35+
</property>
36+
</widget>
37+
<widget class="QTextBrowser" name="textBrowser">
38+
<property name="geometry">
39+
<rect>
40+
<x>10</x>
41+
<y>30</y>
42+
<width>256</width>
43+
<height>192</height>
44+
</rect>
45+
</property>
46+
<property name="html">
47+
<string>&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.0//EN&quot; &quot;http://www.w3.org/TR/REC-html40/strict.dtd&quot;&gt;
48+
&lt;html&gt;&lt;head&gt;&lt;meta name=&quot;qrichtext&quot; content=&quot;1&quot; /&gt;&lt;style type=&quot;text/css&quot;&gt;
49+
p, li { white-space: pre-wrap; }
50+
&lt;/style&gt;&lt;/head&gt;&lt;body style=&quot; font-family:'Ubuntu'; font-size:11pt; font-weight:400; font-style:normal;&quot;&gt;
51+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;This application was first developed in 2013 by Lukas Kern, Carsten Klein and Jochen Bauer as a project in the class &amp;quot;Programming II&amp;quot; in the M.Sc. Course in the department of electrical engineering at the University of applied science Saarbrücken (HTW Saar).&lt;/p&gt;
52+
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
53+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;(c) 2013, Lukas Kern, Carsten Klein, Jochen Bauer&lt;/p&gt;
54+
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
55+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;Special thanks to Thomas Hergenhahn and its libnodave communication library! &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
56+
</property>
57+
</widget>
58+
<widget class="QPushButton" name="pushButton">
59+
<property name="geometry">
60+
<rect>
61+
<x>80</x>
62+
<y>230</y>
63+
<width>98</width>
64+
<height>27</height>
65+
</rect>
66+
</property>
67+
<property name="text">
68+
<string>Close</string>
69+
</property>
70+
</widget>
71+
</widget>
72+
<resources/>
73+
<connections>
74+
<connection>
75+
<sender>pushButton</sender>
76+
<signal>clicked()</signal>
77+
<receiver>AboutPLCAnalyzer</receiver>
78+
<slot>close()</slot>
79+
<hints>
80+
<hint type="sourcelabel">
81+
<x>128</x>
82+
<y>243</y>
83+
</hint>
84+
<hint type="destinationlabel">
85+
<x>136</x>
86+
<y>131</y>
87+
</hint>
88+
</hints>
89+
</connection>
90+
</connections>
91+
</ui>

‎connectionsettings.ui

+44-44
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
</font>
9696
</property>
9797
<property name="text">
98-
<string>Operanden</string>
98+
<string>Operands</string>
9999
</property>
100100
</widget>
101101
</item>
@@ -143,7 +143,7 @@
143143
<item row="1" column="0">
144144
<widget class="QLabel" name="label_8">
145145
<property name="text">
146-
<string>Speicherbereich</string>
146+
<string>Memory area</string>
147147
</property>
148148
</widget>
149149
</item>
@@ -204,14 +204,14 @@
204204
<item row="1" column="3">
205205
<widget class="QLabel" name="label_9">
206206
<property name="text">
207-
<string>Adresse</string>
207+
<string>Address</string>
208208
</property>
209209
</widget>
210210
</item>
211211
<item row="1" column="5">
212212
<widget class="QLabel" name="label_10">
213213
<property name="text">
214-
<string>Repräsentation</string>
214+
<string>Representation</string>
215215
</property>
216216
</widget>
217217
</item>
@@ -335,7 +335,7 @@
335335
<item row="1" column="1">
336336
<widget class="QLabel" name="label_15">
337337
<property name="text">
338-
<string>Größe</string>
338+
<string>Size</string>
339339
</property>
340340
</widget>
341341
</item>
@@ -359,19 +359,29 @@
359359
</font>
360360
</property>
361361
<property name="text">
362-
<string>Einstellungen</string>
362+
<string>Settings</string>
363363
</property>
364364
</widget>
365365
<widget class="QWidget" name="layoutWidget">
366366
<property name="geometry">
367367
<rect>
368-
<x>13</x>
369-
<y>63</y>
368+
<x>16</x>
369+
<y>62</y>
370370
<width>261</width>
371-
<height>178</height>
371+
<height>161</height>
372372
</rect>
373373
</property>
374374
<layout class="QGridLayout" name="gridLayout_2">
375+
<item row="4" column="1">
376+
<widget class="QLineEdit" name="lineEdit_local_MPI">
377+
<property name="toolTip">
378+
<string>0 - 127</string>
379+
</property>
380+
<property name="alignment">
381+
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
382+
</property>
383+
</widget>
384+
</item>
375385
<item row="5" column="1">
376386
<widget class="QLineEdit" name="lineEdit_Rack">
377387
<property name="toolTip">
@@ -395,28 +405,7 @@
395405
<item row="3" column="0">
396406
<widget class="QLabel" name="label_3">
397407
<property name="text">
398-
<string>Geschwindigkeit</string>
399-
</property>
400-
</widget>
401-
</item>
402-
<item row="5" column="0">
403-
<widget class="QLabel" name="label_6">
404-
<property name="text">
405-
<string>Rack</string>
406-
</property>
407-
</widget>
408-
</item>
409-
<item row="4" column="0">
410-
<widget class="QLabel" name="label_4">
411-
<property name="text">
412-
<string>Lokale MPI</string>
413-
</property>
414-
</widget>
415-
</item>
416-
<item row="1" column="0">
417-
<widget class="QLabel" name="label_5">
418-
<property name="text">
419-
<string>CPU MPI</string>
408+
<string>Speed</string>
420409
</property>
421410
</widget>
422411
</item>
@@ -474,17 +463,35 @@
474463
<item row="0" column="0">
475464
<widget class="QLabel" name="label">
476465
<property name="text">
477-
<string>Protokoll</string>
466+
<string>Protocol</string>
478467
</property>
479468
</widget>
480469
</item>
481-
<item row="0" column="1">
482-
<widget class="QComboBox" name="ComboBox_Protokoll"/>
470+
<item row="5" column="0">
471+
<widget class="QLabel" name="label_6">
472+
<property name="text">
473+
<string>Rack</string>
474+
</property>
475+
</widget>
476+
</item>
477+
<item row="4" column="0">
478+
<widget class="QLabel" name="label_4">
479+
<property name="text">
480+
<string>Locale MPI</string>
481+
</property>
482+
</widget>
483+
</item>
484+
<item row="1" column="0">
485+
<widget class="QLabel" name="label_5">
486+
<property name="text">
487+
<string>CPU MPI</string>
488+
</property>
489+
</widget>
483490
</item>
484491
<item row="2" column="0">
485492
<widget class="QLabel" name="label_2">
486493
<property name="text">
487-
<string>IP-Adresse</string>
494+
<string>IP-Address</string>
488495
</property>
489496
</widget>
490497
</item>
@@ -511,15 +518,8 @@
511518
</property>
512519
</widget>
513520
</item>
514-
<item row="4" column="1">
515-
<widget class="QLineEdit" name="lineEdit_local_MPI">
516-
<property name="toolTip">
517-
<string>0 - 127</string>
518-
</property>
519-
<property name="alignment">
520-
<set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
521-
</property>
522-
</widget>
521+
<item row="0" column="1">
522+
<widget class="QComboBox" name="ComboBox_Protokoll"/>
523523
</item>
524524
</layout>
525525
</widget>

‎filestream.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/******************************************************************************
2-
* *File: filestream.h *
3-
* *Date: 2013-09-26 *
2+
* *File: filestream.cpp *
3+
* *Date: 2013-09-29 *
44
* *Version: 1.0 *
55
* *Author(s): Carsten Klein <[email protected]> *
66
* Jochen Bauer <[email protected]> *

‎help.ui

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ui version="4.0">
3+
<class>Help</class>
4+
<widget class="QWidget" name="Help">
5+
<property name="geometry">
6+
<rect>
7+
<x>0</x>
8+
<y>0</y>
9+
<width>488</width>
10+
<height>267</height>
11+
</rect>
12+
</property>
13+
<property name="windowTitle">
14+
<string>Help</string>
15+
</property>
16+
<widget class="QTextBrowser" name="textBrowser">
17+
<property name="enabled">
18+
<bool>true</bool>
19+
</property>
20+
<property name="geometry">
21+
<rect>
22+
<x>4</x>
23+
<y>2</y>
24+
<width>481</width>
25+
<height>231</height>
26+
</rect>
27+
</property>
28+
</widget>
29+
<widget class="QPushButton" name="pushButton">
30+
<property name="geometry">
31+
<rect>
32+
<x>190</x>
33+
<y>240</y>
34+
<width>98</width>
35+
<height>20</height>
36+
</rect>
37+
</property>
38+
<property name="text">
39+
<string>Close</string>
40+
</property>
41+
</widget>
42+
</widget>
43+
<resources/>
44+
<connections>
45+
<connection>
46+
<sender>pushButton</sender>
47+
<signal>clicked()</signal>
48+
<receiver>Help</receiver>
49+
<slot>close()</slot>
50+
<hints>
51+
<hint type="sourcelabel">
52+
<x>238</x>
53+
<y>249</y>
54+
</hint>
55+
<hint type="destinationlabel">
56+
<x>243</x>
57+
<y>133</y>
58+
</hint>
59+
</hints>
60+
</connection>
61+
</connections>
62+
</ui>

0 commit comments

Comments
 (0)