AXIS P1445-LE-3 License Plate Verifier Kit

About the product

AXIS P1445-LE-3 License Plate Verifier Kit consists of an AXIS P1445-LE Network Camera and pre-installed AXIS License Plate Verifier application, making it a kit for automated vehicle entry and exit management. AXIS P1445-LE-3 uses an allowlist and a blocklist to verify access to controlled areas such as parking lots.

Get started

Basic setup

  1. These setup instructions are valid for cameras that are not sold as a kit with AXIS License Plate Verifier
  2. Install the application

These setup instructions are valid for all scenarios:

  1. Camera mounting recommendations

  2. Setup assistant

  3. Adjust the area of interest

  4. Select region

  5. Set up event storage

Camera mounting recommendations

  • When you select the mounting location, remember that direct sunlight can distort the image, for example, during sunrise and sunset.

  • The mounting height for a camera in a Access control scenario should be half of the distance of that between the vehicle and the camera.

  • The mounting height for camera in a Free flow (slow traffic license plate recognition) scenario should be less than half of the distance of that between the vehicle and the camera.

  • Access control capture distance: 2–7 m (6.6–23 ft). This example is based on the AXIS P3265–LVE-3 License Plate Verifier kit.
  • Capture distance: (x)Mounting height (y)
    2.0 m (6.6 ft)1.0 m (3.3 ft)
    3.0 m (9.8 ft)1.5 m (4.9 ft)
    4.0 m (13 ft)2.0 m (6.6 ft)
    5.0 m (16 ft)2.5 m (8.2 ft)
    7.0 m (23 ft)3.5 m (11 ft)
  • Free flow capture distance: 7–20m (23–65 ft). This example is based on the AXIS P1465–LE-3 License Plate Verifier kit.
  • Capture distance (x)Mounting height (y)
    7.0 m (23 ft)3.0 m (9.8 ft)
    10.0 m (33 ft)4.0 m (13 ft)
    15.0 m (49 ft)6.0 m (19.5 ft)
    20.0 m (65 ft)10.0 m (33 ft)
  • The camera’s mounting angle should not be larger than 30° in any direction.

  • Mounting angle from the side.
  • Mounting angle from above.
  • The image of the license plate should not tilt more than 5° horizontally. If the image is tilted more than 5°, we recommended that you adjust the camera so that the license plate is displayed horizontally in the live stream.

  • Horizontal tilt.

Setup assistant

When you first run the application, set up Free flow or Access control using the setup assistant. If you want to make changes later on, it can be found in the Settings tab under Setup assistant.

Free flow

In Free flow, the application can detect and read license plates in slow speed traffic on larger access roads, city centers and enclosed areas like campuses, ports or airports. This allows for LPR-forensic search and LPR triggered events in a VMS.

  1. Select Free flow and click Next.

  2. Select the image rotation that corresponds to how your camera is mounted.

  3. Select the number of areas of interest. Note that one area can detect plates in both directions.

  4. Select the region where the camera is located.

  5. Select capture type.

    • License plate crop saves only the license plate.

    • Vehicle crop saves the entire captured vehicle.

    • Frame downsized 480x270 saves the entire image and reduces the resolution to 480x270.

    • Full frame saves the entire image at full resolution.

  6. Drag the anchor points to adjust the area of interest. See Adjust the area of interest.

  7. Adjust the direction of the area of interest. Click the arrow and rotate to set the direction. The direction determines how the application registers vehicles entering or exiting the area.

  8. Click Next

  9. In the Protocol drop-down list, select one of the following protocols:

    • TCP

    • HTTP POST

  10. In the Server URL field, type the server address and port in the following format: 127.0.0.1:8080

  11. In the Device ID field, type the name of the device or leave as is.

  12. Under Event types, select one or more of the following options:

    • New means the first detection of a license plate.

    • Update is either a correction of a character on a previously detected license plate, or when a a direction is detected as the plate moves and is tracked across the image.

    • Lost is the last tracked event of the license plate before it exits the image. It also contains the direction of the license plate.

  13. To turn on the feature, select Send event data to server.

  14. To reduce bandwidth when using HTTP POST, you can select Do not to send images through HTTP POST.

  15. Click Next.

  16. If you already have a list of registered plates, choose to import as either a blocklist or allowlist.

  17. Click Finish.

Access control

Use the setup wizard for quick and easy configuration. You can choose to Skip to leave the guide at any time.

  1. Select Access control and click Next.

  2. Select the type of access control to use:

  3. In the Barrier mode drop-down list, under Open from lists, select Allowlist.

  4. In the Vehicle direction drop-down list, select out.

  5. In the ROI drop-down-list, select the area of interest you would like to use, or if you would like to use all.

  6. Click Next.

On the Image settings page:

  1. Select the number of areas of interest.

  2. Select the region where the camera is located.

  3. Select capture type. See Adjust the image capture settings.

  4. Drag the anchor points to adjust the area of interest. See Adjust the area of interest.

  5. Adjust the direction of the area of interest. The direction determines how the application registers vehicles entering or exiting the area.

  6. Click Next

On the Event data page:

Note
  1. In the Protocol drop-down list, select one of the following protocols:

    • TCP

    • HTTP POST

  2. In the Server URL field, type the server address and port in the following format: 127.0.0.1:8080.

  3. In the Device ID field, type the name of the device or leave as is.

  4. Under Event types, select one or more of the following options:

    • New means the first detection of a license plate.

    • Update is either a correction of a character on a previously detected license plate, or when a a direction is detected as the plate moves and is tracked across the image.

    • Lost is the last tracked event of the license plate before it exits the image. It also contains the direction of the license plate.

  5. To turn on the feature, select Send event data to server.

  6. To reduce bandwidth when using HTTP POST, you can select Do not to send images through HTTP POST.

  7. Click Next

  8. On the Import list from a .csv file page:
  1. If you already have a list of registered plates, choose to import as either a blocklist or allowlist.

  2. Click Finish.

How to access the product's webpage

If you do not know the IP address of your product, use AXIS IP Utility or AXIS Device Manager to locate the product on the network. Both applications are free and can be downloaded from axis.com/support

We recommend the following browsers:

  • ChromeTM

  • Firefox®

  1. Start the web browser.

  2. Enter the IP address or host name of the Axis product in the browser’s address field.

  3. Enter the username and password. If this is the first time you access the product, you must first configure the root password.

  4. If this is the first time you access the product, you are prompted to do some initial settings. When you’re done, the product’s live view page opens in your browser..

For more information about how to discover and assign an IP address, see the document How to assign an IP address and access your device on the product page at axis.com

Create an administrator account

The first time you log in to your device, you must create an administrator account.

  1. Enter a username.

  2. Enter a password. See Secure passwords.

  3. Re-enter the password.

  4. Accept the license agreement.

  5. Click Add account.

Important

The device has no default account. If you lose the password for your administrator account, you must reset the device. See Reset to factory default settings.

Secure passwords

Important

Axis devices send the initially set password in clear text over the network. To protect your device after the first login, set up a secure and encrypted HTTPS connection and then change the password.

The device password is the primary protection for your data and services. Axis devices do not impose a password policy as they may be used in various types of installations.

To protect your data we strongly recommend that you:

  • Use a password with at least 8 characters, preferably created by a password generator.

  • Don’t expose the password.

  • Change the password at a recurring interval, at least once a year.

Install the application

Note

The cameras P1445-LE-3, P3245-LE-3, P1455-LE-3 come with AXIS License Plate Verifier preinstalled in the firmware.

Note

To install the application on the device, you need administrator rights.

  1. Go to the device’s webpage.

  2. Go to Settings > Apps.

  3. Click Add to upload the application file (.eap) to the camera.

  1. To activate the license, you need a license key that is generated by the license code and the Axis device serial number. If you don’t have a license key on the computer, do the following:
  2. Go to axis.com/support/license-key-registration#/registration

  3. Enter the serial number and the license code.

  4. Save the license key file on the computer. Browse to select the file and then click Activate.

Adjust the area of interest

The area of interest is the area in the live view where the application looks for license plates. For optimal performance, keep the area of interest as small as possible. To adjust the area of interest, do the following:

  1. Go to Settings .

  2. Click Edit area of interest.

  3. To improve verification and captured images, go to Zoom and adjust the slider to your needs.

  4. To have the camera automatically focus on the vehicles, click Autofocus. To set the focus manually, go to Focus and adjust it with the slider.

  5. To move the area of interest, click anywhere in the area and drag it to where the license plates are most visible. If you place the area of interest outside the live view, it will automatically jump back to default position. Make sure the region of interest stays in position after you have saved the settings.

  6. To adjust the area of interest, click anywhere in the area and drag the anchor points highlighted in blue.

    • To reset the area of interest, right click within the area and select Reset.

    • To add anchor points, click the on one of the yellow anchor points. The anchor point will turn blue, showing it can be manipulated. New yellow points are automatically added next to the blue anchor point. The maximum number of blue anchor points is eight.

  7. Click anywhere outside the area of interest to save your changes.

  8. To get the correct direction feedback in the Event log, you need to turn the arrow to match the driving direction.

    1. Click the arrow icon.

    2. Select the anchor point and rotate the arrow so it aligns with the driving direction.

    3. Click outside the area of interest to save the changes.

  9. Note that one area can detect plates in both directions. The direction feedback shows up in the Direction column.
  • To add a second area of interest, select 2 in the Area of interest drop-down menu.

Example with one area of interest.
Note
  • If you are using a standalone camera, you can have the app set the recommended settings for license plate recognition.
    1. Click Recommended LPR settings. You will see a table where the current settings and the recommended settings differ.

    2. Click Update settings to have the app change the settings their recommended values.

Select region

  1. Go to Settings > Image.

  2. In the Region drop-down list, select your region.

Adjust the image capture settings

  1. Go to Settings > Image.

  2. To change the resolution of captured images, go to Resolution

  3. To change the rotation of the captured image, go to Image rotation

  4. To change how you save your captured images, go to Save full frame:

    • License plate crop saves only the license plate.

    • Vehicle crop saves the entire captured vehicle.

    • Frame downsized 480x270 saves the entire image and reduces the resolution to 480x270.

    • Full frame saves the entire image at full resolution.

Set up event storage

An event consists of the captured image, the license plate, the area of interest number, vehicle direction, access, and the date and time.

This example use case explains how to store events of allowlisted license plate numbers for 30 days.

  • Requirements:
  • Camera physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • Internal storage or an SD card installed in the camera.

  1. Go to Settings > Events.

  2. Under Save events, select Allowlisted.

  3. Under Delete events after, select 30 days.

  4. Note

    To detect an inserted SD card when the app is running, you need to restart the app. If an SD card is installed in the camera, the app will automatically choose the SD card as the default storage.
    AXIS License Plate Verifier uses the cameras internal memory to save up to 1,000 events, using license plate crops as the frame. If you use larger frames, it will vary the amount of events you can save.
    To change the image capture settings, go to Settings > Image. An SD card can save up to 100,000 events using any type of frame.

Installation

Preview mode

Preview mode is ideal for installers when fine tuning the camera view during the installation. No login is required to access the camera view in preview mode. It is available only in factory defaulted state for a limited time from powering up the device.

This video demonstrates how to use preview mode.

Manage lists

Add detected license plate to list

A license plate can be added directly to a list after being detected by the application.

  1. Click the Event log tab.

  2. Go to Latest Event.

  3. Click Add to list next to the license plate that you’d like to add.

  4. Select the list you would like to add the license plate in the list drop down menu.

  5. Click Append.

Add descriptions to license plates

To add a description to a license plate in the list:

  • Go to List management.

  • Select the license plate you want to edit and click the pen icon.

  • Type the relevant information in the Description field at the top of the list

  • Click the disk icon to save.

Customize list names

You can change the name of any of the lists to fit your specific use case.

  1. Go to List management.

  2. Go to the list menu of the list you want to change.

  3. Select Rename.

  4. Type the name of the list.

The new list name will be updated in any existing configurations.

Import allowlisted license plate numbers

You can import allowlisted license plate numbers from a .csv file on the computer. In addition to the license plate number, you can also add comments for each license plate number in the .csv file.

The structure of the .csv file must look like this: license plate,date,description

Example

Only license plate: AXIS123

License plate + description: AXIS123,,John Smith

License plate + date + description: AXIS123,2022-06-08,John Smith

  1. Go to List management

  2. Go to the context menu next to Allowlist and select Import from file.

  3. Browse to select a .csv file on the computer.

  4. Click OK.

  5. Check that the imported license plate numbers appear in the Allowlist.

Share license plate lists with other cameras

You can share the license plate lists with other cameras on the network. The synchronization will override all current license plate lists in the other cameras.

  1. Go to List management.

  2. Under Camera synchronization, type the IP address, username and password.

  3. Click +.

  4. Click Camera synchronization.

  5. Check that the date and time under Last sync updates accordingly.

Schedule lists

Lists can be scheduled to only be active during certain times during certain days of the week. To schedule a list:

  • Go to List management.

  • Go the list menu of the list you want to schedule.

  • Select Schedule in the pop-up menu.

  • Select the start and end time, and the day when the list should be active.

  • Click the button next to Enabled.

  • Click Save.

Additional settings

Configure text overlay

A text overlay shows the following event information in the live view: weekday, month, time, year, license plate number.

  1. Go to Settings > Image.

  2. Activate Text overlay.

  3. Set Overlay duration to a value between 1 and 9 seconds.

  4. Select either date, time and license plate (Datetime + LP), or just the license plate (LP).

  5. Check that the overlay appears in the live view.

Detect license plates in low-light conditions

Each detection gets a score by the algorithm, this is called the sensitivity level (confidence parameter). Detections that have a lower score than the selected level will not show up in the list of events.

For scenes with low lighting you can lower the sensitivity level.

  1. Go to Settings > Detection parameters.

  2. Adjust the slider under Sensitivity level. To avoid false detections, we recommend that you lower the threshold value with 0.05 at a time.

  3. Check that the algorithm detects the license plates as expected.

Allow fewer characters on license plates

The application has a default minimum number of characters for a license plate to be detected. The default minimum number of characters is five. You can configure the application to detect license plates with fewer characters.

  1. Go to Settings > Detection parameters.

  2. In the Minimum number of characters field, type the minimum number of characters you want to allow.

  3. Check that the application detects license plates as expected.

Allow only exact matches of license plates

The matching algorithm automatically allows a deviation of one character when matching the detected license plate against the allowlist or blocklist. However, some scenarios need an exact match of all characters of the license plate.

  1. Go to List management.

  2. Click to activate Strict matching.

  3. Check that the application matches the license plates as expected.

Allow more than one character deviation when matching license plates

The matching algorithm automatically allows a deviation of one character when matching the detected license plate against the allowlist or blocklist. However, you can allow more than one character deviation.

  1. Go to Settings > Detection parameters.

  2. Under Allowed character deviation, select the number of characters that are allowed to be different.

  3. Check that the application matches the license plates as expected.

Give limited access to operators

Operators can be given a limited access to the app using an URL. This way they only have access to the Event log and List management. The URL can be found under Settings > User rights.

Set up secure connection

