# Příručka pro &knutclient;

Daniel
Prynych

    Daniel@prynych.cz

2001
2002
2003
2004
2006
2007
2008
2009
2010
Daniel Prynych
&FDLNotice;
17/6/2010
0.13.04

&knutclient; je grafická klientská aplikace pro UPS systém NUT.

Tento dokument popisuje aplikaci &knutclient; verze 1.0.2

KDE
kdeutils
KNutClient
NUT
UPS

## Úvod

&knutclient; je program který umožňuje sledovat stav UPS-ek systému NUT.

## Použití &knutclient;

### Hlavní okno aplikace &knutclient;

&knutclient; je klientská grafická aplikace pro systém NUT "Network UPS Tools". Umožňuje sledovat stav UPS-ek a zobrazovat hodnoty proměnných které vybraná UPS-ka a její ovladač podporuje.

Od verze 0.6.0 &knutclient; podporuje spouštění okamžitých příkazů, a možnost změny RW proměnných.

Od verze 0.9.0 nepodporuje &knutclient; protokol UDP.

Hlavní okno aplikace &knutclient;

Hlavní okno programu je rozděleno na dvě části.

Levé část "Hlavní panel" obsahuje následující údaje indikující stav vybrané UPS-ky. Provoz na síť, provoz na baterie, přetížení, nutnost vyměnit baterii, vybití baterie, kalibraci baterie, údaj o dobu běhu po odpojení sítě (RUNTIME) a pod. Déle jsou zde neměnné údaje, to jsou údaje které se za provozu nemění a jsou proto přečteny jen jednou při výběru UPS-ky, například jméno UPS-ky, její sériové číslo, výrobce a pod.

Pravá část obsahuje analogové panely (měřáky), které udávají hodnotu proměnných veličin jako je vstupní napětí, zatížení UPS-ky, kapacitu baterie, teplotu UPS-ky, napětí baterie apod.

&knutclient; obsahuje nástrojovou lištu (toolbar) ze standardními tlačítky a tlačítko pro výběr sledované UPS-ky.

### &knutclient; a panel KDE

&knutclient; a panel KDE

Od verze 0.8.0 &knutclient; dokuje v panelu KDE. Jeho icona je proměnná a zobrazuje informace o zatížení UPS, runtime a a kapacitě baterie, podle toho který typ icony je vybrán. Po přesunu ukazatele myši na ikonu se zobrazí informační okno "ToolTip" které obsahuje více informací o UPS, Nazev, Jméno, Adresu, Stav, Runtime ...

### Více o vlastnostech &knutclient;

Pro spojení se serverovou části NUT-u (upsd) používá &knutclient; protokol, TCP.Po vybraní UPS-ky v nástrojové liště se &knutclient; pokusí přečíst data, pokud se mu to nepodaří, pokus opakuje a to maximálně 2 krát. &knutclient; poté čte data v pravidelných intervalech. Při prvním čtení čte všechny vybrané proměnné, v dalších již jen proměnné které zobrazují analogové panely, RUNTIME a stav UPS-ky. Proměnné zobrazující jméno UPS-ky, výrobce, sériové číslo a pod se tedy čtou jen jednou protože se nepředpokládá jejich změna.

Novější verze upsd (od verze 1.3), již nepodporují protokol UDP.

Chyby vznikající za běhu programu se zobrazují ve stavové lište. Do stavové lišty je vnořen seznam (ComboBox), ktery obsahuje hlašení chyb, a to včetne datumu, času a nazvy UPS-ky. Maximální délka seznamu je 50 řádek.

Chyby vznikající jako odezva na činnost uživatele jsou zobrazeny ve zvláštním okně.

## Popis příkazů

### Hlavní okno aplikace &knutclient;

#### Menu Soubor

Soubor Zobrazení Ups proměnných a příkazů

  Vypíše Ups proměnné pro zvolenou UPS-ku

Soubor Spuštění okamžitých příkazů

  Provede na UPS daný okamžitý příkaz

Soubor Nastavení UPS RW proměnných

  Provede změnu UPS RW proměnné

Ctrlq Soubor Ukončit

  Ukončí činnost programu

#### Menu Spojení

F1 Spojení Obnovit Spojeni

  Obnoví spojení s UPS serverem (upsd).

#### Menu Nastavení

Nastavení Zobrazovat nástrojovou lištu

  Zapne/Vypne zobrazení nástrojové lišty (Toolbar)

Nastavení Zobrazovat stavovou lištu

  Zapne/Vypne zobrazování nástrojové lišty

