SnapArc 3 Stahování archivů z řídicích systémů a regulátorů

SnapArc 3 Stahování archivů z řídicích systémů a regulátorů Návod na obsluhu

Verze 1.00

snaparc_g_cz_100

SNAPARC 3

AMiT, spol. s r. o. nepřejímá žádné záruky, pokud se týče obsahu této publikace a vyhrazuje si právo měnit obsah dokumentace bez závazku tyto změny oznámit jakékoli osobě či organizaci. Tento dokument může být kopírován a rozšiřován za následujících podmínek: 1. Celý text musí být kopírován bez úprav a se zahrnutím všech stránek. 2. Všechny kopie musí obsahovat označení autorského práva společnosti AMiT, spol. s r. o. a veškerá další upozornění v dokumentu uvedená. 3. Tento dokument nesmí být distribuován za účelem dosažení zisku. V publikaci použité názvy produktů, firem apod. mohou být ochrannými známkami nebo registrovanými ochrannými známkami příslušných vlastníků. AMiT je registrovaná ochranná známka.

Copyright (c) 2016, AMiT, spol. s r. o. Výrobce: AMiT, spol. s r. o. Naskové 1100/3, 150 00 Praha www.amit.cz Technická podpora: [email protected]

snaparc_g_cz_100

2/20

SNAPARC 3

Obsah Historie revizí .................................................................................................. 4 Související dokumentace ................................................................................ 4

1

Úvod ...................................................................................................... 5

2

Instalace ................................................................................................ 7

2.1 2.2 2.3

Doporučená konfigurace PC .......................................................................... 7 Instalace ......................................................................................................... 7 Odinstalace .................................................................................................... 7

3

Stahovací nástroj SnapArc ................................................................. 8

4

Grafické uživatelské rozhraní ............................................................. 9

4.1 4.2 4.2.1 4.2.2

4.4 4.5 4.5.1 4.5.2

Kontrola uživatelských vstupů ........................................................................ 9 Nabídkové menu .......................................................................................... 10 Soubor .......................................................................................................... 10 Nastavení ..................................................................................................... 10 PC se připojuje jako stanice ......................................................................... 11 Nápověda ..................................................................................................... 11 Konfigurace .................................................................................................. 11 Přidání/změna konfigurace připojení ............................................................ 11 Sériová linka ................................................................................................. 11 Ethernet ........................................................................................................ 12 Servisní mód ................................................................................................ 13 Přidání/změna konfigurace archivu .............................................................. 13 Obecné ......................................................................................................... 14 Názvy záhlaví ............................................................................................... 15 Stavový řádek ............................................................................................... 16 Stahování ..................................................................................................... 16 Průběh stahování ......................................................................................... 17 Vytváření názvů archivních souborů............................................................. 18

5

Automatické spouštění ..................................................................... 19

4.2.3 4.3 4.3.1

4.3.2

Vypnutí ověřování proměnných .................................................................... 20

3/20

snaparc_g_cz_100

SNAPARC 3 Historie revizí Jméno dokumentu: snaparc_g_cz_100.pdf Verze 100

Datum Autor změny 01. 09. 2016 Kuklík Jan

Změny Nový dokument

Související dokumentace 1.

AtouchX – Manuál komunikačního ovladače AtouchX soubor: atouchx.chm

2.

Nápověda k části PseDet vývojového prostředí DetStudio soubor: Psedet_cs.chm

snaparc_g_cz_100

4/20

SNAPARC 3

1

Definice použitých pojmů Stanice Řídicí systém nebo programovatelný regulátor firmy AMiT spol. s r. o. Symbolická adresa Symbolická adresa začíná otazníkem, který následuje přiděleným jménem (např. ?mojestanice). Validace Vyčtení všech zadaných proměnných v konfiguraci ze stanice a porovnání jejich typů a dimenzí s definicí těchto proměnných v konfiguraci.

5/20

snaparc_g_cz_100

SNAPARC 3

2

Úvod SnapArc je nástroj pro stahování archivů ze stanic firmy AMiT spol. s r. o. na pevný disk počítače. Základní  vlastnosti 

  

snaparc_g_cz_100

Možnost vytváření, načítaní a ukládání konfigurací Možnost ukládat archivy do souboru typu *.txt, *.csv nebo *.mdb Podpora ukládání archivů podle nastaveného typu archivu Podpora stahování více archivů z více stanic najednou Možnost spouštění programu v Plánovaných úlohách

6/20

SNAPARC 3

3 3.1