To protect communication and data between devices, for example between the camera and the door controller, set up a secure connection with HTTPS using certificates.

  1. Go to Settings > Security.

  2. Under HTTPS, Enable HTTPS.

  3. Select either Self-signed or CA-signed.

Note

Find out more about HTTPS and how to use it at help.axis.com/axis-os-hardening-guide.

Clear all events

After you set up the app, it can be a good idea to clear the records of any images or captured plates from the setup process.

To clear all images and plates from the database:

  • Go to Settings > Maintenance.
  • Click Clear all recognition results.

  • Click Yes.

Use virtual ports to trigger actions

Virtual ports can be used together with access control to trigger any kind of action. This example explains how to set up AXIS License Plate Verifier together with the camera’s I/O port to display a text overlay using a virtual port.

  • Requirements:
  • Camera physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • Cables connected between the barrier and the camera’s I/O port.

  • Basic setup done. See Basic setup.

  1. Go to the application’s webpage and select the Settings tab.

  2. Go to Access control.

  3. Under Access control , select the Type drop-down list, select Internal I/O.

  4. Select the I/O output #.

  5. Select a port in the Virtual port drop-down list.

  6. In the Barrier mode drop-down list, select Open to all.

  7. In the Vehicle direction drop-down list, select any.

  8. In the ROI drop-down-list, select the area of interest you would like to use, or if you would like to use all.

  9. In the camera’s webpage, go to System > Events.

  10. Click Add rule.

  11. Under Condition select Virtual input is active and the port number you have selected.

  12. Under Action, select Use overlay text.

  13. Select Video channels.

  14. Type the text you want displayed.

  15. Add the duration of the text.

  16. Click Save.

  17. Go to Video > Overlays.

  18. Go to Overlays.

  19. Select Text in the drop-down menu and click +.

  20. Type #D or select the modifier in the Modifiers drop-down list.

  21. Check that the text overlay is displayed when a vehicle enters the region of interest in the live view.

Vehicle entry and exit scenario

In the scenario for vehicle entry and exit, the application reads the vehicle license plate captured by the camera and verifies the license plate against a list of authorized or unauthorized license plate numbers stored in the camera.

This scenario requires the application embedded in a camera with I/O support or a connected I/O relay module to open and close the barrier.

Two possible setups for the vehicle entry and exit scenario.
  1. Axis camera with AXIS License Plate Verifier
  2. I/O communication
  3. Barrier
  4. Axis I/O relay module
  5. IP communication

Open a barrier for known vehicles using a relay module

This example use case explains how to set up AXIS License Plate Verifier together with a relay module to open a barrier for a known vehicle driving through a specific region of interest (ROI) into, let’s say a parking area.

  • Requirements:
  • Camera physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • Cables connected between the barrier and the relay module.

  • Basic setup done. See Basic setup.

  1. Go to the camera’s webpage, select Settings and open AXIS License Plate Verifier.

  2. Go to the relay module’s webpage and make sure the relay port is connected to the camera’s I/O port.

  3. Copy the relay module’s IP address.

  4. Go back to AXIS License Plate Verifier.

  5. Go to the Settings>Access control

  6. Go to Type and select Relay in the drop-down list.

  7. In the I/O output drop-down list, select the I/O port that is connected to the barrier.

  8. In the Barrier mode drop-down list, select Open from lists and then check Allowlist.

  9. In the Vehicle direction drop-down list, select in.

  10. In the ROI drop-down list, select the area of interest that covers the traffic lane.

  11. Enter the following information:

    • the IP address for the relay module in format 192.168.0.0

    • the username for the relay module

    • the password for the relay module

  12. To make sure the connection works, click Connect.

  13. To activate the connection, click Turn on integration.

  14. Go to the List management tab

  15. Enter the license plate number in the Allowlist field.

  16. Note

    The physical input ports 1 to 8 on the relay module correspond to ports 1 to 8 in the drop-down list. However, the relay ports 1 to 8 on the relay module correspond to ports 9 to 16 in the drop-down list. This is valid even if the relay module only has 8 ports.

  17. Check that the application identifies the license plate number in the allowlist as a known vehicle and that the barrier opens as expected.

Open a barrier for known vehicles using the camera's I/O

This example explains how to set up AXIS License Plate Verifier together with the camera’s I/O port to open a barrier for a known vehicle entering, for example, a parking area.

  • Requirements:
  • Camera physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • Cables connected between the barrier and the camera’s I/O port.

  • Basic setup done. See Basic setup.

Open a barrier for known vehicles using the camera's I/O
  1. Go to the application’s webpage and select the Event log tab and add detected license plates to a list. See Add detected license plate to list

  2. To edit the lists directly, go to the List management tab.

  3. Enter the authorized license plate numbers in the Allowlist field.

  4. Go to the Settings tab.

  5. Under Access control , select the Type drop-down list, select Internal I/O.

  6. Select the I/O output #.

  7. In the Barrier mode drop-down list, select Open from lists and then check Allowlist.

  8. In the Vehicle direction drop-down list, select in.

  9. In the ROI drop-down-list, select the area of interest you would like to use, or if you would like to use all.

  10. Check that the application identifies the license plate number in the allowlist as a known vehicle and that the barrier opens as expected.

Note

You can change the name of any of the lists to fit your specific use case.

Get notified about an unauthorized vehicle

This example explains how to set up the application so that an event that triggers a notification can be created in the camera.

  1. Go to List management.

  2. Enter the license plate number in the Blocklist field.

  3. Go to the camera’s webpage.

  4. Go to Settings > Events and set up an action rule with the application as a condition and with a notification as an action.

  5. Check that the application identifies the added license plate number as an unauthorized vehicle and that the action rule runs as expected.

Vehicle access control scenario

In the scenario for vehicle access control, the application can be connected to an Axis network door controller to configure access rules, create schedules for access times, and handle vehicle access not only for employees, but also, for example, visitors and suppliers.

For backup, use an access system involving a door controller and card reader. To set up the door controller and the card reader, see the user documentation at axis.com

  1. Axis camera with AXIS License Plate Verifier
  2. IP communication
  3. Axis network door controller with card reader
  4. I/O communication
  5. Barrier
  6. Optional third-party software

Connect to a door controller

In this example we connect the camera to a network door controller which means the camera works as a sensor. The camera forwards the information to the controller which in turn analyzes the information and triggers the events.

Note

When switching between the AXIS License Plate Verifier and AXIS Entry Manager, make sure to refresh the webpages to get access to all parameters.

  • Requirements:
  • Camera and door controller physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • Basic setup done. See Basic setup.

How to get the application up and running with AXIS A1001 Door Controller.
  1. Hardware configuration in AXIS Entry Manager
  2. Go to AXIS Entry Manager and start a new hardware configuration under Setup.

  3. In the hardware configuration, rename the network door controller to “Gate controller”.

  4. Click Next.

  5. In Configure locks connected to this controller, clear the Door monitor option.

  6. Click Next.

  7. In Configure readers connected to this controller, clear the Exit reader option.

  8. Click Finish.

  1. Configuration in AXIS License Plate Verifier
  2. Go the AXIS License Plate Verifier webpage.

  3. Go to the Settings>Access control.

  4. Go to Type and select Controller in the drop-down list.

  5. Enter the following information:

    • the IP address for the controller in format 192.168.0.0

    • the username for the controller

    • the password for the controller

  6. Click Connect.

  7. If the connection is successful, “Gatecontroller” shows up in the Network Door Controller name drop-down list. Select “Gatecontroller”.

  8. In the Reader name drop-down list, select the reader connected to the door “Gatecontroller”, for example “Reader entrance”. These names can be changed in AXIS Entry Manager.

  9. To activate the connection, select Turn on integration.

  10. Enter one of the user’s license plate number, or use the default, in the test field and click Test integration. Check that the test was successful.

  1. Configure users, groups, doors, and schedules in AXIS Entry Manager
  2. Go to AXIS Entry Manager.

  3. Go to Access Management.

  4. Go to Doors > Add identification type.

  5. In the Credentials needed drop-down list, select License plate only.

  6. To set limits for when the identification type can be used, drag and drop a Schedule to the door.

  7. Add users and, for each user, add the credential License plate.

  8. Click Add credential again and enter the license plate information.

  9. Click Add new group and enter the information.

  10. To add users to a group, drag and drop Users to the user group.

  11. To give users access, drag and drop the Door to the user group.

  12. To limit the access time, drag and drop a Schedule to the user group.

  13. Overview of AXIS Entry Manager user interface.
    1. Users
    2. Doors
    3. Schedules
    4. User groups

Connect to AXIS Secure Entry

This example describes connecting an Axis door controller in AXIS Camera Station and AXIS Secure Entry with AXIS Licence Plate Verifier.

  • Requirements:
  • Camera and door controller physically installed and connected to the network.

  • AXIS License Plate Verifier up and running on the camera.

  • AXIS Camera Station client version 5.49.449 and up.

  • Basic setup done. See Basic setup.

In AXIS Camera Station, see Add a reader.

In the AXIS License Plate Verifier app:

  1. In the Settings tab, go to Configuration wizard and click Start.

  2. Select Access Control.

  3. Select Secure Entry, and click Next.

  4. In AXIS Camera Station:
  5. Type the IP address of the door controller, available in the device list in AXIS Camera Station > Configuration > Other Devices.

  6. To add a Authentication key, go to AXIS Camera Station > Configuration > Encrypted communication.

  7. Go to External Peripheral Authentication Key and click Show authentication key.

  8. Click Copy key.

  9. In the AXIS License Plate Verifier app:
  10. Go to Authentication key in the configuration wizard and paste the key.

  11. Click Connect.

  12. Select the Door controller name in the drop-down menu.

  13. Select the Reader name in the drop-down menu.

  14. Check Turn on integration.

  15. Click Next.

  16. Adjust the area of interest. See Adjust the area of interest.

  17. Click Next twice and then Finish.

Integration

Use profiles to push events to multiple servers

With profiles, you can push an event to different servers using different protocols at the same time. To use profiles:

  1. Select a profile in the Profiles drop-down menu.

  2. Configure the rule. See Push event information to third-party software.

  3. Click Save.

  4. Select a new profile in the Profiles drop-down menu.

Push event information to third-party software

Note

The application sends the event information in JSON format. For more information, log in using your MyAxis account, go to the AXIS VAPIX Library and select AXIS License Plate Verifier

With this feature you can integrate third-party software by pushing the event data through TCP or HTTP POST.

  • Before you start:
  • The camera must be physically installed and connected to the network.

  • AXIS License Plate Verifier must up and running on the camera.

  1. Go to Integration > Push events.

  2. In the Protocol drop-down list, select one of the following protocols:

    • TCP

    • HTTP POST

      • Type the user name and password.

  3. In the Server URL field, type the server address and port in the following format: 127.0.0.1:8080

  4. In the Device ID field, type the name of the device or leave as is.

  5. Under Event types, select one or more of the following options:

    • New means the first detection of a license plate.

    • Update is either a correction of a character on a previously detected license plate, or when a a direction is detected as the plate moves and is tracked across the image.

    • Lost is the last tracked event of the license plate before it exits the image. It also contains the direction of the license plate.

  6. To turn on the feature, select Send event data to server.

  7. To reduce bandwidth when using HTTP POST, you can select Do not to send images through HTTP POST.

  8. Click Save.

  9. Note

    To push events using HTTP POST, you can use an authorization header instead of a user name and password, go to the Auth-Header field, and add a path to an authentication API.

Send images of license plates to a server

With this feature you can push images of the license plates to a server through FTP.

  • Before you start:
  • The camera must be physically installed and connected to the network.

  • AXIS License Plate Verifier must up and running on the camera.

  1. Go to Integration > Push events.

  2. In the Protocol drop-down list, select FTP.

  3. In the Server URL field, type the server address in the following format: ftp://10.21.65.77/LPR.

  4. In the Device ID field, type the name of the device. A folder with this name will be created for the images. Images are created using the following format: timestamp_area of interest_direction_carID_license plate text_country.jpg.

  5. Type the username and password for the FTP server.

  6. Select the path and name modifiers for the filenames.

  7. Click Done.

  8. Under Event types, select one or more of the following options:

    • New means the first detection of a license plate.

    • Update is either a correction of a character on a previously detected license plate, or when a a direction is detected as the plate moves and is tracked across the image.

    • Lost is the last tracked event of the license plate before it exits the image. It also contains the direction of the license plate.

    • Note

      Direction is only included in the filename when Lost or Update is selected.

  9. To turn on the feature, select Send event data to server.

  10. Click Save.

Note

Note that the image varies depending on what type of capture mode you have selected, see Adjust the image capture settings.

Note

If push events fail, the app will resend up to the first 100 failed events to the server.
When using FTP in push events to a Windows server, do not use %c for naming of images that gives you date and time. This is due to the fact that Windows does not accept the naming set by the function %c for date and time.  Note that this is not an issue when using a Linux server.

Direct integration with 2N

This example describes direct integration with a 2N IP device.

  1. Set up an account in your 2N device:
  2. Go to 2N IP Verso.

  3. Go to Services > HTTP API > Account 1.

  4. Select Enable account.

  5. Select Camera access.

  6. Select License plate recognition.

  7. Copy the IP address.

  8. In the AXIS License Plate Verifier app:
  1. Go to Integration > Direct integration.

  2. Add the IP address or URL to the 2N device.

  3. Select Connection type.

  4. Select what the Barrier is used for.

  5. Type your username and password.

  6. Click Enable integration.

  7. Click Save.

To check in the integration is working:

  1. Go to 2N IP Verso.

  2. Go to Status > Events.

Integrate with Genetec Security Center

This example describes setting up a direct integration with Genetec Security Center.

In Genetec Security Center:

  1. Go to Overview.

  2. Make sure that Database, Directory and License are online. If they’re not, run all Genetec and SQLEXPRESS services in Windows.

  3. Go to Genetec Config Tool > Plugins.

  4. Click Add an entity.

  5. Go to Plugin and select LPR plugin.

  6. Click Next.

  7. Click Next.

  8. Click Next.

  9. Select the LPR plugin you’ve added and go to Data sources .

  10. Under ALPR reads API:
  11. Check Enabled.

  12. In Name, type: Plugin REST API.

  13. In API path prefix, type: lpr.

  14. In REST port, select 443.

  15. In WebSDK host, type: localhost.

  16. In WebSDK port, select 443.

  17. Check Allow self signed certificates.

  18. Under Security Center events data source:
  19. Check Enabled.

  20. In Name, type Security Center Lpr Events.

  21. In Processing frequency, select 5 sec in the drop-down menu.

  22. Go to the Data sinks tab.

  23. Click +.

  24. In Type, select Database.

  25. Select and configure the database:.

    • Check Enabled.

    • In Source, check Plugin REST API and Native ALPR Events.

    • In Name, type Reads DB.

    • In Include, check Reads, Hits and Images.

    • Go to the Resources tab.

    • Click Delete the database and then Create a database.

  26. Create an API user:
  27. Go to Config Tool > User Management.

  28. Click Add an entity.

  29. Select User.

  30. Type a username and password. Leave the other fields unchanged.

  31. Select the added user and go to the Privileges tab.

  32. Check to allow everything under Application privileges.

  33. Check to allow Third-party ALPR reads API.

  34. Click Apply.

