SZARP

http://www.szarp.org

System SZARP - dokumentacja techniczna

SZARP v.3.0

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: ipk.sgml 6720 2009-05-13 14:18:44Z koder $

Michał Blajerski

Sławomir Chyłek

Marcin Goliszewski

Jarosław Janik

Paweł Kolega

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 analysis
5.2.12. Przykłady elementów param
5.2.13. Elementy defined i drawdefinable
5.2.14. Elementy boilers oraz boiler
5.2.15. Element interval
5.2.16. Elementy seasons oraz season
5.2.17. 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. Format bazy SzarpBase

7.1. Format plików bazy

7.2. Konwersja bazy na nowy format

7.3. Program extrszb

7.4. Program szbedit

7.5. Import danych do bazy - program szbwriter

7.5.1. Konfiguracja programu
7.5.2. Dane wejściowe

8. Instrukcja obsługi programu meaner3

8.1. Konfiguracja programu
8.2. Wykonywanie zadań w programie meaner3
8.3. Parametry informacyjne programu

9. Import danych z regulatorów węzłów Samson (system InTouch) lub Mikrob (program PRO-2000)

10. BODAS - Baza Ogólnopolska Danych Archiwalnych Systemu SZARP

10.1. Koncepcja systemu
10.2. Realizacja BODASa push
10.3. Konfiguracja BODASa push
10.4. Szczegóły konfiguracji
10.5. BODAS pull

11. Statusy modemów - opis zwracanych wartości.

11.1. Opis wartości

12. ISL

12.1. Biblioteka serwera HTTP

12.2. Konfiguracja serwera HTTP

12.3. Program paramd

12.3.1. Konfiguracja programu

12.3.2. Dostęp do zasobów serwera paramd

12.3.2.1. Dostęp do informacji o parametrach
12.3.2.2. Dostęp do informacji o raportach

12.3.3. Ustawianie wartości parametrów

12.3.4. Definiowanie własnych raportów

12.4. Wizualizacja z wykorzystaniem ISL - HOWTO

12.4.1. Opis działania

12.4.2. Instalacja i konfiguracja serwera ISL

12.4.3. Uruchomienie przykładowego schematu

12.4.4. Co można umieścić w schemacie

12.4.5. Edycja schematów w programie Inkscape

12.4.5.1. Instalacja wtyczki do edycji schematów ISL
12.4.5.2. Konfiguracja wtyczki - wybór konfiguracji
12.4.5.3. Tworzenie elementów tekstowych
12.4.5.4. Modyfikacja atrybutów elementów

13. Environs

13.1. Krótki opis i zasada działania environs'a.
13.2. Instalacja
13.3. Backupowanie danych
13.4. Odzyskiwanie danych.
13.5. Wypalanie backup'ów.
13.6. Dodatki, zagadnienia zaawansowane.

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

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. Szarp VPN

16.1. Krótki opis

16.2. Instalacja

16.2.1. Instalacja na serwerze
16.2.2. Instalacja na kliencie

16.3. Bezpieczne repozytorium apt

17. Uniwersalny daemon do komunikacji z urządzeniami w protokole M-Bus

17.1. Konfiguracja
17.2. Badanie konfiguracji nowo podłączanego urządzenia

18. Daemon do odczytu danych ze stacji meteorologicznej Davis Vantage Pro

18.1. Konfiguracja wlkdmn
18.2. Eksport danych z plików WLK

19. Tabela kodów ASCII

Spis tabel
19-1. Tablica kodów ASCII

Spis rysunków
5-1. Przykładowy wygląd okna programu