Skip to main content
OpenEye Knowledge Base

HALO Smart Sensor Integration Instructions

  1. Last updated
  2. Save as PDF
Enable HALO Integration in OpenEye Web Services (OWS)
 

 

  

NOTE: Environmental Sensor Integrations are only available with certain licensing tiers. See OWS Licensing for more information.

  1. From the Cloud Portal, select the Management tab.
  2. Choose Integrations from the drop-down menu.

EU - Management - Integrations.png

  1. Click on Add New Integration. Add New Integration Button.png
  2. Choose HALO Sensor and click Next.

  OWS_Halo_UI_1.png

  1. The HALO Sensor will be added to the Manage Integrations list, and you will be taken to the configuration page for the HALO Sensor.

OWS_Halo_UI_2.png

  1. Click API Access Keys.

OWS_Halo_UI_3.png

  1. Click Add Key and you will be presented with the Secret Key. Enter a Key Name and click Add. Add Button.png

NOTE: This is the only time you will be able to view the Secret Key. Be sure to copy it somewhere.

OWS_Halo_UI_4.png

  1. After clicking Add you will be presented with the created API Access Key. Copy this down.

OWS_Halo_UI_5.png

Enable OWS Integration in your HALO Smart Sensor

NOTE: Go to HALO Smart Sensor if you need more information configuring the HALO Smart Sensor Integration.

  1. Log in to your HALO Smart Sensor as Administrator.
  2. Click on the gears in the lower left, then click on Integration to open the Integration menu.

Halo_UI_1.png

  1. Click on Integration to open the Integration menu.

Halo_Integration_1.png

  1. In the Set String field, enter the following by copying and pasting the text below:

POST:https://%USER%:%PSWD%@halo.api.gp4f.com/api/monitoring/integration/halo/event?[JSONBODY]{"sensorName": "%NAME%", "macAddress" : "%MAC%", "eventType": "%EID%", "localEventDate" : "%DATE%", "localEventTime" : "%TIME%"}
  1. In the Reset String field, remove any current values.
  2. In the User field, enter the following, where API ACCESS KEY equals the API Access Key you generated in step 8 above.

AKI=API ACCESS KEY
Example: "AKI=J5P8WBSV8HUB"

  1. In the Password field, enter the following, where SECRET KEY is the Secret Key you generated in step 7 above.

AKS=SECRET KEY
Example: "AKS=yZd-W57xNUMlzFUJQefTWjdpuMpZV_Y0"

  1. Click Events and send a Test event from any of the configured sensors.
  2. Click Save.
  3. Scroll to the bottom and click Close.
  4. If the correct information is entered, you should see a Status: Accepted message, as shown in the above screenshot.

Halo_Events_1.png

 

Mapping the HALO Smart Sensor to a Camera
  1. In OWS, open the Integrations menu under Management and click Edit. Edit Button.png

OWS_Halo_UI_6.png

  1. Click Sensors / Camera Mapping and select the Sensor Name for your HALO Smart Sensor. 

NOTE: If you do not see your HALO Smart Sensor then one of the previous steps was not completed. Please double check that the AKI, AKS, and Set String are correct.
OWS_Halo_UI_7.png

  1. Click Add Camera. Add Camera button.png
  2. Click the + button next to the camera that you would like to associate with the sensor and click Select. Select button.png

OWS_Halo_UI_8.png

  1. The camera will now be associated with the HALO Smart Sensor.

NOTE: If you associate multiple cameras with the sensor, then only the camera marked as Primary will be sent with email alerts.

Creating a Halo Smart Sensor Alert Rule in OWS
  1. Within the Alerts tab in the OWS Cloud Portal, select Alert Rules from the dropdown menu.

Alert Rules dropdown.png

  1. Click Add New Rule.

Add New Rule button.png

  1. Click Environmental and click Next.

Create a New Alert Rule Sensor Environmental.png

  1. Name the alert and give it a Description as desired.

Create Environmental Name and Description.png
NOTE: The Name given to an alert will appear as the subject line of email notifications sent by that alert

  1. Click Create.

Create button.png

  1. Click the Event Group drop down menu and select the desired Event Group, then click the Event Type drop down and select the desired Event Type, according to the table below:
Event Group: Health Event Group: Safety Vape/THC
Air Quality Index Threshold Exceeded Aggression sounds detected THC detected
CO2cal Threshold Exceeded Air Masking detected Vape detected
Health Index Threshold Exceeded Gunshot detected  
Humidity Threshold Exceeded HELP sounds detected  
NO2 Threshold Exceeded Tamper detected  
PM2.5 Threshold Exceeded    
Temperature Threshold Exceeded    
TVOC Threshold Exceeded    

NOTE: OpenEye Web Services (OWS) only supports the HALO event name. If an event name is customized, OWS will no longer recognize the event and send alerts or display the alerts in Alert History.

  1. After selecting the desired options, scroll down and click Save. Save Button.png

OWS_Alert_Rule_3.png

  1. Click Sensors from the left menu.
  2. Click Add Sensor. Add Sensor button.png
  3. Click the + button next to the desired HALO Smart Sensor then click Select. Select button.png

OWS_Alert_Rule_4.png

  1. If Email Alerts are desired, click Users / Notifications from the left menu. Users Notifications tab.png
  2. Click Add Group or Add User Add Group Add User button.png and select the Group or User that you would like to receive Email Alerts and click Select. Select button.png
  3. For more information, see the related link Creating an Alert Rule.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    How-to
  2. Tags
    This page has no tags.