SZARP http://www.szarp.org

System SZARP - dokumentacja techniczna

SZARP v.3.1

Niniejszy dokument opisuje różne zagadnienia związane z systemem SZARP, nieinteresujące z punktu widzenia zwykłego użytkownika. Jest przeznaczony dla osób rozwijających aplikacje czy też konfigurujących system.

$Id$

Michał Blajerski

Sławomir Chyłek

Marcin Goliszewski

Jarosław Janik

Paweł Kolega

Daniel Majewski

Dariusz Marcinkiewicz

Paweł Pałucha

Adam Smyk


Spis treści
1. Instalacja systemu SZARP
1.1. Wymagane biblioteki i programy
1.2. Kompilacja i instalacja systemu
1.3. Instalacja pakietów binarnych
1.3.1. Przygotowanie systemu
1.3.2. Wybór roli
1.3.3. Aktualizacja pakietów
1.3.4. Opis pakietów
1.4. Struktura katalogów
1.5. Konfiguracja w środowisku KDE albo window managerze
1.6. Na skróty, czyli o czym pamiętać przy instalacji serwera/terminala systemu SZARP
2. Konfiguracja SZARP 2.1
2.1. Plik parcook.cfg
2.2. Pliki lineX.cfg
2.3. Plik PTT.act
2.4. Plik definable.cfg
2.5. Pliki konfiguracyjne programu draw
2.5.1. Struktura pliku ekrnxxxx.cor
2.5.2. Struktura okna
2.5.3. Struktura opisu osi
2.5.4. Struktura opisu wykresu
3. Program sender
3.1. Konfiguracja programu sender
3.2. Uruchamianie programu sender
3.3. Algorytm działania programu sender
4. Biblioteka libpar
4.1. Format pliku szarp.cfg
4.1.1. Opis ogólny
4.1.2. Sekcje
4.1.3. Parametry
4.1.4. Dyrektywy
4.1.5. Funkcje
4.1.6. Zmienne
4.2. Interfejs biblioteki
4.2.1. Inicjalizacja biblioteki
4.2.2. Odczytywanie wartości parametrów
5. IPK - konfiguracja systemu SZARP
5.1. Koncepcja
5.1.1. Po co nowy format konfiguracji
5.1.2. Założenia
5.2. Format pliku IPK
5.2.1. Struktura pliku
5.2.2. Element params
5.2.3. Element device
5.2.4. Elementy radio i unit
5.2.5. Element send
5.2.6. Element param
5.2.7. Element value
5.2.8. Element define
5.2.9. Element raport
5.2.10. Element draw
5.2.11. Element treenode
5.2.12. Przykłady elementów param
5.2.13. Elementy defined i drawdefinable
5.2.14. Elementy seasons oraz season
5.2.15. Elementy i atrybuty z innych przestrzeni nazw
5.3. Tworzenie i edycja konfiguracji
5.3.1. Używanie konfiguracji w formacie IPK
5.3.2. Narzędzia do plików XML
5.3.3. Konwersja konfiguracji SZARP 2.1 na IPK.
5.3.4. Konwersja konfiguracji IPK na SZARP 2.1
5.3.5. Weryfikacja poprawności konfiguracji
5.3.6. Tworzenie i używanie szablonów
5.3.7. Samodzielne tworzenie i edytowanie konfiguracji IPK
5.3.8. Określanie kolejności wykresów i raportów.
5.3.9. Program Edytor IPK
5.3.10. Spis narzędzi do IPK
5.4. IPK dla programistów
5.4.1. Interfejs biblioteki IPK
5.4.2. Korzystanie z parserów konfiguracji SZARP 2.1
5.4.3. Rozszerzanie IPK
5.5. Łączenie wielu konfiguracji w jedną
5.5.1. Koncepcja
5.5.2. Tworzenie i uaktualnianie konfiguracji
5.5.3. Plik konfiguracyjny
5.5.4. Szablony parametrów definiowalnych
6. Składnia formuł parametrów definiowalnych
6.1. Składnia formuł typu DRAWDEFINABLE
6.2. Składnia formuł typu RPN
6.3. Przykłady formuł definiowalnych DRAWDEFINABLE
6.4. Parametry definiowalne LUA
6.4.1. Wykaz predefiniowanych zmiennych
6.4.2. Wykaz dostępnych funkcji
6.4.3. Przykłady wpisów w params.xml
7. Obsługiwane urządzenia
7.1. Sterownik aqtdmn
7.2. Sterownik boruta_fc
7.3. Sterownik boruta_fp210
7.4. Sterownik boruta_lumel
7.5. Sterownik boruta_modbus
7.6. Sterownik boruta_modbus_z
7.7. Sterownik boruta_wmtp
7.8. Sterownik boruta_zet
7.9. Sterownik borutadmn
7.10. Sterownik calcdmn
7.11. Sterownik dbdmn
7.12. Sterownik ddedmn
7.13. Sterownik defdmn
7.14. Sterownik dpafdmn
7.15. Sterownik dprdmn
7.16. Sterownik execdmn
7.17. Sterownik iecdmn
7.18. Sterownik k601dmn
7.19. Sterownik kamsdmn
7.20. Sterownik kwmsdmn
7.21. Sterownik lbdmn
7.22. Sterownik lecmdmn
7.23. Sterownik mbdmn
7.24. Sterownik mbrtudmn
7.25. Sterownik mbtcpdmn
7.26. Sterownik mbusdmn
7.27. Sterownik melsdmn
7.28. Sterownik muksdmn
7.29. Sterownik npozytondmn
7.30. Sterownik nrsdmn
7.31. Sterownik pafdmn
7.32. Sterownik polludmn
7.33. Sterownik prodmn
7.34. Sterownik pythondmn
7.35. Sterownik ratedmn
7.36. Sterownik sampledmn
7.37. Sterownik sbusdmn
7.38. Sterownik setdmn
7.39. Sterownik snap7dmn
7.40. Sterownik tcpdmn
7.41. Sterownik testdmn
7.42. Sterownik wlkdmn
8. Format bazy SzarpBase
8.1. Format plików bazy
8.2. Konwersja bazy na nowy format
8.3. Program extrszb
8.4. Program szbedit
8.5. Import danych do bazy - program szbwriter
8.5.1. Konfiguracja programu
8.5.2. Dane wejściowe
9. Instrukcja obsługi programu meaner3
9.1. Konfiguracja programu
9.2. Wykonywanie zadań w programie meaner3
9.3. Parametry informacyjne programu
10. Import danych z regulatorów węzłów Samson (system InTouch) lub Mikrob (program PRO-2000)
11. BODAS - Baza Ogólnopolska Danych Archiwalnych Systemu SZARP
11.1. Koncepcja systemu
11.2. Realizacja BODASa
11.3. Konfiguracja BODASa do wysyłania danych z obiektu
12. Statusy modemów - opis zwracanych wartości.
12.1. Opis wartości
13. ISL
13.1. Biblioteka serwera HTTP
13.2. Konfiguracja serwera HTTP
13.3. Program paramd
13.3.1. Konfiguracja programu
13.3.2. Dostęp do zasobów serwera paramd
13.3.2.1. Dostęp do informacji o parametrach
13.3.2.2. Dostęp do informacji o raportach
13.3.3. Ustawianie wartości parametrów
13.3.4. Definiowanie własnych raportów
13.4. Wizualizacja z wykorzystaniem ISL - HOWTO
13.4.1. Opis działania
13.4.2. Instalacja i konfiguracja serwera ISL
13.4.3. Uruchomienie przykładowego schematu
13.4.4. Co można umieścić w schemacie
13.4.5. Edycja schematów w programie Inkscape
13.4.5.1. Instalacja wtyczki do edycji schematów ISL
13.4.5.2. Konfiguracja wtyczki - wybór konfiguracji
13.4.5.3. Tworzenie elementów tekstowych
13.4.5.4. Modyfikacja atrybutów elementów
14. Aplikacja SSS.
14.1. Krótki opis.
14.2. Konfiguracja programu.
14.3. Baza użytkowników.
14.4. Protokół SSS/SSC
14.5. Interfejs WWW do administracji użytkownikami
14.6. Serwer komentarzy (remarks server)
14.6.1. Konfiguracja
14.6.2. Baza danych
15. Komputery przenośne.
15.1. Spis treści
15.2. Krótki opis i wymagane biblioteki.
15.3. Konfiguracja.
15.4. Podstawy korzystania.
16. Tabela kodów ASCII
17. Instalacja DDE Proxy w systemie Windows
17.1. Opis instalacji aplikacji DDE Proxy na platformie Windows
Spis tabel
16-1. Tablica kodów ASCII
Spis rysunków
5-1. Przykładowy wygląd okna programu