MERKEZ YAZILIM API Bilgileri

Transkript

1 MERKEZ YAZILIM API Bilgileri Bu dökümanın amacı, Merkez yazılımın izleme istasynlarından veri alabilmesini sağlayabilmek için gerekli API bilgilerini sunmaktır. Bu dküman, T.C. Çevre ve Şehircilik Bakanlığı tarafından tarihinde hazırlanmıştır.

2 API Bilgileri 1. API Bağlantı Bilgileri Merkez iletişim mdülü API a HTTP/1.1 request i göndererek veri srgulama yapacaktır. API endpint güvenliği sağlamak amacıyla bağlantı esnasında RFC 2617 de tanımlanan Basic access authenticatin ile kullanıcı adı/şifre dğrulamasına izin verebilir. 2. Veri frmatı API a yapılan srguların cevabı RFC 7159 ve ECMA-404 te tanımlanan JSON (JavaScript Object Ntatin) frmatında lacaktır. Aksi belirtilmedikçe, tüm string alanlar en fazla 50 karakter lacaktır. 3. Veri Status Kdları Verilere ait status kdları aşağıda yer alan tablda verilmiştir: Status Kdu Status Kd Adı Açıklama 0 Veri Yk Arada veri yksa bu değerlerin durum bilgisi "0" larak gelmelidir. 1 Veri Geçerli Geçerli veri, ölçüm verisi, rtalamaya baz alınacak veri 2 Ölçüm Yk Ölçüm cihazının ilgili kanalının taramaya kapatılması. Örneğin cihaz ph, d, iletkenlik ölçüyr. Ben sadece ph ölçümünü kapatıp diğerlerini devam etmesini istiyrum. Sadece ph ı Scan ff yapıp diğerlerini çalışır durumda bırakıyrum. 3 Ort Yetersiz Ortalama alarm kriteri yetersiz lduğu durum.örn: cihazdan 10 saniyede bir değer kunuyr. 5 dakika snunda 30 tane veri var. Bunların rtalaması geçerli lan verilerden alınıyr. Eğer verinin belli bir kısmı, mesala %30 'u, geçersiz ise ne lacak? 4 Geçersiz Cihazın ölçüm kanalında (ph iletkenlik debi etc ) herhangi bir uygunsuz veri lduğunda (cihazn ölçtüğü değer belirlenen ölçüm aralığının dışındaysa, cihazda ölçüm kanalını etkileyen bir alarm varsa, etc.) herhangi bir uygunsuzluk durmunda. 5 Sıfır Kalibrasynu Cihazın sıfır ayarı, iletkenlik ms., ph 7, ç 0 ppm. Debi 0 m3/h 6 Span Kalibrasynu Hassasiyet ayarı(örnek: ph için 4 veya 7, sıcaklık için sıcaklık kalibratörü) 7 Kal Limit Dışı Cihaz tmmatik slusyn beslemeli ise span knsantrasynunda sapma lursa uyarı vermesi için 8 İletişim Hatası Veirini frmatında hata lduğuda.(örnek ph 7.2 yerine a,b gibi bir değer geldiğinde 9 Sistem Kalibrasynda Harici bir kalibrasyn düzeneği ile cihaza kalibrasyn uygulaması yapılırken durumu bu lmalı 10 Enerji Kesintisi Şebeke kesildiğinde bu durum "10" larak işaretlenir. Sistem UPS den beslenmeye devam edecektir. 11 Kntrl Sensörler ölçmeye devam ediyr ancak uyarı veriyr. "Bakım Isteği, Sensör Kirlendi" ph sensörü bufferı azalmış" gibi. 12 Alarm Ölçülen kanalın değeri geçersiz. "Sensr Hatası", "Debi Sinyali Hatalı", cihaz kanalda alarm gösterdiğinde bu durum ilgili sensrun kanalının status bilgisini "12" larak işaretleyecek ve değerleri geçersiz kılacaktır. 13 Prses Kapalı Ölçüm nktasında prses çalışmıyr ise. 14 Stand By Cihaz veya sensör ölçüm yapmadığı durumda lması gereken status dur. 15 Purge Yıkamadan snra numune klnunun tamamen numune ile dlana kadar geçen sürede status "15 larak gönderilmelidir.

