Vivotek VSS HALO Smart Sensor Installation Guide

Vivotek VSS HALO Smart Sensor

Product Information

The HALO Smart Sensor is a device that can be integrated into Vivotek’s VSS Video Management Software. It allows operators to visualize and record real- time data from the HALO Smart Sensor as if it were a typical IP Camera. The HALO Smart Sensor can also transmit messages via TCP/IP to VSS to enable Alarm Notifications.

Specifications

• Manufacturer: IPVIDEO CORPORATION
• Model: HALO Smart Sensor
• Firmware Version: 2.82
• VSS Version Compatibility: 1.0.0

Product Usage Instructions

Step 1: Obtaining the Stream URL

To connect VSS to HALO, you need to capture the Stream URL. Follow these steps:

1. Navigate to the HALO Smart Sensor using a web browser.
2. Click on the Integration Icon in the bottom navigation bar.
3. Scroll down to the RTSP settings.
4. Highlight and Copy the Stream URL displayed at the top of the settings area.
5. Click the RTSP Stream Enabled switch.
6. Set Authentication to Both.
7. Enter a Username and Password.
8. Enter the RTSP Port (Default is 554).
9. Click Save to save RTSP Image Settings.

Step 2: Configuring Messaging Settings

To enable Alarm Notifications, you need to configure the messaging settings. Follow these steps:

1. Click on the Actions Icon in the bottom navigation bar.
2. Check the Messaging Set checkboxes for each of the Event Identifiers.
3. Scroll down and click the Save button to save settings.

Step 3: Configuring Integrations

To integrate HALO with VSS, follow these steps:

1. Click on the Integrations Icon in the bottom navigation bar.
2. Set the protocol to TCP.
3. Enter “halo.event.%EID%” for the Set String and check the On radio button to enable.
4. Enter “halo.reset.%EID%” for the Set String and check the On radio button to enable.
5. Enter the IP Address of the VSS Server in the IP Address field.
6. Enter 3444 in the Port field.
7. Click the Save button.

Step 4: Adding HALO Smart Sensor to VSS

To add the HALO Smart Sensor to VSS, follow these steps:

1. Login to the VSS Client as an Administrator.
2. Click on Settings icon in the top right navigation and select Settings from the drop-down menu.
3. In the Device section, click on Cameras.
4. On the Device Management window, click the Add Camera icon.
5. Select RTSP from the Drop Down Menu.
6. Enter the RTSP URL and Port (IPADDRESS/stream): 554.
7. Select TCP from the Protocol Drop Down Menu.
8. Click the Add button.
9. Enter the RTSP URL Username and Password as defined in the HALO Smart Sensor RTSP Settings and click Apply.

Step 5: Monitoring HALO Smart Sensor

To monitor the live activity of the HALO Smart Sensor, follow these steps:

1. Click on the Monitor tab.
2. Drag the HALO Smart Sensor from the left navigation bar into the Viewing area of VSS.
3. Collapse the left navigation bar to focus on the live activity of the HALO Smart Sensor.

Step 6: Configuring Alarm Management

To configure alarms for the HALO Smart Sensor, follow these steps:

1. On the main Settings screen, click on Add & Delete under Alarm.
2. On the Alarm Management screen, click on the Add Alarm icon.
3. In the If section of the screen, click on the External Device Event icon.
4. Click on the Add Trigger button.
5. Select TCP Message (Using default port 3444).
6. Select the VSS Server.
7. Select “text matches” in the drop-down menu and enter “halo.event.Vape” (Do not include Quotations).

Frequently Asked Questions (FAQ)

Q: What is the firmware version required for integrating HALO with VSS?

A: The integration was tested using HALO Firmware version 2.82.

Q: Which version of VSS is compatible with HALO?

A: The integration was tested using VSS version 1.0.0.

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

HALO SMART SENSOR – ENABLE RTSP STREAM

To capture the Stream URL needed to connect VSS to HALO, simply navigate to the HALO Smart   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

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.

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

VSS CLIENT – SETTINGS MENU

Click on Settings icon in the top right navigation and select Settings from the drop down menu

In the Device section, click on Cameras

On the Device Management window, Click the Add Camera icon

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

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

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

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

1. In the “If” section of the screen, click on the External Device Event icon
2.  Click on the Add Trigger button
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

In the “Do” section of the screen, click on the Add Action button

1. Select one of the available Actions from the drop down menu

2. Click the Add button to save the Action

3. In the “At” section of the screen, leave the default selection, Always, unless it is preferred to operate during a defined schedule.

4. Specify a Title and Description for triggers in the available text fields

5. Click the Add button to save the Alarm

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.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>