ModemTec SOAP rozhraní. popis a dokumentace funkcí

ModemTec 2010-02-26

SOAP rozhraní popis a dokumentace funkcí

Obecné vlastnosti rozhraní SOAP

OBECNÉ VLASTNOSTI ROZHRANÍ SOAP Systém ISAR je vybaven rozhraním pro komunikaci externích aplikací s ISARem. Rozhraní je realizováno pomocí rozhraní SOAP, které poskytuje tzv. webové služby nebo-li funkce na ovládání a nastavování jednotlivých prvků systému ISAR. Pomocí SOAP jsou tak k dispozici funkce např. k přidávání měřičů do systému, jejich přidělování k data-koncentrátorům a k získávání naměřených dat. SOAP rozhraní je využíváno samotným ISAR v režimu, kdy se centrální systém připojuje na jednotlivé agregační servery a centrálně tak může spravovat téměř neomezený počet měřících míst.

KOMUNIKAČNÍ ROZHRANÍ SOAP rozhraní je určeno adresou pro zpracování SOAP požadavků. Na tuto adresu jsou zasílány požadavky z externích aplikací. Adresa SOAP rozhraní je http://adresa_isaru/soap . Komunikaci se serverem ISAR je možné realizovat jak pomocí šifrovaného SSL připojení v rámci protokolu HTTPS tak pomocí vytvoření VPN připojení na server, podobně jako se k serveru připojují data-koncentrátory. Druhá varianta je preferovaná. Rozhraní SOAP disponuje jednou základní funkcí pro zasílání požadavků. Jedná se o funkci s názvem ags, jejíž parametry jsou autorizační údaje (login, heslo), název příkazu a parametry příkazu. Volání může být doplněno o nepovinné parametry jako je například maximální čas (timeout) zpracování požadavku. Příklady volání funkce ags: ags ( login, heslo, queueMeterGetTarif, { meterId=211 } ) ags ( login, heslo, profileMeterGet, { meterId = 211, timeFrom = 1234567890, timeTo = 1234578901 } ) Na základě autorizačních údajů jsou zpřístupněny jen určité měřiče a funkce příslušející danému uživateli. Funkce ags je zpracována synchronně a v rámci maximální doby zpracování je zaslána odpověď. Odpovědí na funkci ags je asociativní pole hodnot. Toto pole je tvořeno jak hodnotami popisující úspěch provádění příkazu ( errCode, errMsg, …) , tak jsou v něm obsažena případná data získaná vykonáním příkazu. errCode

výsledek volání příkazu ( 0 – ok, 1 – unknown command, 2 – SQL error, 3 – timeout, … )

errMsg

textový popis chyby při zpracování požadavku

Dle typu příkazu jsou pak vrácena data, která jsou součástí asociativního pole. Popis jednotlivých položek je součástí dokumentace příkazu.

ISAR - dokumentace SOAP

Modemtec

2

Funkce pro vyčítání a modifikaci dat databáze AGS

FUNKCE PRO VYČÍTÁNÍ A MODIFIKACI DAT DATABÁZE AGS DATA KONCENTRÁTORY dcList Vyčtení seznamu data-koncentrátorů, které jsou dostupné uživateli. Funkce nemá vstupní parametry.

NÁVRATOVÉ HODNOTY: count dcArray

počet data koncentrátorů pole (seznam) data koncentrátorů včetně parametrů v asociativním poli s položkami id sn location status status_last addr timer_client timer_profiles timer_events version grp

identifikátor DC sériové číslo umístění DC (textový popis) stav DC (offline, online) čas poslední komunikace s DC adresa DC v PLC síti (pod touto adresou DC vysílá) časovač komunikace DC s AGS interval vyčítání profilů z modemů (standardně 600s) interval vyčítání událostí z modemů (standardně 60s) verze software v DC skupina DC

dcAdd přidání data-koncentrátoru

dcModify úprava parametrů data-koncentrátoru

dcRemove odebrání data-koncentrátoru – lze pouze v případ

dcGet vyčtení parametrů data-koncentrátoru


Modemtec

3


dcMeterAdd Přiřazení měřiče k DC. Funkce nastaví do tabulky DC měřič, tento se začne oslovovat v případě nedostupnosti je vyhledáván přes opakovače. Pokud byl přiřazen k jinému, je od něj odebrán.