Instalace Doporučená konfigurace PC Pro úspěšný chod programu se předpokládá použití počítače se systémem Windows XP SP3 (a vyšším) s nainstalovaným .NET Framework 4.0 (a vyšším) a nainstalovanou knihovnou AtouchX. Knihovna AtouchX je dostupná na stránkách www.amit.cz v sekci Automation a prostředí .NET na stránkách www.microsoft.com.

3.2

Instalace Pro instalaci je nutné mít na počítači administrátorská práva. Pro vlastní chod programu postačí běžná uživatelská práva. Program SnapArc se instaluje pomocí instalátoru SnapArcSetupxxx.exe, který je dostupný na stránkách www.amit.cz v sekci Automation. Při instalaci probíhá kontrola existence potřebných knihoven. Pokud na počítači nebudou naistalovány, pokusí se instalátor tyto knihovny doinstalovat. Pro instalaci knihovny .NET je potřebné internetové připojení.

3.3

Odinstalace Program lze odinstalovat následujícím postupem. V ovládacích panelech vyberte položku Přidat nebo odebrat programy, Vyberte program SnapArc a zvolte funkci Odebrat. Nebo v nabídce Start – AMiT – SnapArc – Odinstalovat aplikaci SnapArc.

7/20

snaparc_g_cz_100

SNAPARC 3

4

Stahovací nástroj SnapArc Program SnapArc umožňuje stahování archivů ze stanic firmy AMiT spol. s r. o. a jejich ukládání na pevný disk počítače. Najednou lze stahovat více archivů z více stanic. U každého archivu lze definovat formát, v jakém se budou ukládat stažená data:  Databáze Microsoft Access – soubory typu *.mdb  Databáze ViewDet – soubory typu *.mdb  Textový soubor – soubory typu *.txt  Comma-separated values (oddělovač středník) – soubory typu *.csv Každému archivu je možné nastavit typ archivu:  denní,  týdenní,  měsíční,  roční. Podporované typy připojení ke stanicím:  sériová linka,  ethernet (UDP, TCP),  servisní mód. Program pracuje ve dvou režimech:  Automatický režim – za pomoci naplánovaných úloh, provádí se pouze stahování (žádná konfigurace),  Dialogový režim – možnost plné konfigurace. Program ukládá logovací informace do souboru SNAPARC.LOG do složky C:\Users\<jméno uživatelského profilu>\Documents\SnapArc. Program nepodporuje práci s provozním deníkem.

snaparc_g_cz_100

8/20

SNAPARC 3

5

Grafické uživatelské rozhraní Grafické rozhraní je rozděleno na tři základní části. V horní liště je nabídkové menu, které umožňuje pracovat s danou konfigurací a nastavením programu. Uprostřed okna jsou tabulky pro nastavení stahování. Na dolním okraji okna je stavový řádek.

Obr. 1 – Okno programu

5.1

Kontrola uživatelských vstupů Každá hodnota, která je uživatelem zadána, je kontrolována zda splňuje podmínky očekávané hodnoty. Pokud uživatel zadá neplatnou hodnotu (místo čísla text, zápornou hodnotu místo kladné, …), je vstupní box ohraničen červeným rámečkem a po najetí kurzoru na tento box je zobrazena chyba. V tabulce se chyba označuje vykřičníkem vedle řádku s chybou. Chyba se zobrazuje po umístění kurzoru na vykřičník. Kontrola chyby u samostatného text boxu probíhá ihned po zadání znaku. U tabulky probíhá kontrola poté, co je hodnota v tabulce potvrzena, to je vstoupením kurzoru na jiný prvek v otevřeném okně.

9/20

snaparc_g_cz_100

SNAPARC 3

Obr. 2 – Chybný uživatelský vstup

Obr. 3 – Chybný uživatelský vstup v tabulce Pokud uživatel nezadá všechny vstupy správně, je mu znemožněno potvrzení dialogového okna. Doporučuje se, aby uživatel chybu vstupu ihned po vzniku opravil. Pokud tak neudělá, je možné, že program při dalším vyhodnocování vstupu nebude vyhodnocovat hodnotu správně (předchozí chybná hodnota nemůže být použita pro kontrolu vstupů).

5.2 5.2.1

Nabídkové menu Soubor Menu Soubor umožňuje vytvoření nové konfigurace, načtení a uložení konfigurace a také ukončení programu.

5.2.2

Nastavení Menu Nastavení umožňuje nastavit jazyk programu a nastavit parametry PC pro komunikaci se stanicemi.

Obr. 4 – Nastavení adresy PC

snaparc_g_cz_100