In the AXIS License Plate Verifier app:

  1. Go to the Integration tab.

  2. Select Genetec Security Center in the drop-down list.

  3. In URL/IP, type your address according to this template: https://server-address/api/V1/lpr/lpringestion/reads.

  4. Type in your Genetec username and password.

  5. Click Enable integration.

  6. Go to the Settings tab.

  7. Under Security > HTTPS.

  8. Select Self-signed, or CA-signed depending on the settings in Genetec Security Center.

In Genetec Security Center:

  1. Go to Genetec Security desk.

  2. Under Investigation, click Reads.

  3. Go to the Reads tab.

  4. Filter the result to your needs.

  5. Click Generate report.

Note

You can also read Genetec’s documentation on integrating third party ALPR plugins. You can do that here (requires registration).

The web interface

To reach the device’s web interface, type the device’s IP address in a web browser.

Note

Support for the features and settings described in this section varies between devices. This icon indicates that the feature or setting is only available in some devices.

Show or hide the main menu.

Access the release notes.

Access the product help.

Change the language.

Set light theme or dark theme.

The user menu contains:

  • Information about the user who is logged in.

  • Change account : Log out from the current account and log in to a new account.

  • Log out : Log out from the current account.

The context menu contains:

  • Analytics data: Accept to share non-personal browser data.

  • Feedback: Share any feedback to help us improve your user experience.

  • Legal: View information about cookies and licenses.

  • About: View device information, including firmware version and serial number.

  • Legacy device interface: Change the device’s web interface to the legacy version.

Status

Time sync status

Shows NTP synchronization information, including if the device is in sync with an NTP server and the time remaining until the next sync.

NTP settings: View and update the NTP settings. Takes you to the Date and time page where you can change the NTP settings.

Device info

Shows the device information, including firmware version and serial number.

Upgrade firmware: Upgrade the firmware on your device. Takes you to the Maintenance page where you can do a firmware upgrade.

RAM use: Percentage of RAM that’s used.

CPU use: Percentage of CPU that’s used.

GPU use: Percentage of GPU that’s used.

GPU bus use: Percentage of GPU bus that’s used.

Decoding process: Current status of the decoding process, Running or Stopped.

IP address: The device’s IP address.

Date and time: The device’s date and time.

Ongoing recordings

Shows ongoing recordings and their designated storage space.

Recordings: View ongoing and filtered recordings and their source. For more information, see Recordings

Shows the storage space where the recording is saved.

Connected clients

Shows the number of connections and connected clients.

View details: View and update the list of connected clients. The list shows IP address, protocol, port, state, and PID/process of each connection.

Video

Click to play the live video stream.

Click to freeze the live video stream.

Click to take a snapshot of the live video stream. The file is saved in the ‘Downloads’ folder on your computer. The image file name is [snapshot_YYYY_MM_DD_HH_MM_SS.jpg]. The size of the snapshot depends on the compression that the specific web-browser engine where the snapshot is received applies, therefore, the snapshot size may vary from the actual compression setting that is configured in the device.

Click to show I/O output ports. Use the switch to open or close the circuit of a port, for example, to test external devices.

Click to manually turn on or turn off the IR illumination.

Click to manually turn on or turn off the white light.

Click to access onscreen controls:

  • Predefined controls: Turn on to use the available onscreen controls.

  • Custom controls: Click Add custom control to add an onscreen control.

Starts the washer. When the sequence starts, the camera moves to the configured position to receive the wash spray. When the whole wash sequence is completed, the camera returns to its previous position. This icon is only visible when the washer is connected and configured.

Starts the wiper.

Click and select a preset position to go to that preset position in the live view. Or, click Setup to go to the preset position page.

Adds or removes a focus recall area. When you add a focus recall area, the camera saves the focus settings at that specific pan/tilt range. When you have set a focus recall area and the camera enters that area in the live view, the camera recalls the previously saved focus. It’s enough to cover half of the area for the camera to recall the focus.

Click to select a guard tour, then click Start to play the guard tour. Or, click Setup to go to the guard tours page.

Click to manually turn on the heater for a selected period of time.

Click to start a continuous recording of the live video stream. Click again to stop the recording. If a recording is ongoing, it will resume automatically after a reboot.

Click to show the storage that is configured for the device. To configure the storage, you need to be logged in as an administrator.

Click to access more settings:

  • Video format: Select the encoding format to use in the live view.

  • Client stream information: Turn on to show dynamic information about the video stream used by the browser that shows the live video stream. The bitrate information differs from the information shown in a text overlay, because of different information sources. The bitrate in the client stream information is the bitrate of the last second, and it comes from the encoding driver of the device. The bitrate in the overlay is the average bitrate of the last 5 seconds, and it comes from the browser. Both values cover only the raw video stream and not the additional bandwidth generated when it’s transported over the network through UDP/TCP/HTTP.

  • Adaptive stream: Turn on to adapt the image resolution to the viewing client’s actual display resolution, to improve the user experience and help prevent a possible overload of the client’s hardware. The adaptive stream is only applied when you view the live video stream in the web interface in a browser. When adaptive stream is turned on, the maximum frame rate is 30 fps. If you take a snapshot while adaptive stream is turned on, it will use the image resolution selected by the adaptive stream.

  • Level grid: Click to show the level grid. The grid helps you decide if the image is horizontally aligned. Click to hide it.

  • Pixel counter: Click to show the pixel counter. Drag and resize the box to contain your area of interest. You can also define the pixel size of the box in the Width and Height fields.

  • Refresh: Click to refresh the still image in the live view.

  • PTZ controls: Turn on to display PTZ controls in the live view.

Click to show the live view at full resolution. If the full resolution is larger than your screen size, use the smaller image to navigate in the image.

Click to show the live video stream in full screen. Press Esc to exit full screen mode.

Installation

Capture mode: A capture mode is a preset configuration that defines how the camera captures images. When you change the capture mode, it can affect many other settings, such as view areas and privacy masks.

Mounting position: The orientation of the image can change depending on how you mount the camera.

Power line frequency: To minimize image flicker, select the frequency your region uses. The American regions usually use 60 Hz. The rest of the world mostly uses 50 Hz. If you're not sure of your region's power line frequency, check with the local authorities.

Rotate: Select the preferred image orientation.

Zoom: Use the slider to adjust the zoom level.

Focus: Use the slider to manually set the focus.

AF: Click to make the camera focus on the selected area. If you don’t select an autofocus area, the camera focuses on the entire scene.

Autofocus area: Click to show the autofocus area. This area should include the area of interest.

Reset focus: Click to make the focus return to its original position.

Note

In cold environments, it can take several minutes for the zoom and focus to become available.

Image correction

Important

We recommend you not to use multiple image correction features at the same time, since it can lead to performance issues.

Barrel distortion correction (BDC): Turn on to get a straighter image if it suffers from barrel distortion. Barrel distortion is a lens effect that makes the image appear curved and bent outwards. The condition is seen more clearly when the image is zoomed out.

Crop: Use the slider to adjust the correction level. A lower level means that the image width is kept at the expense of image height and resolution. A higher level means that image height and resolution are kept at the expense of image width.

Remove distortion: Use the slider to adjust the correction level. Pucker means that the image width is kept at the expense of image height and resolution. Bloat means that image height and resolution are kept at the expense of image width.

Image stabilization: Turn on to get a smoother and steadier image with less blur. We recommend that you use image stabilization in environments where the device is mounted in an exposed location and subject to vibrations due to, for example, wind or passing traffic.

Focal length: Use the slider to adjust the focal length. A higher value leads to higher magnification and a narrower angle of view, while a lower value leads to a lower magnification and a wider angle of view.

Stabilizer margin: Use the slider to adjust the size of the stabilizer margin, which determines the level of vibration to stabilize. If the product is mounted in an environment with a lot of vibration, move the slider towards Max. As a result, a smaller scene is captured. If the environment has less vibration, move the slider towards Min.

Straighten image: Turn on and use the slider to straighten the image horizontally by rotating and cropping it digitally. The functionality is useful when it’s not possible to mount the camera exactly level. Ideally, straighten the image during installation.

: Click to show a supporting grid in the image.

: Click to hide the grid.

The image before and after it has been straightened.

Image

Appearance

Scene profile: Select a scene profile that suits your surveillance scenario. A scene profile optimizes image settings, including color level, brightness, sharpness, contrast, and local contrast, for a specific environment or purpose.

  • Forensic: Suitable for surveillance purposes.

  • Indoor: Suitable for indoor environments.

  • Outdoor: Suitable for outdoor environments.

  • Vivid: Useful for demonstration purposes.

  • Traffic overview: Suitable for vehicle traffic monitoring.

Saturation: Use the slider to adjust the color intensity. You can, for example, get a grayscale image.

Contrast: Use the slider to adjust the difference between light and dark.

Brightness: Use the slider to adjust the light intensity. This can make objects easier to see. Brightness is applied after image capture, and doesn’t affect the information in the image. To get more details from a dark area, it’s usually better to increase gain or exposure time.

Sharpness: Use the slider to make objects in the image appear sharper by adjusting the edge contrast. If you increase the sharpness, it may increase the bitrate and the amount of storage space needed as well.

Wide dynamic range

WDR: Turn on to make both bright and dark areas of the image visible.

Local contrast: Use the slider to adjust the contrast of the image. A higher value makes the contrast higher between dark and light areas.

Tone mapping: Use the slider to adjust the amount of tone mapping that is applied to the image. If the value is set to zero, only the standard gamma correction is applied, while a higher value increases the visibility of the darkest and brightest parts in the image.

White balance

When the camera detects the color temperature of the incoming light, it can adjust the image to make the colors look more natural. If this is not sufficient, you can select a suitable light source from the list.

The automatic white balance setting reduces the risk of color flicker by adapting to changes gradually. If the lighting changes, or when the camera is first started, it can take up to 30 seconds to adapt to the new light source. If there is more than one type of light source in a scene, that is, they differ in color temperature, the dominating light source acts as a reference for the automatic white balance algorithm. This behavior can be overridden by choosing a fixed white balance setting that matches the light source you want to use as a reference.

Light environment:

  • Automatic: Automatic identification and compensation for the light source color. This is the recommended setting which can be used in most situations.

  • Automatic – outdoors: Automatic identification and compensation for the light source color. This is the recommended setting which can be used in most outdoor situations.

  • Custom – indoors: Fixed color adjustment for a room with some artificial light other than fluorescent lighting and good for a normal color temperature around 2800 K.

  • Custom – outdoors: Fixed color adjustment for sunny weather conditions with a color temperature around 5500 K.

  • Fixed – fluorescent 1: Fixed color adjustment for fluorescent lighting with a color temperature around 4000 K.

  • Fixed – fluorescent 2: Fixed color adjustment for fluorescent lighting with a color temperature around 3000 K.

  • Fixed – indoors: Fixed color adjustment for a room with some artificial light other than fluorescent lighting and good for a normal color temperature around 2800 K.

  • Fixed – outdoors 1: Fixed color adjustment for sunny weather conditions with a color temperature around 5500 K.

  • Fixed – outdoors 2: Fixed color adjustment for cloudy weather condition with a color temperature around 6500 K.

  • Street light – mercury: Fixed color adjustment for ultraviolet emission in mercury vapor lights common in street lighting.

  • Street light – sodium: Fixed color adjustment that compensates for the yellow orange color of sodium vapor lights common in street lighting.

  • Hold current: Keep the current settings and do not compensate for light changes.

  • Manual: Fix the white balance with the help of a white object. Drag the circle to an object that you want the camera to interpret as white in the live view image. Use the Red balance and Blue balance sliders to adjust the white balance manually.

Day-night mode

IR-cut filter:

  • Auto: Select to automatically turn on and off the IR-cut filter. When the camera is in day mode, the IR-cut filter is turned on and blocks incoming infrared light, and when in night mode, the IR-cut filter is turned off and the camera’s light sensitivity increases.

  • On: Select to turn on the IR-cut filter. The image is in color, but with reduced light sensitivity.

  • Off: Select to turn off the IR-cut filter. The image is in black and white for increased light sensitivity.

Threshold: Use the slider to adjust the light threshold where the camera changes from day mode to night mode.

  • Move the slider towards Bright to decrease the threshold for the IR-cut filter. The camera changes to night mode earlier.

  • Move the slider towards Dark to increase the threshold for the IR-cut filter. The camera changes to night mode later.

IR light

If your device doesn’t have built-in illumination, these controls are only available when you connect a supporting Axis accessory.

Allow illumination: Turn on to let the camera use the built-in light in night mode.

Synchronize illumination: Turn on to automatically synchronize the illumination with the surrounding light. The synchronization between day and night only works if the IR-cut filter is set to Auto or Off.

Automatic illumination angle: Turn on to use the automatic illumination angle. Turn off to set the illumination angle manually.

Illumination angle: Use the slider to manually set the illumination angle, for example, if the angle needs to be different from the camera’s angle of view. If the camera has a wide angle of view, you can set the illumination angle to a narrower angle, which equals a greater tele position. This will result in dark corners in the image.

IR wavelength: Select the desired wavelength for the IR light.

White light:

Allow illumination: Turn on to let the camera use white light in night mode.

Synchronize illumination: Turn on to automatically synchronize the white light with the surrounding light.

Exposure

Select an exposure mode to reduce rapidly changing irregular effects in the image, for example, flicker produced by different types of light sources. We recommend you to use the automatic exposure mode, or the same frequency as your power network.

Exposure mode:

  • Automatic: The camera adjusts the aperture, gain, and shutter automatically.

  • Automatic aperture: The camera adjusts the aperture and gain automatically. The shutter is fixed.

  • Automatic shutter: The camera adjusts the shutter and gain automatically. The aperture is fixed.

  • Hold current: Locks the current exposure settings.

  • Flicker-free: The camera adjusts the aperture and gain automatically, and uses only the following shutter speeds: 1/50 s (50 Hz) and 1/60 s (60 Hz).

  • Flicker-free 50 Hz: The camera adjusts the aperture and gain automatically, and uses the shutter speed 1/50 s.

  • Flicker-free 60 Hz: The camera adjusts the aperture and gain automatically, and uses the shutter speed 1/60 s.

  • Flicker-reduced: This is the same as flicker-free, but the camera might use shutter speeds faster than 1/100 s (50 Hz) and 1/120 s (60 Hz) for brighter scenes.

  • Flicker-reduced 50 Hz: This is the same as flicker-free, but the camera might use shutter speeds faster than 1/100 s for brighter scenes.

  • Flicker-reduced 60 Hz: This is the same as flicker-free, but the camera might use shutter speeds faster than 1/120 s for brighter scenes.

  • Manual: The aperture, gain, and shutter are fixed.

Exposure zone: Use exposure zones to optimize the exposure in a selected part of the scene, for example, the area in front of an entrance door.

Note

