Cluebase VMS User Manual - Revision history

Vcloudai at 05:59, 8 July 2026

2026-07-08T05:59:45Z

← Older revision		Revision as of 06:59, 8 July 2026
Line 530:		Line 530:
	'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.		'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.

	~~===~~ Offline geographical maps ~~===~~
			'''Offline geographical maps'''

	Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.		Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.

Vcloudai: Add offline geographical maps section

2026-07-08T05:54:54Z

Add offline geographical maps section

← Older revision		Revision as of 06:54, 8 July 2026
Line 529:		Line 529:

	'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.		'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.

			=== Offline geographical maps ===

			Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.

			[[File:Cluebase VMS offline map create new map.png\|alt=Create new offline geographical map\|none\|thumb\|Create new offline geographical map]]

			To create an offline map:

			# Open '''Main menu -> Maps''' and click '''+''' to add a new map.
			# Enter the map title.
			# In the '''Map type''' field, select '''Global offline map'''.
			# Click '''Create'''.

			[[File:Cluebase VMS offline map regions window.png\|alt=Regions selection window\|none\|thumb\|Regions selection window]]

			After the offline map is created, open the regions download window using the regions/download button in the bottom-right corner of the map editor.

			[[File:Cluebase VMS offline map choose region.png\|alt=Choose the required regions\|none\|thumb\|Choose the required regions]]

			In the '''Regions''' window, expand the required continent, country, or area. The list shows the available regions and the approximate download size for each one.

			To download a region, click the download button next to its name. Repeat this action for every region that must be available offline.

			[[File:Cluebase VMS offline map downloaded region.jpg\|alt=Downloaded offline map region\|none\|thumb\|Downloaded offline map region]]

			Once the required regions have been downloaded, the offline map can be used in the same way as other maps. Operators can zoom and move around the downloaded area, draw polygons, and place cameras, sensors, or doors on the map.

	== Camera groups<br> ==		== Camera groups<br> ==

Vcloudai: /* Multi-server functionality */

2026-07-06T17:34:34Z

Multi-server functionality

← Older revision		Revision as of 18:34, 6 July 2026
Line 402:		Line 402:
	[[File:Bind.png\|alt=bind\|none\|thumb\|600x600px]]		[[File:Bind.png\|alt=bind\|none\|thumb\|600x600px]]
	Fill the server access fields and click bind.		Fill the server access fields and click bind.

			If connection to one of the linked servers is lost, a corresponding notification appears in the Alarm panel.

	== Storage settings ==		== Storage settings ==

Vcloudai: /* VCA video analytics */

2026-07-03T11:38:07Z

VCA video analytics

← Older revision		Revision as of 12:38, 3 July 2026
Line 683:		Line 683:

	Once you’re satisfied with your settings, click '''“Save rule”''' to apply it. Once saved, your custom detector will appear in the [[File:Ai.png\|frameless\|25x25px]] menu list in Layout video window and can be configured and used in the same way as the Embedded analytics.		Once you’re satisfied with your settings, click '''“Save rule”''' to apply it. Once saved, your custom detector will appear in the [[File:Ai.png\|frameless\|25x25px]] menu list in Layout video window and can be configured and used in the same way as the Embedded analytics.

	~~=== VCA video analytics ===~~
	~~Cluebase VMS can natively connect VCA video analytics platform that integrates a variety of 3rd party video analytics plugins.~~

	~~To connect a VCA server to Cluebase VMS go to: Main menu -> Settings -> Analytics -> VCA server settings.~~
	~~[[File:Vca settings.png\|alt=vca settings\|none\|thumb]]~~
	~~Add the required information to the fields, select 'Enable VCA settings' option and click save. VCA server is connected.~~

	~~Go to the [[File:Ai.png\|alt=ai button\|20x20px]] menu to use and configure the VCA-based video analytics detectors.~~

	~~If the VCA server is connected to the VMS then the VCA modules will function in the same way as the Embedded analytics.~~

	=== Face recognition lists ===		=== Face recognition lists ===

Vcloudai at 10:54, 3 July 2026

2026-07-03T10:54:27Z