10/20

SNAPARC 3 PC se připojuje jako stanice – číslo (0 až 31), pod kterým se PC připojuje do sítě. Více informací o adresaci PC, lze nalézt v nápovědě komunikačního ovladače AtouchX (viz Související dokumentace).

5.2.3

Nápověda Menu Nápověda umožňuje zobrazit nápovědu k programu a obecné informace o programu.

5.3

Konfigurace Konfigurace označuje seznam všech připojení a jejich definic archivů. Toto se definuje v prostřední části programu SnapArc, které je dále děleno na dvě tabulky. Horní tabulka obsahuje seznamem připojení. Spodní tabulka obsahuje seznam archivů pro vybrané připojení. Každá tato tabulka umožňuje přidávat, upravovat i odstraňovat jednotlivé položky ze seznamu. Pod tabulkami je tlačítko „Začít stahovat“ pro spuštění stahování archivů.

5.3.1

Přidání / změna konfigurace připojení Pro každé připojení je nutné provést správné nastavení parametrů připojení. Je-li to nutné, musí uživatel pracovat i s ofsetem. Více informací o komunikačním ovladači AtouchX se dočtete v nápovědě tohoto ovladače (viz Související dokumentace).

Poznámka Práce s ofsetem a adresou stanice je rozdílná v programu SnapArc oproti

standardní práci s komunikačním ovladačem AtouchX. V případě SnapArc se adresa stanice nedefinuje jako „přečíslovaná“ adresa, tedy součet adresy nastavené např. přes DIP přepínače + ofset, ale pouze jako skutečně nastavená adresa. „Přečíslovanou“ adresu pro ovladač AtouchX dopočítává program SnapArc sám. Je však stále nutné zajistit jedinečnost všech „přečíslovaných“ adres v rámci definice celé sítě. Sériová linka

Obr. 5 – Nastavení komunikace – COM

11/20

snaparc_g_cz_100

SNAPARC 3 COM – číslo sériového portu (1 až 256), prostřednictvím kterého komunikuje PC se stanicí. Rychlost – komunikační rychlost, pomocí které se komunikuje se stanicí. Tato rychlost musí být nastavena na sériovém rozhraní připojené stanice. Ofset – posun čísla stanice oproti číslu DIP přepínače. Parametr může nabývat pouze hodnot 0, 32, 64, 96, 128, 160, 192 a 224. Ethernet Komunikace pomocí ethernetu může probíhat pomocí protokolu UDP nebo TCP (protokol TCP podporují pouze „W“ systémy s NOS v3.59 a vyšším).

Obr. 6 – Nastavení komunikace – Ethernet IP adresa – IP adresa, na které je dostupná stanice. Jde zadat v číselném tvaru (např. 192.168.35.1) nebo symbolicky. Port – UDP / TCP port (0 až 65535, implicitně 59), prostřednictvím kterého stanice komunikuje na přidělené IP adrese. Heslo – bezpečnostní heslo (0 až 232 - 1), které je nadefinováno v IP konfiguraci stanice. Znalost hesla je nutná pro přístup na stanici. Timeout – maximální čas v milisekundách (0 až 3600000, implicitně 3000), který čeká PC na odpověď na každý zaslaný paket stanici. Ofset – (0 až 65504) posun čísla stanice oproti číslu DIP přepínače. Protokol – typ protokolu, který se má použít.

snaparc_g_cz_100

12/20

SNAPARC 3 Servisní mód Pro komunikaci v servisním módu musí být ve stanici nahrán NOS verze minimálně 3.39.

Obr. 7 – Nastavení komunikace – Servisní mód COM – číslo sériového portu (1 až 256), prostřednictvím kterého komunikuje PC se stanicí. Timeout – maximální čas v milisekundách (0 až 3600000, implicitně 1000), který čeká PC na odpověď na každý zaslaný paket stanici. Ofset – (0 až 65504) posun čísla stanice oproti číslu DIP přepínače.

5.3.2

Přidání / změna konfigurace archivu Při jakékoli změně v konfiguraci archivu je doporučeno odstranit soubory, do kterých by se mělo znovu zapisovat. Pokud se program pokusí zapisovat do souboru s chybnou nebo rozdílnou strukturou, skončí zápis chybou nebo nekonzistencí dat v souboru. Při ukládání konfigurace archivu do seznamu konfigurací (potvrzení dialogového okna Nastavení archivů) je provedena kontrola na existenci potenciálně shodných souborů ve složce pro ukládání archivů. Může-li dojít k přepisu je uživatel varován dialogovým oknem.