PARAMETRY: dcId meterId path hops

id DC id měřiče routování - cesta k měřiči (nepovinné, určí se automaticky) routování - počet skoků přes opakovače (nepovinné, určí se automaticky)

dcMeterRemove Odebrání měřiče z DC. Funkce odebere z tabulky DC měřič, tento přestane být oslovován koncentrátorem. Vyhledán může být následně až po vypršení časového limitu pro odregistraci.

PARAMETRY: dcId id DC meterId id měřiče


Modemtec

4


dcMeterList Funkce vrací seznam měřičů přiřazených k DC včetně jejich parametrů.

PARAMETRY: dcId

identifikátor DC

NÁVRATOVÉ HODNOTY: count meters

počet měřičů pole jednotlivých měřičů včetně parametrů id id měřiče type typ měřiče (např. LG3) version verze firmware modulu address adresa měřiče v PLC síti last_event pointer událostí last_profile pointer profilů last_profile_time čas posledního vyčtení profilů path cesta pro systém routování hops počet skoků pro systém routování


Modemtec

5


MĚŘIČE meterList Funkce vrací seznam všech evidovaných měřičů v AGS dostupných uživateli. Funkce je bez vstupních parametrů. Měřiče vrací včetně parametrů.

NÁVRATOVÉ HODNOTY: count meters

počet měřičů pole jednotlivých měřičů včetně parametrů v asociativním poli s položkami id id měřiče description popis měřiče type typ měřiče (např. LG1) version verze firmware modulu address adresa měřiče v PLC síti last_event pointer událostí last_profile pointer profilů last_profile_time čas posledního vyčtení profilů grp skupina měřiče tariff poslední nastavený tarif dle události z měřiče schema id nastaveného kalendáře rr_next čas vygenerování následujícího odečtového záznamu rr_next_modem čas naprogramovaného času pro odečet v měřiči p1 parametr 1 (offset elektroměru v kWh) p2 parametr 2 (hodnota jednotky v kWh) offset_tx offset tarifu (tx – t1 až t4) status stav měřiče (up, down) probe_last čas poslední komunikce s měřičem comment komentář profiles_interval nastavený interval vyčítání profilů limit_power nastavený stav limitovače (hodnota v jednotkách měřiče na kterou se kontroluje překročení) limit_interval interval v sekundách, ve kterém se kontroluje limit relay1_status stav relé č. 1 (0 – off, 1 – on, -1 – neznámý) relay2_status stav relé č. 2 relay3_status stav relé č. 3 relay4_status stav relé č. 4 shutdown_status stav odpojovače (1 – zapnut, 0 – vypnut, -1 – neznámý)

meterAdd přidání měřiče do evidence

meterRemove odebrání měřiče

meterModify


Modemtec

6

Funkce pro vyčítání a modifikaci dat databáze AGS nastavení parametrů měřiče, také nastavení skupiny měřiče

meterGet Vyčtení parametrů měřiče.

PARAMETRY: meterId

id měřiče

NÁVRATOVÉ HODNOTY: Návratové hodnoty funkce jsou stejné jako parametry viz funkce meterList .

meterAllowedDcList Vyčtení seznamu povolených DC, na kterých se může měřič zaregistrovat. Pokud je seznam prázdný, znamená to, že se může zaregistrovat na libovolném DC.

PARAMETRY: meterId

id měřiče

NÁVRATOVÉ HODNOTY: count dcs

počet povolených DC (pokud je count=0 jsou povoleny všechny) pole s id koncentrátorů dcId id koncentrátoru

meterAllowedDcAdd Přidání DC do seznamu povolených DC, na kterých se může modem zaregistrovat. Pokud byl seznam prázdný, tak přidáním se povolí registrace pouze na tomto DC.

PARAMETRY: meterId dcId

id měřiče id koncentrátoru

meterAllowedDcRemove Odebrání DC ze seznamu povolených DC, na kterých se může modem zaregistrovat. Pokud vznikne prázdný seznam, budou povoleny všechny DC.

PARAMETRY: meterId dcId

id měřiče id koncentrátoru


Modemtec