The exposure zones are related to the original image (unrotated), and the names of the zones apply to the original image. This means, for example, that if the video stream is rotated 90°, then the Upper zone becomes the Right zone in the stream, and Left becomes Lower.

  • Automatic: Suitable for most situations.

  • Center: Uses a fixed area in the center of the image to calculate the exposure. The area has a fixed size and position in the live view.

  • Full: Uses the entire live view to calculate the exposure.

  • Upper: Uses an area with a fixed size and position in the upper part of the image to calculate the exposure.

  • Lower: Uses an area with a fixed size and position in the lower part of the image to calculate the exposure.

  • Left: Uses an area with a fixed size and position in the left part of the image to calculate the exposure.

  • Right: Uses an area with a fixed size and position in the right part of the image to calculate the exposure.

  • Spot: Uses an area with a fixed size and position in the live view to calculate the exposure.

  • Custom: Uses an area in the live view to calculate the exposure. You can adjust the size and position of the area.

Max shutter: Select the shutter speed to provide the best image. Low shutter speeds (longer exposure) might cause motion blur when there is movement, and a too high shutter speed might affect the image quality. Max shutter works with max gain to improve the image.

Max gain: Select the suitable max gain. If you increase the max gain, it improves the visible level of detail in dark images, but also increases the noise level. More noise can also result in increased use of bandwidth and storage. If you set the max gain to a high value, images can differ a lot if the light conditions are very different from day to night. Max gain works with max shutter to improve the image.

Motion-adaptive exposure: Select to reduce motion blur in low-light conditions.

Blur-noise trade-off: Use the slider to adjust the priority between motion blur and noise. If you want to prioritize low bandwidth and have less noise at the expense of details in moving objects, move the slider towards Low noise. If you want to prioritize the preservation of details in moving objects at the expense of noise and bandwidth, move the slider towards Low motion blur.

Note

You can change the exposure either by adjusting the exposure time or by adjusting the gain. If you increase the exposure time, it results in more motion blur, and if you increase the gain, it results in more noise. If you adjust the Blur-noise trade-off towards Low noise, the automatic exposure will prioritize longer exposure times over increasing gain, and the opposite if you adjust the trade-off towards Low motion blur. Both the gain and exposure time will eventually reach their maximum values in low-light conditions, regardless of the priority set.

Lock aperture: Turn on to keep the aperture size set by the Aperture slider. Turn off to allow the camera to automatically adjust the aperture size. You can, for example, lock the aperture for scenes with permanent light conditions.

Aperture: Use the slider to adjust the aperture size, that is, how much light passes through the lens. To allow more light to enter the sensor and thereby produce a brighter image in low-light conditions, move the slider towards Open. An open aperture also reduces the depth of field, which means that objects close to or far from the camera can appear unfocused. To allow more of the image to be in focus, move the slider towards Closed.

Exposure level: Use the slider to adjust the image exposure.

Defog: Turn on to detect the effects of foggy weather and automatically remove them for a clearer image.

Note

We recommend you not to turn on Defog in scenes with low contrast, large light level variations, or when the autofocus is slightly off. This can affect the image quality, for example, by increasing the contrast. Furthermore, too much light can negatively impact the image quality when defog is active.

Optics

Temperature compensation: Turn on if you want the focus position to be corrected based on the temperature in the optics.

IR compensation: Turn on if you want the focus position to be corrected when IR-cut filter is off and when there is IR light.

Calibrate zoom and focus: Click to reset the optics and the zoom and focus settings to the factory default position. You need to do this if the optics have lost calibration during transport, or if the device has been exposed to extreme vibrations.

Stream

General

Resolution: Select the image resolution suitable for the surveillance scene. A higher resolution increases bandwidth and storage.

Frame rate: To avoid bandwidth problems on the network or reduce storage size, you can limit the frame rate to a fixed amount. If you leave the frame rate at zero, the frame rate is kept at the highest possible rate under the current conditions. A higher frame rate requires more bandwidth and storage capacity.

Compression: Use the slider to adjust the image compression. High compression results in a lower bitrate and lower image quality. Low compression improves the image quality, but uses more bandwidth and storage when you record.

Signed video: Turn on to add the signed video feature to the video. Signed video protects the video from tampering by adding cryptographic signatures to the video.

Zipstream

Zipstream is a bitrate reduction technology, optimized for video surveillance, that reduces the average bitrate in an H.264 or H.265 stream in real time. Axis Zipstream applies a high bitrate in scenes where there are multiple regions of interest, for example, in scenes with moving objects. When the scene is more static, Zipstream applies a lower bitrate, and thereby reduces the required storage. To learn more, see Reducing the bit rate with Axis Zipstream

  • Select the bitrate reduction Strength:
  • Off: No bitrate reduction.

  • Low: No visible quality degradation in most scenes. This is the default option and it can be used in all types of scenes to reduce the bitrate.

  • Medium: Visible effects in some scenes through less noise and a slightly lower level of detail in regions of lower interest, for example, where there’s no movement.

  • High: Visible effects in some scenes through less noise and a lower level of detail in regions of lower interest, for example, where there’s no movement. We recommend this level for cloud-connected devices and devices that use local storage.

  • Higher: Visible effects in some scenes through less noise and a lower level of detail in regions of lower interest, for example, where there’s no movement.

  • Extreme: Visible effects in most scenes. The bitrate is optimized for smallest possible storage.

Optimize for storage: Turn on to minimize the bitrate while maintaining quality. The optimization does not apply to the stream shown in the web client. This can only be used if your VMS supports B-frames. Turning on Optimize for storage also turns on Dynamic GOP.

Dynamic FPS (frames per second): Turn on to allow the bandwidth to vary based on the level of activity in the scene. More activity requires more bandwidth.

Lower limit: Enter a value to adjust the frame rate between minimal fps and the stream default fps based on scene motion. We recommend you to use lower limit in scenes with very little motion, where the fps could drop to 1 or lower.

Dynamic GOP (Group of Pictures): Turn on to dynamically adjust the interval between I-frames based on the level of activity in the scene.

Upper limit: Enter a maximum GOP length, that is, the maximum number of P-frames between two I-frames. An I-frame is a self-contained image frame that is independent of other frames.

P-frames: A P-frame is a predicted image that shows only the changes in the image from the previous frame. Enter the desired number of P-frames. The higher the number, the less bandwidth is required. However, if there is network congestion, there could be a noticeable deterioration in the video quality.

Bitrate control

  • Average: Select to automatically adjust the bitrate over a longer time period and provide the best possible image quality based on the available storage.

    • Click to calculate the target bitrate based on available storage, retention time, and bitrate limit.

    • Target bitrate: Enter desired target bitrate.

    • Retention time: Enter the number of days to keep the recordings.

    • Storage: Shows the estimated storage that can be used for the stream.

    • Maximum bitrate: Turn on to set a bitrate limit.

    • Bitrate limit: Enter a bitrate limit that is higher than the target bitrate.

  • Maximum: Select to set a maximum instant bitrate of the stream based on your network bandwidth.

    • Maximum: Enter the maximum bitrate.

  • Variable: Select to allow the bitrate to vary based on the level of activity in the scene. More activity requires more bandwidth. We recommend this option for most situations.

Orientation

Mirror: Turn on to mirror the image.

Audio

Include: Turn on to use audio in the video stream.

Source: Select what audio source to use.

Stereo: Turn on to include built-in audio as well as audio from an external microphone.

Overlays

: Click to add an overlay. Select the type of overlay from the dropdown list:

  • Text: Select to show a text that is integrated in the live view image and visible in all views, recordings and snapshots. You can enter your own text, and you can also include pre-configured modifiers to automatically show, for example, time, date, and frame rate.

    • : Click to add the date modifier %F to show yyyy-mm-dd.

    • : Click to add the time modifier %X to show hh:mm:ss (24-hour clock).

    • Modifiers: Click to select any of the modifiers shown in the list to add them to the text box. For example, %a shows the day of the week.

    • Size: Select the desired font size.

    • Appearance: Select the text color and background color, for example, white text on a black background (default).

    • : Select the position of the overlay in the image.

  • Image: Select to show a static image superimposed over the video stream. You can use .bmp, .png, .jpeg, or .svg files.

    To upload an image, click Images. Before you upload an image, you can choose to:

    • Scale with resolution: Select to automatically scale the overlay image to fit the video resolution.

    • Use transparency: Select and enter the RGB hexadecimal value for that color. Use the format RRGGBB. Examples of hexadecimal values: FFFFFF for white, 000000 for black, FF0000 for red, 6633FF for blue, and 669900 for green. Only for .bmp images.

  • Scene annotation: Select to show a text overlay in the video stream that stays in the same position, even when the camera pans or tilts in another direction. You can choose to only show the overlay within certain zoom levels.

    • : Click to add the date modifier %F to show yyyy-mm-dd.

    • : Click to add the time modifier %X to show hh:mm:ss (24-hour clock).

    • Modifiers: Click to select any of the modifiers shown in the list to add them to the text box. For example, %a shows the day of the week.

    • Size: Select the desired font size.

    • Appearance: Select the text color and background color, for example, white text on a black background (default).

    • : Select the position of the overlay in the image. The overlay is saved and remains in the pan and tilt coordinates of this position.

    • Annotation between zoom levels (%): Set the zoom levels which the overlay will be shown within.

    • Annotation symbol: Select a symbol that appears instead of the overlay when the camera is not within the set zoom levels.

  • Streaming indicator: Select to show an animation superimposed over the video stream. The animation indicates that the video stream is live, even if the scene doesn’t contain any motion.

    • Appearance: Select the animation color and background color, for example, red animation on a transparent background (default).

    • Size: Select the desired font size.

    • : Select the position of the overlay in the image.

  • Widget: Linegraph: Show a graph chart that displays how a measured value changes over time.

    • Title: Enter a title for the widget.

    • Overlay modifier: Select an overlay modifier as data source. If you have created MQTT overlays, they will be located at the end of the list.

    • : Select the position of the overlay in the image.

    • Size: Select the size of the overlay.

    • Visible on all channels: Turn off to show only on your currently selected channel. Turn on to show on all active channels.

    • Update interval: Choose the time between data updates.

    • Transparency: Set the transparency of the entire overlay.

    • Background transparency: Set the transparency only of the background of the overlay.

    • Points: Turn on to add a point to the graph line when data is updated.

    • X axis

      • Label: Enter the text label for the x axis.

      • Time window: Enter how long time the data is visualized.

      • Time unit: Enter a time unit for the x axis.

    • Y axis

      • Label: Enter the text label for the y axis.

      • Dynamic scale: Turn on for the scale to automatically adapt to the data values. Turn off to manually enter values for a fixed scale.

      • Min alarm threshold and Max alarm threshold: These values will add horizontal reference lines to the graph, making it easier to see when the data value becomes too high or too low.

  • Widget: Meter: Show a bar chart that displays the most recently measured data value.

    • Title: Enter a title for the widget.

    • Overlay modifier: Select an overlay modifier as data source. If you have created MQTT overlays, they will be located at the end of the list.

    • : Select the position of the overlay in the image.

    • Size: Select the size of the overlay.

    • Visible on all channels: Turn off to show only on your currently selected channel. Turn on to show on all active channels.

    • Update interval: Choose the time between data updates.

    • Transparency: Set the transparency of the entire overlay.

    • Background transparency: Set the transparency only of the background of the overlay.

    • Points: Turn on to add a point to the graph line when data is updated.

    • Y axis

      • Label: Enter the text label for the y axis.

      • Dynamic scale: Turn on for the scale to automatically adapt to the data values. Turn off to manually enter values for a fixed scale.

      • Min alarm threshold and Max alarm threshold: These values will add horizontal reference lines to the bar chart, making it easier to see when the data value becomes too high or too low.

View areas

: Click to create a view area.

Click the view area to access settings.

Name: Enter a name for the view area. The maximum length is 64 characters.

Aspect ratio: Select desired aspect ratio. The resolution adjusts automatically.

PTZ: Turn on to use pan, tilt, and zoom functionality in the view area.

Privacy masks

: Click to create a new privacy mask.

Privacy masks: Click to change the color of all privacy masks, or to delete all privacy masks permanently.

Mask x: Click to rename, disable, or permanently delete the mask.

Audio

Device settings

Input: Turn on or off audio input. Shows the type of input.

Allow stream extraction: Turn on to allow stream extraction.

Input type: Select the type of input, for instance, if it’s internal microphone or line.

Power type: Select power type for your input.

Apply changes: Apply your selection.

Echo cancellation: Turn on to remove echoes during two-way communication.

Separate gain controls: Turn on to adjust the gain separately for the different input types.

Automatic gain control: Turn on to dynamically adapt the gain to changes in the sound.

Gain: Use the slider to change the gain. Click the microphone icon to mute or unmute.

Output: Shows the type of output.

Gain: Use the slider to change the gain. Click the speaker icon to mute or unmute.

Stream

Encoding: Select the encoding to use for the input source streaming. You can only choose encoding if audio input is turned on. If audio input is turned off, click Enable audio input to turn it on.

Audio clips

Add clip: Add a new audio clip. You can use .au, .mp3, .opus, .vorbis, .wav files.

Play the audio clip.

Stop playing the audio clip.

The context menu contains:

  • Rename: Change the name of the audio clip.

  • Create link: Create a URL that, when used, plays the audio clip on the device. Specify the volume and number of times to play the clip.

  • Download: Download the audio clip to your computer.

  • Delete: Delete the audio clip from the device.

Recordings

Click to filter the recordings.

From: Show recordings done after a certain point in time.

To: Show recordings up until a certain point in time.

Source: Show recordings based on source. The source refers to the sensor.

Event: Show recordings based on events.

Storage: Show recordings based on storage type.

Ongoing recordings: Show all ongoing recordings on the device.

Start a recording on the device.

Choose which storage device to save to.

Stop a recording on the device.

Triggered recordings will end when manually stopped or when the device is shut down.

Continuous recordings will continue until manually stopped. Even if the device is shut down, the recording will continue when the device starts up again.

Play the recording.

Stop playing the recording.

Show or hide information and options about the recording.

Set export range: If you only want to export part of the recording, enter a time span.

Encrypt: Select to set a password for exported recordings. It will not be possible to open the exported file without the password.

Click to delete a recording.

Export: Export the whole or a part of the recording.

Apps

Add app: Install a new app.

Find more apps: Find more apps to install. You will be taken to an overview page of Axis apps.

Allow unsigned apps: Turn on to allow installation of unsigned apps.

Allow root-privileged apps: Turn on to allow apps with root privileges full access to the device.

View the security updates in AXIS OS and ACAP apps.

Note

The device’s performance might be affected if you run several apps at the same time.

Use the switch next to the app name to start or stop the app.

Open: Access the app’s settings. The available settings depend on the application. Some applications don’t have any settings.

The context menu can contain one or more of the following options:

  • Open-source license: View information about open-source licenses used in the app.

  • App log: View a log of the app events. The log is helpful when you contact support.

  • Activate license with a key: If the app requires a license, you need to activate it. Use this option if your device doesn’t have internet access.

    If you don’t have a license key, go to axis.com/products/analytics. You need a license code and the Axis product serial number to generate a license key.

  • Activate license automatically: If the app requires a license, you need to activate it. Use this option if your device has internet access. You need a license code to activate the license.

  • Deactivate the license: Deactivate the license to replace it with another license, for example, when you change from a trial license to a full license. If you deactivate the license, you also remove it from the device.

  • Settings: Configure the parameters.

  • Delete: Delete the app permanently from the device. If you don’t deactivate the license first, it remains active.

System

Time and location

Date and time

