Frequently Asked Questions (FAQ)

This page provides answers to the most commonly asked questions regarding the system settings.

How to –°onfigure the Hardware Tab Settings?

Select the hardware type:

  • Select the CPU hardware type to run the analytics processing on the central processor.
  • Select the GPU hardware type to run the analytics processing on the graphics processor.
The analytics is processed faster by the GPU than by the CPU.

Select the decoding type. Depending on the type of decoding, the video is processed on different devices:

  • CPU selection provides video decoding on the central processor.
  • Intel selection provides video decoding on the Intel Integrated Graphics Processor (Intel HD Graphics).
  • NVDEC selection provides video decoding on the NVIDIA graphics processor.

The FPS mode allows to set the number of frames per second processed by the analytics:

  • A higher frame rate gives a better result if the video contains dynamic objects (e.g. the people flow in a shopping center or the vehicle traffic on the road).
  • A lower frame rate is sufficient if the video contains static objects (e.g. vehicles in a parking lot).
The higher the frame rate, the more resources are required for analytics to process the video.

The Key Frame mode selects only keyframes from the video stream. Keyframes have the lowest compression ratio, which saves resources for decoding and processing the video stream by the analytics.

Suitable for video streams with compression (e.g. h264, h265, etc.).

The Once Every X Seconds mode processes 1 frame after a set period of time, while the remaining frames are skipped.

Suitable for cases where very rare frame processing (less than 1 frame per second) is required.



How to Get Google Maps API Key?

To get the Google Maps API key, open the Google Maps Platform by the link and click the Get Started button:

Sign in to the Google account or register to continue.

Once signed in, verify the Google billing account.

Step 1:

  • Select the appropriate answers from the drop-down lists
  • Carefully read the Terms of Service and check the box to agree
  • Click the Continue button

Step 2:

  • Enter the phone number
  • Click the Send Code button

Once the verification code is obtained by SMS:

  • Fill in the required field with the obtained verification code
  • Click the Verify button

Step 3:

  • Fill in the required fields
  • Click the Start My Free Trial button
The system withdraws $1 from the specified card for verification, after which the money is returned back to the specified card. Make sure to have enough funds on the account to complete the verification.

Once the billing account is verified:

  • Answer a few questions
  • Click the Submit button

After the submission, a new window with the generated API key opens:

  • Copy the API key to the clipboard
  • Click the Maybe Later button

After redirecting to the control console, select the APIs item:

In the APIs item, make sure the following APIs are enabled:

  • Geocoding API
  • Maps JavaScript API
  • Roads API
  • Street View Static API

How to Access API Documentation?

To access the API documentation (Swagger), use one of the following methods.

Access API Documentation through the Settings section:

  1. Navigate to the Settings section
  2. Open the General item
  3. Click the View API Documentation button within the API Token tab

Access API Documentation via URL:

  1. Copy the following URL: http://your-server-ip-address/settings/plugin_docs
  2. Paste the URL into the address bar of your browser
  3. Replace "your-server-ip-address" in the URL with the IP address of your server

How to Create a Cyclic RTSP Video Stream from a Video File?

To create a cycled RTSP video stream from a video file, proceed with the following instructions.

Download the ZIP archive with the MediaMTX software at the following link: Download MediaMTX. Extract the downloaded archive in the root folder of your Drive C:


Do not create additional folders; the files will be unpacked into the existing dedicated folder.

Open the "mediamtx_v0.23.6" folder on Drive C:

Copy the video files intended for conversion into an RTSP video stream into the "demo" folder:

The example of video files inserted in the "demo" folder:

Ensure the required video files are encoded in the H.264/H.265 codec.

Execute the "mediamtx.exe" file:

Allow firewall access:

  • Ensure that TCP Port 8554 is available when launching the MediaMTX program.
  • You can add new video files to the "demo" folder without exiting the MediaMTX program.
  • For proper video stream operation, the MediaMTX program must be continuously running.

Check in the VLC Player that the video stream opens and plays:

  1. Enter the address as follows: rtsp://localhost:8554/LPR_005_GERMANY.avi
  2. Click the Play button

After following these steps, the video stream should open and play, as shown in the example:

Use "localhost" only if the Middleware is installed on the same computer. Otherwise, enter the IP address of the server where the Middleware is installed.