7


meterAllowedDcAll Povolení registrace měřiče na všech DC. Funkce vyprázdní seznam povolených DC pro měřič.

PARAMETRY: meterId

id měřiče

meterParentMeterSet nastavení nadřazeného měřiče pro vyhodnocování součtů při měření černých odběrů

SKUPINY Skupiny slouží k rozdělení měřičů, DK do skupin, jednotlivým uživatelům pak může být přidělen přístup do skupiny a to jak pro čtení a zápis nebo jen pro čtení.

groupList vyčtení seznamu skupin

groupAdd přidání skupiny

groupRemove odebrání skupiny

groupUserAdd přidání uživatele do skupiny

groupUserRemove odebrání uživatele ze skupiny


Modemtec

8


KALENDÁŘE calendarList Funkce vrací seznam kalendářů. Nemá vstupní parametry.

NÁVRATOVÉ HODNOTY: count calendarArray

počet kalendářů pole jednotlivých měřičů včetně parametrů v asociativním poli s položkami id name grp

id kalendáře název kalendáře skupina kalendáře

calendarAdd Přidání kalendáře do evidence AGS (tabulka TOU). AGS spravuje kalendáře a distribuuje je do data koncentrátorů a měřičů podle nastavení přiřazení.

PARAMETRY: name grp

název vytvářeného kalendáře číslo skupiny v rámci evidence AGS (nepovinný parametr)

NÁVRATOVÉ HODNOTY: calendarId

přidělené id (jednoznačný identifikátor) vytvořeného kalendáře

calendarModify Úprava parametrů kalendáře.

PARAMETRY: calendarId name grp

id kalendáře nový název kalendáře číslo skupiny v rámci evidence AGS (nepovinný parametr)

calendarRemove Odstranění kalendáře z evidence AGS. Tímto povelem dojde také k odstranění přiřazení tohoto kalendáře modemům.

PARAMETRY: calendarId

id kalendáře


Modemtec

9


calendarEventAdd Přidání události (řádku) do kalendáře, určuje například, který den v týdnu a v kolik hodin se má provést přepnutí tarifu. Události lze určovat na jednotlivé dny týdne, navíc v kalendáři může být nadefinováno 20 výjimek (určeno hlavně pro svátky).

PARAMETRY: calendarId order dow date timeAt tariff R1 R2 R3 R4

id kalendáře, do kterého se má přidat událost pořadové číslo záznamu (jedinečné v rámci kalendáře) (nepovinné, pokud není vyplněno, je vygenerováno) pořadové číslo dne v týdnu pro záznam (0 – pondělí … 6 – neděle) v případě přidávání svátku musí být dow nevyplněno nebo -1 den v roce, kdy se má událost vykonat (formát DDMM) (nepovinné pokud vyplněné dow) čas události v rámci vybraného dne (formát HHMM) změna tarifu (nemusí být vyplněno, pokud se nemá přepnout tarif) (hodnoty 1-4) nastavení relátka č. 1 (hodnoty on / off) (nepovinné) nastavení relátka č. 2 (hodnoty on / off) (nepovinné) nastavení relátka č. 3 (hodnoty on / off) (nepovinné) nastavení relátka č. 4 (hodnoty on / off) (nepovinné)

NÁVRATOVÉ HODNOTY: order

přidělené pořadové číslo události kalendáře

calendarEventList Vyčtení všech událostí kalendáře.


id kalendáře, do kterého se má přidat událost

NÁVRATOVÉ HODNOTY: count

počet události kalendáře kalendářů

eventArray

pole jednotlivých událostí order pořadové číslo dow den v týdnu date den v roce timeAt čas události v rámci dne tariff přepnutí na tarif R1 nastavení relátka č. 1 R2 nastavení relátka č. 2 R3 nastavení relátka č. 3 R4 nastavení relátka č. 4

calendarEventRemove Odebrání jedné události z kalendáře.

PARAMETRY: ISAR - dokumentace SOAP

Modemtec

10

Funkce pro vyčítání a modifikaci dat databáze AGS calendarId order

id kalendáře, do kterého se má přidat událost pořadové číslo události v rámci kalendáře

calendarClear Vymazání všech událostí kalendáře.


id kalendáře