3 16 Analizör Bakımı 17 Ölçüm Araliği Üzerinde 18 Ölçüm Aralığı Altında 19 Kalibrasyn Hatası 20 Rate Of Change 21 NumuneAkisi Yk 22 Deşarj Yk 23 Yıkama 24 Haftalık Yıkama 25 İstasyn Bakımda 26 Tesis Bakımda Rezerve Aynı zamanda eğer tmatik kalibrasyn yapılmış ise kalibrasyndan snra yine sensör temas nktası tamamen numune ile dlana kadar lması gereken status dur. Sensörde veya nalizörde bakım yapılıyr iken lması gereken status sinyalidir. Örneğin bir cihaza hem ph hemde iletkenlik baglı ve bu cihaz bakıma alınmışsa hem ph kanalı hemde iletkenlik kanalı status 16 larak işaretlenmelidir. Diğer sttauslar ne ise aynı kalmalıdır. Sensörün ölçtüğü değer mantıklı değerin üzerinde lduğunda lması gereken durumdur. Örneğin: ph 15 iken veya sıcaklık 80 derecenin üzerinde iken.(bunlar örnektir. Prsese göre farklılıklar labilir.,) Yukarıda tanımlı lan durumun tersidir. Örneğin ph sıfırn altında iken veya sıcaklık 0 derecenin altında iken veya atıksu debisi negatif lcuyrsa Sensörler de yapılan kalibrasynda değer ayarlana alt ve üst limitlerin dışına çıktığında ölçüm kanalı kalibrasyn hatası larak işaretlenir. Bu durum tekrar kalibrasyn yapılıp kalibrasyn sapmalarının limitler dahilinde luncaya kadar geçerlidir. Değer belli bir aralıkta yazılım prgramında ayarlanmış lan limit değerinin üzerin çıkarsa veri bu status ile işaretlenir. Örneğin: ph 7-8 arasında değişirken aniden 2 ye düşerse (bu örnektir) Numune klnundan önce kullanılması gereken akış dedektöründeki akış miktarının sıfır veya sıfra yakın lduğu durumlarda bağlı lan tüm sensörlerin status bilgisi 21 lmalıdır. (Deşarj debisi hariç) Bu atıksu arıtma tesisinden gelecek lan sinyallerden bir tanesidir. Eğer atıksu arıtma tesisi deşarj yapmıyrsa tüm ölçüm kanallarındaki status 22 lmalıdır. Buna deşarj debiside dahildir. Her 6 saate bir 20 dakika yapılan yıkama durumunda debi ve sıcaklık dışındaki(ki bu sensörler klnda değil) tüm kanalların status u 23 lmalıdır. Her yıkamadan snra belli bir sürede purge status u lmalıdır. Her haftada bir saat süresince yapılan yıkama durumunda debi ve sıcaklık dışındaki(ki bu sensörler klnda değil) tüm kanalların status u 24 lmalıdır. Her yıkamadan snra belli bir sürede purge status u lmalıdır. İstasyn sensörler dışında başka nedenlerden ötürü bakıma alınmış ve ölçülen değerler geçersiz ise verilerin status u 25 larak işaretlenir. Örneğin: Örnekleme hattı değişirken örnekleme hattının çalışmamasından etkilenen kanalların status u 25 larak işaretlenmelidir. Arıtma tesisi bakımda iken tesisden kabine verilmesi gereken sinyaldir. Bu sinyal sisteme geldiğinde tüm değerler 26 status larak işaretlenir.