← Older revision		Revision as of 11:54, 3 July 2026
Line 564:		Line 564:
	#*Camera Sabotage Detection		#*Camera Sabotage Detection
	#* Object Detection		#* Object Detection
	#* Face ID Lite		#*Human detection
	~~# '''Additional AI Modules''' These specialized detectors are available as add-ons:~~		#*Vehicle detection
	#* Smoke & Fire Detection		#*People counting
			#*Vehicle counting
			#* Face recognition Lite
			#*Smoke & Fire Detection
	#* PPE (Personal Protective Equipment) Detection		#* PPE (Personal Protective Equipment) Detection
	#* ~~Traffic Analytics~~		#* Illegal parking detection
			#*Waste detection
			#*other additional AI models supplied with the software
	# '''YOLO Custom Video Analytics''' Integrate your own custom-trained models using the YOLO (You Only Look Once) architecture for object detection tailored to specific use cases.		# '''YOLO Custom Video Analytics''' Integrate your own custom-trained models using the YOLO (You Only Look Once) architecture for object detection tailored to specific use cases.
	# '''Visual Assistant – LLM-based Analytics''' A cutting-edge module powered by large language models (LLM) for advanced, customizable video analytics workflows using natural language logic.		# '''Visual Assistant – LLM-based Analytics''' A cutting-edge module powered by large language models (LLM) for advanced, customizable video analytics workflows using natural language logic.
	~~# '''VCA Enhanced Video Analytics Pack''' An advanced plugin-based solution that expands analytics capabilities significantly. 👉 [[Video Analytics Manual\|View VCA Analytics Manual]]~~
	# '''3rd Party Video Analytics Modules''' The VMS can integrate with external analytics providers, allowing flexible support for various industry-specific solutions.<br />		# '''3rd Party Video Analytics Modules''' The VMS can integrate with external analytics providers, allowing flexible support for various industry-specific solutions.<br />
	=== ~~Embedded~~ AI video analytics ===		=== AI video analytics ===
	Cluebase VMS has got a wide variety of embedded video analytics.		Cluebase VMS has got a wide variety of embedded video analytics.

Line 581:		Line 585:

	In the [[File:Ai.png\|alt=ai button\|20x20px]] menu choose the desired video analytics detector, enable, configure it and click [[File:Apply.png\|alt=apply\|50x50px]] to apply the settings.		In the [[File:Ai.png\|alt=ai button\|20x20px]] menu choose the desired video analytics detector, enable, configure it and click [[File:Apply.png\|alt=apply\|50x50px]] to apply the settings.
	[[File:~~Ai settings~~.png\|alt=ai settings\|none\|thumb]]		[[File:Video analytics editor.png\|alt=ai settings\|none\|thumb]]


	When required, enable the View zone option in the detector settings to use the detection zone (mask).		When required, enable the View zone option in the detector settings to use the detection zone (mask).
	[[File:Zone.jpg\|alt=zone\|none\|thumb]]		[[File:Zone.jpg\|alt=zone\|none\|thumb]]

	~~=== Additional AI Modules ===~~
	~~Cluebase VMS supports advanced AI-powered detectors that go beyond the standard embedded analytics. These modules are available as optional components and include:~~

	* '''Smoke & Fire Detection'''
	* '''PPE (Personal Protective Equipment) Detection'''
	* '''Traffic Analytics'''
	~~⚠️ '''Important:''' These features require the installation of the dedicated '''ai container''' on your system.~~

	~~During the installation process, the system will prompt the user with the following message in the console:~~
	~~Cluebase VMS analytics module will take 6 GB of free space. Would you like to proceed? Press 'y' to install or any other button to skip.~~

	* If the user '''presses y''', the AI container will be installed, enabling the Additional AI Modules to function within the VMS.
	* If the user '''presses any other key''', the installation will skip the AI container, and these modules will not be available. In this case, attempts to use the Additional AI Modules in the VMS will result in the following error message: '''“Analytics server is unavailable.”'''
	~~To ensure these features are active and operational, make sure the AI container is installed during setup.~~

	~~If the ai container is installed the Additional AI Modules will function in the same way as the Embedded analytics.~~

	=== YOLO Custom Video Analytics ===		=== YOLO Custom Video Analytics ===

Vcloudai at 06:08, 3 July 2026

2026-07-03T06:08:30Z