ODEČTOVÉ ZÁZNAMY rrMeterGet Vyčtení odečtového záznamu dle zadaného času odečtu, pokud je v databázi.

PARAMETRY: meterId timeAt

číslo měřiče čas odečtu v unix time

NÁVRATOVÉ HODNOTY: errCode dataT1 dataT2 dataT3 dataT4 dataTSUM timeAGS

0 – ok, 1 – nenalezen záznam data pro tarif T1 – bez přepočtu na jednotky měřiče data pro tarif T2 data pro tarif T3 data pro tarif T4 celkový součet za všechny tarify čas zpracování (vyčtení) záznamu na agregačním serveru

rrMeterGet2 Vyčtení odečtových záznamů dle zadaného časového intervalu. V případě, že není nalezen žáden záznam, vrací funkce errCode=1.

PARAMETRY: meterId timeFrom timeTo

číslo měřiče čas začátku intervalu v unix time čas konce intervalu v unix time

NÁVRATOVÉ HODNOTY: count rrArray

počet zaslaných odečtových záznamů pole odečtových záznamů včetně parametrů v asociativním poli s požkami time timeF


čas odečtového záznamu čas odečtového záznamu - formátovaný Modemtec

11

Funkce pro vyčítání a modifikaci dat databáze AGS dataT1 dataT2 dataT3 dataT4 dataTSUM timeAGS

data pro tarif T1 – bez přepočtu na jednotky měřiče data pro tarif T2 data pro tarif T3 data pro tarif T4 celkový součet za všechny tarify čas zpracování (vyčtení) záznamu na agregačním serveru

rrMeterSet Nastavení způsobu generování odečtových záznamů (denní, týdenní, měsíční, …), nastavení data a času prvního odečtu, po tomto nastavení si AGS hlídá automatické generování odečtových záznamů na daném měřiči, v případě neúspěchu při nastavování odečtu, vygeneruje událost. U všech elektroměrů Landis & Gyr je nastaven opakovaný odečtový denní záznam, kdy se ukládá o půlnoci odečtový záznam včetně registrů elektroměru (až 64 položek).


Modemtec

12


PROFILOVÁ DATA profileMeterGet Požadavek na zaslání hodnot profilů v uvedeném časovém intervalu. Zasláno je maximálně 1000 řádků v jednom dotazu. Všechna data je možné vyčíst postupně pomocí parametru profileFrom zadaného v dotazu.

PARAMETRY: meterId timeFrom timeTo profilesFrom profilesOrder

číslo měřiče čas začátku intervalu v unix time čas konce intervalu v unix time pořadové číslo řádku v rámci intervalu (pro postupné vyčítání), číslováno od 0, určuje kolik ř. přeskočit řazení výstupu („time asc“ , „time desc“, „time_ags desc“) time asc řazení podle času v měřiči vzestupně time desc řazení podle času v měřiči sestupně time_ags desc řazení podle času načtení a uložení v serveru AGS sestupně

NÁVRATOVÉ HODNOTY: errCode profilesFrom profilesCount profilesRemain profiles

0 – ok, 1 – nenalezen žádný profil pořadové číslo řádku v rámci intervalu počet zaslaných profilových řádků počet zbývajících profilových řádků v rámci časového intervalu profily v poli, parametry v asociativním poli s položkami profile_id dc_id time_ags time_meter tsum t1 t2 t3 t4

id profilového řádku id DC, který řádek vyčetl čas serveru AGS, ve kterém přijal a uložil profil čas uložení profilového řádku v měřiči součet za všechny tarify (hodnota bez přepočítání koeficienty) hodnota pro tarif t1 hodnota pro tarif t2 hodnota pro tarif t3 hodnota pro tarif t4

profileClear vyprázdnění databáze dle zadaného časového intervalu, je možné pročistit databázi promazáním profilů (např. ponecháním pouze profilů v každou celou hodinu)


Modemtec

13


UDÁLOSTI – MĚŘIČ / GLOBAL eventGet Vyčtení zpracovaných událostí dle zadaného časového intervalu nebo pomocí sekvenčního čísla (id události). Časem se zde rozumí čas zápisu události do AGS.

PARAMETRY: method idFrom idTo timeFrom timeTo eventsFrom eventsOrder