4 4. Tarih ve Saat Biçim Bilgisi API a yapılan srgularda kullanılacak tarih frmatı ve API cevabında kullanılacak tarih frmatı ISO 8601 standardında lacaktır. Tarih: Karma tarih/saat (UTC): T23:35:00+00:00 5. API Kmutları API kmutlarına ilişkin özet aşağıda verilmiştir. /v1/site/:id/data /v1/site/:id/digitalinput /v1/time /v1/site/:id/digitalmnitrstatus/:channelid /v1/site/:id/calibratin /v1/site/:id/diagnstics /v1/pwerff /v1/site/:id/instantaneus /v1/site/:id/instantcalibratin /v1/site/:id/lgbk /v1/site/:id/channels Örnek: Aşağıda verilen örnekte 1 numaralı ölçüm nktasına ait veriler talep edilmektedir Data Parametrelerin ölçüm verileri 1 (bir) dakikalık rtalamalar ile sunulması gerekmektedir. Data request i, ölçüm nktalarından veri alma amacıyla kullanılmaktadır. /v1/site/:id/data frm <datetime> Başlangıç tarih/saat t <datetime> Bitiş tarih/saat timebase <int> Zaman esası (psiynel) limit <int> Talep edilen veri data adedi (psiynel) /v1/site/:id/data?frm=<datetime>&t=<datetime>[&timebase=<int>][&limit=<int>] Aşağıda yer alan örnek request te 1 numaralı ölçüm nktası için 24 Nisan :00 ile 24 Nisan :00 arası 1 dakikalık zaman esaslı verilerden ilk 2 adet kayıt talep edilmektedir. Zaman esası gönderilmediği taktirde ölçüm nktasına ait varsayılan zaman esaslı rtalama veri gönderilir. /v1/site/1/data/?frm= t09:00:00&t= t11:00:00&timebase=1&limit=2