Add the video stream obtained from the video file to the system. Configure the mandatory parameters following these steps:

  1. Select the Camera button in the Video Streams section
  2. Choose RTSP as the stream type
  3. Enter the server address in the Host field
  4. Enter 8554 in the Port field
  5. Specify the /video_file_name in the Path field, as shown in the example: /LPR_005_GERMANY.avi
  6. Provide the complete stream address in the Video Source Address field, as shown in the example: rtsp://localhost:8554/LPR_005_GERMANY.avi
To learn more about the configuration of other parameters while adding a video stream, refer to our Manage Cameras documentation.

Once the video stream is saved, the Success Notification identifies, that the video stream was successfully created and can be used for video analytics:

For any further tasks involving the created cyclic RTSP video stream, it is essential to have the MediaMTX program running continuously.

Check the video stream grabs the frame:

  1. Find the desired video stream in the Description block
  2. Hover the mouse over the Settings icon to open the drop-down menu
  3. Select the View Camera information option
  4. Click the Update button in the pop-up window

If you are not receiving an image, please ensure that you have correctly specified the following:

  1. IP address is entered correctly in the Host field
  2. File name is specified correctly in the Path field
  3. MediaMTX program is continuously running

If everything has been done correctly, then the issue is with the video content, resulting in an error, which indicates that the frame can not be grabbed from the video stream:


How to Change the Region for LPR Analytics Without Reinstalling the System?

To modify the region for License Plate Recognition (LPR) analytics, proceed with the following steps.

Navigate to the "alpr.properties" file, which is, by default, located at:

C:\ProgramData\Incoresoft\process-runner\alpr.properties
This file is in JSON format and can be manually edited.

Edit the "alpr.properties" file.

Open the alpr.properties file in a text editor and locate the following section:

{
"motion": "false",
"model": "EUROPE"
}

To change the LPR model for the desired region, update the value for the "model" parameter to one of the following options:

  • "EUROPE"
  • "ARABIC"
  • "AUSTRALIA"
  • "USA"

For the "USA" model, also add the "submodel_id" parameter, and set its value to "1":

{
"motion": "true",
"submodel_id": "1",
"model": "USA"
}

Save the modified "alpr.properties" file, ensuring that the JSON structure remains valid, and all values are enclosed in quotes.

After editing the "alpr.properties" file, restart the IncoreSoft ProcessRunner service to apply the changes.

For the "ARABIC" model, additionally enable UTF-8 support. In the Windows OS open the Start menu, select the Control Panel, and choose Regional Standards. In the Region window, follow these steps:

  1. Navigate to the Administrative tab
  2. Click the Change System Locale button. In the Region Settings pop-up window:
    • Check the box for Beta: Use Unicode UTF-8 for Worldwide Language Support
    • Click the Ok button
  3. Click the Apply button to save the changes

How to Enable Video Stream Display in the Analytics Live View?

If the analytics is functioning correctly and producing results, but the video stream is not displaying in the live mode, and you see the message "Failed to load the video in MJPEG format. Please try to update the video stream" or "Reconnecting to the video stream. Please wait...", follow these steps:

  1. Open the Settings section
  2. Navigate to the Servers item
  3. Click the Settings icon on the toolbox for the required server
  4. Specify the IP address of the analytic server responsible for broadcasting real-time analytics in the Interface IP field
  5. Click the Save button to save the changes

If you changed the Port, after saving the settings it is necessary to restart the analytical services:

  • For Windows:
    1. Press the Win + X keys and select the Computer Management option in the context menu
    2. Navigate to the Services and Applications tab
    3. Select the Services option
    4. Select Incoresoft ProcessRunner Service from the list and click the Restart button to restart the service
  • For Linux: sudo systemctl restart incoresoft-process-runner.service

How to Change the System User Language in Windows?

Changing the system user language in Windows can be beneficial when encountering issues such as difficulty with initial system login, adding a video stream to the system, or creating analytics. This is particularly relevant when the "Request processing error" system message appears, often associated with the system user language set to Turkish.

To change the system user language in Windows, follow these steps:

  1. Open the Start Menu
  2. Navigate to Settings
  3. Select the Time & Language settings block
  4. Click the Language section in the left menu

Proceed with the following steps:

  1. Choose English for the Windows Display Language setting
  2. Go to Administrative Language Settings
  3. Click the Copy Settings... button
  4. Check the box for Welcome Screen and System Accounts
  5. Click the Ok button in the Welcome Screen and New User Accounts Settings pop-up window
  6. Click the Apply button in the Region pop-up window to save changes