Nastavení Nastavení klávesových zkratek...

  Otevře konfigurační dialog pro přiřazení klávesy k akci.

Nastavení Nastavit &knutclient;

  Otevře hlavni konfigurační dialog

Nastavení Použít popis

  Zapne/Vypne používání popisů u zobrazení UPS proměnných a příkazů.

### Icona v panelu KDE

Menu icony v KDE panelu

#### Menu

UPS

  Slouží pro výběr UPS-ky

Zobrazení Ups proměnných a příkazů

  Vypíše Ups proměnné pro zvolenou UPS-ku

Spuštění okamžitých příkazů

  Provede na UPS daný okamžitý příkaz

Nastavení UPS RW proměnných

  Provede změnu UPS RW proměnné

Obnovit Spojeni

  Obnoví spojení s UPS serverem (upsd)

Nastavení Nastavit &knutclient;

  Aktivuje konfigurační dialog

O aplikaci &knutclient;

  Zobrazí informace o aplikaci &knutclient;

Minimalizovat

  Zavře hlavní okno

Konec

  Ukončí činnost programu

### Zobrazení proměnných

Toto okno zobrazý seznam všech proměnných a okamžitých příkazů, které existují pro zvolenou UPS-ku.

Okno proměnných a okamžitých příkazů

### Okamžité příkazy

Okamžité příkazy jsou vykonávány přímo na na UPS-ce, NUT server předává požadavek na příkaz příslušnému ovladači (driveru) a ten pak příkaz vyvolá na UPS-ce. Okno pro ovládaní Vám nabízí ty příkazy, které příslušný ovladač (driver) podporuje.

OK

  Tlačítko OK provede vybraný příkaz.

Zrušit

  Tlačítko zrušit zavře okno.

Příkaz

  Zde je možno vybrat příkaz který je pak následně vykonán

### Uživatelsky měnitelné (RW) proměnné

Uživatelsky měnitelné (RW) proměnné jsou skupinou proměnných které muže měnit přímo uživatel, většina z nich je přímo ekvivalentní nastavení příslušné UPS-ky. Uživatelsky měnitelné proměnné jsou dvojího typu znakové (CHAR) a výčtové (ENUM). Znakové proměnné jsou prostý řetězec znaků o definované maximální délce. Výčtové proměnné je seznam povolených hodnot na které muže být proměnná nastavená.

Uživatelsky měnitelné proměnná není změněna na serveru NUT-u (upsd) ale sever pouze dá příslušnému ovladači (driveru) příkaz ke změně, ten ihned provede změnu nastavení UPS-ky. Tato činnost není okamžitá a může trvat i několik sekund.

OK

  Tlačítkem OK je změna proměnné provedena.

Zrušit

  Tlačítkem Zrušit je okno zavřeno.

Implicitní

  Tlačítkem Implicitní mužeme obnovit současnou hodnotu proměnné.

Proměnná

  Zde je možno vybrat proměnnou která bude změněna

Hodnota

  Zde je možno u znakové proměnné zadat, nebo u výčtové proměnné vybrat její hodnotu. Nabídkové pole se automaticky mění podle typu proměnné.

### Nastavení aplikace &knutclient;

Okno pro nastavení má pět částí Nastavení, UPS, Panel Písma a Analog.

#### Nastavení

Část NASTAVENÍ slouží pro nastavení počtu sloupců analogových panelů, barvy pozadí hlavního okna, vstupního výstupního napětí (120/230)V, vstupní a výstupní frekvence (50/60)Hz a povolení použití hodnot input.transfer (input.transfer.low a input.transfer.high)

&knutclient;

Počet sloupců

  Určuje maximální počet sloupců pro analogové panely

Použít vlastní barvu pozadí

  Dovoluje zvolit vlastní barvu pozadí pro základní okno.

Barva pozadí

  Umožňuje zvolit barvu pozadí

Použít dialog "Jste si jistý"

  Při aktivaci, se při ukončení programu objeví dialog "Jste si jistý" který vyžaduje potvrzení, jinak se program neukončí.

Použít hlavní okno když program startuje

  Nastaví zobrazení hlavního okna při startu programu.

Zobrazit okno zpráv, když program hlásí chybu.

  Povoli zobrazení okna zpráv, kde je zobrazen popis chyby. Má význam jen, když není zakázáno dokování programu.

Vstupní napětí

  Umožňuje vybrat vstupní (výstupní) napětí 230/120V. Položka nemá význam pokud je zároveň zvolena položka Použít input.transfer hodnoty .