5 Örnek Respnse "data": [ "datetime": " T09:00:00", "data": [ "channelid": 0, "value": 1.0, "status": 1 "channelid": 1, "value": 249.1, "status": 3 "channelid": 2, "value": , "status": 4 "datetime": " T09:30:00", "data": [ "channelid": 0, "value": 1.0, "status": 1 "channelid": 1, "value": 248.8, "status": 3 "channelid": 2, "value": -9999, "status": 8

6 4.2. Digital Input Digitalinput request i, ölçüm nktalarından dijital giriş verilerini alma amacıyla kullanılır. Dijital giriş verilerine örnek larak kapı açık, yüksek kabin sıcaklığı veya elektrik yk verilebilir. Dijital giriş verileri, yalnızca dijital giriş kanallarından birinde durum değişikliği lduğu taktirde yeniden üretilmelidir. /v1/site/:id/digitalinput - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psiynel) /v1/site/:id/digitalinput?frm=<datetime>&t=<datetime>[&limit=<int>] Aşağıda yer alan örnek request te 1 numaralı ölçüm nktası için 13 Mayıs :46 ile 14 Mayıs :48 arası dijital giriş verilerinden ilk 4 adedi talep edilmektedir. /v1/site/1/digitalinput/?frm= t13:46:00&t= t13:48:00&limit=4 Örnek Respnse "digitalinput": [ "datetime": " T13:46:15", "state": "0x00" "datetime": " T13:47:30", "state": "0x01" "datetime": " T13:52:05", "state": "0x00" "datetime": " T13:52:15", "state": "0x01" 4.3. Time Time request i, veri tplama sistemine ait sistem saatini alma amacıyla kullanılır. Time request inde herhangi bir parametre gönderilmemektedir. /v1/time Örnek Respnse "systemdatetime": " T23:20:40"

7 4.4. Digital Mnitr Status DigitalMnitrStatus request i, ölçüm nktasındaki bir kanala ait dijital kanal durum bilgisini alma amacıyla kullanılır. Analizörlerden gelen dijital durum bilgileri örneğin WarmUp, Alarm, Zer, Cal, IRLamp Fault, vb. veriler labilir; cihazların röle kntakları değil, dijital çıkış durum bilgileri kullanılmalıdır. Kanala ait lası status bit leri ve açıklamaları kurulum esnasında bakanlığa bildirilmelidir. /v1/site/:id/digitalmnitrstatus/:channelid - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psiynel) /v1/site/:id/digitalmnitrstatus/:channelid/?frm=<datetime>&t=<datetime>[&limi t=<int>] Aşağıda yer alan örnek request te 1 numaralı ölçüm nktasında bulunan 2 id li kanal için 7 Temmuz :46 ile 8 Temmuz :48 arası dijital kanal durum verilerinden ilk 2 adedi talep edilmektedir. /v1/site/1/digitalmnitrstatus/2/?frm= t13:46:00&t= t13:48:00&limit=2 Örnek Respnse "channelid": 2, "digitalmnitrstatus": [ "datetime": " T13:48:47", "state": "0x18" "datetime": " T13:50:53", "state": "0x18"

8 4.5. Calibratin Calibratin request i, ölçüm nktasında kanallara ait tüm kalibrasyn bilgilerini alma amacıyla kullanılır. Alınan cevapta site (ölçüm nktası) id si ve kalibrasyn verileri yer alır. Kalibrasyn verileri, her kalibrasyn için ve farklı kalibrasyn tipleri için bilgiler içerir. Bu bilgiler aşağıdaki gibidir: - datetime [datetime]: Kalibrasyn zamanı - valid [bl]: Kalibrasynun geçerli lup lmadığı - factr [duble]: Kalibrasyn snucunda elde edilen sapma faktörü - channelid [int]: Kanal ID si - Zer kalibrasynu için: zer [duble]: sıfır değeri ffset [duble]: t kalibrasyn sekansına başladığından bu yana geçen zaman dakika ve saniye cinsinden duratin [duble]: sıfır için tanımlanan süre samples [duble]: duratin zamanı içerisinde rtalamanın alınmaya başlayacağı süre. reference [duble]: sıfır referans değeri ( O2 için 20.9 labilir) value [duble]: cihazın samples süresi içerisinde kuduğu değerlerin rtalamasıdır. std [duble]: Ortalama alınan verilerin standart sapmasıdır. - Span kalibrasynu için: ffset [duble]: t kalibrasyn sekansına başladığından bu yana geçen zaman dakika ve saniye cinsinden duratin [duble]: span için tanımlanan süre samples [duble]: duratin zamanı içerisinde rtalamanın alınmaya başlayacağı süre. reference [duble]: span referans değeri value [duble]: cihazın samples süresi içerisinde kuduğu değerlerin rtalamasıdır std [duble]: Ortalama alınan verilerin standart sapmasıdır - Multipint (çk nktalı) kalibrasynda her bir kalibrasyn nktası için: ffset [duble]: t kalibrasyn sekansına başladığından bu yana geçen zaman dakika ve saniye cinsinden pint [duble]: Kalibrasyn nktası durum status kdu duratin [duble]: span X için tanımlanan süre reference [duble]: span X referans değeri value [duble]: cihazın duratin süresi içerisinde kuduğu değerlerin rtalamasıdır std [duble]: Ortalama alınan verilerin standart sapmasıdır userlgin [max 50 karakter string]: Sisteme giriş yapan kullanıcı bilgileri peratrname [max 50 karakter string]: Operatör adı peratintype [int]: 1: Otmatik, 2: Manuel /v1/site/:id/calibratin - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psinel) /v1/site/:id/calibratin?frm=<datetime>&t=<datetime>[&limit=<int>]

9 Aşağıda yer alan örnek request te 1 numaralı ölçüm nktasına ait 1 Nisan 2015 ile 21 Nisan 2015 arası kalibrasyn verileri talep edilmektedir. /v1/site/1/calibratin/?frm= &t= Örnek Respnse "calibratin": [ "datetime": " T12:17:09", "valid": false, "factr": , "channelid": 2, "zer": "zer": 0.2, "ffset": 5.0, "duratin": 5.0, "samples": 5.0, "reference": 0.0, "value": 0.2, "std": 0.0 "span": "ffset": 15.0, "duratin": 5.0, "samples": 5.0, "reference": 5.0, "value": 4.9, "std": 0.0 "multipint": null "datetime": " T15:49:22", "valid": true, "factr": , "channelid": 2, "zer": "zer": 0.2, "ffset": 5.0, "duratin": 5.0, "samples": 5.0, "reference": 0.0, "value": 0.2, "std": 0.0 "span": "ffset": 15.0, "duratin": 5.0, "samples": 5.0, "reference": 5.0, "value": 4.9, "std": 0.0 "multipint": [ "ffset": 25, "pint": "type": 31 "duratin": 5, "reference": 10.0, "value": 10.2, "std": 0.0, "userlgin": "Administratr (Operate Service)", "peratrname": "N User Exists (Operate Viewer)", "peratintype": 2 "ffset": 35, "pint": "type": 38

10 "duratin": 5, "reference": 20.0, "value": , "std": 0.0, "userlgin": "Administratr (Operate Service)", "peratrname": "N User Exists (Operate Viewer)", "peratintype": 2 "ffset": 45, "pint": "type": 39 "duratin": 5, "reference": 30.0, "value": , "std": 0.0, "userlgin": "Administratr (Operate Service)", "peratrname": "N User Exists (Operate Viewer)", "peratintype": 2 "ffset": 55, "pint": "type": 43 "duratin": 5, "reference": 70.0, "value": , "std": 0.0, "userlgin": "Administratr (Operate Service)", "peratrname": "N User Exists (Operate Viewer)", "peratintype": 2 "ffset": 65, "pint": "type": 44 "duratin": 5, "reference": 100.0, "value": , "std": 0.0, "userlgin": "Administratr (Operate Service)", "peratrname": "N User Exists (Operate Viewer)", "peratintype": 2

11 4.6. Diagnstics Diagnstics request i, ölçüm nktasında kanallara ait diyagnstik verilerini alma amacıyla kullanılır. Alınan cevapta site (ölçüm nktası) id si ve diyagnstik verileri yer alır. Diyagnstik verileri; kanal id si, tarih/saat ve diyagnstik bilgilerinden. Diyagnstik bilgileri aşağıdaki gibidir: - cmmand [max 50 karakter string]: Cihazın sinyal değerini almak için gereken kmut - units [max 50 karakter string]: Ölçülen sensör değerinin birimi (mv, Amp, Deg.C vb..) - value [duble]: Nümerik sinyal değeri /v1/site/:id/diagnstics - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psinel) /v1/site/:id/diagnstics?frm=<datetime>&t=<datetime>[&limit=<int>] /v1/site/1/diagnstics/?frm= &t= Örnek Respnse "diagnstics": [ "channelid": 1, "datetime": " T00:00:00", "data": [ "cmmand": "cmd1", "units": "unt1", "value": "1.1" "cmmand": "cmd2", "units": "unt2", "value": "2.2" "cmmand": "cmd3", "units": "unt3", "value": "3.3" "channelid": 1, "datetime": " T00:00:00", "data": [ "cmmand": "cmd1", "units": "unt1", "value": "1.1" "cmmand": "cmd2", "units": "unt2", "value": "2.2" "cmmand": "cmd3", "units": "unt3", "value": "3.3"

12 4.7. Pwer Off PwerOff request i, veri tplama sisteminin kapalı lduğu zamanları srgulamak amacıyla kullanılır. /v1/pwerff - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psinel) /v1/pwerff?frm=<datetime>&t=<datetime>[&limit=<int>] /v1/pwerff/?frm= &t= &limit=3 Örnek Respnse "pwerff": [ "start": " T19:15:36", "end": " T19:15:35" "start": " T19:21:04", "end": " T19:21:03" "start": " T19:33:08", "end": " T19:33:07" 4.8. Instantaneus Instantaneus request i, ölçüm nktasına ait kanalların anlık örnekleme verilerini srgulamak amacıyla kullanılır. Alınan cevaptaki veriler, analizörden kunan ham verilerdir. /v1/site/1/instantaneus Örnek Respnse "instantaneus": [ "datetime": " T16:40:11.05", "channelid": 0, "value": 16.8, "status": 1 "datetime": " T16:40:11.05", "channelid": 1, "value": 4.0, "status": 1 "datetime": " T16:40:11.05", "channelid": 2, "value": , "status": 8

13 4.9. Instant Calibratin InstantCalibratin request i, ölçüm nktasına ait kanalların anlık kalibrasyn verilerini srgulamak amacıyla kullanılır. Herhangi bir sekansın herhangi bir anını çalıştırdığınızda elde edilen değeri temsil eder. Anlık kalibrasyn verileri, gerçekleştirilen her anlık kalibrasyn için bilgiler içerir. Bu bilgiler aşağıdaki gibidir: - datetime [datetime]: Kalibrasyn zamanı - channelid [int]: Kanal ID si - value [duble]: Ölçülen değer - status [int]: değerin durum bilgisi ( span, zer vb..) /v1/site/:id/instantcalibratin - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psinel) /v1/site/:id/instantcalibratin?frm=<datetime>&t=<datetime>[&limit=<int>] /v1/site/1/instantcalibratin/?frm= &t= &limit=2 Örnek Respnse "instantcalibratin": [ "datetime": " T06:00:00", "channelid": 0, "value": 7.0, "status": 1 "datetime": " T05:00:00", "channelid": 0, "value": 6.0, "status": 1

14 4.10. Lgbk Lgbk request i, ölçüm nktasına ait bakım kayıtlarını ve veritplama sisteminde gerçekleşen işlemleri srgulama amacıyla kullanılır. Lgbk verileri, sistemde kayıtlı lg lar ile ilgili bilgiler içerir. Lgbk verileri, bakım işlemleri haricinde veri tplama sisteminde gerçekleştirilen tüm işlemleri (kullanıcı girişleri, knfigürasyn değişikliği, kanal) içermelidir. Bu bilgiler aşağıdaki gibidir: - datetime [datetime]: Kayıt zamanı - lg : Kayıt verileri equipment [max 50 karakter string]: Cihaz bilgisi invaliddata [int]: Bakım yapılıyrsa, bakım esnasında verinin geçersiz kılınıp kılınmadığı (0: geçerli, 1: geçersiz) tendtype [max 50 karakter string]: Bakımın/işlemin türü (Arıza, Periydik Bakım, Yıllık Bakım, Kntrl, Kullanıcı Girişi, Knfigürasyn değişikliği, vb.) technician [max 50 karakter string]: Bakımı yapan ya da işlemi gerçekleştiren kullanıcı bilgisi descriptin [max 2000 karakter string]: Bakım ya da işlem ile ilgili detaylı açıklama spareparts [max 2000 karakter string]: Değişen yedek parçalar (parçalar ; ile ayrılmış) /v1/site/:id/lgbk - frm <datetime> Başlangıç tarih/saat - t <datetime> Bitiş tarih/saat - limit <int> (ptinal) Talep edilen veri adedi (psinel) /v1/site/:id/lgbk?frm=<datetime>&t=<datetime>[&limit=<int>] /v1/site/1/lgbk/?frm= &t= &limit=2 Örnek Respnse "lgbk": [ "datetime": " T13:21:39", "lg": "equipment": "", "invaliddata": 0, "tendtype": "User Lgin", "technician": "Erl Egemen", "descriptin": "User lgged in.", "spareparts": "" "datetime": " T13:22:47", "lg": "equipment": "PM10 Analizru", "invaliddata": 0, "tendtype": "Scheduled - weekly", "technician": "Erl Egemen", "descriptin": "Haftalik periydik degisim", "spareparts": "Filtre;Hlder"

15 4.11. Channels Channels request i ölçüm nktasına ait ölçüm kanallarının bilgilerini almak için kullanılır. /v1/site/:id/channels /v1/site/1/channels Örnek Respnse "channels": [ "id": 0, "name": "ph", "units": "null", "address": 0 "id": 1, "name": "ILETKENLIK", "units": "us", "address": 1 "id": 2, "name": "COZ_OKSIJEN", "units": "mg/l", "address": 2