Obr. 8 – Varování na možný přepis Uložení konfigurace archivu je uživateli povolena pouze pokud všechna vstupní pole jsou správně vyplněna a tabulka WID – Data obsahuje alespoň jeden platný řádek s datovou maticí archivu.

13/20

snaparc_g_cz_100

SNAPARC 3 Obecné

Obr. 9 – Nastavení archivu – obecné Jméno archivu – unikátní jméno archivu. Toto jméno se objevuje i v názvu vytvářených archivních souborů. Pokud nebude zadáno unikátní jméno, dochází k pokusu o přepis již vytvořených souborů nebo zápisu do souboru s chybnou strukturou. Adresa stanice – adresa (číslo) stanice (0 až 31). Typ souboru – typ souboru, do kterého se budou data ukládat. Cesta k souboru – umístění, kam se budou ukládat archivní soubory se staženými daty. Umístění musí v době vytváření konfigurace již existovat. Typ archivu – časové období, které určuje počet dat uložených v jednom souboru. Hloubka archivu – hloubka archivu ve stanici. WID – Index – číselný identifikátor proměnné indexu archivu. WID – Čas – číselný identifikátor proměnné obsahující časovou osu archivu. WID – Data – tabulka obsahující seznam datových matic archivu:  WID – číselný identifikátor datové proměnné v archivu,  Typ – typ datové proměnné v archivu (více informací o datových typech v nápovědě k části PseDet prostředí DetStudio),  Počet řádků – počet řádků datové proměnné.

snaparc_g_cz_100

14/20

SNAPARC 3 

„Odebrat“ – umožňuje odebrání datové matice. Tlačítko je přístupné pouze pokud uživatel má vybrán řádek a v tabulce je definována více než jedna datová proměnná.

Upozornění Hodnoty zadané v WID – Index, WID – Čas a v tabulce WID – Data (WID, Typ

a Počet řádků) musí přesně odpovídat hodnotám nastaveným ve stanici. Stejně tak musí přesně odpovídat hodnota Hloubka archivu s počty sloupců archivních matic. Pokud všechny tyto hodnoty nebudou souhlasit, neproběhne Validace archivu úspěšně. Není tedy možné stahovat jen výřez archivní matice. Názvy záhlaví Při definování archivu je automaticky vytvořeno jméno pro jednotlivé datové sloupce (resp. řádky) archivní matice odvozené od čísla WIDu databázové proměnné.

Obr. 10 – Nastavení archivu – názvy záhlaví Jméno – jméno datového sloupce, které bude uloženo na první řádce v souboru. WID – číselný identifikátor datové proměnné (pouze pro čtení). Řádek – řádek datové proměnné (pouze pro čtení). Formát – formát ukládané hodnoty. Podle tohoto formátu bude hodnota upravena a zapsána do souboru (pouze pro *.csv a *.txt soubory).

15/20

snaparc_g_cz_100

SNAPARC 3 Formát ukládané hodnoty

5.4

Formát General number Scientific 0 0,0 0,00 0,000 000,0 ###,#

Příklad čísla 12345,123456 12345,123456 12345,123456 12345,123456 12345,123456 12345,123456 12,345 12,345

Zobrazí se 12345,123456 1,23E+04 12345 12345,1 12345,12 12345,123 012,3 12,3

Stavový řádek Ve stavovém řádku se v pravé části zobrazuje cesta k právě otevřenému souboru konfigurace. Pokud není konfigurace doposud načtena nebo uložena, není nic zobrazeno.

5.5

Stahování Po stisku tlačítka „Začít stahovat“ se provede základní kontrola definic konfigurací. Po úspěšné kontrole se objeví okno zobrazující průběh stahování. V tomto okně se vypisují informace o právě stahovaných vzorcích.

Upozornění Před spuštěním stahování dat archivů se provádí validace. Toto může probíhat

delší dobu (v závislosti na počtu archivů a nastavení sítě).

Obr. 11 – Ukázka stahování

snaparc_g_cz_100

16/20

SNAPARC 3

Obr. 12 – Ukázka stahování – validace s chybou

Stahování lze předčasně ukončit tlačítkem „Ukonči stahování a zavři okno“. Pokud při validaci některého archivu dojde k chybě, nezačne se tento archiv vůbec stahovat. Pokud se vyskytne chyba při stahování archivu a ukládání archivního vzorku do databáze je stahování ukončeno a ve statusu se zobrazí, v které části nastala chyba. Jsou-li dostupné další informace o chybě, tak jsou zobrazeny ve sloupci poznámka. Pro korektní stahování archivů musí ve stanici běžet aplikace. Více informací o nastavení stanic naleznete na webových stránkách www.amit.cz v sekci Automation viz nápověda k části PseDet prostředí DetStudio.