1 – pomocí sekvenčního čísla (id), 2 – pomocí časového intervalu pro method=1 - počáteční id intervalu pro method=1 - koncové id intervalu v případě method=2 - čas začátku intervalu v unix time v případě method=2 - čas konce intervalu v unix time pořadové číslo řádku v rámci intervalu (pro postupné vyčítání), číslováno od 0, určuje kolik ř. přeskočit řazení výstupu („time asc“ , „time desc“, „time_ags desc“) time asc řazení podle času události vzestupně time desc řazení podle času události sestupně time_ags asc řazení podle času načtení a uložení v serveru AGS vzestupně time_ags desc řazení podle času načtení a uložení v serveru AGS sestupně id asc řazení podle id vzestupně výchozí řazení je id asc

NÁVRATOVÉ HODNOTY: errCode events

eventsFrom eventsCount eventsRemain

0 – ok, 1 – nenalezena žádná událost pole s vyčtenými událostmi, každá událost obsahuje následující parametry, některé události mohou mít více parametrů id id události code číselný kód (typ) události name název události (např. meterShutdown) meter_id id měřiče (modemu) pokud je k dispozici dc_id id data koncentrátoru time_ags čas uložení události na AGS time_at čas události z měřiče / DK pořadové číslo řádku v rámci intervalu počet zaslaných událostí počet zbývajících událostí v rámci intervalu

UDÁLOSTI A JEJICH PARAMETRY: 01 meterShutdown

vypnutí napájení za elektroměrem (zastavení dodávky proudu)

26 meterShutdownEnd

ukončení vypnutí napájení (obnovení dodávky)

15 meterTariffSet tariff

v měřiči došlo k přepnutí tarifu nastavený tarif (hodnota 1-4)

02 meterCoverDetached

sundání krytu svorkovnice

16 meterCoverAttached

nandání krytu svorkovnice


Modemtec

14

Funkce pro vyčítání a modifikaci dat databáze AGS 14 meterMgFieldDetected

detekce magnetického pole

25 meterMgFieldEnd

konec působení magnetického pole

06 meterPowerLost

ztráta napájení měřiče, událost je generována při zapnutí měřiče, čas události je časem vypnutí

07 meterPowerRestored

obnovení napájení měřiče

11 meterDiscovered

vyhledání měřiče DK (měřič je detekován DK)

12 meterAdded

přidání neexistujícího měřiče do databáze AGS (přidělení id)

10 meterTimeSet

nastavení (synchronizace) času měřiče (na základě testu a korekce) s DK

17 meterRelaysDirect 18 meterRelaysCalendar R1 R2 R3 R4

nastavení relátek na přímý příkaz nastavení relátek na základě události z kalendáře on/off – stav relátka R1 on/off – stav relátka R2 on/off – stav relátka R3 on/off – stav relátka R4

phase

podpětí fáze o 10% tedy méně než 207V číslo fáze (1-3)

phase

přepětí fáze o 10% tedy více než 253V číslo fáze (1-3)

phase

napětí fáze zpátky v normě (navazuje na jeden z předchozích stavů) číslo fáze (1-3)

19 meterUnderVoltage

20 meterOverVoltage

27 meterNormalVoltage

23 meterOnline

měřič je vyhodnocen AGS ve stavu online (poslední komunikace není starší 5 min.)

24 meterOffline

měřič je vyhodnocen AGS ve stavu offline (poslední komunikace starší 5 min.)

22 meterButtonPressed

na elektroměru stlačeno tlačítko pro uživatele (na obnovení dodávky)

21 meterFlashError

chyba zápisu do flash paměti měřiče

28 meterCalendarActivated

přepnutí pasivního kalendáře na aktivní

13 dcMeterAssigned

přiřazení měřiče k DK (součást registračního procesu měřiče)

03 dcOnline

ustavení komunikace s DK

04 dcOffline

ztráta komunikace s DK

05 dcEventOther

další události z DK


Modemtec

15


