Navigation and terminology tutorial

Terminology

GUI / application - Graphical User Interface means this application. It is the interface with which you, the user, controls and manages your Ainalytics™ devices and view the information provided by them.

Device is the physical hardware that runs the analytics. There are multiple types of our devices (all of them Nvidia Jetson), but generally we mean the device or devices you are using.

Camera usually means IP camera you are using as input to the analytics software. We support many types and brands of cameras.

Stream is the input into the analytics software. Usually an IP camera, but input can also be a USB camera on the device or pre-recorded videos on filesystem.

Pipeline is the basis of our analytical software. It takes streams on input, runs AI detectors, AI classifiers and other analytics (regions of interest, overcrowding, line cross, direction detection) and outputs video.

Alert is an extra type of analysis, where the user can create complex rules, to trigger under specific conditions. These alerts are recorded in the time database and can also be used as notifications.

Notification is a message you receive after an alert is generated. There are multiple types of notifications and each of them can be configured to be sent to different channels (slack, email)

Navigation

Navigation in this GUI is divided into two basic parts - navigation tree and main screen, both are described bellow.

Navigation tree

Navigation tree is located on the left. It contains entries for anything you want to do in the GUI, and its purpose is to open the entry on the main screen. It is divided into four tabs, representing dashboards, realtime data, historical data and device management. After clicking a tab, a tree with devices is opened. Clicking a device will show its entries, double clicking an entry will open it as a page on the main screen.

Dashboards - Here you can see categories of dashboards and your setup dashboards under each one of them. Double-clicking a dashboard will open it in a new page.

Realtime data - In this tree, under each device are the analytical pipelines that run on it. Double-clicking a pipeline will open a live video player with its output.

Historical data - There are more options under each device here. Video streams and analytical pipelines open an archive video player of the corresponding data. Grafana opens its interface, where you can view, create and edit graphs.

Device management -
- Video streams will open a video sources administration window where you manage the input streams of the device.
- Analytical pipelines open the analytical pipelines administration window. From here you set up most of the analysis you want your device to do. From classifiers and detectors, to regions of interest and line crossings.
- Eventbus opens an eventbus window where you manage alerts and notifications.
- System opens a user administration window where you manage users, and their privileges for the device.
Besides connected devices, there are also entries for discovered devices, double-clicking them will open a window to connect to it.

Main screen

Any page you work with, will open on the main screen. Navigation on the main screen is divided into two parts - primary and secondary pages and tabs, containing settings, detailed information and help.

On top of the screen you have primary pages. Those are all the entries from the navigation tree you have opened. Under primary pages is the header of the active window. You will find the title and basic information there. In some windows, especially those that contain many options, there will also be secondary pages under the header. Secondary pages are related only to the active window. Under secondary pages is the active window.

On the right side you can find tabs, containing settings, info and help related to the active window.

Application layout