A program telepítője két fájlból áll:
- setup.sh
- wsmra.zip (weather service multi release archive)
A telepítéshez a setup.sh fájlnak futtatási jogosultságot kell adni, például parancssorból a chmod 700 setup.sh
paranccsal.
Ezután telepíthető a program a következőképpen:
- a setup.sh futtatásával
- parancssorból, a tartalmazó mappából indítva a programot:
./setup.sh
./setup.sh /abszolút/elérési/útvonal/...
- kattintással, majd a "Végrehajtás terminálban" opció választásával
- parancssorból, a tartalmazó mappából indítva a programot:
- a program alapértelmezetten az aktuális felhasználó asztalára települ a WService nevű mappába
- bárhogy indítottuk is el a telepítést, a folyamat elején egyszer még jóvá kell hagyni a telepítési útvonalat, illetve ekkor utoljára lehetőség nyílik módosítani is azt, abszolút elérési útvonal megadásával
- a telepítő a megadott útvonalon szereplő mappákat létrehozza, amennyiben azok még nem léteznek, és kicsomagolja az architektúrának megfelelő verziót
- amennyiben az aktuális architektúra nem támogatott, törli a kicsomagolt összes fájlt, az utolsónak létrehozott "szülőmappával" együtt, és a telepítés megszakad
- ha az architektúra támogatott, létrehoz egy start.sh fájlt a telepített program főkönyvtárába
- beütemezi
cron
-ban a program futtatását minden 4. órában
- A program főkönyvtárában a start.sh elindításával:
- terminálból:
./start.sh
- kattintással, majd a "Végrehajtás terminálban" opció választásával
- terminálból:
- a program elindul
-u
paraméterrel "user módban":- megnyílik a parancssor
- a program megpróbálja a köpönyeg.hu web API elérésével letölteni a legfrissebbb adatokat
- ezeket letárolja a merevlemezen fájlban
- elkészíti a GUI-hoz szükséges bemenő adatokat
- a parancssor logüzeneteken jelenít meg a program futásának mindenkori állapotáról
- ha hiba lép fel, a program újrapróbálkozik, alapértelmezetten összesen 3 futtatást kísérel meg, 5 másodperces eltérésekkel
- a futtatás végén, akár sikeres volt a lefutás, akár sikertelen, billentyűzet leütésre vár a felhasználótól, így idő és lehetőség nyílik a logok megvizsgálására (kizárólag "user módban")
- billetyűgomb leütése után új böngészőablak nyílik meg, ahol az adatok grafikonos vizualizációját láthatjuk
- a böngésző ablak bezárásával a parancssor is bezárul, a program futása befejeződött
A böngészőben a grafikonok a zöld saroknál fogva átméretezhetők.
A program automatikus futása során is keletkeznek logok, ezek megtekinthetők az elérési_útvonal/app/Logs
mappában, a legtöbb szövegszerkesztővel jól olvasható formában. Gépi feldolgozásuk táblázatként lehetséges, tabulátorral tagolt (tsv) fájlként.
A program állítható paraméterei az elérési_útvonal/app/appsettings.json
fájlban találhatóak, kulcs-érték párok formájában. Ezt a konfigurációt a program minden futtatás során újra "lebuildeli".
A kulcsokhoz tartozó értékek megváltoztatásával lehet a programot be(de leginkább csak el)állítani. A lényegesebb kulcsok, amiket potenciálisan érdemes lehet átállítani (természetesen saját felelősségre):
- MainLoop.Delay: próbálkozások közötti késleltetés (másodperc)
- MainLoop.MaxTries: maximális próbálkozási kísérletek száma (darab)
- WebService.Timeout: maximális várakozási idő a szerver válaszára (másodperc)
- DataFilter.TargetRegion: az adatgyűjtés céljául szolgáló magyarországi régió neve, unicode formátumban
- ILogger.LogLevel: a logüzenetek részletességére utaló filter
Ezeken kívül, parancssorban a crontab -e
paranccsal, a programhoz tartozó cron-bejegyzés módosítása lehetséges, az automatikus futási gyakoriság állításának céljából.
Helytelen konfiguráció a program hibás működését, vagy akár működésképtelenségét idézheti elő!
- A telepítési útvonalon a WService mappa rekurzív törlése
- Parancssorban a
crontab -e
paranccsal, a programhoz tartozó cron-bejegyzés törlése.