eventMeterGet Požadavek na zaslání událostí z měřičů v uvedeném časovém intervalu. Zasláno je maximálně 1000 řádků v jednom dotazu. Všechna data je možné vyčíst postupně pomocí parametru eventsFrom zadaného v dotazu. Přenášejí se události vzniklé na samotných měřičů, tak jak jsou z nich vyčteny bez dalších úprav na globální události v AGS. Pro přenos zpracovaných událostí je zde příkaz eventGet.

PARAMETRY: meterId timeFrom timeTo eventsFrom eventsMax eventsOrder

číslo měřiče čas začátku intervalu v unix time čas konce intervalu v unix time pořadové číslo řádku v rámci intervalu (pro postupné vyčítání), číslováno od 0, určuje kolik ř. přeskočit maximální počet přenesených událostí (0 – omezeno protokolem) řazení výstupu („time asc“ , „time desc“, „time_ags desc“)

NÁVRATOVÉ HODNOTY: errCode events eventsFrom eventsCount eventsRemain

0 – ok, 1 – nenalezen žádný profil pole s vyčtenými událostmi pořadové číslo řádku v rámci intervalu počet zaslaných událostí počet zbývajících událostí v rámci časového intervalu

eventClear, eventMeterClear čištění databáze událostí

DATA O KVALITĚ SIGNÁLU Z měřičů jsou pravidelně vyčítána data o signálu. Tato se ukládají do databáze a mohou být vyčtena pro analýzu.

probeMeterGet získání dat ohledně kvality signálu

PARAMETRY: meterId timeFrom timeTo

číslo měřiče čas od čas do


Modemtec

16

Funkce pro práci s frontou příkazů

FUNKCE PRO PRÁCI S FRONTOU PŘÍKAZŮ Všechny funkce typu QUEUE mají stejné chování. Parametry funkce určí, jak se má provést, návratovou hodnotou se pouze potvrzuje, že došlo ke zpracování a zařazení příkazu do fronty příkazů. V návratové hodnotě je queueId , které identifikuje pořadové číslo a později se na stav příkazu dá zjistit funkcí queueStatus. Synchronní zpracování požadavku: Parametrem všech funkcí queue může být parametr wait, který pokud je nastaven na hodnotu „1“, pak se příkaz queue vykoná synchronně a návratová data či potvrzení je součástí odpovědi. Návratová data jsou shodná s tím, co vrací funkce queueStatus. Pomocí parametru timeout lze zadat maximální čas pro vykonání synchronního požadavku. Pokud je parametr neuveden, pak je hodnota 10s.

queueStatus vyčtení stavu příkazu ve frontě, zda je již ukončen, prováděn nebo vypršel časový limit, funkce vrací také data výsledku zaslaná data koncentrátorem

PARAMETRY: id – číslo události

NÁVRATOVÉ HODNOTY: dc číslo datakoncentrátoru modem_id id modemu status stav příkazu ve frontě T1 T2 T3 WT A0 FF OK prio msg inserted accepted completed expire rawdata

timeout komunikace - DC-modem (modem neodpovídá) timeout komunikace - ISAR-DC (DC neodpovídá, problem v komunikaci nebo je offline) timeout prikazu na DC (DC je online, přijal příkaz ale z nějakého důvodu ho neprovedl) ISAR předává požadavek DC DC přijal požadavek jiná chyba při zpracování (např. neznámá funkce pro DC - DC je starší verze) požadavek splněn priorita zpracování provedený příkaz pro DC čas vložení příkazu do fronty čas přijetí DC čas dokončení příkazu čas kdy dojde k vypršení a dale se již na DC neposílá data odpovědi z DC

PŘÍKAZY PRO DK queueDcProfilesRead zaslání příkazu pro okamžité vyčtení uložených profilů z měřičů, DK nečeká na vykonání pravidelné smyčky


Modemtec

17


queueDcEventsRead zaslání příkazu pro okamžité vyčtení dosud nevyčtených událostí z měřičů

queueDcConfigReload znovunačtení konfigurace DK


Modemtec

18


PŘÍKAZY PRO DK - BROADCAST queueDcBroadcastShutdown Hromadné rozeslání povelu na zastavení dodávky (použitím odpojovače). Součástí povelu může být určení skupiny měřičů (meterGroup), na které má být shutdown zaslán. Příkaz vzhledem k časové náročnosti nelze poslat synchronně. Přes queueStatus je možné vyčíst stav příkazu.