Vstupní (výstupní) frekvence

  Umožňuje vybrat vstupní (výstupní) frekvenci 50/60Hz. Položka nemá význam pokud je zároveň zvolena položka Použít High-Low input.transfer hodnoty.

Použít input.transfer hodnoty

  Nastaví vstupní napětí a vstupní frekvenci na základě hodnot v proměnných NUT-u input.transfer.low (LOWXFER) a input.transfer.high (HIGHXFER). Tyto proměnné udávají rozpětí hodnot vstupního napětí, které muže UPS-ka ještě bezpečně zpracovat. Na základě těchto hodnot &knutclient; nastaví napětí a frekvence pro panely které je používají. Například vstupní napětí, výstupní napětí, vstupní frekvence, výstupní frekvence apod.

#### UPS

Část UPS slouží pro nastavení seznamu UPS-ek a jejich parametrů. Levá část obsahuje seznam UPS-ek. Pravá část tlačítka pro přidávání, změnu parametrů a smazání záznamu o UPS-kách.

&knutclient;

Přidat

  Přidá do seznamu další UPS-ku a nastaví její parametry.

Úpravy

  Změní parametry vybrané UPS-ky

Smazat

  Smaže UPS-ku v seznamu

##### Nastavení parametrů

Toto okno slouží k nastavení parametrů UPS-ky.

Název

  Určuje jméno UPS-ky pro program &knutclient;

Adresa UPS

  Určuje adresu počítače ke kterému je UPS připojena. Tedy adresu UPS v síti. Příklad : ns.alo.cz, localhost, 192.168.1.12.

Jméno UPS

  Určuje jméno UPS tak jak je definuje NUT. Pokud není ups definováno, je automaticky použita první ups v seznamu systému NUT daného pc. To platí jen za předpokladu že minimalní verze upsd je 1.3. Blíže v dokumentaci k systému NUT. Příklad : victron, myups, apc700

Zpoždění (ms)

  Určuje interval mezi dvěma přenosy dat (čteni dat) ze systému NUT.

Port

  Nastaví port na který se &knutclient; připojí.

Uživatelské jméno

  Určuje uživatelské jméno (USERNAME) které &knutclient; použije při prokázaní totožnosti uživatele serveru to jest, programu upsd

Heslo

  Určuje heslo (PASSWORD) pro pro prokázaní totožnosti uživatele.

Store NUT password in configuration file.

  Při zvolení této volby bude heslo uloženo do konfiguračního souboru. V konfiguračním souboru je heslo uloženo nezašifrovaně. Pokud nebude tato volba zvolena bude heslo po ukončení programu zapomenuto.

UPS Proměnné

  Umožňuje vybrat proměnné které budou zobrazeny na analogových panelech v pravé části hlavního okna.

Parametry Uživatelské jméno a Heslo mají význam jen pri použití okamžitých příkazů a změnách RW proměnných, při sledování stavu UPS-ky není uživatelské jméno a heslo potřebné. Heslo (PASSWORD) a uživatelské jméno (USERNAME) mají své ekvivalenty v systému NUT v souboru upsd.users.

#### Panel

Část PANEL slouží pro určení které informační části hlavního panelu budou zobrazené

&knutclient;

Přetížení

  Povoluje/zakazuje zobrazení přetížení.

Baterie je vybitá

  Povoluje/zakazuje zobrazení vybití baterie.

Vyměnit baterie

  Povoluje/zakazuje zobrazení nutnosti výměny baterie.

Kalibrace UPS

  Povoluje/zakazuje zobrazení kalibrace UPS.

Výrobce + Model

  Povoluje/zakazuje zobrazení výrobce a modelu UPS-ky.

Výrobce

  Povoluje/zakazuje zobrazení výrobce UPS-ky.

Model

  Povoluje/zakazuje zobrazení modelu UPS-ky.

Sériové č.

  Povoluje/zakazuje zobrazení sériového čísla UPS-ky.

Verze Firmvare

  Povoluje/zakazuje zobrazení verze firmware UPS-ky.

Runtime

  Povoluje/zakazuje zobrazení doby po kterou je UPS-ka schopna po výpadku napájení dodávat el. proud.

Použít vlastní barvu pozadí

  Dovoluje zvolit vlastní barvu pozadí pro hlavní panel.

Barva pozadí

  Umožňuje zvolit barvu pozadí pro hlavní panel.

#### Písma

Část PÍSMA slouží pro výběr používaných písmen.

&knutclient;

