Yazılımın HALO Akıllı Sensör API Temel Yazılımı
İleri
Bu belge, toplu olarak BASIC API veya Uygulama Programlama Arayüzü olarak bilinen Halo Akıllı Sensörün özellik grubunu açıklamaktadır. Bu tartışma, bir veya daha fazla HALO Akıllı Sensörü (HALO) 3. taraf (IPVideo olmayan) yazılım bileşenleri veya sistemleriyle entegre etmekle ilgilenen programcılar veya entegratörlerin kullanımına yöneliktir. Genel olarak HALO API'nin amacı, bilgileri geleneksel bir Ethernet ağı üzerinden HALO'dan harici programa verimli bir şekilde aktarmaktır. Bu hedefi gerçekleştirmek için API üç bölüme ayrılmıştır: Olaya Dayalı Soket Bağlantısı, Kalp Atışı Soket Bağlantısı ve Olay Verileri URL. BACnet arayüzü de mevcuttur ve ayrı bir belgede ele alınmaktadır.
API Tasarımı
API, TCP/IP gibi endüstri standardı formatlar kullanılarak tasarlanmıştır. HTTP, HTTPS ve JSON. Tasarım, harici program veya uygulamanın geliştirilmesinde herhangi bir özel veya tescilli tekniğin veya kütüphanenin kullanılmasını gerektirmez. API esnektir ve tam olarak gereken verileri en verimli şekilde sağlayacak şekilde yapılandırılabilir ve programlanabilir. Yukarıdaki bölümlerin her birinin işleyişine ilişkin ayrıntılar, bu kılavuzun aşağıdaki bölümlerinde ele alınmaktadır.
Harici Mesajlaşma
Bu tesis, bir Olay tetiklendiğinde (ayarlandığında) uyarıları veya alarmları ve Olay verilerini harici bir programa, VMS sistemine, sunucuya vb. iletmek için kullanılır. Bir Olay temizlendiğinde (sıfırlandığında) sinyal vermek için isteğe bağlı mesajlar da etkinleştirilebilir. Bu teslimat gerçek zamanlı olarak bir TCP/IP soketine veya HTTP/S sunucusuna yapılabilir. Özelleştirilebilir içeriğe sahip bir dizi yapılandırılabilir protokol vardır. Kimlik doğrulama ve şifreleme mevcuttur.
Kalp atışı
Kalp atışı mesajları, canlı/kullanılabilirlik kanıtı sağlamak için yapılandırılabilir bir aralıkta (Olayların tetiklenme zamanı yerine) gönderilir. Harici Mesajlaşma ile benzer yeteneklere sahiptirler ancak genellikle belirli bir olayla ilgili ayrıntılar yerine genel durum bilgilerini içerecek şekilde yapılandırılırlar.
Olay Verileri URL
Bu özellik yalnızca bir Gizlilik Anlaşması kapsamında mevcuttur ve yalnızca harici programın tüm Etkinlik değerlerine, eşiklere ve durum işaretlerine erişim gerektirdiğinde kullanılmalıdır. Bu veriler genellikle talep üzerine harici program tarafından alınır, ancak çok yüksek bir sıklıkta değildir. Bu yöntem, makul bir yoklama oranı kullanıldığında genellikle bir miktar gecikmeye neden olur. Tipik yoklama oranları dakikada bir ile 5 saniyede bir arasında değişir ve mutlak maksimum oran saniyede birdir. Bu yöntem aynı zamanda bir Olay (uyarı) alındığında ek destekleyici verileri almak için de kullanılabilir.
Harici Mesajlaşma ayrıntıları
HALO'nun bir bölümü web arayüz Entegrasyon açılır penceresi, çeşitli değerlerin uzak bir TCP soketine veya bir HTTP/HTTPS sunucusuna gönderilebildiği tek bir 3. taraf bağlantısının yapılandırılmasını sağlar. Yer tutucular (belirteçler), iletilen metne canlı değerler eklemek için kullanılır. Her ne kadar "Harici Mesajlaşma" olarak etiketlenmiş olsa da bu kanal, HALO tarafından aktif olarak sağlanan gerçek zamanlı Olay tetikleyicilerini gerektiren neredeyse her türlü amaç için kullanılabilir. Bu düzenleme oldukça esnektir çünkü "Eylemler" üzerindeki seçimler bu kanal üzerinden hangi HALO Olaylarının iletileceğini belirler.
HTTP modunda, Dizeleri Ayarla ve Sıfırla URLİstenilen hedef sunucunun gerektirdiği şekilde girilmesi ve biçimlendirilmesi gereken e-postalar. Kimlik doğrulama için Kullanıcı ve Şifre alanı kullanılabilir. Aşağıdaki HTTP moduna bakın.
TCP modunda, Ayarlama ve Sıfırlama Dizeleri yalnızca alıcı TCP soketine gönderilen tek bir mesajın verileridir. Hedefin gerektirdiği şekilde biçimlendirilebilirler. Hedef, Adres ve Bağlantı Noktası alanlarında belirtilir. Aşağıdaki TCP Moduna bakın.
Her iki modda da, bağlantının veya diğer sorunların düzeltilmesine yardımcı olabilecek en son mesajın durumu görüntülenir. Bir mesajı zorlamak için Eylemler açılır penceresindeki Olay TEST düğmelerini kullanabilirsiniz:
Bu tür mesajları etkinleştirmek için Ayarlama veya Sıfırlama için Genel Açık/Kapalı Açık olmalıdır. Bir Olayın yalnızca başlangıcı ilgi çekici olduğundan sıfırlama genellikle kullanılmaz, ancak bu değişiklik gösterebilir. Her Etkinlik, Eylemler açılır penceresinde Ayarla mesajını mı yoksa Sıfırla mesajını mı kullanacağını bağımsız olarak belirleyebilir. Göz küresi düğmeleri, anahtar kelime değişiklikleri ve biçimlendirmeden sonra gönderilenlerin kaba bir temsilini gösterecektir. Tekrar Bekletme özelliği, sık iletilerin başka bir ileti gönderilmeden önce geciktirilmesi yoluyla kısıtlanması için kullanılabilir. Bu, Etkinlik başına bağımsız olarak yapılır. HALO, Olayların hızla yeniden tetiklenmesini önlemek amacıyla olaylar için 15 saniyelik yerleşik bir tutma süresine sahiptir. Dakikada bir türden 1'den fazla Olay gönderilmediğinden emin olmak istiyorsanız Tekrar Bekletme'yi 60 (saniye) olarak ayarlayabilirsiniz.
Kalp atışı ayrıntıları
Kalp Atışı iletimleri, Eylemler sayfasıyla herhangi bir etkileşimin olmaması dışında yukarıdakine benzer şekilde çalışır. Bunun yerine, Kalp Atışı iletimi Aralık alanıyla yapılandırıldığı şekilde düzenli olarak gerçekleşir. HTTP modunda, Ayarla ve Sıfırla Dizeleri URLİstenilen hedef sunucunun gerektirdiği şekilde girilmesi ve biçimlendirilmesi gereken e-postalar. Kimlik doğrulama için Kullanıcı ve Şifre alanı kullanılabilir. Aşağıdaki HTTP moduna bakın.
Heartbeat'in birincil amacı, HALO Akıllı Sensörün kullanım ömrünün kanıtını uzaktaki bir uygulamaya sağlamak olsa da, bu mesaj aynı zamanda seçilen sensörleri veya mevcut Olay durumu bilgilerini iletmek için de kullanılabilir. Eskiampyukarıdaki dosya uzun bir dize parametresi gönderir. URL Halo adını, sensör değerlerinin çoğunluğunu ve son olarak boş veya o anda tetiklenen Olayların bir listesini içeren Tetiklendi=%AKTİF%'i içerir.
HTTP (ve HTTPS) Modu
Harici Mesajlaşma ve Kalp Atışı dizeleri http: veya https olabilir: URLgerektiği gibi. Hedef sunucunun ihtiyacına göre yol ve parametreler girilebilir. %NAME% (HALO cihaz adı) veya %EID% (Olay kimliği) gibi anahtar kelimeler gerektiği gibi eklenebilir ve mesaj gönderildiğinde ilgili verilerle değiştirilecektir. Hızlı başvuru için sık kullanılan anahtar kelimelerin bir listesi gösterilir.
The URL yol, anahtar kelimelerin yanı sıra parametreleri de içerebilir. URL. Parametreler NAME=VALUE çiftleri veya bir JSON nesnesi ya da hedef sunucuya bağlı olarak özel bir format olabilir. EskiampHarici Mesajlaşma dosyaları, tetiklenen Etkinliği belirtmek için %EID% değerini içerir:
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat dosyalarına %ACTIVE% (şu anda tetiklenen Olaylar) veya bir sensör değeri eklenebilir:
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:…% değerleri, evtYYYYMMDD.csv günlüğünde sağdaki sensör sütunu başlıklarında bulunan adları kullanır. fileS. Bunlar genellikle:
Hedef sunucu GET istekleri yerine HTTP PUT veya POST'u tercih ediyorsa, URL PUT: veya POST: ile. Bağımsız olarak, birçok sunucuda popüler olan bir JSON verisini, [JSONBODY] anahtar sözcüğünü ve ardından JSON biçimli bir nesneyi ekleyerek ekleyebilirsiniz. Eskiamptarih:
PUT:https://server.com/event[JSONBODY]{“location”:”%NAME%”,”event”:”%EID%”}
The URL tipik IP adresini (ve IPv6'yı) ve bağlantı noktası ve kullanıcı parolası seçeneklerini destekler veya Temel veya Özet gibi kimlik doğrulama yöntemleri için gerekirse hedef sunucu olarak Kullanıcı ve Parola alanlarını kullanabilirsiniz:
https://username:password@123.321.123.321:9876/event…
TCP Modu
Adres ve Bağlantı Noktası alanları hedefi belirttiğinden, Harici Mesajlaşma ve Kalp Atışı dizeleri yalnızca veriler içindir. Adres, IPv4 ve IPv6 adlarını destekler.
Dize, yukarıda açıklanan HTTP mesajlarının veri bölümleri gibi veya hedef sunucunun gerektirdiği şekilde biçimlendirilebilir.
ExampHarici Mesajlaşma dosyaları, tetiklenen Etkinliği belirtmek için %EID% değerini içerir:
konum=%NAME%,olay=%EID%
{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat dosyalarına %ACTIVE% (şu anda tetiklenen Olaylar) veya bir sensör değeri eklenebilir:
konum=%NAME%&Tetiklendi=%AKTİF%
{“konum”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
"Entegrasyon Seti" ve "Entegrasyon Sıfırlama" sütunlarındaki onay kutuları, hangi Olayların gönderimi tetikleyeceğini belirler. Olaylar ve Eylemlerin kurulumu hakkında daha fazla bilgiyi HALO Yönetici Kılavuzu'nda bulabilirsiniz.
JSON Olay Mesajlarının Teslimi
Bazı geliştiriciler, düz ASCII metni yerine endüstri standardı kendinden etiketli JSON olarak biçimlendirilmiş Etkinlik verilerini almayı tercih eder; çünkü öncekiler daha güvenilir ve daha kolay ayrıştırılır. HALO'da web Sayfanın “Mesajlaşma” sekmesinde, “Harici Mesajlaşma” ayarları “Set String” ve “Reset String” ve “Kalp Atışı” “Mesaj” kısmından JSON mesajlarını sağlayabilirsiniz.
ExampŞunlar:
“Harici Mesajlaşma” Ayarları Ayar Dizini:
{ “cihaz”:”%NAME%”, “olay”:”%EID%”, “alarm”:”evet” }
Bu, belirtilen sunucuya kolay cihaz adını, etkinlik adını ve yeni başladığını bildiren tek bir TCP veya UDP JSON mesajı gönderecektir.
“Harici Mesajlaşma” Ayarları Sıfırlama Dizesi:
{ “cihaz”:”%NAME%”, “olay”:”%EID%”, “alarm”:”hayır” }
Bu, belirtilen sunucuya kolay cihaz adını, olay adını ve koşulun artık durdurulduğunu bildiren tek bir TCP veya UDP JSON mesajı gönderecektir.
“Kalp atışı” Mesajı:
{ “cihaz”:”%NAME%”, “alive”:”%DATE% %TIME%” }
Bu, belirli aralıklarla, belirtilen sunucuya, HALO'nun belirtilen zamanda canlı olduğunu bildiren bir TCP veya UDP JSON mesajı gönderecektir.
Belgeler / Kaynaklar
 |
Yazılımın HALO Akıllı Sensör API Temel Yazılımı [pdf] Kullanıcı Kılavuzu HALO Akıllı Sensör API Temel Yazılımı |
