This repository has been archived by the owner on Feb 28, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 26
/
README
198 lines (135 loc) · 6.72 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
SZARP - System Zbierania Archiwizacji i Prezentacji danych
==========================================================
http://www.szarp.org/
Copyright (C) 1991-2010 Witold Kowalewski Praterm Automatyzacja Ciepłownictwa
Copyright (C) 1995-2009 Praterm S.A.
Copyright (C) 1991-2018 various authors (see AUTHORS file)
Table of contents
-----------------
1. What is SZARP?
2. What does SZARP mean? How to pronounce it?
3. What are the features of SZARP?
4. What is the origin of SZARP?
5. On what platform is SZARP running?
6. How to install SZARP?
7. Where can I find documentation?
8. How can I get SZARP sources?
9. How to setup my first SZARP server?
10. How can I get help?
1. What is SZARP?
-----------------
SZARP is a full-featured SCADA system designed for monitoring slowly
changing industrial processes, for example operations of urban heating
systems. It is completely free software, published under terms of the GNU
General Public License 2.0 (or any later version).
2. What does SZARP mean? How to pronounce it?
---------------------------------------------
SZARP is an acronym for a Polish name: "System Zbierania ARchwizacji i
Prezentacji danych", which means "System for Data Acquisition, Archiving and
Presentation". Digraph "sz" in Polish is pronounced similarly to English "sh",
so "SZARP" should be pronounced as a word "sharp".
3. What are the features of SZARP?
----------------------------------
SZARP architecture is organized into three layers.
The first layer are device drivers. There are several drivers available,
including:
* Modbus RTU/TCP (master and slave)
* MBus
* Praterm ZET/Sterkom PLC
* Pollustat, Infocal and Kamstrup heating meters
* DDE (Dynamic Data Exchange) protocol
* communication with Python scripts through IPC
* importing data from text files and text output of programs
These device drivers are called "line daemons" (for historical reasons).
The second layer consist of data collecting daemons that read data from
drivers, calculate average probes and formulas (called "defined parameters")
and finally save data to SZARP database. Probes are generally available with
any predefined resolution using the sz4 database (e.g. 1s or 1ms). There
is also a web server available for serving parameters' values through HTTP.
In the third layer there are client programs, including:
* Raporter - a program for viewing current values of parameters.
* Reporter4 - as above, but for parameters from sz4 base.
* Controller - a program for signalizing parameters' values irregularities.
* Ekstraktor - a program for exporting data from databases to spreadsheet
files.
* Draw - a powerful tool for viewing and analyzing historical data.
More information about SZARP architecture is available in documentation.
4. What is the origin of SZARP?
-------------------------------
SZARP was developed since 1991 (sic!) by Praterm company and was used in
all heating systems (over 20) owned by Praterm and that much other systems
all over Poland. In 2007 Praterm decided to publish almost all of the code
under GNU GPL. Nowadays SZARP is developed as an Open Source project on
GitHub.
Project website is located at http://www.szarp.org/. Today, the main founder of
SZARP's development is Newterm (http://newterm.pl/) company.
5. On what platform is SZARP running?
-------------------------------------
SZARP is developed and deployed for Debian GNU/Linux and Raspbian, but should
compile and run on any modern Linux distribution on i386, amd64 and armel/armhf
architectures. Client applications should also run on Windows XP/Vista/7/10
machines with NTFS filesystem.
6. How to install SZARP?
------------------------
File INSTALL contains installation instructions.
7. Where can I find documentation?
----------------------
Unluckily most of the user documentation is available only in Polish. Sources
of documentation are in resources/documentation/new/ directory and available
online at http://szarp.org/en/docs. Most of the new code is pretty-well
documented (in English) using Doxygen.
8. How can I get SZARP sources?
-------------------------------
See http://www.szarp.org/en/download.
9. How to setup my first SZARP server?
---------------------------------------
First install szarp-server and szarp-wx packages (for details see
INSTALL):
apt-get install szarp-server szarp-wx
In a configuration stage, you have to set 4-letter name of a configuration
(called "configuration prefix"), for example use "test". Answer "yes" to a
question about creating 'szbase' directory. To use modern sz4 database backend,
select sz4 from the list of available databases.
Now look at the /etc/szarp directory. There are two files:
* parstart.cfg - obsolete. To choose which services will be run,
do: dpkg-reconfigure szarp-server, which will create systemd service links
* szarp.cfg - this is a SZARP system configuration file. There are a lot of
available options, but for now you only need to set configuration prefix.
Modify the beginning of the file so it looks like this:
$if $prefix$=""
$prefix$:="test"
# $prefix$:=exec("hostname -s")
$end
($prefix$ variable should be set to "test")
If all above is done, you have to prepare SZARP parameters configuration. We
will make configuration with one line daemon that polls system for average
load. Go to the directory /opt/szarp/test and create subdirectory called
'config'. Place there a file named 'params.xml' with the following content:
<?xml version="1.0" encoding="utf-8"?>
<params xmlns="http://www.praterm.com.pl/SZARP/ipk" xmlns:exec="http://www.praterm.com.pl/SZARP/ipk-extra" version="1.0" read_freq="10" send_freq="10" title="Test configuration">
<device daemon="/opt/szarp/bin/execdmn" path="/opt/szarp/test/get_la.sh" exec:frequency="10">
<unit id="1" type="1" subtype="1" bufsize="1">
<param name="Test:System:average system load" short_name="lavg" unit="-" prec="2" base_ind="auto">
<raport title="System report" order="1"/>
<draw title="System" min="0" max="100" order="1"/>
</param>
</unit>
</device>
</params>
Then, in directory /opt/szarp/test/config run command:
/opt/szarp/bin/i2smo
(this parses XML configuration, if every thing is ok, you should see "OK")
Prepare an executable script /opt/szarp/test/get_la.sh with the following
content:
#!/bin/bash
cat /proc/loadavg | cut -d ' ' -f 1 | tr -d '.'
Save it and restart SZARP services:
systemctl restart szarp-server.target
And that's all, you should be able to point your browser to
http://localhost:8081 and see your configured
parameter. You can also run Draw3 program:
/opt/szarp/bin/draw3
and analyze your system average load.
10. How can I get help?
--------------------
You can try to write us at <coders@newterm.pl>.