The time format depends on the web browser’s language settings.

Note

We recommend you synchronize the device’s date and time with an NTP server.

Synchronization: Select an option for the device’s date and time synchronization.

  • Automatic date and time (manual NTS KE servers): Synchronize with the secure NTP key establishment servers connected to the DHCP server.

    • Manual NTS KE servers: Enter the IP address of one or two NTP servers. When you use two NTP servers, the device synchronizes and adapts its time based on input from both.

  • Automatic date and time (NTP servers using DHCP): Synchronize with the NTP servers connected to the DHCP server.

    • Fallback NTP servers: Enter the IP address of one or two fallback servers.

  • Automatic date and time (manual NTP servers): Synchronize with NTP servers of your choice.

    • Manual NTP servers: Enter the IP address of one or two NTP servers. When you use two NTP servers, the device synchronizes and adapts its time based on input from both.

  • Custom date and time: Manually set the date and time. Click Get from system to fetch the date and time settings once from your computer or mobile device.

Time zone: Select which time zone to use. Time will automatically adjust to daylight saving time and standard time.

  • DHCP: Adopts the time zone of the DHCP server. The device must connected to a DHCP server before you can select this option.

  • Manual: Select a time zone from the drop-down list.

Note

The system uses the date and time settings in all recordings, logs, and system settings.

Device location

Enter where the device is located. Your video management system can use this information to place the device on a map.

  • Latitude: Positive values are north of the equator.

  • Longitude: Positive values are east of the prime meridian.

  • Heading: Enter the compass direction that the device is facing. 0 is due north.

  • Label: Enter a descriptive name for the device.

  • Save: Click to save your device location.

Network

IPv4

Assign IPv4 automatically: Select to let the network router assign an IP address to the device automatically. We recommend automatic IP (DHCP) for most networks.

IP address: Enter a unique IP address for the device. Static IP addresses can be assigned at random within isolated networks, provided that each address is unique. To avoid conflicts, we recommend you contact your network administrator before you assign a static IP address.

Subnet mask: Enter the subnet mask to define what addresses are inside the local area network. Any address outside the local area network goes through the router.

Router: Enter the IP address of the default router (gateway) used to connect devices that are attached to different networks and network segments.

Fallback to static IP address if DHCP isn’t available: Select if you want to add a static IP address to use as fallback if DHCP is unavailable and can’t assign an IP address automatically.

Note

If DHCP isn’t available and the device uses a static address fallback, the static address is configured with a limited scope.

IPv6

Assign IPv6 automatically: Select to turn on IPv6 and to let the network router assign an IP address to the device automatically.

Hostname

Assign hostname automatically: Select to let the network router assign a hostname to the device automatically.

Hostname: Enter the hostname manually to use as an alternative way of accessing the device. The server report and system log use the hostname. Allowed characters are A–Z, a–z, 0–9 and -.

DNS servers

Assign DNS automatically: Select to let the DHCP server assign search domains and DNS server addresses to the device automatically. We recommend automatic DNS (DHCP) for most networks.

Search domains: When you use a hostname that is not fully qualified, click Add search domain and enter a domain in which to search for the hostname the device uses.

DNS servers: Click Add DNS server and enter the IP address of the DNS server. This provides the translation of hostnames to IP addresses on your network.

HTTP and HTTPS

HTTPS is a protocol that provides encryption for page requests from users and for the pages returned by the web server. The encrypted exchange of information is governed by the use of an HTTPS certificate, which guarantees the authenticity of the server.

To use HTTPS on the device, you must install an HTTPS certificate. Go to System > Security to create and install certificates.

Allow access through: Select if a user is allowed to connect to the device through the HTTP, HTTPS, or both HTTP and HTTPS protocols.

Note

If you view encrypted web pages through HTTPS, you might experience a drop in performance, especially when you request a page for the first time.

HTTP port: Enter the HTTP port to use. The device allows port 80 or any port in the range 1024-65535. If you are logged in as an administrator, you can also enter any port in the range 1-1023. If you use a port in this range, you get a warning.

HTTPS port: Enter the HTTPS port to use. The device allows port 443 or any port in the range 1024-65535. If you are logged in as an administrator, you can also enter any port in the range 1-1023. If you use a port in this range, you get a warning.

Certificate: Select a certificate to enable HTTPS for the device.

Network discovery protocols

Bonjour®: Turn on to allow automatic discovery on the network.

Bonjour name: Enter a friendly name to be visible on the network. The default name is the device name and MAC address.

UPnP®: Turn on to allow automatic discovery on the network.

UPnP name: Enter a friendly name to be visible on the network. The default name is the device name and MAC address.

WS-Discovery: Turn on to allow automatic discovery on the network.

One-click cloud connection

One-click cloud connection (O3C) together with an O3C service provides easy and secure internet access to live and recorded video from any location. For more information, see axis.com/end-to-end-solutions/hosted-services.

Allow O3C:

  • One-click: This is the default setting. Press and hold the control button on the device to connect to an O3C service over the internet. You need to register the device with the O3C service within 24 hours after you press the control button. Otherwise, the device disconnects from the O3C service. Once you register the device, Always is enabled and the device stays connected to the O3C service.

  • Always: The device constantly attempts to connect to an O3C service over the internet. Once you register the device, it stays connected to the O3C service. Use this option if the control button on the device is out of reach.

  • No: Disables the O3C service.

Proxy settings: If needed, enter the proxy settings to connect to the proxy server.

Host: Enter the proxy server’s address.

Port: Enter the port number used for access.

Login and Password: If needed, enter username and password for the proxy server.

Authentication method:

  • Basic: This method is the most compatible authentication scheme for HTTP. It’s less secure than the Digest method because it sends the username and password unencrypted to the server.

  • Digest: This method is more secure because it always transfers the password encrypted across the network.

  • Auto: This option lets the device select the authentication method depending on the supported methods. It prioritizes the Digest method over the Basic method.

Owner authentication key (OAK): Click Get key to fetch the owner authentication key. This is only possible if the device is connected to the internet without a firewall or proxy.

SNMP

The Simple Network Management Protocol (SNMP) allows remote management of network devices.

SNMP: Select the version of SNMP to use.

  • v1 and v2c:

    • Read community: Enter the community name that has read-only access to all supported SNMP objects. The default value is public.

    • Write community: Enter the community name that has read or write access to all supported SNMP objects (except read-only objects). The default value is write.

    • Activate traps: Turn on to activate trap reporting. The device uses traps to send messages for important events or status changes to a management system. In the web interface, you can set up traps for SNMP v1 and v2c. Traps are automatically turned off if you change to SNMP v3 or turn off SNMP. If you use SNMP v3, you can set up traps through the SNMP v3 management application.

    • Trap address: Enter the IP address or host name of the management server.

    • Trap community: Enter the community to use when the device sends a trap message to the management system.

    • Traps:

      • Cold start: Sends a trap message when the device starts.

      • Warm start: Sends a trap message when you change an SNMP setting.

      • Link up: Sends a trap message when a link changes from down to up.

      • Authentication failed: Sends a trap message when an authentication attempt fails.

Note

All Axis Video MIB traps are enabled when you turn on SNMP v1 and v2c traps. For more information, see AXIS OS Portal > SNMP.

  • v3: SNMP v3 is a more secure version, which provides encryption and secure passwords. To use SNMP v3, we recommend you to activate HTTPS, as the password is then sent through HTTPS. This also prevents unauthorized parties’ access to unencrypted SNMP v1 and v2c traps. If you use SNMP v3, you can set up traps through the SNMP v3 management application.

    • Password for the account “initial”: Enter the SNMP password for the account named “initial”. Although the password can be sent without activating HTTPS, we don’t recommend it. The SNMP v3 password can only be set once, and preferably only when HTTPS is enabled. Once the password is set, the password field is no longer displayed. To set the password again, you must reset the device to factory default settings.

Security

Certificates

Certificates are used to authenticate devices on a network. The device supports two types of certificates:

  • Client/server certificates

    A client/server certificate validates the device’s identity, and can be self-signed or issued by a Certificate Authority (CA). A self-signed certificate offers limited protection and can be used before a CA-issued certificate has been obtained.

  • CA certificates

    You can use a CA certificate to authenticate a peer certificate, for example to validate the identity of an authentication server when the device connects to a network protected by IEEE 802.1X. The device has several pre-installed CA certificates.

These formats are supported:

  • Certificate formats: .PEM, .CER, and .PFX

  • Private key formats: PKCS#1 and PKCS#12

Important

If you reset the device to factory default, all certificates are deleted. Any pre-installed CA certificates are reinstalled.

Add certificate : Click to add a certificate.

  • More: Show more fields to fill in or select.

  • Secure keystore: Select to use Secure element or Trusted Platform Module 2.0 to securely store the private key. For more information on which secure keystore to select, go to help.axis.com/en-us/axis-os#cryptographic-support.

  • Key type: Select the default or a different encryption algorithm from the drop-down list to protect the certificate.

The context menu contains:

  • Certificate information: View an installed certificate’s properties.

  • Delete certificate: Delete the certificate.

  • Create certificate signing request: Create a certificate signing request to send to a registration authority to apply for a digital identity certificate.

Secure keystore:

  • Secure element (CC EAL6+): Select to use secure element for secure keystore.

  • Trusted Platform Module 2.0 (CC EAL4+, FIPS 140-2 Level 2): Select to use TPM 2.0 for secure keystore.

IEEE 802.1x and IEEE 802.1AE MACsec

IEEE 802.1x is an IEEE standard for port-based network admission control providing secure authentication of wired and wireless network devices. IEEE 802.1x is based on EAP (Extensible Authentication Protocol).

To access a network protected by IEEE 802.1x, network devices must authenticate themselves. The authentication is performed by an authentication server, typically a RADIUS server (for example, FreeRADIUS and Microsoft Internet Authentication Server).

Certificates

When configured without a CA certificate, server certificate validation is disabled and the device tries to authenticate itself regardless of what network it is connected to.

When using a certificate, in Axis' implementation, the device and the authentication server authenticate themselves with digital certificates using EAP-TLS (Extensible Authentication Protocol - Transport Layer Security).

To allow the device to access a network protected through certificates, you must install a signed client certificate on the device.

Authentication method: Select an EAP type used for authentication. The default option is EAP-TLS. EAP-PEAP/MSCHAPv2 is a more secure option.

Client certificate: Select a client certificate to use IEEE 802.1x. The authentication server uses the certificate to validate the client’s identity.

CA certificate: Select CA certificates to validate the authentication server’s identity. When no certificate is selected, the device tries to authenticate itself regardless of what network it is connected to.

EAP identity: Enter the user identity associated with the client certificate.

EAPOL version: Select the EAPOL version that is used in the network switch.

Use IEEE 802.1x: Select to use the IEEE 802.1x protocol.

IEEE 802.1AE MACsec

IEEE 802.1AE MACsec is an IEEE standard for media access control (MAC) security that defines connectionless data confidentiality and integrity for media access independent protocols.

The settings are only available if you use EAP-TLS as the authentication method:

Mode

  • Dynamic CAK / EAP-TLS: The default option. After a secured connection, the device checks for MACsec on the network.

  • Static CAK / pre-shared key (PSK): Select to set the key name and value to connect to the network.

The settings are only available if you use EAP-PEAP/MSCHAPv2 as the authentication method:

  • Password: Enter the password for your user identity.

  • Peap version: Select the Peap version that is used in the network switch.

  • Label: Select 1 to use client EAP encryption; select 2 to use client PEAP encryption. Select the Label that the network switch uses when using Peap version 1.

Prevent brute-force attacks

Blocking: Turn on to block brute-force attacks. A brute-force attack uses trial-and-error to guess login info or encryption keys.

Blocking period: Enter the number of seconds to block a brute-force attack.

Blocking conditions: Enter the number of authentication failures allowed per second before the block starts. You can set the number of failures allowed both on page level and device level.

Firewall

Activate: Use the toggle to turn on the firewall.

Default Policy: Choose to Allow or Deny a default state for the firewall.

Address: Enter the IP numbers that are allowed or denied access to the device. You can use IPv4/IPv6 or CIDR format

Protocol: Choose which protocol to add to the rule.

Port: Enter a port number between 1 and 65535.

Policy: Choose to Allow or Deny this rule.

Pending rules: An overview of the rules that you are yet to confirm.

Confirm rules: Click to activate a selected rule.

Active rules: An overview of the rules you are currently running on the device.

Custom signed firmware certificate

To install test firmware or other custom firmware from Axis on the device, you need a custom signed firmware certificate. The certificate verifies that the firmware is approved by both the device owner and Axis. The firmware can only run on a specific device which is identified by its unique serial number and chip ID. Only Axis can create custom signed firmware certificates, since Axis holds the key to sign them.

Install: Click to install the certificate. You need to install the certificate before you install the firmware.

The context menu contains:

  • Delete certificate: Delete the certificate.

Accounts

Accounts

Add account: Click to add a new account. You can add up to 100 accounts.

Account: Enter a unique account name.

New password: Enter a password for the account. Passwords must be 1 to 64 characters long. Only ASCII printable characters (code 32 to 126) are allowed in the password, for example, letters, numbers, punctuation, and some symbols.

Repeat password: Enter the same password again.

Privileges:

  • Administrator: Has full access to all settings. Administrators can also add, update, and remove other accounts.

  • Operator: Has access to all settings except:

    • All System settings.

    • Adding apps.

  • Viewer: Has access to:

    • Watch and take snapshots of a video stream.

    • Watch and export recordings.

    • Pan, tilt, and zoom; with PTZ user access.

The context menu contains:

Update account: Edit the account properties.

Delete account: Delete the account. You can’t delete the root account.

Anonymous access

Allow anonymous viewing: Turn on to allow anyone access the device as a viewer without logging in with an account.

Allow anonymous PTZ operating: Turn on to allow anonymous users to pan, tilt, and zoom the image.

SSH accounts

Add SSH account: Click to add a new SSH account.

  • Restrict root access: Turn on to restrict functionality that requires root access.

  • Enable SSH: Turn on to use SSH service.

Account: Enter a unique account name.

New password: Enter a password for the account. Passwords must be 1 to 64 characters long. Only ASCII printable characters (code 32 to 126) are allowed in the password, for example, letters, numbers, punctuation, and some symbols.

Repeat password: Enter the same password again.

Comment: Enter a comment (optional).

The context menu contains:

Update SSH account: Edit the account properties.

Delete SSH account: Delete the account. You can’t delete the root account.

OpenID Configuration

Important

Enter the right values to ensure you can log in to the device again.

Client ID: Enter the OpenID username.

Outgoing Proxy: Enter the proxy address for the OpenID connection to use a proxy server.

Admin claim: Enter a value for the admin role.

Provider URL: Enter the web link for the API endpoint authentication. Format should be https://[insert URL]/.well-known/openid-configuration

Operator claim: Enter a value for the operator role.

Require claim: Enter the data that should be in the token.

Viewer claim: Enter the value for the viewer role.

Remote user: Enter a value to identify remote users. This will help to display the current user in the device’s web interface.

Scopes: Optional scopes that could be part of the token.

Client secret: Enter the OpenID password

Save: Click to save the OpenID values.