PARAMETRY: dcId behavior meterGroup

id data-koncentrátoru chování tlačítka pro obnovení dodávky (0 – zakázat dodávku, 1 – povolit dodávku, …) skupina (multicast)

queueDcBroadcastWakeup Hromadné rozeslání povelu na obnovení dodávky (použitím odpojovače). Součástí povelu může být určení skupiny měřičů.

PARAMETRY: dcId meterGroup

id data-koncentrátoru skupina

queueDcBroadcastRelay Hromadné rozeslání povelu na přepnutí relé. Součástí povelu může být určení skupiny měřičů. V příkazu se uvádějí jen ta relé, kde má dojít ke změně stavu.

PARAMETRY: dcId meterGroup R1 R2 R3 R4

id data-koncentrátoru skupina nastavení relátka č. 1 (hodnoty on / off) (nepovinné) nastavení relátka č. 2 (hodnoty on / off) (nepovinné) nastavení relátka č. 3 (hodnoty on / off) (nepovinné) nastavení relátka č. 4 (hodnoty on / off) (nepovinné)

queueDcBroadcastTariff Hromadné rozeslání povelu na přepnutí tarifu. Součástí povelu může být určení skupiny měřičů.

PARAMETRY: dcId meterGroup tariff

id data-koncentrátoru skupina číslo tarifu (1-4)


Modemtec

19


queueDcBroadcastLimit Hromadné rozeslání povelu na nastavení limitu pro automatické odpojení. Součástí povelu může být určení skupiny měřičů.

PARAMETRY: dcId meterGroup powerLimit interval behavior

id data-koncentrátoru skupina limit spotřeby (určeno v jednotkách měřiče – registru, který se kontroluje) (hodnota -1 ruší nastavení) délka intervalu v minutách, ve kterých se hlídá dosažení hodnoty powerLimit chování tlačítka pro obnovení dodávky (0 – zakázat dodávku, 1 – povolit dodávku, …)


Modemtec

20


PŘÍKAZY PRO MĚŘIČ queueMeterGetConfig Zaslání příkazu na vyčtení veškeré konfigurace modemu. Údaje se uloží do databáze ISARu a jsou následně dostupná synchronně pomocí funkce meterGet (dílčí měřič) nebo meterList (všechny měřiče).

PARAMETRY: meterId

číslo měřiče

queueMeterTariffGet Vyčtení aktuálního tarifu nastaveného v měřiči.

PARAMETRY: meterId

číslo měřiče

queueMeterTariffSet Okamžité nastavení tarifu měřiče.

PARAMETRY: meterId tariff

id měřiče číslo tarifu na který okamžitě přepnout měřič (hodnoty 1-4)

queueMeterRrSet nastavení času provedení odečtu do měřiče

queueMeterRrGet Vyčtení odečtového záznamu. Odečet se uloží v databázi a je pak dostupný přes funkci rrMeterGet, rrMeterGet2.

PARAMETRY meterId type

id měřiče 0 – okamžitý odečet, 1 – uložený odečet, 4 – prvně uložený odečet po zapnutí měřiče

queueMeterProfileSet Nastavení intervalu vyčítání profilových dat z měřiče (elektroměru) a ukládání do modulu.


Modemtec

21


PARAMETRY meterId interval

id měřiče interval v sekundách, jedna z následujících hodnot 60, 120, 180, 300, 600, 900, 1800, 3600, 43200, 86400

queueMeterRelayGet okamžité zjištění stavu relé

queueMeterRelaySet Okamžité nastavení relé.

PARAMETRY meterId relay status

id měřiče číslo relé (1-4) nový stav relé (0 – vypnuto, 1 – sepnuto)

queueMeterShutdown Poslání příkazu na měřič na vypnutí shutdown relé (stykač) – zastavení dodávky energie.

PARAMETRY meterId behavior

adresa měřiče chování tlačítka pro obnovení dodávky (0 – zakázat dodávku, 1 – povolit dodávku, …)

queueMeterWakeup Obnovení dodávky energie.

PARAMETRY meterId

adresa měřiče

queueMeterLimit Nastavení limitu pro automatickou funkci odpojovače.

PARAMETRY: meterId powerLimit interval behavior

