Configuration Manager

Configuration Manager

Configuration Manager, also known as Config Manager and short as CM is the web based tool for manipulating VIS config files. Introduced in Version 25, many system parameters of VIS has been moved to YAML files.

How to access Configuration Manager

CM is installed with VIS, served as a stand alone web based application and resides at http port 15000. Therefore open a browser that can access the Visbox, in the address box type in the IP of the Visbox and append port 15000. CM will be served.

When CM loads, it reads the existing configuration files of the system and every time you hit "Update VIS configuration" button it will save to the very same file(s).

How to apply changes

Configuration Manager immediately reflects each update to the respective YAML files, but VIS needs to be restarted for the new configuration to affect.

Fresh Installation Configuration

For new installations follow the instruction below:

1. Create IO module(s) first
2. Create all Vislets and their respective regions
3. Create one event, associate it with IO module immediately by selecting an IO module, add actions and associate with respective regions
4. Define notifications if required

Fundamentals

How to add a camera

Follow the below instructions to add a most basic camera feed to VIS as a Vislet.

1. Go to Vislets tab
2. If there are any cameras defined you will see it on the upper section. A clean installation would look like this:

   

3. Type in following information:
   1. Display name, name of the camera
   2. Socket port, for the connection between VIS and Visor - this needs to be unique per Vislet and not utilized or reserved
   3. Stream URL, depending on the camera
4. Leave the rest as is and hit Create Vislet, this is how it looks like before saving:

   

   Adding new camera

5. This is how it looks like after saving:

   

Assuming PF model is deployed, the newly added Vislet will begin detecting classes in the model, eg. person and forklift.

Adding another camera

To add a second camera, make sure button says "Create Vislet", otherwise you could be updating an existing camera. Type in necessary information, make sure port is not in use and hit the Create Vislet button.

Updating an existing camera

If you have previously added cameras on the Vislet tab, click the one you want to update. Create Vislet button turns to Update Vislet. Change information you want and click update button.

Deleting an existing camera

On the Vislets tab a list of existing Vislets is displayed. Every Vislet has a trash bin icon associated. Click the bin next to the Vislet you want to delete. An confirmation box will appear.

How to add regions to a Vislet

To add the most simplistic region follow the instructions below:

1. Click the Vislet you want to add a region, Regions section will appear at the bottom of the page
2. Type in name of the region
3. Leave custom property blank
4. Leave Region Pool Id 0 (zero)
5. Default regions type is "Presence", leave it selected. Page looks like this:

   

   Adding a new region

6. Click Create Region button and you will have a new region. Page should look like this after adding:

   

   A new region added

After adding regions in the Config Manager, you need to use the Visor app to draw the regions. In each camera every newly added region will be visible as a small square at the left corner.

Newly added regions will be displayed on the feed but they will not have an effect until associated with an event.

How to add an event

If you want to react to an event, first you need to create it on the Events tab. Unless you want to associate it with an output you only need a number to define it. An event will be used to trigger an output, to be recorded and sent as an email notification.

Let's create an event for detection of persons in previously defined PF region of Kamera 1 with event number id 666. This is how it looks like after adding an event:

You need to active the newly added event in each region you want it to run. For that follow the steps below:

1. Go to Vislets tab,
2. Select Vislet,
3. Select region
4. Active events you want
5. Click Update Region button

When associated like this, detection of any class of the deployed model will be forwarded to the interpreter class with the defined event id. This settings will also record the event with default video settings.

In order to trigger an output based on this event first you need to add an IO module and then associate the event with the newly added IO module and finally update the region to trigger the event.

Caution

Events are no stand alone entities therefore an event not associated with a region immediately after being created will disappear when the browser is reloaded.

How to add an IO module

In order to add an IO module visit IO Modules tab of the Configuration Manager. Follow the steps below to add a new IO module:

1. Type in display name
2. Username and password to connect to the device
3. IP address and main port of the device
4. Select type (currently CM supports only the IPIO)

   

   Adding an IO module

5. This is how it looks like after adding an IO module

   

   IO module added

How to associate an event with an IO module

1. Select event or type in new event id
2. Select an existing IO module from the drop down box
3. Click "Add Action"

   

   Adding an action to event

4. An action line appears
5. Select output pin (1-8)
6. Set "Event Start" to a state you want the output assumes when the event starts
7. Set "Event End" to a state you want the output assumes when the event ends
8. Add further channels as many as you need
9. Click "Create Event" when you are all set

   

   Event associated with IO module

10. For newly created events don't forget to associate with a region immediately before refreshing or reloading the browser

How to associate an event with a region

Go to Vislets tab, select Vislet, and then region you want to trigger the event, turn the event on and update the region.