Enable OpenID: Turn on to close current connection and allow device authentication from the provider URL.

Events

Rules

A rule defines the conditions that triggers the product to perform an action. The list shows all the currently configured rules in the product.

Note

You can create up to 256 action rules.

Add a rule: Create a rule.

Name: Enter a name for the rule.

Wait between actions: Enter the minimum time (hh:mm:ss) that must pass between rule activations. It is useful if the rule is activated by, for example, day-night mode conditions, to avoid that small light changes during sunrise and sunset activate the rule repeatedly.

Condition: Select a condition from the list. A condition must be met for the device to perform an action. If multiple conditions are defined, all of them must be met to trigger the action. For information about specific conditions, see Get started with rules for events.

Use this condition as a trigger: Select to make this first condition function only as a starting trigger. It means that once the rule is activated, it remains active for as long as all the other conditions are met, no matter the state of the first condition. If you don’t select this option, the rule will simply be active whenever all the conditions are met.

Invert this condition: Select if you want the condition to be the opposite of your selection.

Add a condition: Click to add an additional condition.

Action: Select an action from the list and enter its required information. For information about specific actions, see Get started with rules for events.

Recipients

You can set up your device to notify recipients about events or send files. The list shows all the recipients currently configured in the product, along with information about their configuration.

Note

You can create up to 20 recipients.

Add a recipient: Click to add a recipient.

Name: Enter a name for the recipient.

Type: Select from the list:

  • FTP

    • Host: Enter the server's IP address or hostname. If you enter a hostname, make sure that a DNS server is specified under System > Network > IPv4 and IPv6.

    • Port: Enter the port number used by the FTP server. The default is 21.

    • Folder: Enter the path to the directory where you want to store files. If this directory doesn’t already exist on the FTP server, you will get an error message when uploading files.

    • Username: Enter the username for the login.

    • Password: Enter the password for the login.

    • Use temporary file name: Select to upload files with temporary, automatically generated filenames. The files get renamed to the desired names when the upload completes. If the upload is aborted/interrupted, you don’t get any corrupt files. However, you probably still get the temporary files. This way you know that all files that have the desired name are correct.

    • Use passive FTP: Under normal circumstances, the product simply requests the target FTP server to open the data connection. The device actively initiates both the FTP control and data connections to the target server. This is normally needed if there is a firewall between the device and the target FTP server.

  • HTTP

    • URL: Enter the network address to the HTTP server and the script that will handle the request. For example, http://192.168.254.10/cgi-bin/notify.cgi.

    • Username: Enter the username for the login.

    • Password: Enter the password for the login.

    • Proxy: Turn on and enter the required information if a proxy server must be passed to connect to the HTTP server.

  • HTTPS

    • URL: Enter the network address to the HTTPS server and the script that will handle the request. For example, https://192.168.254.10/cgi-bin/notify.cgi.

    • Validate server certificate: Select to validate the certificate that was created by HTTPS server.

    • Username: Enter the username for the login.

    • Password: Enter the password for the login.

    • Proxy: Turn on and enter the required information if a proxy server must be passed to connect to the HTTPS server.

  • Network storage

    You can add network storage such as NAS (network-attached storage) and use it as a recipient to store files. The files are stored in the Matroska (MKV) file format.

    • Host: Enter the IP address or hostname for the network storage.

    • Share: Enter the name of the share on the host.

    • Folder: Enter the path to the directory where you want to store files.

    • Username: Enter the username for the login.

    • Password: Enter the password for the login.

  • SFTP

    • Host: Enter the server's IP address or hostname. If you enter a hostname, make sure that a DNS server is specified under System > Network > IPv4 and IPv6.

    • Port: Enter the port number used by the SFTP server. The default is 22.

    • Folder: Enter the path to the directory where you want to store files. If this directory doesn’t already exist on the SFTP server, you will get an error message when uploading files.

    • Username: Enter the username for the login.

    • Password: Enter the password for the login.

    • SSH host public key type (MD5): Enter the fingerprint of the remote host’s public key (a 32-digit hexadecimal string). The SFTP client supports SFTP servers using SSH-2 with RSA, DSA, ECDSA, and ED25519 host key types. RSA is the preferred method during negotiation, followed by ECDSA, ED25519, and DSA. Make sure to enter the right MD5 host key that is used by your SFTP server. While the Axis device supports both MD5 and SHA-256 hash keys, we recommend using SHA-256 due to stronger security over MD5. For more information on how to configure an SFTP server with an Axis device, go to the AXIS OS Portal.

    • SSH host public key type (SHA256): Enter the fingerprint of the remote host’s public key (a 43-digit Base64 encoded string). The SFTP client supports SFTP servers using SSH-2 with RSA, DSA, ECDSA, and ED25519 host key types. RSA is the preferred method during negotiation, followed by ECDSA, ED25519, and DSA. Make sure to enter the right MD5 host key that is used by your SFTP server. While the Axis device supports both MD5 and SHA-256 hash keys, we recommend using SHA-256 due to stronger security over MD5. For more information on how to configure an SFTP server with an Axis device, go to the AXIS OS Portal.

    • Use temporary file name: Select to upload files with temporary, automatically generated filenames. The files get renamed to the desired names when the upload completes. If the upload is aborted or interrupted, you don’t get any corrupt files. However, you probably still get the temporary files. This way, you know that all files that have the desired name are correct.

  • SIP or VMS:

    SIP: Select to make a SIP call.

    VMS: Select to make a VMS call.

    • From SIP account: Select from the list.

    • To SIP address: Enter the SIP address.

    • Test: Click to test that your call settings works.

  • Email

    • Send email to: Enter the email address to send emails to. To enter multiple addresses, use commas to separate them.

    • Send email from: Enter the email address of the sending server.

    • Username: Enter the username for the mail server. Leave this field empty if the mail server does not require authentication.

    • Password: Enter the password for the mail server. Leave this field empty if the mail server does not require authentication.

    • Email server (SMTP): Enter the name of the SMTP server, for example, smtp.gmail.com, smtp.mail.yahoo.com.

    • Port: Enter the port number for the SMTP server, using values in the range 0-65535. The default value is 587.

    • Encryption: To use encryption, select either SSL or TLS.

    • Validate server certificate: If you use encryption, select to validate the identity of the device. The certificate can be self-signed or issued by a Certificate Authority (CA).

    • POP authentication: Turn on to enter the name of the POP server, for example, pop.gmail.com.

    • Note

      Some email providers have security filters that prevent users from receiving or viewing large amount of attachments, from receiving scheduled emails and similar. Check the email provider's security policy to avoid your email account being locked or missing out on your expected emails.

  • TCP

    • Host: Enter the server's IP address or hostname. If you enter a hostname, make sure that a DNS server is specified under System > Network > IPv4 and IPv6.

    • Port: Enter the port number used to access the server.

Test: Click to test the setup.

The context menu contains:

View recipient: Click to view all the recipient details.

Copy recipient: Click to copy a recipient. When you copy, you can make changes to the new recipient.

Delete recipient: Click to delete the recipient permanently.

Schedules

Schedules and pulses can be used as conditions in rules. The list shows all the schedules and pulses currently configured in the product, along with information about their configuration.

Add schedule: Click to create a schedule or pulse.

Manual triggers

You can use the manual trigger to manually trigger a rule. The manual trigger can, for example, be used to validate actions during product installation and configuration.

MQTT

MQTT (Message Queuing Telemetry Transport) is a standard messaging protocol for the Internet of Things (IoT). It was designed for simplified IoT integration and is used in a wide variety of industries to connect remote devices with a small code footprint and minimal network bandwidth. The MQTT client in Axis device firmware can simplify integration of data and events produced in the device to systems which are not video management software (VMS).

Set up the device as an MQTT client. MQTT communication is based on two entities, the clients and the broker. The clients can send and receive messages. The broker is responsible for routing messages between clients.

You can learn more about MQTT in AXIS OS Portal.

ALPN

ALPN is a TLS/SSL extension that allows for the selection of an application protocol during the handshake phase of the connection between the client and server. This is used to enable MQTT traffic over the same port that is used for other protocols, such as HTTP. In some cases, there might not be a dedicated port open for MQTT communication. A solution in such cases is to use ALPN to negotiate the use of MQTT as the application protocol on a standard port, allowed by the firewalls.

MQTT client

Connect: Turn on or off the MQTT client.

Status: Shows the current status of the MQTT client.

Broker

Host: Enter the hostname or IP address of the MQTT server.

Protocol: Select which protocol to use.

Port: Enter the port number.

  • 1883 is the default value for MQTT over TCP

  • 8883 is the default value for MQTT over SSL

  • 80 is the default value for MQTT over WebSocket

  • 443 is the default value for MQTT over WebSocket Secure

ALPN protocol: Enter the ALPN protocol name provided by your MQTT broker provider. This is only applicable with MQTT over SSL and MQTT over WebSocket Secure.

Username: Enter the username that the client will use to access the server.

Password: Enter a password for the username.

Client ID: Enter a client ID. The client identifier is sent to the server when the client connects to it.

Clean session: Controls the behavior at connection and disconnection time. When selected, the state information is discarded at connect and disconnect.

HTTP proxy: A URL with a maximum length of 255 bytes. You can leave the field empty if you don't want to use an HTTP proxy.

HTTPS proxy: A URL with a maximum length of 255 bytes. You can leave the field empty if you don't want to use an HTTPS proxy.

Keep alive interval: Enables the client to detect when the server is no longer available without having to wait for the long TCP/IP timeout.

Timeout: The time interval in seconds to allow a connect to complete. Default value: 60

Device topic prefix: Used in the default values for the topic in the connect message and LWT message on the MQTT client tab, and in the publication conditions on the MQTT publication tab.

Reconnect automatically: Specifies whether the client should reconnect automatically after a disconnect.

Connect message

Specifies if a message should be sent out when a connection is established.

Send message: Turn on to send messages.

Use default: Turn off to enter your own default message.

Topic: Enter the topic for the default message.

Payload: Enter the content for the default message.

Retain: Select to keep the state of client on this Topic

QoS: Change the QoS layer for the packet flow.

Last Will and Testament message

The Last Will Testament (LWT) lets a client provide a testament along with its credentials when connecting to the broker. If the client disconnects ungracefully at some point later (maybe because his power source died), it can let the broker deliver a message to other clients. This LWT message has the same form as an ordinary message and gets routed via the same mechanics.

Send message: Turn on to send messages.

Use default: Turn off to enter your own default message.

Topic: Enter the topic for the default message.

Payload: Enter the content for the default message.

Retain: Select to keep the state of client on this Topic

QoS: Change the QoS layer for the packet flow.

MQTT publication

Use default topic prefix: Select to use the default topic prefix, that is defined in the device topic prefix in the MQTT client tab.

Include topic name: Select to include the topic that describes the condition in the MQTT topic.

Include topic namespaces: Select to include ONVIF topic namespaces in the MQTT topic.

Include serial number: Select to include the device’s serial number in the MQTT payload.

Add condition: Click to add a condition.

Retain: Defines which MQTT messages are sent as retained.

  • None: Send all messages as non-retained.

  • Property: Send only stateful messages as retained.

  • All: Send both stateful and stateless messages as retained.

QoS: Select the desired level for the MQTT publication.

MQTT subscriptions

Add subscription: Click to add a new MQTT subscription.

Subscription filter: Enter the MQTT topic that you want to subscribe to.

Use device topic prefix: Add the subscription filter as prefix to the MQTT topic.

Subscription type:

  • Stateless: Select to convert MQTT messages into a stateless message.

  • Stateful: Select to convert MQTT messages into a condition. The payload is used as the state.

QoS: Select the desired level for the MQTT subscription.

Storage

Network storage

Ignore: Turn on to ignore network storage.

Add network storage: Click to add a network share where you can save recordings.

  • Address: Enter the IP address or host name of the host server, typically a NAS (network-attached storage). We recommend you to configure the host to use a fixed IP address (not DHCP since a dynamic IP address can change) or that you use DNS. Windows SMB/CIFS names are not supported.

  • Network share: Enter the name of the shared location on the host server. Several Axis devices can use the same network share since each device gets its own folder.

  • User: If the server requires a login, enter the username. To log in to a specific domain server, type DOMAIN\username.

  • Password: If the server requires a login, enter the password.

  • SMB version: Select the SMB storage protocol version to connect to the NAS. If you select Auto, the device tries to negotiate one of the secure versions SMB: 3.02, 3.0, or 2.1. Select 1.0 or 2.0 to connect to older NAS that don’t support higher versions. You can read more about SMB support in Axis devices here.

  • Add share without testing: Select to add the network share even if an error is discovered during the connection test. The error can be, for example, that you didn’t enter a password even though the server requires one.

Remove network storage: Click to unmount, unbind, and remove the connection to the network share. This removes all settings for the network share.

Unbind: Click to unbind and disconnect the network share.
Bind: Click to bind and connect the network share.

Unmount: Click to unmount the network share.
Mount: Click to mount the network share.

Write protect: Turn on to stop writing to the network share and protect recordings from being removed. You can’t format a write-protected network share.

Retention time: Select how long to keep recordings, to limit the amount of old recordings, or to comply with regulations regarding data storage. If the network storage becomes full, old recordings are removed before the selected time period passes.

Tools

  • Test connection: Test the connection to the network share.

  • Format: Format the network share, for example, when you need to quickly erase all data. CIFS is the available file system option.

  • Use tool: Click to activate the selected tool.

Onboard storage

Important

Risk of data loss and corrupted recordings. Do not remove the SD card while the device is running. Unmount the SD card before you remove it.

Unmount: Click to safely remove the SD card.

Write protect: Turn on to stop writing to the SD card and protect recordings from being removed. You can’t format a write-protected SD card.

Autoformat: Turn on to automatically format a newly inserted SD card. It formats the file system into ext4.

Ignore: Turn on to stop storing recordings on the SD card. When you ignore the SD card, the device no longer recognizes that the card exists. The setting is only available for administrators.

Retention time: Select how long to keep recordings, to limit the amount of old recordings, or to comply with regulations regarding data storage. If the SD card becomes full, old recordings are removed before the selected time period has passed.

Tools

  • Check: Check for errors on the SD card. This only works for the ext4 file system.

  • Repair: Repair errors in the ext4 file system. To repair an SD card with the VFAT file system, eject the SD card, insert it in a computer, and perform a disk repair.

  • Format: Format the SD card, for example, when you need to change the file system or quickly erase all data. VFAT and ext4 are the two available file system options. The recommended format is ext4, due to its resilience against data loss if the card is ejected or if there is an abrupt power loss. However, you need a third-party ext4 driver or application to access the file system from Windows®.

  • Encrypt: Use this tool to format the SD card and enable encryption. Encrypt deletes all data stored on the SD card. After using Encrypt, the data that’s stored on the SD card is protected using encryption.

  • Decrypt: Use this tool to format the SD card without encryption. Decrypt deletes all data stored on the SD card. After using Decrypt, the data that’s stored on the SD card is not protected using encryption.

  • Change password: Change the password required to encrypt the SD card.

  • Use tool: Click to activate the selected tool.