id měřiče limit spotřeby (určeno v jednotkách měřiče – registru, který se kontroluje) (hodnota -1 ruší nastavení) délka intervalu v minutách, ve kterých se hlídá dosažení hodnoty powerLimit chování tlačítka pro obnovení dodávky (0 – zakázat dodávku, 1 – povolit dodávku, …)

queueMeterTimeSync Zaslání povelu na synchronizaci času měřiče s DK.


Modemtec

22


PARAMETRY meterId

adresa měřiče

queueMeterTimeGet Vyčtení systémového času z měřiče.

PARAMETRY meterId

id měřiče

queueMeterCalendarSet Nahrání kalendáře do měřiče (nahrává se do pasivního kalendáře)

PARAMETRY meterId calendarId

id měřiče id kalendáře k nahrání do měřiče

queueMeterCalendarSwitch Nastavení času přepnutí pasivního kalendáře na aktivní

PARAMETRY meterId timeAt

id měřiče čas přepnutí pasivního kalendáře na aktivní

queueMeterCalendarGet Stažení kalendáře z měřiče.

PARAMETRY meterId

id měřiče

NÁVRATOVÉ HODNOTY: calendarId

id kalendáře (nemusí souhlasit s aktuální databází AGS)

eventArray

pole událostí order pořadové číslo dow den v týdnu date den v roce timeAt čas události v rámci dne tariff přepnutí na tarif R1 nastavení relátka č. 1 R2 nastavení relátka č. 2


Modemtec

23

Funkce pro práci s frontou příkazů R3 R4

nastavení relátka č. 3 nastavení relátka č. 4

queueMeterRegClear vynulování stavového registru

queueMeterRegTimeoutSet Nastavení času odregistrace do měřiče. Pokud modem není osloven po delší dobu než je nastaven touto funkcí, pak se „odregistruje“ a začne odpovídat na nové vyhledávání v síti. Standardně je hodnota pro odregistraci v modemu nastavena na 60 minut.

PARAMETRY meterId regTimeout

id měřiče čas odregistrace


Modemtec

24

Systémové funkce

SYSTÉMOVÉ FUNKCE UŽIVATELÉ ISARU Jedná se o množinu funkcí určených k modifikací přístupových údajů do prezentační vrstvy ISARu. V ISARu jsou definováni uživatelé, kterým jsou přidělovány role v sytému. Role je výčet systémových práv opravňujících přístup k jednotlivým funkcím ISARu. Systémová práva jsou pevně dána ISARem.

userList vyčtení seznamu uživatelů

userAdd přidání uživatele

userModify změna parametrů uživatele

userRemove odebrání uživatele

userAddRole přiřazení role k uživateli

userRemoveRole odebrání role uživateli

roleList vyčtení seznamu rolí

roleAdd přidání uživatelské role

roleModify úprava parametrů role

roleRemove smazání role z databáze

roleAddPrivilege přiřazení systémového práva k roli


Modemtec

25

Formáty předávaných parametrů

roleRemovePrivilege PROVOZNÍ FUNKCE ISARU agsBackupNow provedení okamžité zálohy databáze

agsSettings nastavuje chování ags dle zaslaných parametrů

agsVpnRestart restart vpn serveru

agsUpgrade provede upgrade systému ze souboru v adresáři upgrade

agsReload Příkaz provede restart serveru. Parametrem příkazu je čas, kdy se má server restartovat. Je tak možné provést okamžitý nebo odložený restart.

agsShutdown Příkaz provede vypnutí serveru.

agsStatus Vyčtení stavových informací serveru. (verze, uptime, velikost databáze, počet měřičů, dk, atd.)

agsConfigExport export celé konfigurace ags (evidence měřičů, dk, přiřazení, nastavení uživatelů a skupin)

FORMÁTY PŘEDÁVANÝCH PARAMETRŮ Časový údaj

datum či čas je předáván vždy ve formě tzv. timestamp, jedná se o počet sekund od 1.1.1970, údaj je vždy v UTC

POUŽITÉ ZKRATKY AGS DC

agregační server data-koncentrátor


Modemtec

26

ModemTec SOAP rozhraní. popis a dokumentace funkcí

Recommend Documents