← Older revision		Revision as of 07:08, 3 July 2026
Line 349:		Line 349:

	Example: 10 sec means the camera will stay at each preset for 10 seconds before moving to the next.		Example: 10 sec means the camera will stay at each preset for 10 seconds before moving to the next.


			== Physical Keyboard Commands ==
			Cluebase VMS supports physical keyboard commands for faster operation in live view, layouts, PTZ control, and archive mode. These shortcuts are useful for operators who need to navigate between cameras, control video windows, switch layouts, or work with archive playback without using the mouse.

			General keyboard navigation:

			'''Arrow keys''' - Move between cameras in the current layout. The selected camera is highlighted with a blue frame.

			'''Enter''' - Enlarge the selected video window. Press again or use the interface controls to return to the layout view.

			'''A''' - Switch the selected camera to archive mode.

			'''Shift + Left Arrow / Shift + Right Arrow''' - Switch to the previous or next layout.

			'''M''' - Open or close the main menu.

			'''E''' - Open or close the events panel.


			<u>PTZ keyboard control:</u>

			When the PTZ control window is open, the keyboard can be used to control the selected PTZ camera.

			'''Arrow keys''' Move the PTZ camera up, down, left, or right.

			'''+ / -''' Zoom in or zoom out.

			'''Number keys 1-9''' Move the camera to the corresponding PTZ preset position.


			<u>Archive mode keyboard control:</u>

			When the selected camera is opened in archive mode, the following keyboard commands are available.

			'''Left Arrow / Right Arrow''' Move backward or forward between archive segments.

			'''+ / -''' Increase or decrease playback speed.

			'''Shift & ' + ' / Shift +& ' - '''' Zoom in or zoom out on the archive timeline.

			'''T''' - Open the timestamp navigation panel. The cursor is automatically placed in the time input field, so the operator can enter the required time immediately. Press Enter to jump to the selected timestamp.

	== Multi-server functionality ==		== Multi-server functionality ==

Vcloudai: /* Pan Tilt Zoom (PTZ) */

2026-07-03T05:54:29Z

Pan Tilt Zoom (PTZ)

← Older revision		Revision as of 06:54, 3 July 2026
Line 319:		Line 319:
	'''Directional Pad -''' Use the central control wheel to move the camera:		'''Directional Pad -''' Use the central control wheel to move the camera:

	'''Up / Down / Left / Right''' – Tilt or pan in the selected direction		'''Up / Down / Left / Right''' – Tilt or pan in the selected direction. Arrow keys on the physical keyboard are also functional for this purpose.

	'''Center circle''' – Stops movement when clicked (if applicable)		'''Center circle''' – Stops movement when clicked (if applicable)
Line 326:		Line 326:
	'''Zoom Slider'''		'''Zoom Slider'''

	+ to zoom in		+ to zoom in. The '+' button on the physical keyboard is also functional.

	– to zoom out		– to zoom out The '-' button on the physical keyboard is also functional.

	Drag the slider to smoothly adjust zoom level		Drag the slider to smoothly adjust zoom level
Line 335:		Line 335:
	'''PTZ Presets'''		'''PTZ Presets'''

	'''Numbered Buttons (1–9) -''' Press a number to move the camera to a previously saved preset position.		'''Numbered Buttons (1–9) -''' Press a number to move the camera to a previously saved preset position. The 1-9 buttons on the physical keyboard is also functional.

	'''Save -''' choose a number (1–9), after adjusting the camera’s position, then press '''Save''' to save the current PTZ position as a preset.		'''Save -''' choose a number (1–9), after adjusting the camera’s position, then press '''Save''' to save the current PTZ position as a preset.

Vcloudai: /* Hardware and Software requirements */

2026-06-30T15:30:05Z

Hardware and Software requirements