Použít vlastní písma

  Povoluje/zakazuje možnost vybrat vlastní písma pro Hlavni panel a Analogové panely.

Hlavní panel / Analogové panely

  Určuje pro který panel se bude vybírat písmo.

Požadované písmo

  Vybírá písma pro zadaný typ panelu. Má význam jen tehdy pokud je vybrána položka Použít vlastní písmo.

#### Analog

Část Analog slouží pro nastavení barev na analogových panelech.

&knutclient;

Použít vlastní barvu pozadí

  Dovoluje zvolit vlastní barvu pozadí pro analogový panel.

Barva pozadí

  Umožňuje zvolit barvu pozadí pro analogový panel.

Použít vlastní barvy

  Dovoluje zvolit vlastní barvy pro následující části analogového panelu.

Barva ručičky

  Umožňuje zvolit barvu ručičky pro analogový panel. Standardní barva je černá.

Barva OK rozsahu

  Umožňuje zvolit barvu podbarvení stupnice pro rozsah správných (OK) hodnot. Standardní barva je zelená.

Barva rozsahu varování

  Umožňuje zvolit barvu podbarvení stupnice pro rozsah varovaní. Standardní barva je žlutá.

Barva rozsahu chyby

  Umožňuje zvolit barvu podbarvení stupnice pro rozsah chyby. Standardní barva je červená.

Barva stupnice

  Umožňuje zvolit barvu stupnice pro analogový panel. Standardní barva je černá.

Barva písma

  Umožňuje zvolit barvu písma pro analogový panel. Standardní barva je černá.

Vylepšení zpracování ručičky

  Umožňuje vybrat grafický způsob zpracování ručičky.

#### Dokovaní

Část DOCK slouží pro nastavení parametrů "dokovaní" programu.

&knutclient;

Typ zobrazení v doku. (Dokem je míněn panel KDE.)

Obrázkové

  Nastavuje obrazkový typ icony.

Obrázkové

  Nastavuje souhrny typ icony, pouze pro specialisty.

Prvky ToolTipu. (ToolTipem je míněna "bublinova" napověda.)

Výrobce

  Povoluje/zakazuje zobrazení výrobce UPS-ky.

Model

  Povoluje/zakazuje zobrazení modelu UPS-ky.

Sériové č.

  Povoluje/zakazuje zobrazení sériového čísla UPS-ky.

Verze Firmvare

  Povoluje/zakazuje zobrazení verze firmware UPS-ky.

Runtime

  Povoluje/zakazuje zobrazení doby po kterou je UPS-ka schopna po výpadku napájení dodávat el. proud.

Kapacita baterie

  Povoluje/zakazuje zobrazení kapacity baterie.

Zatížení UPS

  Povoluje/zakazuje zobrazení zatížení UPS.

Použít vlastní barvu pozadí

  Dovoluje zvolit vlastní barvu pozadí pro iconu v KDE panelu, když typ zobrazení icony v panelu je obrázkový.

Barva pozadí

  Umožnuje zvolit barvu pozadí.

## Otázky a odpovědi

&reporting.bugs; &updating.documentation;

&knutclient; nepracuje ale program upsc ano. Co mam dělat ?

Zkontrolujte nastaveni čísla portu. Od ver. 0.5 (NUT) je změněno číslo portu 3493. Klikněte na odkaz pro další údaje.

## Credits and License

&knutclient;

Program copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Daniel Prynych Daniel@prynych.cz

Documentation copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Daniel Prynych Daniel@prynych.cz

Translations done by:

- Daniel Prynych Daniel@prynych.cz Čeština

&underFDL; &underGPL;

## Instalace

### Jak získat &knutclient;

&knutclient; není částí KDE projektu http://www.kde.org. &knutclient; může být nalezen na ftp://ftp.buzuluk.cz/pub/alo/knutclient/

### Požadavky

Pro úspěšné použití &knutclient; potřebujete KDE 4.3.x

Seznam změn můžete najít na http://www.knut.prynych.cz.

### Překlad a instalace

Pro překlad a instalaci &knutclient; napište následující příkazy v základním adresáři Vaší &knutclient; aplikace.

    % cmake ../. -DCMAKE_INSTALL_PREFIX=/usr/ -DCMAKE_BUILD_TYPE=Release
    % make
    % make install

Od doby kdy KDE aplikace používají cmake nemůžete mít žádné problémy při překladu :-). Jestliže přesto vzniknou nějaké problémy hlaste je prosím do KDE konference.

&documentation.index;