소프트웨어 HALO Smart Sensor API 기본 소프트웨어
앞으로
이 문서는 집합적으로 BASIC API 또는 응용 프로그래밍 인터페이스로 알려진 Halo Smart Sensor의 기능 그룹에 대해 설명합니다. 이 토론은 하나 이상의 HALO(HALO 스마트 센서)를 타사(비 IPVideo) 소프트웨어 구성 요소 또는 시스템과 통합하는 데 관심이 있는 프로그래머 또는 통합자가 사용하기 위한 것입니다. 일반적으로 HALO API는 기존 이더넷 네트워크를 통해 HALO에서 외부 프로그램으로 정보를 효율적으로 전송하기 위한 것입니다. 이 목표를 달성하기 위해 API는 이벤트 기반 소켓 연결, 하트비트 소켓 연결 및 이벤트 데이터의 세 섹션으로 나뉩니다. URL. BACnet 인터페이스도 존재하며 별도의 문서에서 다룹니다.
API 디자인
API는 TCP/IP와 같은 업계 표준 형식을 사용하여 설계되었습니다. HTTP, HTTPS 및 JSON. 디자인은 외부 프로그램이나 응용 프로그램의 개발에 사용되는 특수 또는 독점 기술이나 라이브러리를 요구하지 않습니다. API는 유연하며 필요한 데이터를 가장 효율적인 방식으로 정확하게 전달하도록 구성 및 프로그래밍할 수 있습니다. 위의 각 섹션의 작동에 대한 자세한 내용은 이 가이드의 다음 섹션에서 다룹니다.
외부 메시징
Event 발생(설정) 시 외부 프로그램, VMS 시스템, 서버 등에 경보나 경보, Event 데이터를 전달하는 기능입니다. 이벤트가 지워지면(재설정) 신호를 보내기 위해 선택적 메시지를 활성화할 수도 있습니다. 이 전달은 실시간으로 TCP/IP 소켓 또는 HTTP/S 서버로 이루어질 수 있습니다. 사용자 정의 가능한 컨텐츠가 포함된 다양한 구성 가능한 프로토콜이 있습니다. 인증 및 암호화가 가능합니다.
심장박동
하트비트 메시지는 구성 가능한 간격으로(이벤트가 트리거되는 대신) 전송되어 라이브/가용성 증명을 제공합니다. 외부 메시징과 유사한 기능 범위를 갖지만 일반적으로 특정 이벤트에 대한 세부 정보보다는 일반 상태 정보를 포함하도록 구성됩니다.
이벤트 데이터 URL
이 기능은 NDA 하에서만 사용할 수 있으며 외부 프로그램이 모든 이벤트 값, 임계값 및 상태 플래그에 액세스해야 하는 경우에만 사용해야 합니다. 이 데이터는 일반적으로 외부 프로그램의 요구에 따라 검색되지만 매우 높은 빈도는 아닙니다. 이 방법은 일반적으로 적당한 폴링 속도를 사용할 때 약간의 대기 시간이 발생합니다. 일반적인 폴링 속도는 분당 한 번에서 5초당 한 번까지이며 절대 최대 속도는 초당 한 번입니다. 이 방법은 이벤트(경고)가 수신될 때 추가 지원 데이터를 검색하는 데 사용할 수도 있습니다.
외부 메시지 세부정보
HALO의 일부 web 인터페이스 통합 팝업은 다양한 값을 원격 TCP 소켓 또는 HTTP/HTTPS 서버로 보낼 수 있는 단일 타사 연결 구성을 제공합니다. 자리 표시자(토큰)는 전송된 텍스트에 실시간 값을 삽입하는 데 사용됩니다. "외부 메시징"이라는 레이블이 붙었지만 이 채널은 HALO에서 적극적으로 전달하는 실시간 이벤트 트리거가 필요한 거의 모든 목적에 사용할 수 있습니다. 이 배열은 "작업"에 대한 선택이 이 채널을 통해 전송하는 HALO 이벤트를 결정하기 때문에 매우 유연합니다.
HTTP 모드에서 Set 및 Reset Strings는 URL원하는 대상 서버에서 요구하는 대로 입력하고 형식을 지정해야 합니다. 사용자 및 암호 필드는 인증에 사용할 수 있습니다. 아래 HTTP 모드를 참조하십시오.
TCP 모드에서 Set 및 Reset Strings는 수신 TCP 소켓으로 전송되는 단일 메시지의 데이터일 뿐입니다. 대상에서 필요에 따라 형식을 지정할 수 있습니다. 대상은 주소 및 포트 필드에 지정됩니다. 아래의 TCP 모드를 참조하십시오.
두 모드 모두 연결 또는 기타 문제를 해결하는 데 도움이 될 수 있는 가장 최근 메시지의 상태가 표시됩니다. 작업 팝업의 이벤트 테스트 버튼을 사용하여 메시지를 강제 실행할 수 있습니다.
이러한 유형의 메시지를 활성화하려면 설정 또는 재설정에 대한 전역 켜짐/꺼짐이 켜짐이어야 합니다. 리셋은 이벤트의 시작에만 관심이 있기 때문에 자주 사용되지 않지만 상황은 다를 수 있습니다. 각 이벤트는 동작 팝업에서 설정 또는 재설정 메시지를 사용할지 여부를 독립적으로 지정할 수 있습니다. 안구 버튼은 키워드 대체 및 형식 지정 후에 전송되는 내용을 대략적으로 표시합니다. 반복 보류는 다른 메시지를 보내기 전에 지연시켜 빈번한 메시지를 조절하는 데 사용할 수 있습니다. 이것은 이벤트별로 독립적으로 수행됩니다. HALO에는 이벤트의 빠른 재트리거를 방지하기 위해 15초의 이벤트 대기 시간이 내장되어 있습니다. 유형의 이벤트가 분당 1개 이상 전송되지 않도록 하려면 반복 보류를 60(초)으로 설정할 수 있습니다.
하트비트 세부정보
Heartbeat 전송은 Actions 페이지와의 상호 작용이 없다는 점을 제외하고 위와 유사한 방식으로 작동합니다. 대신, 하트비트 전송은 간격 필드로 구성된 대로 정기적으로 발생합니다. HTTP 모드에서 설정 및 재설정 문자열은 URL원하는 대상 서버에서 요구하는 대로 입력하고 형식을 지정해야 합니다. 사용자 및 암호 필드는 인증에 사용할 수 있습니다. 아래 HTTP 모드를 참조하십시오.
Heartbeat의 주요 목적은 원격 애플리케이션에 HALO 스마트 센서의 수명 증명을 제공하는 것이지만 이 메시지는 선택한 센서 또는 현재 이벤트 상태 정보를 전송하는 데에도 사용할 수 있습니다. 전amp위의 le은 긴 문자열 매개변수를 URL Halo 이름, 대부분의 센서 값, 마지막으로 Triggered=%ACTIVE%(비어 있을 수 있음) 또는 현재 트리거된 이벤트 목록을 포함합니다.
HTTP(및 HTTPS) 모드
외부 메시징 및 하트비트 문자열은 http: 또는 https:일 수 있습니다. URL필요에 따라 s. 경로 및 매개변수는 대상 서버에서 필요에 따라 입력할 수 있습니다. %NAME%(HALO 장치 이름) 또는 %EID%(이벤트 ID)와 같은 키워드는 필요에 따라 삽입될 수 있으며 메시지가 전송될 때 해당 데이터로 대체됩니다. 빠른 참조를 위해 일반적으로 사용되는 키워드 목록이 표시됩니다.
그만큼 URL 경로에는 키워드와 매개변수가 포함될 수 있습니다. URL. 매개변수는 대상 서버에 따라 NAME=VALUE 쌍 또는 JSON 개체이거나 사용자 지정 형식일 수 있습니다. 전amp외부 메시징에 대한 파일에는 트리거된 이벤트를 나타내는 %EID%가 포함됩니다.
- https://server.com/event/%NAME%/%EID%
- https://server.com/event?location=%NAME%&event=%EID%
- https://server.com/event?{“location”:”:%NAME%”,”event”:”%EID%”}
ExampHeartbeat에 대한 파일은 %ACTIVE%(현재 트리거된 이벤트) 또는 센서 값을 추가할 수 있습니다.
- https://server.com/alive?location=%NAME%&Triggered=%ACTIVE%
- https://server.com/event?{“location”:”:%NAME%”,”NH3”:%SENSOR:NH3%}
%SENSOR:...% 값은 evtYYYYMMDD.csv 로그의 오른쪽 센서 열 머리글에 있는 이름을 사용합니다. file에스. 일반적으로 다음과 같습니다.
대상 서버가 GET 요청 대신 HTTP PUT 또는 POST를 선호하는 경우 접두사를 사용할 수 있습니다. URL PUT: 또는 POST:로. 독립적으로 [JSONBODY] 키워드 뒤에 JSON 형식의 개체를 추가하여 많은 서버에서 널리 사용되는 JSON 페이로드를 추가할 수 있습니다. 전amp르 :
PUT:https://server.com/event[JSONBODY]{“위치”:”%NAME%”,”이벤트”:”%EID%”}
그만큼 URL 일반 IP 주소(및 IPv6) 및 포트 및 사용자 암호 옵션을 지원하거나, 기본 또는 다이제스트와 같은 인증 방법을 위한 대상 서버가 필요한 경우 사용자 및 암호 필드를 사용할 수 있습니다.
https://username:password@123.321.123.321:9876/event…
TCP 모드
외부 메시징 및 하트비트 문자열은 주소 및 포트 필드가 대상을 지정하기 때문에 데이터 전용입니다. 주소는 이름, IPv4 및 IPv6을 지원합니다.
문자열은 위에서 설명한 HTTP 메시지의 데이터 부분처럼 또는 대상 서버의 요구에 따라 형식을 지정할 수 있습니다.
Examp외부 메시징에 대한 파일에는 트리거된 이벤트를 나타내는 %EID%가 포함됩니다.
위치=%NAME%, 이벤트=%EID%
{“위치”:”:%NAME%”,”이벤트”:”%EID%”}
ExampHeartbeat에 대한 파일은 %ACTIVE%(현재 트리거된 이벤트) 또는 센서 값을 추가할 수 있습니다.
위치=%NAME%&트리거됨=%ACTIVE%
{"위치":":%NAME%","NH3":%센서:NH3%}
"통합 세트" 및 "통합 재설정" 열의 확인란은 전송을 트리거하는 이벤트를 결정합니다. 이벤트 및 작업 설정에 대한 자세한 내용은 HALO 관리자 가이드에서 확인할 수 있습니다.
JSON 이벤트 메시지 전달
일부 개발자는 일반 ASCII 텍스트가 더 안정적이고 더 쉽게 구문 분석되기 때문에 업계 표준 자체 레이블 JSON 형식의 이벤트 데이터를 수신하는 것을 선호합니다. 헤일로에서 web 페이지 "메시징" 탭에서 "외부 메시징" 설정 "문자열 설정" 및 "문자열 재설정" 및 "하트비트" "메시지"에서 JSON 메시지를 제공할 수 있습니다.
Examp레:
"외부 메시징" 설정 문자열 설정:
{ “기기”:”%NAME%”, “이벤트”:”%EID%”, “알람”:”예” }
이것은 친숙한 장치 이름, 이벤트 이름 및 방금 시작되었음을 보고하는 단일 TCP 또는 UDP JSON 메시지를 지정된 서버로 보냅니다.
"외부 메시징" 설정 재설정 문자열:
{ “기기”:”%NAME%”, “이벤트”:”%EID%”, “알람”:”아니요” }
이것은 친숙한 장치 이름, 이벤트 이름 및 조건이 이제 중지되었음을 보고하는 단일 TCP 또는 UDP JSON 메시지를 지정된 서버로 보냅니다.
"하트비트" 메시지:
{ "기기":"%NAME%", "활성":"%DATE% %TIME%" }
이렇게 하면 지정된 시간에 HALO가 활성 상태임을 보고하는 TCP 또는 UDP JSON 메시지를 지정된 서버에 주기적으로 보냅니다.
문서 / 리소스
 |
소프트웨어 HALO Smart Sensor API 기본 소프트웨어 [PDF 파일] 사용자 가이드 HALO 스마트 센서 API 기본 소프트웨어 |
