Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Ganz Manuals
  4. Server
  5. AI AIBOX
  6. User manual

Ganz AI AIBOX User Manual

Hide thumbs

Advertisement

Quick Links

Download this manual
GANZ
User Manual
Device setting Guide
For AI AIBOX
V.1.0.8
Caution: The contents of this manual are subject to change at any time without prior notice.

Advertisement

loading
Need help?

Need help?

Do you have a question about the AI AIBOX and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Ganz AI AIBOX

Summary of Contents for Ganz AI AIBOX

  • Page 1 GANZ User Manual Device setting Guide For AI AIBOX V.1.0.8 Caution: The contents of this manual are subject to change at any time without prior notice.
  • Page 2 2. Names and Functions ........................... 5 3. AI AIBOX Device Settings ..........................7 1. Device installation ..........................7 1.1 Installing the AI AIBOX Device ......................7 2. Search for devices on the network ....................... 8 2.1 Download the Device Management Tool ..................8 2.2 Running screen ..........................
  • Page 3 5.1 Remote support Settings ........................ 17 4. Application usage guide ..........................17 1. Application Activate ........................... 17 2. Event Action Setting Guide ......................... 19 2.1 Alarm setting example (Intrusion) ....................20 3. Counter Setting Guide ........................25 3.1 Counter working process ........................ 25 3.2 Counter Setting Example (Occupancy Counting) ................
  • Page 4 1. HTTP ..............................68 2. FTP Upload ............................75 3. AWS S3 Upload ..........................77 4. MQTT Publish ............................ 79 5. Email Alarm ............................87 3. VMS..............................89 1. Cortrol Plug-in Integration Guide...................... 89 2. AIAIBOX Plugin Integration Guide for Network Optix VMS ............102 3.
  • Page 5 1. Overview 2. Components 1. Components Cable clamp Adapter Screw 2. Names and Functions...
  • Page 7 3. AI AIBOX Device Settings AI AIBOX is an AI video analysis device that analyzes multi-channel video using various types of AI algorithms to extract meaningful objects or identify various situations visually detected on the screen. AI algorithms can be used to extract objects and follow the event after judging the situation with AI metadata.
  • Page 8 2. Search for devices on the network 2.1 Download the Device Management Tool Download and install the Device Management Tool from the link below. AI AIBOX is possible to search the device’s IP and set the network via the Device Management Tool program provided by GANZ.
  • Page 9 When run for the first time, it shows a list of AI AIBOXs connected to the network. In the ID / Password field, admin / 1234 is entered by default. ● When the AI AIBOX is in “factory default or factory reset” status, “1234” is set as a temporary password for network settings in the tool ●...
  • Page 10 - If the network settings have not been changed, it is due ID or Password being incorrect, please check again. 2. After setting the network, double-click the device information in the list to access the AI AIBOX. - The AI AIBOX webpage will open in the default browser in Windows.
  • Page 11 3.3 Initial password setting of Device When accessing the AI AIBOX for the first time, the initial password setting UI is displayed. Set the password want to use. The password can use the alphabet, numbers, and special characters, and it should be set to 8 to 16 characters.
  • Page 12 4.1 Camera Video Input Setting To enable the AI AIBOX to receive and analyze video from a camera, you must first set up the camera’s connecting information. Click the ‘Video Stream’ in the sidebar navigation menu displays the settings menu for receiving video from the camera.
  • Page 13 ⑥ Set the maximum video buffering time. If, due to network conditions or camera types, video information is not transmitted smoothly and is received in a sudden burst, AI AIBOX can redistribute it into smooth videos according to the buffering setting. As the ‘Video Buffering’ setting is a maximum value, the actual buffering will be less than the set value if there are no problems with the camera and network performance.
  • Page 14 4.4 Multiple channels of video stream at once Set up multiple channels of video streams at once. You can set up multiple channels of video streams in bulk using copy and paste, as well as features such as Apply to All. To use the Bulk Setup feature, click the ‘Edit Video’...
  • Page 16 4.6 Searching for setting ONVIF cameras Once the video stream is set up and connected, click the ‘Configure AI App’ button, select the appropriate app, and set the event action rule.
  • Page 17 Mac Address and Remote Code displayed on the UI. 4. Application usage guide AI AIBOX works by adding various applications in the form of add-ons. To add and use the application to the device, a license to use the application should be issued from the device dealer.
  • Page 18 If the device has a license, the app will appear as a green header in the ‘Explore AI apps’ menu. In the ‘Explore AI apps’, you can click on the app that you want to use to go to the settings menu for that app.
  • Page 19 2. Event Action Setting Guide Many of the various applications supported by AI AIBOX have a structure that performs predefined actions for events detected based on AI. By defining events and setting related actions, notification on real-time events can be used for a variety of purposes.
  • Page 20 2.1 Alarm setting example (Intrusion) To set up an intrusion detection event action, click the ‘Explore AI Apps – Intrusion Detection’ in the sidebar navigation menu. To set a new detection rule, click the button in the intrusion detection settings. 2.1.1 Event Action Rules Setting 1.
  • Page 21 2.1.2 Event Setting 1. Click the button to set up the event. 2. Select the video want to detect via the dropdown to the right of the Event Type. Please refer to the video to properly set the detection zone. The detection zone can be set using the functions below.
  • Page 22 Drag the vertex to move it.  Click the yellow line to add a new vertex at that point.  Right-click the vertex to remove it.  Drag the gray box to move the label position.  After done, the video will look like below with the event zone ad label set up above. 3.
  • Page 23 Event Count Label : Enter the name of the label widget drawn over the video.  Target Object : Select the event detection target. Person, Vehicle, and bike can be set.  Event Count Reset : Set whether the event counts value or not. When enabled, the count value is ...
  • Page 24 2.1.5 Filter settings (optional) Schedule and Combined Rule filters can be used to set up event filters to drive actions. The schedule and Combined Rule filter settings described below are not required to configure an action rule, so you only need to set them if necessary.
  • Page 25 3.1 Counter working process By setting up a counter application, AI AIBOX counts objects internally and archives the counting data to internal storage at regular intervals. The stored data can be retrieved directly from the edge through the API. Edge storage has limitations in areas...
  • Page 26 3.2 Counter Setting Example (Occupancy Counting) Utilize the Occupancy Counting application to count people in real-time not only in stores, but also in buildings, specific areas of buildings, floors, or any other unit. 3.2.1 Counting Method Occupancy counting operates according to the following methods. 1.
  • Page 27 3.2.4 AI AIBOX Counter Setting 1. To set up counting people in a space, click the ‘Explore AI Apps’ – ‘Occupancy Counting’ in the sidebar navigation menu. 2. Click the button to create a new counter in the upper-right corner of the Occupancy Counting list.
  • Page 28 4. Click the button to add the enter/exit zone. If there are multiple entrances and exits, every entrance and exit be added as a counting zone. 3.2.5 Counting Zone Setting 1. Select the video you want to count from the Select Video dropdown in the top right corner. 2.
  • Page 29 Right-click the vertex to remove it  Drag the gray box to move the label position  3. Click the button to save after setting each option. Set the counting zone to every entrance and exit the same as above to count the whole passengers. Zone Name : Enter the name of this zone.
  • Page 30 3.2.8 Setting up real-time reporting (optional) This feature allows you to send count values to a user-configured HTTP server in real time. Not setting it does not affect the behavior of the counter. Click the “Settings” button to configure the real-time count reporting feature. 3.2.8.1 Reporting setting Activation To enable real-time reporting, turn on the switch in the...
  • Page 31 Under Data transfer format, click the button in the View format item to see the live count data transfer protocol information. 3.3 Counter Action Rule Setting Example You can set events and create action rules based on the counter values of the counters you set. Each counter app includes a separate menu where you can set up rules.
  • Page 32 2. Select the channel on which you want the event widget to appear and specify the location of the widget. The channel on which the event occurs will also be set to the channel on which the widget will be displayed. 3.
  • Page 33 Periodic – The count event occurs at regular time intervals.  Events occur at regular intervals based on the event cycle you set.  If you have added a range condition such as greater than/less than setting as a condition ...
  • Page 34 3.3.4 Finish setup 1. Click the button at the very bottom to save intrusion detection event settings after setting up the event, action in the event action rule set page. 2. If everything is set up correctly, you can see the new event in the list on the Intrusion Detection application screen.
  • Page 35 Rules set in the application in the form of an event action  Events that make up a rule are set in an application in the form of an event action  System I/O devices, such as alarm inputs or virtual alarm inputs ...
  • Page 36 3.4.1 Reporting Preferences Settings 1. Report Name : Enter the name to identify this report setting. A random default value is inserted, change this if required. Once you have set a report name, you can use the {{REPORT NAME}} token in ...
  • Page 37 1. Reporting Cycle : Set the frequency of data reports. 2. Report Time : Set when to report based on reporting cycle. 3. Data : Set the scope of reporting data. 4. Resolution : Set the units for aggregating report data. 3.4.3 Recipient settings Recipient settings are similar to action settings in Event action rule settings.
  • Page 38 3.5 Counter Statistics Report Format Guide 3.5.1 Reporting data format If you’ve set up reporting, then a statistical report is sent when the next cycle comes around. Statistical reports are sent as CSV or JSON type data, depending on your settings. Multiple zones can be set for a single counter.
  • Page 39 The counter is named Gangnam Station Traffic Counter, and it has two counting areas set up: the Gate 6 Crosswalks, and Gate 5 Front. By adding reporting settings in the PeopleCounting app, you can receive statistical reports periodically for these counters.
  • Page 40 Aggregation start time from counters 1. timestamp The Unix Epoch value of when the data started being collected. 2. datetime Date and time values from when the data started being collected. It is set in the format specified in the System-Date and Time setting. Aggregated statistical data from counters 1.
  • Page 41 Aggregation start time from counters 1. timestamp The Unix Epoch value of when the data started being collected. 2. datetime Date and time values from when the data started being collected. It is set in the format specified in the System-Date and Time setting. Aggregated statistical data from counters 1.
  • Page 42 1.1 Object Minimum Size Filter The Object Minimum Size Filter is a setting that allows a detected object to be recognized as an object only if the size of its bounding box is greater than the size of the box you set. To access the settings, click Object Size Filter in the sidebar menu and select Min Size Filter in the body area.
  • Page 43 1.2.1 How To Filter The Maximum Object Size If the bounding box of an object is even larger by one horizontal or vertical dimension than the maximum size filter of the object, it will be filtered out. Only when the object’s bounding box is completely within the maximum size filter will the object not be filtered out.
  • Page 44 2. Select a Minimum Size Filter type. 3. Drag the filter area to move the filter position. 4. Drag the vertex of the filter box to change the size of the filter.
  • Page 45 1.2.3 Filter Types 1. Not Used 1) No use Minimum Size Filter for this channel. 2. Normal 1) Use a Normal type of Minimum Size Filter. 2) Typically used when the viewing angle is distant, and the screen area contains objects of approximately similar size.
  • Page 46 1.2.4 Save, Load, And Reset The Settings 1. Save : Click the button at the bottom of the screen to save the position and size information of the filter setting. 2. Load : Click the button to load the most recently saved information of the filter that is set on that channel.
  • Page 47 2. Select the channel you want to exclude. 3. Click the button to create an exclusion zone box. Up to 10 exclusion zones can be set. 4. Drag the exclusion zone to move it.
  • Page 48 5. Drag the vertex of the exclusion zone box to change the size of the zone. 6. Double-click or right-click the exclusion zone to delete it. ※Caution It is recommended that the exclusion area is as small as possible to prevent actual objects from being filtered out by the exclusion area settings.
  • Page 49 Even if the exclusion zone does not cover the entire object, the object is excluded as long as its center is within the exclusion zone. 2.2 Save, Load, And Reset The Settings 1. Save : Click the button at the bottom of the screen to save the position and size information of the filter setting.
  • Page 50 3. Arm/Disarm Instant Settings ※ Disarm Configuration Global: t can be configured in the top header of the UI, allowing you to control the operation of all • device actions. This setting takes priority over per-channel settings and system action disarm rules All: You can configure the Arm or Disarm operation of all channels and specified actions..
  • Page 51 Enter a rule name to distinguish of rule. 2. The activate button sets the rule’s activation status. 3. The handler specifies whether this rule is for alarm input or schedule. 4. Disarm state set configures the arm/disarm state when the rule triggers. 5.
  • Page 52 4.2 Schedule You can set a schedule to change disarm status. You can set a schedule by setting a target day and specifying a time. For example, you can set a rule to disarm every Saturday at 00:00. 7. Action setting guide Various types of actions you want to trigger when an AI event occurs can send alarm notifications by defining the event actions in the event action settings.
  • Page 53 Utilizing Event Meta Tokens & Creating Action Message Guide Action handlers that use the network can send messages using various event meta-information, such as the event name and the event occurring time. When you set up an action handler of the type that sends a message from a device, the action message you want to send is configured in a format that you edit yourself.
  • Page 54 1. Select the template you want to set from the drop-down list. 2. Click the button on the right. ※Caution When you use a template message, everything in the edit box is replaced with the template message. If you are working on something, you will lose your work if you replace it with the template message, so be careful when using it.
  • Page 55 The token string can be moved anywhere in the edit box. The list of supported tokens and details of each are described below in the manual. 2 How to use object token {{::OBJ[XXX]}} In the list of event metadata tokens, tokens of the form {{::OBJ[XXX]}} must be used according to specified rules.
  • Page 56 It is an example message sending object information by adding the bounding box positions of two persons’ objects containing a fictional event. The plain text remains the same, and the OBJ token repeats the object information syntax twice the number of objects. 2.3 3rd Example of using an object token If you use the {{LIST OBJECTS[PARAM=COMMA]}} token to enclose the phrases of the list of object information, it will add a comma (,) between each phrase if there is more than one event object.
  • Page 57 ▪ ▪ {{MAC}} ▪ Device MAC address ▪ {{RULE NO}} ▪ The action rule ID containing the event ▪ ▪ ▪ {{RULE NAME}} ▪ The action rule name containing the event ▪ ▪ ▪ ▪ {{EVENT NAME}} ▪ Event name ▪...
  • Page 58 ▪ ▪ ▪ {{EVENT TYPE}} ▪ Event type ▪ ▪ ▪ {{# OF OBJECTS}} ▪ Number of event objects 2. Event time-related tokens For example, if the event was at 18:43:9.739 on 7 March 2023 in the GMT+9:00 time zone, each time token would be replaced as follows.
  • Page 59 ▪ Event month with 2-digit ex) 03 ▪ {{TIME dd}} ▪ Event date with 2-digit ex) 07 ▪ {{TIME HH}} ▪ Event occurrence hour on a 24-hour basis ex) 18 ▪ {{TIME MM}} ▪ Event occurrence minute with 2-digit ex) 43 ▪...
  • Page 60 When using LPR object information, you must use {{LIST OBJECTS}} or {{LIST OBJECTS[PARAM=COMMA]}} to enclose the object display syntax, as with normal object information. ▪ {{::OBJ[LP_TEXT_DETECTED}} ▪ The plate number by License plate recognition ▪ {{::OBJ[LP_TEXT_DB}} ▪ The plate number registered to DB by the user ▪...
  • Page 61 6. Object attributes information token When you activate the Basic Attributes app or the Advanced Attributes app, additional analysis of detected person’s attribute information is performed. If you want to include object attribute information in an action message, the object display syntax should be start and end with {{LIST OBJECTS}} or {{LIST OBJECTS[PARAM=COMMA]}}.
  • Page 62 1. System 1. Relay Relays are functions that output digital signals through device I/O terminals. Relays can be used to control a warning light or to operate with a door lock as a door control signal. Relay actions can be added from the Action Settings. Select the action type to Relay, you’ll see the relevant settings at the bottom.
  • Page 63 2. Camera speaker Output If IP camera connected to the AI AIBOX supports audio output through speakers, you can drive an event action to emit audio output. Camera speaker output operates based on the protocols defined by the ONVIF Audio Backchannel standard.
  • Page 64 2. Select a camera connected to the AI AIBOX to output speaker sound 3. Select a sound source to send to the camera. Sound files can be uploaded on the New menu. MP3 and WAV formats are available. Alternatively, select the audio file on the existing list to send to the camera.
  • Page 65 3.1 Basic Interface Wiring...
  • Page 66 3.2 Action Setup The setup procedures for RS485 and RS232 are the same, with the only difference being the output interface. You can add an RS485 or RS232 action from the action settings screen. When you set the Action Type to RS485, the related settings will be displayed below. 3.3 Message Type You can set the message type to either Hex Codes or UTF-8 formats.
  • Page 67 Hex Codes When you select the Hex Codes format, you can transmit binary data using hexadecimal values. Event metadata tokens cannot be used when transmitting binary data; instead, you must use fixed binary data. Please refer to the setup example provided. Setup Example UTF-8 The UTF-8 format allows settings to be configured using Tokens and templates.
  • Page 68 3.4 RS485 (RS232) Setting Configure Baudrate, DataBits, Parity, and StopBits. These settings are shared across all items of the same action type. Therefore, if you change settings in a specific action handler, it will apply to all action handlers. 2. NETWORK 1.
  • Page 69 2nd URL :If you configure a 2nd URL, the request to the 2nd URL is automatically retried only if the  request to the primary URL fails. However, if the request to the primary URL is successful, the request to the secondary URL will not be made.
  • Page 70 1.4 Show event data API request data can contain event information. 1. Enter event data values using predefined tokens. 2. Select the desired token value from the combo box. The selected token value will be added as {{token}} in the form of {{token}}. ...
  • Page 71 2. You can use event data tokens on the Custom Header settings page. To use a token, select the text field and add the token. It is only available for Value. 1.6 Query Settings The query string can be configured in the same way as the header. Once set, you will see a quick view of the query string.
  • Page 72 2. If you click the button, the settings window pop-upUse the event data token to set the value. There’s also a simple template. There are also simple templates available. ...
  • Page 73 Snapshot settings multipart/form-data allows snapshots to be appended. Content-type: Application/Json Application/Json provides event data token functionality and template functionality. It also provides templates in the form of Json.
  • Page 74 1.8 Message test You can test your setup data using the Test button at the bottom. Success is displayed at the top.
  • Page 75 2. FTP Upload FTP upload allows you to upload an event snapshot to an FTP server when an application event occurs. The directory and file name to store the snapshot file can be set variably using the event’s metadata. The FTP Upload can be added from the Action settings. Select the Action Type to FTP, then, the relevant settings at the bottom.
  • Page 76 2.1 Snapshot Time Range Settings 1. Set the time range for uploading snapshots based on the time of the event. In the example set above, snapshots taken from 2 seconds before the event to 1 second after the event will be uploaded. Periodic snapshots are taken at least once per second for each channel, in addition to event snapshots.
  • Page 77 2. Enter the destination FTP server information and click the button. After adding an FTP server setting, a new entry is added to the FTP server list. Select the desired server in the FTP server list to complete setting up the server. 3.
  • Page 78 3.1 Snapshot Time Range Settings 1. Set the time range for uploading snapshots based on the time of the event. In the example set above, snapshots taken from 2 seconds before the event to 1 second after the event will be uploaded.
  • Page 79 4. Once your AWS S3 storage has been added, it will be listed. ￭ Once you have ticked the destination box, the setup process for your AWS S3 storage is complete. 4. MQTT Publish MQTT You can use the publish feature of to integrate AI AIBOX with a variety of devices.
  • Page 80 4.1 MQTT ? MOTT(Message Queuing Telemetry Transport) is a lightweight messaging protocol that is ideal for efficient communication in low-bandwidth or unreliable network environments, particularly with IoT(Internet of Things) devices. Its lightweight nature makes it specifically designed for delivering messages between remotely connected devices.
  • Page 81 Topic  Topics in MQTT define how messages are categorized. Topics are strings that can be hierarchical. (Ex: “home/livingroom/temperature”) Clients subscribe to the topics they are interested in, and receive messages only about those topics. Message Payload  The message payload is the data component of the MQTT message. It can vary in form, including text or binary data, and its size is determined by the broker’s implementation.
  • Page 82 You can set the Message Payload and set the QoS level. Please refer to “Utilizing Event Meta Tokens & Creating Action Message Guide” for how to set the Message Payload. 4.2.3 MQTT Broker Setting You can add an MQTT Broker, or select a Broker to use from the added MQTT Brokers. Click the ‘Add’...
  • Page 83 You can set the name of the MQTT Broker and set the MQTT Broker access information. If you need help with access information, contact your MQTT Broker representative. 4.3 How to test the MQTT Publish action Here show you how to test using the MQTT Broker and MQTT Web Client, both of which are available for free hivemq from 4.3.1 MQTT Client : Subscribe Setting...
  • Page 84 Click the “Add New Topic Subscription” button after connecting, and then input the name of the Topic (“ACTION_TEST_MQTT_PUBLISH”) you wish to configure in the MQTT Publish action. Once set up, you will see a page below. Check the Message section of this page for the test result once you have set up the MQTT Publish action.
  • Page 85 Set up the MQTT Broker as follows.
  • Page 86 After configuration, click the Test button to run the MQTT Publish Test Action. When you see the MQTT Web Client, the test result is displayed as shown below.
  • Page 87 5. Email Alarm You can email event snapshots and event metadata information when an event occurs. 5.1 Email Action using an SMTP Server Settings Email actions using an SMTP server can be added from the Action settings. 1. Select the Action Type to Email(SMTP), then, the relevant settings at the bottom. If you set up your own SMTP server and credentials, you can configure an email action using that SMTP server.
  • Page 88 2. Click the tap to add a new SMTP server configuration. Registered SMTP server configuration can be referenced to all event actions.
  • Page 89 1. If an SMTP server is added, it shows in the SMTP server list. Select one to configure the email alarm action. 3. VMS 1. Cortrol Plug-in Integration Guide 1.1 Introduction 1.1.1 Prerequisites • AIAIBOX FW version 10124 or greater. • Ganz Cortrol Premier VMS version 1.22 or greater. 1.1.2 Learn about integration architecture...
  • Page 90 • IP Camera transmits video stream to Cortrol VMS and AIAIBOX. • AIAIBOX analyzes the received video stream by AI Apps and sends Metadata & Event to Cortrol VMS. • AIAIBOX responds to Cortrol VMS‘s search requests. 1.2 Configuration 1.2.1 AIAIBOX Configuration Add AI app settings.
  • Page 91 Zone or detailed setting of AI App.
  • Page 92 Add Control Plug-in Action Setting. Enter the Cortrol VMS information ( Server Address, Port number, Username, Password) You can check if the Cortrol VMS settings are correct through the “Login” button. Note. When “Metadata Enable” is enabled, AIAIBOX transmits object Metadata detected by AI to Cortrol VMS.
  • Page 93 1.2.2 AIBOX Channel Mapping Set up the relationship between the AIAIBOX channel and the channel of Cortrol VMS. Press the “Mapping” button to open the settings pop-up window. Enter the Recording identifier (UUID) of the channel registered in Control VMS into AIAIBOX. Recording identifier (UUID) can be obtained from the Details menu of Channel in Cortrol Management Console.
  • Page 95 Enter the Recording identifier (UUID) and press the “Camera update” button to check if it is entered correctly. If the channel is connected successfully, green Connected is displayed. 1.2.3 Create Cortrol External Service Create an external service by clicking the “Create” button on AIAIBOX’s “Cortrol VMS Setup page”. Click the “Apply”...
  • Page 96 If you see the device registered in the format “AIAIBOX-MacAddress” in the External Service tab of the Cortrol Management Console, it’s OK. Next, Create an External Service Group. Enter the name of the new External Service Group as “AI AIBOX”.
  • Page 97 Assign AIAIBOX to the new External Service Group.
  • Page 98 1.2.4 Create Cortrol Event & Rule We need to configure the events, actions, and rules that will be sending notifications Click the “+New Event” button to add a new event. Select Event Type as External Event – External Service.
  • Page 99 Create a rule by combining the created event type and action.
  • Page 100 1.2.5 AIAIBOX Rule Test In AIBOX’s Cortrol Setup page, use the event “Test” button to test whether the setting is successful.
  • Page 101 1.3 Demo 1.3.1 Live Set the Cortrol Client to display Metadata and Alarms to check if it works with AIBOX. (Click the icon at the bottom of the video)
  • Page 102 1.3.2 Search 2. AIBOX Plugin Integration Guide for Network Optix VMS 1 Introduction 1.1 Prerequisites AIBOX FW version 10137 or greater.  Network Optix Witness VMS version 4.2.0.32840 or greater.  Network Optix Witness VMS version 5.0.0.35745 or greater.  1.2 Learn about integration architecture IP Camera transmits video stream to NX VMS and AIAIBOX.
  • Page 103 2 AIBOX NX VMS Plugin Install & Configuration 2.1 Install Nx Witness VMS Install the Nx Witness VMS v5.X or later. You will need both Server and Client, as the Client will be used in configuration. 2.2 Install AIBOX Plugin ( On Windows ) 1.
  • Page 104 4. Download & Install vc_redist.x64.exe ( https://aka.ms/vs/16/release/vc_redist.x64.exe ) 5. Start the Nx Witness server by right-clicking the tray icon and selecting Start Server. 6. Setup communication port & Setup Firewall In the AIAIBOX analytics plugin engine setting menu, ( Network Optix VMS System Administration > Plugins Menu ) set a unique port ( 9911 ) .
  • Page 105 Note) How to Add a Rule or Port to a Windows 10 Firewall https://www.youtube.com/watch?v=JsEulhg5P8k 2.3 Add NX api Account Add NX “api” account to be used by AIAIBOX. When creating an account, enable digest authentication and set the administrator role. 2.4 Enable video channels to use AIBOX analytics plugin In the NX client left panel, right-click the camera you want to process with AIBOX and select Camera Settings.
  • Page 106 1. Enable Metadata : It is not recommended to use it except for installation or debugging purposes. Even if this option is disabled, the object on which the event occurred is automatically displayed (saved). 2. Ignore Metadata (unanalyzed face objects) : Face information that has not been analyzed is ignored. 3.
  • Page 107 A large size of log files can be stored in the {NxInstallPath}\ usually on “C:\Program Files\Network Optix\Nx Witness\MediaServer\”. It should be disabled in a production environment. 6. Metadata Timestamp correction : Metadata (bounding box) is buffered for the set time. (Metadata is displayed delayed for the set time.) 2.5 Enable video channel recording Non-recording analysis channels cannot use the EVENT and OBJECT panel in NX VMS.
  • Page 108 3. AIBOX Configuration Let’s set up to integrate the Loitering Person app with the AIAIBOX Nx VMS Plugin. 3.1 Setting the video source 3.2 Setting up the Loitering Person app 3.2.1 Add Rule...
  • Page 109 3.2.2 Adding event video source...
  • Page 110 3.2.3 Setting Event Configuration AIBOX’s Event Name field is displayed as Caption field in NX VMS. It is recommended to enter a name that can identify the event. It is tagged to the object as shown in the figure below. Also, when registering a rule, you can set a detailed rule through text comparison in the caption field.
  • Page 111 3.3 Adding NX Plugin action handler 3.3.1 Add Action Setting 3.3.2 Select VMS / Nx Plugin 3.3.3 Editing VMS IP and Account...
  • Page 112 Enter the “api” (case sensitive) account information added in the previous step and test using the Login button. If the test is successful, you will see a connected green status indicator. Additional object information can be passed to NX VMS through the Description field. (For example, LPR app license plate recognition information, group information)
  • Page 113 3.3.4 Channel Mapping Channel information connection between AIAIBOX and NX VMS is required. If the channel id is entered correctly, the green Connected status will be displayed when you click the Camera Update button.
  • Page 114 NX channel ID ( Camera ID ) information can be copied from the camera setup menu of NX VMS. 3.2.5 After completing all settings, click the Submit button at the bottom of the webpage. Your settings will not be saved unless you click the submit button.
  • Page 115 3. Demo 3.1 Live Objects with loitering person events are displayed in the NX VMS OBJECTS panel. Saved objects can be searched through the Object “Advanced” menu of NX VMS. When objects are not visible, activate Objects in “Show on Items” in the popup menu of the video window.
  • Page 116 You can then manually specify the ROI area. It is automatically synchronized with the ROI(zone) information of AIAIBOX through AIAIBOX F/W upgrade in the future.
  • Page 117 3.2 Add Nx VMS Event Rules If you set the desktop notification action by adding Camera Rules in NX VMS, you can see the event in the NX VMS EVENTS panel. When registering camera rules, pay attention to the “Event Type” setting. If the APP set in AIBOX and the Event Type do not match, the event will not occur.
  • Page 118 3. AIBOX Integration Guide for Milestone XProtect VMS 1. Introduction 1.1 Prerequisites AIBOX FW version 102700 or greater. Milestone XProtect 2023 R1 or greater. 1.2 Learn about integration architecture There are two ways to integrate AIAIBOX with Milestone XProtect VMS: 1.
  • Page 119 2. Configuration 2.1 Milestone xProtect VMS Configuration We will explain how to integrate AIAIBOX with Milestone XProtect VMS using the Case1 method. Note: For the Case2 integration type, you can skip step 1(Adding the AIAIBOX to Milestone XProtect VMS) and proceed from step 2(Enable the XProtect analytics events).
  • Page 120 If you know the IP address of the AIAIBOX device, choose “Manual”. Enter the login information for the AIBOX. Select “ONVIF” from the device driver options.
  • Page 121 Enter the IP address information of the AIBOX. If you haven’t changed the onvif service port settings of AIBOX, the Port is 80. HTTPS is not used. Add the detected AIAIBOX hardware and change the name as desired. If this fails, recheck the setup and try again.
  • Page 122 2.1.2 Enable the XProtect analytics events Click on the Tools > Options menu in the XProtect Management Client. In the Analytics Event tab, check the Enabled checkbox. The service port must be open in the firewall. If you change the service port, you must enter the same port number when registering the AIBOX’s Milestone action handler.
  • Page 123 2.1.3 Add analytics events and alarm definitions. In the XProtect Management Client, select “Analytics events” from the left panel, right-click, and choose “Add New“.
  • Page 124 Enter the event name as “AIBOX Event“. This value is an essential key for distinguishing events between AIAIBOX and XProtect. It must be entered in the “Message key” property in the Milestone Action handler settings of AIAIBOX.
  • Page 125 In the XProtect Management Client, add “Alarm definitions”. Select “Analytics Events” for the Trigger Event item, and choose the “AIBOX Event” you added earlier. For the Trigger Source item, add the channel of the AIAIBOX. Note: When registering the Trigger Source, if you add the IPCAM channel instead of the AIAIBOX camera channel, it operates as the Case2 integration type.
  • Page 126 RTSP stream address. 2.2.2 Set up the AI App Select the desired AI App and set the AI event for the channel. In the Actions Setting, click the Add button to add the Milestone action handler.
  • Page 127 2.2.3 Enter the Milestone XProtect VMS Server Information Enter the IP address of the Milestone XProtect VMS and the Analytic Event service port number. Then click the channel “Mapping” button. Enter the Camera Channel ID of Milestone XProtect VMS. Note: If you enter the IPCAM channel ID information instead of the AIAIBOX camera channel ID in the camera mapping information, it operates as the Case2 integration type.
  • Page 128 You can find the UUID for the Camera Channel ID by selecting the channel with the mouse while holding down the CTRL key and then looking at the bottom of the info tab. For the “Message Key” property, input the name of the “Analytic Event” that you added in Milestone XProtect. In this guide, we have entered it as “AIBOX Event”.
  • Page 129 The Object field can be utilized in various ways. You can enter event texts, LPR information, etc., so you can send additional information in the Milestone XProtect Alarm Manager. Note: If you want to set the Object property differently for each AI App, you can create a separate Milestone Action handler for each AI App.
  • Page 130 If the event test is successful, check the “Activate Milestone action handler” checkbox and press the “Apply” button to save the handler settings. Finally, press the “Submit” button located at the bottom of the AI App settings to save all configurations.
  • Page 131 3. Demo 3.1 Live In the Live screen of the XProtect Smart Client, the analytics events will be listed within the Alarms panel as well as the annotated video. 3.2 Search In the search menu, click on the “Search for..” button and select Alarms to search for AI Events.
  • Page 132 3.3 Alarm Manager 1. In the Alarm Manager, by clicking on an individual alarm, you can check detailed event occurrence information with recorded video.
  • Page 133 Note: The Alarm Manager is supported in Milestone XProtect Express+ and higher versions. 2. To display analytic event properties in the Smart Client, you might need to adjust settings in the Management Client. First, navigate to “Alarms” and then to “Alarm Data Settings”. From there, choose the event properties you want and transfer them from the left panel to the right.
  • Page 134 7. Schedule Setting Guide A schedule can be set in all event action settings to trigger actions when events occur.
  • Page 135 1. Schedule Overview The schedule operates over a period of time to set the time for sending the notification whenever an event occurs. Depending on weekly, monthly, and yearly schedules can be set. Additionally, specific dates can be designated as exclusion schedules. Actions will not be triggered during the exclusion schedule.
  • Page 136 Schedule Cycle : Set the “schedule cycle” for how often the schedule should repeat as weekly, monthly, or yearly. Schedule Designation : Select whether the schedule is based on days of the week or specific dates. Schedule & Time range : Set the days/dates/Time. Exclusion Schedule : Check the box to set the schedule as an exclusion schedule.
  • Page 137 2. For monthly schedules that use the Date-based option, you can specify the dates of the month for the schedule. For example, you can set a schedule for the 1st, 15th, and the last day of the month. 5. Yearly Schedule 1.
  • Page 138 2. For yearly schedules that use the Date-based option, you can specify the dates for each target month. For example, you can set up a schedule on the 1st, 15th, and the last day of January to March. 6. Time Schedule Setting The time schedule sets to run on the specified date.
  • Page 139 8. Combined Rule Setting Guide You can set compound rule conditions to trigger actions when events occur in event action settings. 1. Overview of Compound Rule Conditions When setting up event action rules for each application, you can set conditions for triggering actions. In addition to setting scheduling conditions, you can also set conditions based on various system conditions to determine whether event actions should be triggered.
  • Page 140 2. Click the button to save after set the each options. UUID : Ender the UUID value assigned to a target event, rule, or system device. When setting up an event action in the application, both the event and rule receive a unique UUID. You can input the UUID of the event or rule that you want to set up as a condition.
  • Page 141 NOT : If NOT is checked, the condition will be true if the UUID event or rule is false. For example, if you specify the UUID of “Event A” and check the NOT checkbox, the condition will be true if “Event A” did not occur. Time Range(In Secs) : Time Range field is used to set the valid time range for UUID events or rules.