BOGEN Nyquist E7000 System Controller Installation Guide

June 11, 2024
BOGEN

BOGEN Nyquist E7000 System Controlle

BOGEN NYQUIST INTEGRATION GUIDE

The HALO Smart Sensor can be integrated into the BOGEN Nyquist E7000 & C4000 solutions using HTTPS Messaging. This allows administrators to program HALO Smart Sensor to send notifications to NYQUIST to trigger the execution of Routines, which in turn, will trigger visual and audible notifications to be played in selected zones/areas. Note: This integration was tested using Bogen Nyquist E7000 version 8.0 and HALO Smart Sensor Device Firmware 2.7.X. This integration requires that the Nyquist system to have the Routines API License installed.

Product Information

  • Product Name: HALO Smart Sensor
  • Manufacturer: IPVIDEO CORPORATION
  • Compatible with: BOGEN Nyquist E7000 & C4000 solutions
  • Integration Method: HTTPS Messaging
  • Firmware Version: 2.7.X

Product Usage Instructions

  1. Click on System Parameters in the left navigation tree, and click the EDIT button as pictured above.

  2. Copy the Routines API Key to the clipboard.

  3. Navigate to the HALO Smart Sensor device user interface and click on Integrations.

  4. Set Protocol to HTTP.

  5. Paste the contents of the COPY of the Routines API Key into the Password field.

  6. Copy the text below, edit the IP Address to match the Nyquist Server, and paste it into the Set String field. https://192.168.1.100/routine/api/%UID%/0/0/abc/xyz[HEADER]Accept:application/json[HEAD ER]Content-
    Type: application/json[HEADER]Authorization:Bearer %PSWD%

  7. Click the On radio button for the Set String.

  8. Click the Save button.

  9. Click on the Actions page and ensure that the Set checkbox is checked for each of the integrated events.

  10. Click on Routines in the left navigation bar.

  11. Enable the Routines API.

  12. Click the Add button to add a Routine for each HALO Smart Sensor Event type. Be sure to use a unique DTMF code (i.e., Routine ID) for each Routine.

  13. Edit the Actions of the Routine to add/create the desired actions associated with the HALO Smart Sensor Event type.

  14. Click on the Events page on the HALO Smart Sensor device interface.

  15. For each event type, enter the DTMF value from each of the Routines created in E7000 in the UID field. Make sure that UID/Event Type matches the desired Routine.

  16. Click Save to save the UID values.

  17. Click on the Actions button in the HALO Smart Sensor User Interface.

  18. Click on the Test button of an Event Type that has been associated to a Routine to generate a test event.

  19. In addition to the Email that all included users in the template receive, the HALO Event should be displayed in the primary dashboard of the Bogen Nyquist interface.

INTRODUCTION

The HALO Smart Sensor can be integrated into the BOGEN Nyquist E7000 & C4000 solutions using HTTPS Messaging. This allows administrators to program HALO Smart Sensor to sendnotifications to NYQUIST to trigger the execution of Routines, which in turn, will trigger visual and audible notifications to be played in selected zones/areas. Note : This integration was tested using Bogen Nyquist E7000 version 8.0 and HALO Smart Sensor Device Firmware 2.7.X This integration requires that the Nyquist system to have the Routines API License installed.

BOGEN NYQUIST – SYSTEM PARAMETERS

BOGEN-Nyquist-E7000-System-Controller-FIG-1

Click on System Parameters in the left navigation tree, and click the EDIT button as pictured above.BOGEN-Nyquist-E7000-System-Controller-
FIG-2

Copy the Routines API Key to the clipboard.

HALO SMART SENSOR – INTEGRATION

Navigate to the HALO Smart Sensor device user interface and click on Integrations.BOGEN-Nyquist-E7000-System-Controller-
FIG-3

  1. Set Protocol to HTTP.

  2. Paste the contents of the COPY of the Routines API Key into the Password field.

  3. Copy the text below, edit the IP Address to match the Nyquist Server and paste into the Set String field.
    https://192.168.1.100/routine/api/%UID%/0/0/abc/xyz[HEADER]Accept:application/json[HEAD ER]Content- Type:application/json[HEADER]Authorization:Bearer %PSWD%

  4. Click the On radio button for the Set String.

  5. Click the Save button.

HALO SMART SENSOR – ACTIONS

Click on the Actions page and ensure that the “Set” checkbox is checked for each of the integrated events.BOGEN-Nyquist-E7000-System-Controller-
FIG-4

BOGEN NYQUIST – ROUTINES MANAGEMENT

BOGEN-Nyquist-E7000-System-Controller-FIG-5

  1. Click on Routines in the left navigation bar.
  2. Enable the Routines API.
  3. Click the Add button to add a Routine for each HALO Smart Sensor Event type. Be sure to use a unique DTMF code (i.e., Routine ID) for each Routine.BOGEN-Nyquist-E7000-System-Controller-FIG-6

Edit the Actions of the Routine to add/create the desired actions associated with the HALO Smart Sensor Event type.BOGEN-Nyquist-E7000-System-Controller-
FIG-7

HALO SMART SENSOR – EVENTS

  1. Click on the Events page on the HALO Smart Sensor device interface.
  2. For each event type, enter the DTMF value from each of the Routines created in E7000 in the UID field. Make sure that UID/Event Type matches the desired Routine.
  3. Click Save to save the UID valuesBOGEN-Nyquist-E7000-System-Controller-FIG-8

HALO SMART SENSOR – TESTING THE CONNECTION

  1. Click on the Actions button in the HALO Smart Sensor User Interface.
  2. Click on the Test button of an Event Type that has been associated to a Routine to generate a test event.
  3. In addition to the Email that all included users in the template receive, the HALO Event should be displayed in the primary dashboard of the Bogen Nyquist interface.BOGEN-Nyquist-E7000-System-Controller-FIG-9BOGEN-Nyquist-E7000-System-Controller-FIG-10
  • IP VIDEO CORPORATION
  • 1490 NORTH CLINTON AVENUE BAY SHORE NY 11706

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>

Related Manuals