Installation Guide for Vivotek models including: VSS HALO Smart Sensor, VSS, HALO Smart Sensor, Smart Sensor, Sensor
Partner Integrations - Building Network Solutions Compatible w/ HALO
2023-10-31 — The HALO Smart Sensor can be integrated into Vivotek's VSS Video Management Software using the RTSP output from the HALO device and the RTSP support of VSS.
VSS INTEGRATION GUIDE IPVIDEO CORPORATION | 1490 NORTH CLINTON AVENUE BAY SHORE NY 11706 Contents INTRODUCTION ..................................................................................................... 2 HALO SMART SENSOR ENABLE RTSP STREAM ................................................... 3 HALO SMART SENSOR ACTIONS ......................................................................... 4 HALO SMART SENSOR INTEGRATIONS ............................................................... 5 VSS CLIENT LOGIN .............................................................................................. 6 VSS CLIENT SETTINGS MENU .............................................................................. 7 VSS CLIENT VISUALIZE HALO SMART SENSOR .................................................. 11 VSS CLIENT ADD ALARM................................................................................... 12 VSS CLIENT ALARM NOTIFICATIONS................................................................. 17 October 31, 2023 1 INTRODUCTION The HALO Smart Sensor can be integrated into Vivotek's VSS Video Management Software using the RTSP output from the HALO device and the RTSP support of VSS. This allows operators to visualize and record the real-time data from the HALO Smart Sensor, as though it were a typical IP Camera. HALO Smart Sensor can also be programmed to transmit messages via TCP/IP to VSS to enable Alarm Notifications Note : This integration was tested using VSS 1.0.0 and HALO Firmware version 2.82 October 31, 2023 2 HALO SMART SENSOR ENABLE RTSP STREAM To capture the Stream URL needed to connect VSS to HALO, simply navigate to the HALO Smart Sensor with a Web Browser and click on the Integration Icon in the bottom navigation bar. Scroll down to the RTSP settings. 1) Highlight and Copy the Stream URL displayed at the top of the settings area. 2) Click the RTSP Stream Enabled switch 3) Set Authentication to Both 4) Enter a Username and Password 5) Enter the RTSP Port (Default is 554) 6) Click Save to save RTSP Image Settings October 31, 2023 3 HALO SMART SENSOR ACTIONS Click on the Actions Icon in the bottom navigation bar. Check the Messaging Set checkboxes for each of the Event Identifiers. Scroll down and click the Save button to save settings. October 31, 2023 4 HALO SMART SENSOR INTEGRATIONS Click on the Integrations Icon in the bottom navigation bar. 1. Set protocol to TCP 2. Enter "halo.event.%EID%" for the Set String and Check the On radio button to enable (Do not include Quotations) 3. Enter "halo.reset.%EID%" for the Set String and Check the On radio button to enable (Do not include Quotations) 4. Enter the IP Address of the VSS Server in the IP Address field 5. Enter 3444 in the Port field. 6. Click the Save button. October 31, 2023 5 VSS CLIENT LOGIN Login to the VSS Client as an Administrator October 31, 2023 6 VSS CLIENT SETTINGS MENU Click on Settings icon in the top right navigation and select Settings from the drop down menu. October 31, 2023 7 In the Device section, click on Cameras On the Device Management window, Click the Add Camera icon October 31, 2023 8 1. Select RTSP from the Drop Down Menu 2. Enter the RTSP URL and Port (IPADDRESS/stream) : 554 3. Select TCP from the Protocol Drop Down Menu 4. Click the Add button to proceed Click the Add button October 31, 2023 9 Enter the RTSP URL Username and Password as defined in the HALO Smart Sensor RTSP Settings and Click Apply The HALO Smart Sensor RTSP stream will be displayed in the Device Management window. Use this interface to change the HALO Smart Sensor Device Name in VSS October 31, 2023 10 VSS CLIENT VISUALIZE HALO SMART SENSOR 1. Click on the Monitor tab 2. Drag the HALO Smart Sensor from the left navigation bar into the Viewing area of VSS Collapse the left navigation bar to monitor the live activity of the HALO Smart Sensor October 31, 2023 11 VSS CLIENT ADD ALARM On the main Settings screen, click on Add & Delete under Alarm On the Alarm Management screen, click on the Add Alarm icon. October 31, 2023 12 1. In the "If" section of the screen, click on the External Device Event icon 2. Click on the Add Trigger button October 31, 2023 13 3. Select TCP Message (Using default port 3444) 4. Select the VSS Server 5. Select text matches in the drop down menu and Enter "halo.event.Vape" (Do not include quotations) in the text field to add a Vape Alarm. Separate Alarms will need to be created for each unique HALO Smart Sensor Event Type. 6. Click the Add button to save the trigger. October 31, 2023 14 1. In the "Do" section of the screen, click on the Add Action button 2. Select one of the available Actions from the drop down menu 3. Click the Add button to save the Action October 31, 2023 15 1. In the "At" section of the screen, leave the default selection, Always, unless it is preferred to operate during a defined schedule. 2. Specify a Title and Description for triggers in the available text fields 3. Click the Add button to save the Alarm October 31, 2023 16 VSS CLIENT ALARM NOTIFICATIONS When HALO Smart Sensor is triggered, event messages are transmitted to the VSS Server, received, and displayed in the VSS Client in the top right corner of the screen. The associated Action is also triggered. October 31, 2023 17Microsoft: Print To PDF