Wear trigger: Set a value for the SD card wear level at which you want to trigger an action. The wear level ranges from 0–200%. A new SD card that has never been used has a wear level of 0%. A wear level of 100% indicates that the SD card is close to its expected lifetime. When the wear-level reaches 200%, there is a high risk of the SD card malfunctioning. We recommend setting the wear trigger between 80–90%. This gives you time to download any recordings as well as replace the SD card in time before it potentially wears out. The wear trigger allows you to set up an event and get a notification when the wear level reaches your set value.

Onboard storage

  • Hard drive
  • Free: The amount of free disk space.

  • Status: If the disk is mounted or not.

  • File system: The file system used by the disk.

  • Encrypted: If the disk is encrypted or not.

  • Temperature: The current temperature of the hardware.

  • Overall heath test: The result after checking the health of the disk.

  • Tools
  • Check: Check the storage device for errors and tries to repair it automatically.

  • Repair: Repair the storage device. Active recordings will pause during the repair. Repairing a storage device may result in lost data.

  • Format: Erase all recordings and format the storage device. Choose a file system.

  • Encrypt: Encrypt stored data.

  • Decrypt: Decrypt stored data. The system will erase all files on the storage device.

  • Change password: Change the password for the disk encryption. Changing the password doesn't disrupt ongoing recordings.

  • Use tool: Click to run the selected tool

Unmount: Click before you disconnect the device from the system. This will stop all ongoing recordings.

Write protect: Turn on to protect the storage device from being overwritten.

Autoformat: The disk will automatically format using the ext4 file system.

SIP

Settings

Session Initiation Protocol (SIP) is used for interactive communication sessions between users. The sessions can include audio and video.

Enable SIP: Check this option to make it possible to initiate and receive SIP calls.

Allow incoming calls: Check this option to allow incoming calls from other SIP devices.

  • Call handling
  • Calling timeout: Set the maximum duration of an attempted call if no one answers.

  • Incoming call duration: Set the maximum time an incoming call can last (max 10 min).

  • End calls after: Set the maximum time that a call can last (max 60 minutes). Select Infinite call duration if you don’t want to limit the length of a call.

  • Ports
  • A port number must be between 1024 and 65535.
  • SIP port: The network port used for SIP communication. The signaling traffic through this port is non-encrypted. The default port number is 5060. Enter a different port number if required.

  • TLS port: The network port used for encrypted SIP communication. The signaling traffic through this port is encrypted with Transport Layer Security (TLS). The default port number is 5061. Enter a different port number if required.

  • RTP start port: The network port used for the first RTP media stream in a SIP call. The default start port number is 4000. Some firewalls block RTP traffic on certain port numbers.

  • NAT traversal
  • Use NAT (Network Address Translation) traversal when the device is located on an private network (LAN) and you want to make it available from outside of that network.
  • Note

    For NAT traversal to work, the router must support it. The router must also support UPnP®.

  • Each NAT traversal protocol can be used separately or in different combinations depending on the network environment.
  • ICE: The ICE (Interactive Connectivity Establishment) protocol increases the chances of finding the most efficient path to successful communication between peer devices. If you also enable STUN and TURN, you improve the ICE protocol’s chances.

  • STUN: STUN (Session Traversal Utilities for NAT) is a client-server network protocol that lets the device determine if it is located behind a NAT or firewall, and if so obtain the mapped public IP address and port number allocated for connections to remote hosts. Enter the STUN server address, for example, an IP address.

  • TURN: TURN (Traversal Using Relays around NAT) is a protocol that lets a device behind a NAT router or firewall receive incoming data from other hosts over TCP or UDP. Enter the TURN server address and the login information.

  • Audio and video
  • Audio codec priority: Select at least one audio codec with the desired audio quality for SIP calls. Drag-and-drop to change the priority.

  • Note

    The selected codecs must match the call recipient codec, since the recipient codec is decisive when a call is made.

  • Audio direction: Select allowed audio directions.

  • H.264 packetization mode: Select which packetization mode to use.

    • Auto: (Recommended) The device decides which packetization mode to use.

    • None: No packetization mode is set. This mode is often interpreted as mode 0.

    • 0: Non-interleaved mode.

    • 1: Single NAL unit mode.

  • Video direction: Select allowed video directions.

  • Additional
  • UDP-to-TCP switching: Select to allow calls to switch transport protocols from UDP (User Datagram Protocol) to TCP (Transmission Control Protocol) temporarily. The reason for switching is to avoid fragmentation, and the switch can take place if a request is within 200 bytes of the maximum transmission unit (MTU) or larger than 1300 bytes.

  • Allow via rewrite: Select to send the local IP address instead of the router's public IP address.

  • Allow contact rewrite: Select to send the local IP address instead of the router's public IP address.

  • Register with server every: Set how often you want the device to register with the SIP server for the existing SIP accounts.

  • DTMF payload type: Changes the default payload type for DTMF.

  • Max retransmissions: Set the maximum number of times the device tries to connect to the SIP server before it stops trying.

  • Seconds until failback: Set the number of seconds until the device tries to reconnect to the primary SIP server after it has failed over to a secondary SIP server.

Accounts

All current SIP accounts are listed under SIP accounts. For registered accounts, the colored circle lets you know the status.

  • The account is successfully registered with the SIP server.
  • There is a problem with the account. Possible reasons can be authorization failure, that the account credentials are wrong, or that the SIP server can’t find the account.

The peer to peer (default) account is an automatically created account. You can delete it if you create at least one other account and set that account as default. The default account is always used when a VAPIX® Application Programming Interface (API) call is made without specifying which SIP account to call from.

  • Add account: Click to create a new SIP account.
  • Active: Select to be able to use the account.

  • Make default: Select to make this the default account. There must be a default account, and there can only be one default account.

  • Answer automatically: Select to automatically answer an incoming call.

  • Prioritize IPv6 over IPv4: Select to prioritize IPv6 addresses over IPv4 addresses. This is useful when you connect to peer-to-peer accounts or domain names that resolve in both IPv4 and IPv6 addresses. You can only prioritize IPv6 for domain names that are mapped to IPv6 addresses.

  • Name: Enter a descriptive name. This can, for example, be a first and last name, a role, or a location. The name is not unique.

  • User ID: Enter the unique extension or phone number assigned to the device.

  • Peer-to-peer: Use for direct calls to another SIP device on the local network.

  • Registered: Use for calls to SIP devices outside the local network, through a SIP server.

  • Domain: If available, enter the public domain name. It will be shown as part of the SIP address when calling other accounts.

  • Password: Enter the password associated with the SIP account for authenticating against the SIP server.

  • Authentication ID: Enter the authentication ID used for authenticating against the SIP server. If it is the same as the user ID, you don’t need to enter the authentication ID.

  • Caller ID: The name which is presented to the recipient of calls from the device.

  • Registrar: Enter the IP address for the registrar.

  • Transport mode: Select the SIP transport mode for the account: UPD, TCP, or TLS.

  • TLS version (only with transport mode TLS): Select the version of TLS to use. Versions v1.2 and v1.3 are the most secure. Automatic selects the most secure version that the system can handle.

  • Media encryption (only with transport mode TLS): Select the type of encryption for media (audio and video) in SIP calls.

  • Certificate (only with transport mode TLS): Select a certificate.

  • Verify server certificate (only with transport mode TLS): Check to verify the server certificate.

  • Secondary SIP server: Turn on if you want the device to try to register on a secondary SIP server if registration on the primary SIP server fails.

  • SIP secure: Select to use Secure Session Initiation Protocol (SIPS). SIPS uses the TLS transport mode to encrypt traffic.

  • Proxies

    • Proxy: Click to add a proxy.

    • Prioritize: If you have added two or more proxies, click to prioritize them.

    • Server address: Enter the IP address of the SIP proxy server.

    • Username: If required, enter the username for the SIP proxy server.

    • Password: If required, enter the password for the SIP proxy server.

  • Video

    • View area: Select the view area to use for video calls. If you select none, the native view is used.

    • Resolution: Select the resolution to use for video calls. The resolution affects the required bandwidth.

    • Frame rate: Select the number of frames per second for video calls. The frame rate affects the required bandwidth.

    • H.264 profile: Select the profile to use for video calls.

Test call

SIP account: Select which account to make the test call from.

SIP address: Enter a SIP address and click to make a test call and verify that the account works.

Stream profiles

A stream profile is a group of settings that affect the video stream. You can use stream profiles in different situations, for example, when you create events and use rules to record.

Add stream profile: Click to create a new stream profile.

Preview: A preview of the video stream with the stream profile settings you select. The preview updates when you change the settings on the page. If your device has different view areas, you can change the view area in the drop-down in the bottom left corner of the image.

Name: Add a name for your profile.

Description: Add a description of your profile.

Video codec: Select the video codec that should apply for the profile.

Resolution: See Stream for a description of this setting.

Frame rate: See Stream for a description of this setting.

Compression: See Stream for a description of this setting.

Zipstream: See Stream for a description of this setting.

Optimize for storage: See Stream for a description of this setting.

Dynamic FPS: See Stream for a description of this setting.

Dynamic GOP: See Stream for a description of this setting.

Mirror: See Stream for a description of this setting.

GOP length: See Stream for a description of this setting.

Bitrate control: See Stream for a description of this setting.

Include overlays: Select what type of overlays to include. See Overlays for information about how to add overlays.

Include audio: See Stream for a description of this setting.

ONVIF

ONVIF accounts

ONVIF (Open Network Video Interface Forum) is a global interface standard that makes it easier for end-users, integrators, consultants, and manufacturers to take advantage of the possibilities offered by network video technology. ONVIF enables interoperability between different vendor products, increased flexibility, reduced cost and future-proof systems.

When you create an ONVIF account, you automatically enable ONVIF communication. Use the account name and password for all ONVIF communication with the device. For more information see the Axis Developer Community at axis.com.

Add accounts: Click to add a new ONVIF account.

Account: Enter a unique account name.

New password: Enter a password for the account. Passwords must be 1 to 64 characters long. Only ASCII printable characters (code 32 to 126) are allowed in the password, for example, letters, numbers, punctuation, and some symbols.

Repeat password: Enter the same password again.

Role:

  • Administrator: Has full access to all settings. Administrators can also add, update, and remove other accounts.

  • Operator: Has access to all settings except:

    • All System settings.

    • Adding apps.

  • Media account: Allows access to the video stream only.

The context menu contains:

Update account: Edit the account properties.

Delete account: Delete the account. You can’t delete the root account.

ONVIF media profiles

An ONVIF media profile consists of a set of configurations that you can use to change media stream settings. You can create new profiles with your own set of configurations or use preconfigured profiles for a quick setup.

Add media profile: Click to add a new ONVIF media profile.

Profile name: Add a name for the media profile.

Video source: Select the video source for your configuration.

  • Select configuration: Select a user-defined configuration from the list. The configurations in the drop-down list correspond to the device's video channels, including multiviews, view areas and virtual channels.

Video encoder: Select the video encoding format for your configuration.

  • Select configuration: Select a user-defined configuration from the list and adjust the encoding settings. The configurations in the drop-down list act as identifiers/names of the video encoder configuration. Select user 0 to 15 to apply your own settings, or select one of the default users if you want to use predefined settings for a specific encoding format.

Note

Enable audio in the device to get the option to select an audio source and audio encoder configuration.

Audio source: Select the audio input source for your configuration.

  • Select configuration: Select a user-defined configuration from the list and adjust the audio settings. The configurations in the drop-down list correspond to the device's audio inputs. If the device has one audio input, it's user0. If the device has several audio inputs, there will be additional users in the list.

Audio encoder: Select the audio encoding format for your configuration.

  • Select configuration: Select a user-defined configuration from the list and adjust the audio encoding settings. The configurations in the drop-down list act as identifiers/names of the audio encoder configuration.

Metadata: Select the metadata to include in your configuration.

  • Select configuration: Select a user-defined configuration from the list and adjust the metadata settings. The configurations in the drop-down list act as identifiers/names of the metadata configuration.

PTZ: Select the PTZ settings for your configuration.

  • Select configuration: Select a user-defined configuration from the list and adjust the PTZ settings. The configurations in the drop-down list correspond to the device's video channels with PTZ support.

Create: Click to save your settings and create the profile.

Cancel: Click to cancel the configuration and clear all settings.

profile_x: Click on the profile name to open and edit the preconfigured profile.

Analytics metadata

Metadata producers

Lists the apps that stream metadata and the channels they use.

Producer: The app that produces the metadata. Below the app is a list of the types of metadata the app streams from the device.

Channel: The channel that the app uses. Select to enable the metadata stream. Deselect for compatibility or resource management reasons.

Detectors

Camera tampering

The camera tampering detector generates an alarm when the scene changes, for example, when the lens is covered, sprayed or severely put out of focus, and the time in Trigger delay has passed. The tampering detector only activates when the camera has not moved for at least 10 seconds. During this period, the detector sets up a scene model to use as a comparison to detect tampering in current images. For the scene model to be set up properly, make sure that the camera is in focus, the lighting conditions are correct, and the camera doesn’t point at a scene that lacks contours, for example, a blank wall. Camera tampering can be used as a condition to trigger actions.

Trigger delay: Enter the minimum time that the tampering conditions must be active before the alarm triggers. This can help prevent false alarms for known conditions that affect the image.

Trigger on dark images: It is very difficult to generate alarms when the camera lens is sprayed, since it is impossible to distinguish that event from other situations where the image turns dark in a similar way, for example, when the lighting conditions change. Turn on this parameter to generate alarms for all cases where the image turns dark. When it’s turned off, the device doesn’t generate any alarm when the image turns dark.

Note

For detection of tampering attempts in static and non-crowded scenes.

Audio detection

These settings are available for each audio input.

Sound level: Adjust the sound level to a value from 0–100, where 0 is the most sensitive and 100 the least sensitive. Use the activity indicator as a guide when you set the sound level. When you create events, you can use the sound level as a condition. You can choose to trigger an action if the sound level rises above, falls below or passes the set value.

Shock detection

Shock detector: Turn on to generate an alarm if the device is hit by an object or if it is tampered with.

Sensitivity level: Move the slider to adjust the sensitivity level at which the device should generate an alarm. A low value means that the device only generates an alarm if the hit is powerful. A high value means that the device generates an alarm even with mild tampering.

Video out

Power settings

Power settings

Delayed shutdown: Turn on if you want to set a delay time before the power turns off.

Delay time: Set a delay time between 1 and 60 minutes.

Power saving mode: Turn on to put the device into power saving mode. When you turn on power saving mode, the IR illumination range reduces.

Set power configuration: Change the power configuration by selecting a different PoE class option. Click Save and restart to save the change.

Note

If you set the power configuration to PoE class 3, we recommend you select Low power profile if your device has that option.

Accessories

I/O ports

Use digital input to connect external devices that can toggle between an open and closed circuit, for example, PIR sensors, door or window contacts, and glass break detectors.

Use digital output to connect external devices such as relays and LEDs. You can activate connected devices through the VAPIX® Application Programming Interface or the web interface.

Port

Name: Edit the text to rename the port.

Direction: indicates that the port is an input port. indicates that it’s an output port. If the port is configurable, you can click the icons to change between input and output.

Normal state: Click for open circuit, and for closed circuit.