After applying these settings, restart the PC for the changes to take effect.


How to Display Analytics Broadcasting in a Browser for Ubuntu with GUI?

If you wish to stream live analytics in your browser on Ubuntu with GUI, regardless of the location of the analytics broadcasting server - whether it's on the same machine or another computer running Windows or Linux - you need to additionally install ffmpeg. Use the following command:

sudo apt-get install ffmpeg

How to Send Events to External Software's API via Event Manager?

To send analytics events data to an external software's API via Event Manager, proceed with the following steps.

Step 1: Create an event in the Events item of the Settings section and configure it in the Event Manager Constructor.

In the Event Manager Constructor:

  1. Insert the API Block in the event chain and click the block to open its parameters
  2. Fill in the fields in the API block:
    • Select the request method from the drop-down list:
      • Get
      • Post
    • Enter the API URL of your external system where the data packages will be sent
    • Select the Content/Type from the drop-down list:
      • application/json
      • application/x-www-form-urlencoded
      • application/xml
  3. Save the event by clicking the Save button
Data transmission from the system occurs through the Event Manager in JSON/XML/POST data formats, contingent on the capability of third-party software to receive these formats. In cases where data reception in the specified formats is not possible, the development of a proxy connector becomes necessary to adapt the data for seamless integration with third-party software.

Step 2: Depending on the source from which you want to receive event data, configure analytics, list, rule, or off-the-list notification settings.

To configure the analytics settings, open the analytics editor:

  1. Navigate to the Notifications tab
  2. Select the Send Events to Event Manager checkbox
  3. Choose the created event from the Events drop-down list
  4. Save the analytics settings
  5. Start the analytics and wait for detection

Upon each detection, the event will be sent through the API block to your external software as a data package.

To configure the list settings, open the list editor:

  1. Navigate to the Notifications tab
  2. Select the Send Events to Event Manager checkbox
  3. Choose the created event from the Events drop-down list
  4. Save the list settings

Afterward, start the analytics included in the list and wait for recognition. Upon each recognition, the event will be sent through the API block to your external software as a data package.

  • Lists are available for Face Recognition and LPR plugins only.
  • To learn more about list management in the Face Recognition plugin, refer to Face Recognition: Lists documentation.
  • To learn more about list management in the LPR plugin, refer to LPR: Lists documentation.

To configure off-the-list notifications, open the Off List Notification Settings:

  1. Select the Send Events to Event Manager checkbox
  2. Choose the created event from the Events drop-down list
  3. Save the off-the-list settings

Afterward, start the analytics included in the off-the-list notification settings and wait for detection. Upon each detection, the event will be sent through the API block to your external software as a data package.

  • Off-the-list notification settings are available exclusively for Face Recognition and LPR plugins.
  • To learn more about setting parameters for off-the-list notifications in the Face Recognition plugin, refer to Off List Notification Settings documentation.
  • To learn more about setting parameters for off-the-list notifications in the LPR plugin, refer to Off List Notification Settings documentation.

To configure the Speed Control rule settings, open the rule editor:

  1. Navigate to the Notifications tab
  2. Select the Send Events to Event Manager checkbox
  3. Choose the created event from the Events drop-down list
  4. Save the rule settings

Afterward, start both analytics included in the Speed Control rule and wait for detection. Upon each detection, the event will be sent through the API block to your external software as a data package.

  • Speed Control rules are available exclusively for the LPR plugin.
  • To learn more about Speed Control rules, refer to Speed Control: Rules documentation.

To configure the Smart Parking rule settings, open the rule editor:

  1. Select the Send Events to Event Manager checkbox
  2. Choose the created event from the Events drop-down list
  3. Save the rule settings

Afterward, start analytics included in the Smart Parking rule and wait for detection. Upon each detection, the event will be sent through the API block to your external software as a data package.

  • Smart Parking rules are available exclusively for the Smart Parking plugin.
  • To learn more about Smart Parking rules, refer to Settings: Rules documentation.
  • These are general guidelines aimed at providing a basic understanding of how to send event data to external systems via API in the Event Manager.
  • For detailed examples of creating events and sending event data (including API blocks and examples of data packages you might receive) from analytics or lists via API to external systems, please refer to our Event Manager: Examples of Use documentation.