5.2.2. Element params

Nadrzędnym elementem jest element params. Zawiera on informację o wersji IPK (aktualnie 1.0), tytuł konfiguracji i okresy (w sekundach), co ile odbywa się odpytywanie sterowników o dane (przez demony linii) i wysyłanie danych przez program sender. Tytuł konfiguracji będzie widoczny jako tytuł okna programu przeglądającego. Do prawidłowego działania szablonów XSLT powinna być także obecna deklaracja przestrzeni nazw (atrybut xmlns).

Przykładowy początek pliku może wyglądać tak:

<?xml version="1.0" encoding="ISO-8859-2"?>
<!--
  To jest konfiguracja dla Katowic.
   -->
<params xmlns="http://www.praterm.com.pl/SZARP/ipk" version="1.0"
        read_freq="10" send_freq="10" title="ZEC Katowice Wydział V">
       

Atrybuty element params:

• xmlns - deklaracja przestrzeni nazw SZARP - http://www.praterm.com.pl/SZARP/ipk, atrybut obowiązkowy. W razie potrzeby można dodać deklaracje innych przestrzeni nazw, zgodnie ze standardem XML.

• version - wersja formatu pliku, musi być równa 1.0, atrybut obowiązkowy.

• read_freq - długość w sekundach trwania pojedynczego cyklu pracy programu parcook, czyli częstotliwość wymieniania danych z postałymi elementami systemu SZARP. Standardowo jest to 10, zmiana tej wartości jest niezalecana i może powodować niepożądane efekty, w szczególności zafałszowanie wartości wyliczanych przez program średnich. Atrybut obowiązkowy.

• send_freq - długość w sekundach trwania pojedynczego cyklu pracy programu sender, czyli częstotliwość wysyłania danych (zadawania parametrów) do sterowników podłączonych regulatorów czy innych urządzeń. Rzeczywista częstotliwość wysyłania danych do urządzenia jest ustalana przez sterownik urządzenia, parametr ten mówi tylko o częstości wysyłania danych z sendera do sterownika. Standardowo jest to 10, zmiana tej wartości jest niezalecana. Atrybut obowiązkowy.

• title - tytuł konfiguracji - zwykle nazwa obiektu, z którego zbierane są dane. Tytuł ten wyświetlany jest przez programy użytkowe SZARP, np. w tytule okna programu przeglądającego. Atrybut obowiązkowy.

• ps_address - adres IP związanego z konfiguracją serwera do ustawiania wartości parametrów. SZARP umożliwia opcjonalnie zdalne zadawanie wartości parametrów do regulatorów, wymaga to konfiguracji serwera psetd, o podanym w tym atrybucie adresie. Atrybut opcjonalny.

• ps_port - numer portu serwera zadawania parametrów o adresie podanym w poprzednio opisanym atrybucie. Atrybut opcjonalny.

• documentation_base_url - adres strony WWW serwera wyświetlającego opcjonalną dokumentację parametrów SZARP. W przypadku braku atrybutu używana jest wartość domyślna, obecnie http://www.szarp.org, która jednak może się zmienić w przyszłej wersji oprogramowania. Atrybut jest opcjonalny, ale zaleca się jego ustawianie.