Go to documentation repository
Documentation for Axxon One 3.0 version. Documentation for Axxon One 2.0 version
is also available.
User Guide. Introduction
Software lifecycle and update policy
Information security of Axxon One
Description of Axxon One
- Basic principles of building a security system based on Axxon One
- Axxon One features: reference information
- Functions of the distributed security system
- Axxon One architecture
- Network Topologies of Axxon One
- Characteristics of Axxon One
- Requirements for hardware and software platform for running Axxon One
- Interface of Axxon One
- Ports used by Axxon One
- Requirements for personnel quantity and qualifications
Axxon One installation
Licensing of the software product
Start and stop Axxon One
- Starting Axxon One
- Stop Axxon One
- Quick user switching
- Quick connection to another server
- Automatic server restart
Layouts
- Configuration of layouts
- Main elements of the user interface
- Surveillance window
- Configuration of surveillance windows
- Select default functions for surveillance windows
- Select the default video stream for all cameras on the layout
- Move input and output icons in the surveillance window
- Configuration of default digital zoom (the Fit screen function)
- Configuration of pan/tilt angle for cameras with Immervision lenses in 180 degrees Panorama display format
- Configuration of display of water level sensor
- Add links to other cameras to the surveillance window
- Color coding of frames
- Context menu of the surveillance window
- Time display
- Displaying video statistics
- Video surveillance mode selection tabs
- Configuration of surveillance windows
- Video wall panel
- Monitor panel
- Interactive map
- Camera search panel
- Alert panel
- Object panel
- The archive navigation panel
- The PTZ control panel
- Story board
- Surveillance window
- Video surveillance
- Video surveillance modes
- Functions available in all video surveillance modes
- Live video surveillance
- Switching to Live mode
- Video surveillance functions available in Live mode
- Arm and disarm a camera
- Selecting video stream quality in a surveillance window (GreenStream)
- Controlling a PTZ сamera
- Managing output
- Displaying the input status
- Automatic replacement of the camera on layouts
- Freeze frame
- Viewing events from the detectors of the selected camera
- Remove a camera from a layout
- Display of track lifespan
- Video surveillance in the Alarm management mode
- Video surveillance in the Archive mode
- Switching to the Archive mode
- Functions of video surveillance available in the archive mode
- Selecting an archive
- Viewing a combined archive
- Synchronized playback of archives
- Compressed playback of archives (TimeCompressor)
- Viewing external archive
- Deleting archive fragment
- Navigating in the archive
- Displaying the causes for the Scene analytics detector to generate an event
- View the results of a saved search query
- Video surveillance in the Archive Search mode
- Search in archive
- Setting a search interval
- Thumbnail search
- Events search
- Metadata search
- Bookmarks search
- Search by titles
- Search by LPs
- Vehicle search
- Face search
- Search by barcode
- Search by tampering type
- Meta search
- Working with search results
- Switching between search results
- Saving search queries
- Heat map
- Line crossing
- Motion in area
- Working with fisheye cameras
- Vehicle license plate recognition and search
- Face recognition and search
- Temperature screening
- Information boards
- Bookmarks
- Export
- Configuration of the interactive map
- Audio monitoring
- Event control
- Macros control
- Configuring information boards
Configuration management
- General information on system configuration
- Devices
- Configuring domains
- Searching, adding, configuring, and removing IP devices
- Configuring system objects for devices
- Server
- Camera
- Configuring video stream settings
- Configuring a privacy mask
- Putting text over the surveillance window
- Bulk application of settings
- Configuring fisheye cameras
- Connecting and configuring cameras over standard protocols
- Configuring connection of cameras with dynamic IP addresses
- Configuring virtual cameras
- Restoring default camera settings
- The IP server object
- Channel
- Input
- Output
- Microphone
- PTZ
- Speaker
- Email notifier
- Embedded storage
- Configuration of the export agent
- Specifics of device configuration
- Features for tracking moving objects
- Receiving events from external systems
- Configuring camera groups
- Automatic copying of data from local Servers to a centralized Server
- Configuring the group of cameras
- Аrchive
- General information about server archives
- Creating archives
- Creating a local archive
- Creating a remote archive
- Creating a cloud archive
- General information about a cloud archive
- Configuring an archive volume based on the Microsoft Azure solution
- Configuring an archive volume based on the Amazon solution
- Configuring an archive volume based on the Seagate Lyve Cloud solution
- Configuring an archive volume based on the Wasabi solution
- Configuring an archive volume based on the MinIO solution
- General information about the Round-robin algorithm
- Creating an archive based on existing archive volumes
- Editing archives
- Configuring archives
- Configuring recording to an archive
- Configuring the default archive
- Configuring a write limit on an archive volume
- Configuring access restrictions to an archive
- Configuring data replication
- Manual archive replication
- Encrypting a volume of an object archive
- Extending the space of an archive volume
- Saving an archive when replacing a video signal device
- Protecting video recordings from FIFO overwriting
- Statuses of archive volumes
- Removing archive volumes
- Removing archives
- Detectors
- General information about detectors and their sub-detectors
- Processors used for detector operation
- Hardware requirements for GPU-based video decoding
- Installing DetectorPack add-ons
- Configuring detectors and their sub-detectors
- Metadata database
- Neural analytics
- General information on neural analytics
- Hardware requirements for neural analytics operation
- Data collection requirements for neural network training
- Optimizing the operation of neural analytics on GPU in Windows OS
- Optimizing the operation of neural analytics on GPU in Linux OS
- The GPU cache generator utility
- General settings of the detectors
- Standard sub-detectors
- General information on the standard sub-detectors
- Video stream and scene requirements for the standard sub-detectors
- Image requirements for the standard sub-detectors
- Configuring Line crossing
- Configuring Loitering in area
- Configuring Stop in area
- Configuring the Track masking
- Configuring Motion in area
- Configuring Entrance in area
- Configuring Exit from area
- Configuring Multiple objects
- Configuring Move from area to area
- Category: Trackers
- Abandoned object detector VI
- Functions of the Abandoned object detector VI
- Video stream and scene requirements for the Abandoned object detector VI
- Image requirements for the Abandoned object detector VI
- Licensing of the software module for the Abandoned object detector VI in Windows OS
- Licensing of the software module for the Abandoned object detector VI in Linux OS
- Configuring the Abandoned object detector VI
- Abandoned object detector VI (Street)
- Functions of the Abandoned object detector VI (Street)
- Video stream and scene requirements for the Abandoned object detector VI (Street)
- Image requirements for the Abandoned object detector VI (Street)
- Licensing of the software module for the Abandoned object detector VI (Street) in Windows OS
- Licensing of the software module for the Abandoned object detector VI (Street) in Linux OS
- Configuring the Abandoned object detector VI (Street)
- Neural tracker
- Object tracker
- Human tracker VL
- Functions of the Human tracker VL
- Video stream and scene requirements for the Human tracker VL and its sub-detectors
- Image requirements for the Human tracker VL and its sub-detectors
- Activating the license for the Human tracker VL in Windows OS
- Activating the license for the Human tracker VL in Linux OS
- Configuring the Human tracker VL
- Stopped object detector
- Motion detector
- Privacy masking
- Motion in area detector VI
- Functions of the Motion in area detector VI
- Video stream and scene requirements for the Motion in area detector VI
- Image requirements for the Motion in area detector VI
- Licensing of the software module for the Motion in area detector VI in Windows OS
- Licensing of the software module for the Motion in area detector VI in Linux OS
- Configuring the Motion in area detector VI
- Movement in prohibited direction VI
- Functions of the Movement in prohibited direction VI detector
- Video stream and scene requirements for the Movement in prohibited direction VI detector
- Image requirements for the Movement in prohibited direction VI detector
- Licensing of the software module for the Movement in prohibited direction VI detector in Windows OS
- Licensing of the software module for the Movement in prohibited direction VI detector in Linux OS
- Configuring the Movement in prohibited direction VI detector
- Line crossing VI
- Functions of the Line crossing VI detector
- Video stream and scene requirements for the Line crossing VI detector
- Image requirements for the Line crossing VI detector
- Licensing of the software module for the Line crossing VI detector in Windows OS
- Licensing of the software module for the Line crossing VI detector in Linux OS
- Configuring the Line crossing VI detector
- Abandoned object detector VI
- Category: Face
- Face detector VL
- Functions of the Face detector VL
- Hardware requirements for the Face detector VL and its sub-detectors
- Video stream and scene requirements for the Face detector VL and its sub-detectors
- Image requirements for the Face detector VL and its sub-detectors
- Optimizing the operation of the Face detector VL on GPU in Windows OS
- Optimizing the operation of the Face detector VL on GPU in Linux OS
- Configuring the Face detector VL
- Mask detector VL
- Face detector VA
- Functions of the Face detector VA
- Manual for switching from the Face detector TV to Face detector VA
- Hardware requirements for the Face detector VA and its sub-detectors
- Video stream and scene requirements for the Face detector VA and its sub-detectors
- Image requirements for the Face detector VA and its sub-detectors
- Optimizing the operation of the Face detector VA on GPU in Windows OS
- Optimizing the operation of the Face detector VA on GPU in Linux OS
- Configuring the Face detector VA
- Mask detector VA
- Checking in lists of faces
- FaceCube+ external face recognition system
- Face detector TV
- Functions of the Face detector TV
- Hardware requirements for the Face detector TV and its sub-detectors
- Video stream and scene requirements for the Face detector TV and its sub-detectors
- Image requirements for the Face detector TV and its sub-detectors
- Optimizing the operation of the Face detector TV on GPU in Windows OS
- Optimizing the operation of the Face detector TV on GPU in Linux OS
- Configuring the Face detector TV
- Mask detector TV
- Face detector VL
- Category: Vehicle
- License plate recognition BRS
- License plate recognition IV
- Functions of the License plate recognition IV
- Hardware requirements for the License plate recognition IV
- Video stream and scene requirements for the License plate recognition IV and its sub-detectors
- Image requirements for the License plate recognition IV and its sub-detectors
- Activating the license for the License plate recognition IV in Windows OS
- Activating the license for the License plate recognition IV in Linux OS
- Configuring the License plate recognition IV
- License plate recognition RR
- Functionality of License plate recognition RR
- Hardware requirements for License plate recognition RR
- Camera requirements for License plate recognition RR and its sub-detectors
- Optimizing the operation of License plate recognition RR on GPU in Windows OS
- Optimizing the operation of License plate recognition RR on GPU in Linux OS
- Configuring License plate recognition RR
- License plate recognition RR—Search in archive
- Functionality of License plate recognition RR—Search in archive
- Hardware requirements for License plate recognition RR—Search in archive
- Camera requirements for License plate recognition RR—Search in archive and its sub-detectors
- Optimizing the operation of License plate recognition RR—Search in archive on GPU in Windows OS
- Optimizing the operation of License plate recognition RR—Search in archive on GPU in Linux OS
- Configuring License plate recognition RR—Search in archive
- License plate recognition RR—Parking
- Functionality of License plate recognition RR—Parking
- Hardware requirements for License plate recognition RR—Parking
- Camera requirements for License plate recognition RR—Parking and its sub-detectors
- Optimizing the operation of License plate recognition RR—Parking on GPU in Windows OS
- Optimizing the operation of License plate recognition RR—Parking on GPU in Linux OS
- Configuring License plate recognition RR—Parking
- Vehicle recognition RR
- Functionality of Vehicle recognition RR
- Hardware requirements for Vehicle recognition RR
- Camera requirements for Vehicle recognition RR and its sub-detectors
- Optimizing the operation of Vehicle recognition RR on GPU in Windows OS
- Optimizing the operation of Vehicle recognition RR on GPU in Linux OS
- Configuring Vehicle recognition RR
- License plate recognition VT
- Functions of the License plate recognition VT
- Hardware requirements for the License plate recognition VT
- Video stream and scene requirements for the License plate recognition VT and its sub-detectors
- Image requirements for the License plate recognition VT and its sub-detectors
- Optimizing the operation of the License plate recognition VT on GPU in Windows OS
- Optimizing the operation of the License plate recognition VT on GPU in Linux OS
- Licensing of the software module for the License plate recognition VT in Windows OS
- Licensing of the software module for the License plate recognition VT in Linux OS
- Configuring the License plate recognition VT
- License plate recognition XR
- Functions of the License plate recognition XR
- Hardware requirements for the License plate recognition XR
- Video stream and scene requirements for the License plate recognition XR
- Image requirements for the License plate recognition XR
- Licensing of the software module for the License plate recognition XR in Windows OS
- Configuring the License plate recognition XR
- Installing and configuring Vaxtor License Server using Docker for License plate recognition XR
- Checking in lists of LPs
- Category: Poses
- Human pose detector
- Person-based privacy masking
- Category: Production Safety
- Audio classification IV
- Neural classifier
- Fire detector
- Equipment detector
- Functions of the Equipment detector
- Video stream and scene requirements for the Equipment detector and its sub-detectors
- Image requirements for the Equipment detector and its sub-detectors
- Example of providing a list of valid equipment at the facility for the Equipment detector
- Configuring the Equipment detector
- Smoke detector
- Water level detector
- Glow detector
- Equipment detector VL
- Functions of the Equipment detector VL
- Video stream and scene requirements for the Equipment detector VL and its sub-detectors
- Image requirements for the Equipment detector VL and its sub-detectors
- Example of providing a list of valid equipment at the facility for the Equipment detector VL
- Activating the license for the Equipment detector VL in Windows OS
- Activating the license for the Equipment detector VL in Linux OS
- Configuring the Equipment detector VL
- Category: Retail
- Category: Service
- Audio loss detector
- Noise detector
- Signal detector
- Video clarity detector
- Detector of atypical changes in the scene VI
- Functions of the Detector of atypical changes in the scene VI
- Video stream and scene requirements for the Detector of atypical changes in the scene VI
- Image requirements for the Detector of atypical changes in the scene VI
- Licensing of the software module for the Detector of atypical changes in the scene VI in Windows OS
- Licensing of the software module for the Detector of atypical changes in the scene VI in Linux OS
- Configuring the Detector of atypical changes in the scene VI
- Category: Other
- Category: Embedded
- General information about embedded detectors
- Embedded IVA analytics
- Embedded ONVIF analytics
- Adding the ONVIF Profile M embedded detection tools
- Embedded license plate recognition detectors
- Embedded vehicle speed measurement radar
- Embedded temperature detector
- Face detection and temperature control with Mobotix M16 TR cameras
- AxxonSoft Tracker in Axis devices
- Multi-camera tracker
- Programming
- General information about macros
- Configuring macros
- Configuration of start conditions
- Examples of macros
- Users
- Options
- System log
Working with Axxon One through the Web client
- Web-Сlient overview
- Hardware and software requirements for the Web-Client operation
- Starting and logging in to the web client
- Web-Client GUI
- Web-Client configuration
- Searching for cameras in the Web-Client
- Working with layouts in Web-Client
- Summary of how to work with layouts in Web-Client
- Selecting and searching for a layout
- Create a new layout in the web client
- Editing and deleting layouts in Web-Client
- Selecting the default layout in web client
- Copy layouts in the web client
- Share layouts in the web client
- Creating a temporary layout in the Web-Client
- Real-time video surveillance in the web client
- Controlling PTZ cameras through the web client
- Viewing video archives through the web client
- Archive position selection panel for the Web-Client
- Archive search in the Web-Client
- Viewing events from camera detectors in the web client
- Running macros in Web-Client
- Viewing and processing alarms in the Web-Client
- Listening to a camera's microphone via the Web-Client
- Digital video zoom in the Web-Client
- Export in the Web-Client
- Viewing camera and archive statistics
- Working with bookmarks in the Web-Client
- Working with interactive map via the Web-Client
Working with Axxon One Through the Mobile Clients
Configuring Failover VMS
- General information about a failover system
- Ports used by the failover system
- Supervisor Web-Interface
- Creating a cluster
- Failover database
- Configure a Failover System Cluster
- Set up access to a supervisor
- Configuration backup and restore for failover VMS
- Transferring configuration from common server to failover server
- Monitoring the status of a cluster
- Connecting to a Node and Configuring of an Axxon domain
- Configuring automatic connection to nodes
- Updating cluster servers
- Setting network interfaces for system nodes operation
- Changing ports in the nodes of the failover system
- Connecting the Client to the Failover Server behind NAT
- Changing logging levels for the Consul and Nomad processes in a failover system
Self-diagnostics service
- General information about the self-diagnostics service
- Starting and stopping the self-diagnostics service
- View metrics in the self-diagnostics service
- Viewing self-diagnostics metrics using third-party Grafana | Prometheus software
Axxon One utilities
- Tray Tool utility
- Network settings utility
- Watermark checker utility
- Backup and restore utility
- Gathering system information utility
- Log management utility
- POS terminal data collection utility
- Console utility for working with archives (vfs_format.exe)
Appendices
Overview
Content Tools