This article explains how to configure and resolve integration issues between Halo Vape Sensors and Nx Witness version 6.1.0 and later.

Issue Overview

Starting with Nx Witness version 6.1.0, certain deprecated API methods (specifically older GET requests used for event generation) were removed. This may cause the VMS to stop receiving events from the Halo Vape Sensors. While a permanent fix is awaiting for Halo to update their integration, in the meantime you can use the following workaround to restore functionality using Digest Authentication and enabling the legacy API.

VMS User Configuration & Permissions

To ensure secure communication, create a dedicated user in the VMS for the Halo sensors with these specific settings:

• Username: Must be strictly lowercase.

• Authentication: Enable Allow insecure (digest) authentication.

• User Level: Do not assigned a specific User Group to follow the principle of least privilege.

• Permissions: Under Global Permissions, enable Generate Events.

Enable Legacy API Support for the VMS

Because the Halo sensor utilizes a deprecated GET request, you must manually re-enable legacy API support in the VMS hidden advanced settings:

1. Navigate to: https://<serverIp>:7001/#/settings/advanced

2. Locate the insecureDeprecatedApiEnabled option.

3. Toggle the setting to Enabled and click Save.

Halo Device Configuration

Device Naming and RTSP Stream

• Device Name: Navigate to Device Management and enter a Unique Name. Click Set Name to save. This name must match the Source field in Nx Witness Event Rules.

HALO SMART SENSOR – ENABLE RTSP STREAM

• RTSP Stream: Navigate to Integration and toggle RTSP Stream Enabled to On.

• Authentication: Set Authentication to Both and define a Username and Password for the stream.

HALO SMART SENSOR – ACTIONS

You must configure the sensor to send messaging triggers:

1. Click the Actions icon in the Halo interface.

2. Check the Msg Set checkboxes for each Event Identifier (e.g., Aggression, Gunshot, Vape) you want to transmit to the VMS.

3. Click Save.

HALO SMART SENSOR – INTEGRATION

Click on the Integration Icon in the bottom navigation bar

• Protocol: Select HTTP.

• Set String: Enter the following, replacing <ServerIP> with your VMS server IP:
  GET:https://<ServerIP>:7001/api/createEvent?caption=%NAME%&description=%EID%&source=%NAME%

• Authentication Type: Select Basic/Digest.

• Credentials: Enter the lowercase Username and Password created in the VMS.

VMS Configuration

Adding Halo as a Camera to the VMS

To visualize real-time data from the sensor as if it were an IP camera, follow these steps:

1. Add Device: In the VMS Client, expand the top-left menu and select Add Device.

2. Enter Stream Details:

   1. Address: Enter rtsp://<Halo_IP>:554/stream.

   2. Login/Password: Enter the RTSP credentials defined in the Halo RTSP settings, not the device admin credentials.

3. Search and Add: Click Search. Once the GENERIC_RTSP device is discovered, check the box and select Add all Devices.

4. Visualize: Drag the Halo sensor from the navigation tree into a layout to see the live dashboard or graph.

Setting the Event Rule in the VMS

1. Create Rule: Go to System Administration > Event Rules and click Add.

2. Event Section: Set WHEN EVENT to Generic Event.

3. Source: In Source Contains, enter the Halo Device Name exactly as it was set in the Halo Vape Sensor.

4. Description: In Description Contains, enter the event type (e.g., Vape). (optional)

5. Action: Select your desired action, such as Open Layout or Show Desktop Notification.

Troubleshooting and Testing

• Verify Source Name: Ensure the Halo Device Name identically matches the Source Contains field in the VMS Event Rules menu.

• Generate Test Event: In the Halo Actions menu, click the Test button for an event identifier.

• Confirm Receipt: Open the VMS Event Log to verify the event appears with the correct timestamp and description.