← Older revision		Revision as of 16:30, 30 June 2026
Line 30:		Line 30:
	'''Minimal server requirements:''' Quad-core ARM or Intel/AMD (32 or 64 bit), 4GB RAM, 2GB HDD/SSD.		'''Minimal server requirements:''' Quad-core ARM or Intel/AMD (32 or 64 bit), 4GB RAM, 2GB HDD/SSD.
	Desktop client requires a PC or Mac computer with Intel/AMD 32 or 64 bit, Apple Silicon or other ARM CPU with at least 2 cores of 1.5 GHz each.		Desktop client requires a PC or Mac computer with Intel/AMD 32 or 64 bit, Apple Silicon or other ARM CPU with at least 2 cores of 1.5 GHz each.
	Supported browsers: Google Chrome v.92+, Mozilla Firefox v.90+, Safari v.14+<br>[https://be.vcloud.ai~~/wp-content/uploads/2024/10/vmshw2.html '''~~Hardware calculator'''] is available for precise VMS resource calculations.		Supported browsers: Google Chrome v.92+, Mozilla Firefox v.90+, Safari v.14+<br>'''[https://calculator.vcloud.ai Hardware calculator]''' is available for precise VMS resource calculations.

	'''Operation systems supported:'''		'''Operation systems supported:'''

Vcloudai at 05:49, 15 June 2026

2026-06-15T05:49:30Z

← Older revision		Revision as of 06:49, 15 June 2026
Line 189:		Line 189:

	Create a New Layout for the cameras as follows below.		Create a New Layout for the cameras as follows below.

			=== Adding RTMP cameras ===
			Cluebase VMS allows adding cameras and video sources using the RTMP protocol. This option is used when a camera, encoder, DVR/NVR, or intermediate streaming server provides an RTMP video stream.

			To add an RTMP camera, open Settings, go to Cameras, and click Add camera.

			The camera configuration form will open.

			Fill in the following fields:

			Device name — enter the camera name that will be displayed in the camera tree and layouts.

			Camera type — select RTMP from the drop-down list.

			Url — enter the full RTMP stream URL.

			[[File:RTMP.png\|none\|thumb]]


			Example RTMP URL:

			rtmp://192.168.1.100/live/camera1

			After entering the required information, click Add.

			The camera will appear in the camera tree under the selected server. If the RTMP stream is available and the URL is correct, the camera status indicator will become green. The camera can then be used in live view, layouts, recording, and other VMS functions.

			Using an intermediate RTMP server

			An intermediate streaming server is required only if the camera itself does not provide an RTMP stream directly.

			In this case, the camera sends its video stream to an intermediate server, and Cluebase VMS receives the stream from that server as RTMP.

			As an intermediate server, you can use simple-rtsp-server / MediaMTX.

			When using MediaMTX, make sure that RTMP is enabled in its YAML configuration file. After RTMP is enabled, configure the camera, encoder, or DVR/NVR to send the stream to the MediaMTX server. This setting is usually available in the camera web interface, encoder settings, or DVR/NVR streaming settings.

			The typical workflow is:

			Enable RTMP in the MediaMTX YAML configuration.

			Configure the camera, encoder, or DVR/NVR to publish the stream to MediaMTX.

			Copy the resulting RTMP stream URL.

			In Cluebase VMS, open Settings, go to Cameras, and click Add camera.

			Select RTMP as the camera type.

			Paste the RTMP URL into the Url field.

			Click Add.

			Notes

			Use RTMP only when the video source provides an RTMP stream directly or through an intermediate streaming server.

			If the camera supports RTSP but does not support RTMP, it can either be added to Cluebase VMS as an RTSP camera or restreamed through an intermediate server with RTMP enabled.

			Make sure the Cluebase VMS server has network access to the RTMP source.

	== Layouts ==		== Layouts ==

Vcloudai: /* Timelapse */

2026-06-10T10:40:47Z

Timelapse

← Older revision		Revision as of 11:40, 10 June 2026
Line 316:		Line 316:
	'''The file system on the drives must be <u>EXT4</u>.'''		'''The file system on the drives must be <u>EXT4</u>.'''

	=== ~~'''~~Timelapse~~'''~~ ===		=== Timelapse ===
	The Timelapse recording mode allows Cluebase VMS to record selected cameras at a reduced frame interval instead of continuous full-time recording. This is useful for long-term monitoring scenarios where it is necessary to keep visual history for extended periods while reducing storage consumption.		The Timelapse recording mode allows Cluebase VMS to record selected cameras at a reduced frame interval instead of continuous full-time recording. This is useful for long-term monitoring scenarios where it is necessary to keep visual history for extended periods while reducing storage consumption.