5.5.1

Průběh stahování      

Vytvoření konfiguračních souborů pro ovladač AtouchX. Konfigurační soubory jsou uloženy do složky C:\Users\<jméno uživatelského profilu>\Documents\SnapArc. Vytvoření instance komunikačního ovladače AtouchX. Ověření připojení stanice, validace archivů. Spuštění stahování archivů. Příjem dat (ze všech archivů současně). Pokud nejsou přijata data v časovém úseku, je archiv prohlášen za nedostupný a stahování tohoto archivu je ukončeno. Stahuje se, dokud všechny archivy nejsou stažené nebo jejich stahování není chybové.

17/20

snaparc_g_cz_100

SNAPARC 3 5.5.2

Vytváření názvů archivních souborů Názvy archivních souborů se vytvářejí automaticky v závislosti na typu archivu (den, týden, měsíc, rok) a na pojmenování archivu. Názvy archivních souborů pro jednotlivé typy archivů vypadají takto: Období Rok Měsíc Týden Den

Jméno souboru Yyyyy_JménoArchivu.přípona Myyyy_mm_JménoArchivu.přípona Wyyyy_ww_JménoArchivu.přípona Dyyyy_mm_dd_JménoArchivu.přípona

Použité zkratky:  yyyy – rok,  mm – měsíc,  dd – den,  ww – týden,  JménoArchivu – jméno archivu zadané uživatelem,  Přípona – přípona vytvářená podle formátu souboru (mdb, csv, txt). Příklad pojmenování souboru: D2002_01_15_Archiv1.csv

Jedná se o denní archiv z 15. ledna 2002. Jméno archivu je Archiv1.

snaparc_g_cz_100

18/20

SNAPARC 3

6

Automatické spouštění Program SnapArc umožňuje zadáním parametrů /RUN soubor_konfigurace automatické odstartování stahování archivů při spuštění programu. Pokud je program takto spuštěn, tak dojde i k automatickému ukončení programu. Ukončení nastane, pokud zadané archivy jsou v koncovém stavu. Koncový stav je dokončení stahování všech dostupných dat archivu nebo chyba při stahování (zařízení není dostupné, chybný formát souboru pro ukládání). Automatické spouštění (a ukončení) lze s výhodou použít ve spojení s Plánovanými úlohami v operačním systému Windows. Potom lze například nakonfigurovat automatické stahování archivu vždy v pátek ve 23:00. Tato funkce samozřejmě předpokládá, že jsou již všechny archivy správně nadefinovány. Při výskytu jakékoli chyby při vytváření komunikačního objektu AtouchX v režimu automatického spouštění stahování archivů dojde k ukončení programu. Při nenalezení konfiguračního souboru nebo jeho chybné struktuře je zobrazeno varovné hlášení a program je ukončen. Pokud nastane chyba při stahování archivu, je tento archiv při stahování přeskakován a stahují se ostatní archivy. Chyba je zapsána do logovacího souboru SNAPARC.LOG ve složce C:\Users\<jméno uživatelského profilu>\Documents\SnapArc. V režimu automatického spuštění je zobrazena notifikační ikona v oznamovací oblasti. Pomocí této ikony jde zobrazit okno se stahováním nebo ukončit stahování.

Obr. 13 – Notifikační ikona v oznamovací oblasti Příklad spuštění: SnapArc.exe /RUN C:\Users\user\Documents\SnapArc\testConf.xml

Upozornění Doporučuje se, aby běžel pouze jeden program SnapArc pracující se složkou

s archivy. Jinak by mohlo docházet k nežádoucím přepisům souborů a chybám.

19/20

snaparc_g_cz_100

SNAPARC 3 Vypnutí validace Před spuštěním stahování dat archivů se provádí validace. Toto může probíhat delší dobu (v závislosti na počtu archivů a nastavení sítě), proto může být přeskočen zadání parametru /F. Příklad spuštění: SnapArc.exe /RUN C:\Users\user\Documents\SnapArc\testConf.xml /F

Standardně je validace zapnuta. V grafickém uživatelském rozhraní není možné validaci vypnout. Upozornění Pořadí parametrů při automatickém spouštění nelze měnit. Parametr /RUN musí

být první, cesta k souboru druhý a na posledním místě může být přepínač vypnutí validace.

snaparc_g_cz_100

20/20