Current state: Shows the current state of the port. The input or output is activated when the current state is different from the normal state. An input on the device has an open circuit when it’s disconnected or when there is a voltage above 1 V DC.

Note

During restart, the output circuit is open. When the restart is complete, the circuit goes back to the normal position. If you change any settings on this page, the output circuits go back to their normal positions regardless of any active triggers.

Supervised: Turn on to make it possible to detect and trigger actions if someone tampers with the connection to digital I/O devices. In addition to detecting if an input is open or closed, you can also detect if someone has tampered with it (that is, cut or shorted). To supervise the connection requires additional hardware (end-of-line resistors) in the external I/O loop.

Edge-to-edge

Pairing

Pairing allows you to use a compatible Axis network speaker or microphone as if it’s part of the camera. Once paired, the network speaker acts as an audio out device where you can play audio clips and transmit sound through the camera. The network microphone will take up sounds from the surrounding area and make it available as an audio input device, usable in media streams and recordings.

Important

For this feature to work with a video management software (VMS), you must first pair the camera with the speaker or microphone, then add the camera to your VMS.

Set a 'Wait between actions (hh:mm:ss)' limit in the event rule when you use a network paired audio device in an event rule with 'Audio detection' as condition and 'Play audio clip' as action. This will help you avoid a looping detection if the capturing microphone picks up audio from the speaker.

Address: Enter host name or IP address to the network speaker.

Username: Enter username.

Password: Enter password for the user.

Speaker pairing: Select to pair a network speaker.

Microphone pairing: Select to pair a microphone.

Clear fields: Click to clear all fields.

Connect: Click to establish connection to the speaker or microphone.

Logs

Reports and logs

Reports

  • View the device server report: View information about the product status in a pop-up window. The Access Log is automatically included in the Server Report.

  • Download the device server report: It creates a .zip file that contains a complete server report text file in UTF–8 format, as well as a snapshot of the current live view image. Always include the server report .zip file when you contact support.

  • Download the crash report: Download an archive with detailed information about the server's status. The crash report contains information that is in the server report as well as detailed debug information. This report might contain sensitive information such as network traces. It can take several minutes to generate the report.

Logs

  • View the system log: Click to show information about system events such as device startup, warnings, and critical messages.

  • View the access log: Click to show all failed attempts to access the device, for example, when a wrong login password is used.

Network trace

Important

A network trace file might contain sensitive information, for example certificates or passwords.

A network trace file can help you troubleshoot problems by recording activity on the network.

Trace time: Select the duration of the trace in seconds or minutes, and click Download.

Remote system log

Syslog is a standard for message logging. It allows separation of the software that generates messages, the system that stores them, and the software that reports and analyzes them. Each message is labeled with a facility code, which indicates the software type generating the message, and assigned a severity level.

Server: Click to add a new server.

Host: Enter the hostname or IP address of the server.

Format: Select which syslog message format to use.

  • Axis

  • RFC 3164

  • RFC 5424

Protocol: Select the protocol to use:

  • UDP (Default port is 514)

  • TCP (Default port is 601)

  • TLS (Default port is 6514)

Port: Edit the port number to use a different port.

Severity: Select which messages to send when triggered.

CA certificate set: See the current settings or add a certificate.

Plain config

Plain config is for advanced users with experience of Axis device configuration. Most parameters can be set and edited from this page.

Maintenance

Restart: Restart the device. This does not affect any of the current settings. Running applications restart automatically.

Restore: Return most settings to the factory default values. Afterwards you must reconfigure the device and apps, reinstall any apps that didn’t come preinstalled, and recreate any events and presets.

Important

The only settings saved after restore are:

  • Boot protocol (DHCP or static)
  • Static IP address
  • Default router
  • Subnet mask
  • 802.1X settings
  • O3C settings

Factory default: Return all settings to the factory default values. Afterwards you must reset the IP address to make the device accessible.

Note

All Axis device firmware is digitally signed to ensure that you only install verified firmware on your device. This further increases the overall minimum cybersecurity level of Axis devices. For more information, see the white paper “Signed firmware, secure boot, and security of private keys” at axis.com.

Firmware upgrade: Upgrade to a new firmware version. New firmware releases can contain improved functionality, bug fixes, and completely new features. We recommend you to always use the latest release. To download the latest release, go to axis.com/support.

  • When you upgrade, you can choose between three options:
  • Standard upgrade: Upgrade to the new firmware version.

  • Factory default: Upgrade and return all settings to the factory default values. When you choose this option, you can’t revert to the previous firmware version after the upgrade.

  • Autorollback: Upgrade and confirm the upgrade within the set time. If you don’t confirm, the device reverts to the previous firmware version.

Firmware rollback: Revert to the previously installed firmware version.

Specifications

Product overview

  1. I/O connector
  2. Audio connector
  3. Status LED indicator
  4. Control button
  5. microSD card slot
  6. Network connector
  7. Part number (P/N) & Serial number (S/N)

LED Indicators

Status LEDIndication
Unlit

Connection and normal operation.

Green

Steady green for 10 seconds for normal operation after startup completed.

Amber

Steady during startup. Flashes during firmware upgrade or reset to factory default.

Amber/Red

Flashes amber/red if network connection is unavailable or lost.

Red

Firmware upgrade failure.

SD card slot

NOTICE
  • Risk of damage to SD card. Don’t use sharp tools, metal objects, or excessive force when inserting or removing the SD card. Use your fingers to insert and remove the card.
  • Risk of data loss and corrupted recordings. Unmount the SD card from the device’s web interface before removing it. Don’t remove the SD card while the product is running.

This device supports microSD/microSDHC/microSDXC cards.

For SD card recommendations, see axis.com.

microSD, microSDHC, and microSDXC Logos are trademarks of SD-3C LLC. microSD, microSDHC, microSDXC are trademarks or registered trademarks of SD-3C, LLC in the United States, other countries or both.

Buttons

Control button

Connectors

Network connector

RJ45 Ethernet connector with Power over Ethernet (PoE).

Audio connector

  • Audio in – 3.5 mm input for a mono microphone, or a line-in mono signal (left channel is used from a stereo signal).

Audio input

1 Tip2 Ring3 Sleeve

Unbalanced microphone (with or without electret power) or line

Electret power if selected

Ground

I/O connector

Use the I/O connector with external devices in combination with, for example, motion detection, event triggering, and alarm notifications. In addition to the 0 V DC reference point and power (12 V DC output), the I/O connector provides the interface to:

Digital input –
For connecting devices that can toggle between an open and closed circuit, for example PIR sensors, door/window contacts, and glass break detectors.
Digital output –
For connecting external devices such as relays and LEDs. Connected devices can be activated by the VAPIX® Application Programming Interface, through an event or from the device’s web interface.

4-pin terminal block

Example
  1. DC ground
  2. DC output 12 V, max 25 mA
  3. Digital input
  4. Digital output

Cleaning recommendations

Troubleshooting

Unknown vehicles are marked as accepted

If the application lets in vehicles with license plates that are not in the allowlist, one probable reason is that the comparison allows a deviation of one character.
For example, if AXI S1234 is in the allowlist the application accepts AXI SI234.
Similarly, if AXIS 1234 is in the allowlist the application accepts AXI 1234.

Go to Additional settings to set the characters allowed.

The connection between the application and controller or relay module doesn’t work

Make sure the controller, or relay module, allows data traffic through HTTP. To find out how to change this setting, go to the user manual for the corresponding device.

For users of AXIS Camera Station

Set up AXIS License Plate Verifier

When a device is configured with AXIS License Plate Verifier, it is considered as an external data source in AXIS Camera Station. You can connect a view to the data source, search for the license plates that are captured by the device, and view the related image.

Note
  • It requires AXIS Camera Station 5.38 or later.
  • AXIS License Plate Verifier requires a license.
  1. Download and install the application on your device.

  2. Configure the application. See AXIS License Plate Verifier user manual.

  3. For an existing AXIS Camera Station installation, renew your server certificate that is used to communicate with the client. See Certificate renewal.

  4. Turn on time synchronization to use the AXIS Camera Station server as the NTP server. See Server settings.

  5. Add the device to AXIS Camera Station. See Add devices.

  6. When the first event is received, a data source is automatically added under Configuration > Devices > External data sources.

  7. Connect the data source to a view. See External data sources.

  8. Search for license plates that are captured by the device. See Data search.

  9. Click to export the search results to a .txt file.

Technical issues, clues, and solutions

If you can’t find what you’re looking for here, try the troubleshooting section at axis.com/support.

Problems upgrading the firmware

Firmware upgrade failure

If the firmware upgrade fails, the device reloads the previous firmware. The most common reason is that the wrong firmware file has been uploaded. Check that the name of the firmware file corresponds to your device and try again.

Problems after firmware upgrade

If you experience problems after a firmware upgrade, roll back to the previously installed version from the Maintenance page.

Problems setting the IP address

The device is located on a different subnet

If the IP address intended for the device and the IP address of the computer used to access the device are located on different subnets, you cannot set the IP address. Contact your network administrator to obtain an IP address.

The IP address is being used by another device

Disconnect the Axis device from the network. Run the ping command (in a Command/DOS window, type ping and the IP address of the device):

  • If you receive: Reply from <IP address>: bytes=32; time=10... this means that the IP address may already be in use by another device on the network. Obtain a new IP address from the network administrator and reinstall the device.

  • If you receive: Request timed out, this means that the IP address is available for use with the Axis device. Check all cabling and reinstall the device.

Possible IP address conflict with another device on the same subnet

The static IP address in the Axis device is used before the DHCP server sets a dynamic address. This means that if the same default static IP address is also used by another device, there may be problems accessing the device.

The device can’t be accessed from a browser

Can’t log in

When HTTPS is enabled, ensure that the correct protocol (HTTP or HTTPS) is used when attempting to log in. You may need to manually type http or https in the browser’s address field.

If the password for the root account is lost, the device must be reset to the factory default settings. See Reset to factory default settings.

The IP address has been changed by DHCP

IP addresses obtained from a DHCP server are dynamic and may change. If the IP address has been changed, use AXIS IP Utility or AXIS Device Manager to locate the device on the network. Identify the device using its model or serial number, or by the DNS name (if the name has been configured).

If required, a static IP address can be assigned manually. For instructions, go to axis.com/support.

Certificate error when using IEEE 802.1X

For authentication to work properly, the date and time settings in the Axis device must be synchronized with an NTP server. Go to System > Date and time.

The device is accessible locally but not externally

To access the device externally, we recommend you to use one of the following applications for Windows®:

  • AXIS Companion: free of charge, ideal for small systems with basic surveillance needs.

  • AXIS Camera Station: 30-day trial version free of charge, ideal for small to mid-size systems.

For instructions and download, go to axis.com/vms.

Problems with streaming

Multicast H.264 only accessible by local clients

Check if your router supports multicasting, or if you need to configure the router settings between the client and the device. You might need to increase the TTL (Time To Live) value.

No multicast H.264 displayed in the client

Check with your network administrator that the multicast addresses used by the Axis device are valid for your network.

Check with your network administrator to see if there is a firewall that prevents viewing.

Poor rendering of H.264 images

Ensure that your graphics card uses the latest driver. You can usually download the latest drivers from the manufacturer’s website.

Color saturation is different in H.264 and Motion JPEG

Modify the settings for your graphics adapter. Go to the adapter’s documentation for more information.

Lower frame rate than expected

  • See Performance considerations.

  • Reduce the number of applications running on the client computer.

  • Limit the number of simultaneous viewers.

  • Check with the network administrator that there is enough bandwidth available.

  • Lower the image resolution.

  • The maximum frames per second is dependent on the utility frequency (60/50 Hz) of the Axis device.

Can’t connect over port 8883 with MQTT over SSL

The firewall blocks traffic using port 8883 as it’s deemed insecure.

In some cases the server/broker might not provide a specific port for MQTT communication. It may still be possible to use MQTT over a port normally used for HTTP/HTTPS traffic.

  • If the server/broker supports WebSocket/WebSocket Secure (WS/WSS), typically on port 443, use this protocol instead. Check with the server/broker provider to see if WS/WSS is supported and which port and basepath to use.

  • If the server/broker supports ALPN, the use of MQTT can be negotiated over an open port, such as 443. Check with your server/broker provider to see if ALPN is supported and which ALPN protocol and port to use.

Reset to factory default settings

Important

Reset to factory default should be used with caution. A reset to factory default resets all settings, including the IP address, to the factory default values.

Note

The camera has been preconfigured with AXIS License Plate Verifier. If you reset to factory default, you need to reinstall the license key. See Install the application.

To reset the product to the factory default settings:

  1. Disconnect power from the product.

  2. Press and hold the control button while reconnecting power. See Product overview.

  3. Keep the control button pressed for 15–30 seconds until the status LED indicator flashes amber.

  4. Release the control button. The process is complete when the status LED indicator turns green. The product has been reset to the factory default settings. If no DHCP server is available on the network, the default IP address is 192.168.0.90.

  5. Use the installation and management software tools to assign an IP address, set the password, and access the device.

    The installation and management software tools are available from the support pages on axis.com/support.

You can also reset parameters to factory default through the device’s web interface. Go to Maintenance > Factory default and click Default.

Upgrade the firmware

Important
  • Preconfigured and customized settings are saved when you upgrade the firmware (provided that the features are available in the new firmware) although this is not guaranteed by Axis Communications AB.
  • Make sure the device remains connected to the power source throughout the upgrade process.
Note

When you upgrade the device with the latest firmware in the active track, the product receives the latest functionality available. Always read the upgrade instructions and release notes available with each new release before you upgrade the firmware. To find the latest firmware and the release notes, go to axis.com/support/device-software.

  1. Download the firmware file to your computer, available free of charge at axis.com/support/device-software.

  2. Log in to the device as an administrator.

  3. Go to Maintenance > Firmware upgrade and click Upgrade.

  4. When the upgrade has finished, the product restarts automatically.

You can use AXIS Device Manager to upgrade multiple devices at the same time. Find out more at axis.com/products/axis-device-manager.

Performance considerations

When setting up your system, it is important to consider how various settings and situations affect the performance. Some factors affect the amount of bandwidth (the bitrate) required, others can affect the frame rate, and some affect both. If the load on the CPU reaches its maximum, this also affects the frame rate.

The following factors are the most important to consider:

  • High image resolution or lower compression levels result in images containing more data which in turn affects the bandwidth.

  • Rotating the image in the GUI can increase the product's CPU load.

  • Access by large numbers of Motion JPEG or unicast H.264 clients affects the bandwidth.

  • Simultaneous viewing of different streams (resolution, compression) by different clients affects both frame rate and bandwidth.

    Use identical streams wherever possible to maintain a high frame rate. Stream profiles can be used to ensure that streams are identical.

  • Accessing Motion JPEG and H.264 video streams simultaneously affects both frame rate and bandwidth.

  • Heavy usage of event settings affects the product’s CPU load which in turn affects the frame rate.

  • Using HTTPS may reduce frame rate, in particular if streaming Motion JPEG.

  • Heavy network utilization due to poor infrastructure affects the bandwidth.

  • Viewing on poorly performing client computers lowers perceived performance and affects frame rate.

  • Running multiple AXIS Camera Application Platform (ACAP) applications simultaneously may affect the frame rate and the general performance.