Skip to content

Latest commit

 

History

History
98 lines (71 loc) · 4.08 KB

DEV.md

File metadata and controls

98 lines (71 loc) · 4.08 KB

ACAP application developer topics

This page is a collection of common topics related to ACAP application development.

Table of contents

Access the device

To log in to an Axis device shell to perform command-line options, SSH is used. Instructions to set up SSH and how to log in to shell are found in the ACAP documentation section Access the device through SSH.

Developer Mode

Developer Mode is a feature introduced in AXIS OS 11.11 that grants SSH access to an ACAP application's dynamic user on an Axis device. When Developer Mode is enabled, the ACAP application's dynamic user is added to the ssh group.

To enable Developer Mode on Axis devices running AXIS OS 11.11 or later, install the axis-unlock-acap-devmode Custom Firmware Certificate (CFC) on the Axis device.

For detailed instructions on how to obtain and install the CFC, as well as how to verify and disable Developer Mode, please refer to the Developer Mode section in the ACAP documentation.

Logs and reports

There are different types of logs and reports that are of interest for an ACAP application.

Access the system log

The system log can be accessed,

  • from a web browser by going to http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi.

  • by making a call to VAPIX API systemlog.cgi.

    curl --anyauth -u <username>:<password> http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi

Access the application log

The application log is a subset of the system log that filter on entries from the ACAP application.

For an application with application name hello_world (set in manifest.json field acapPackageConf.setup.appName), the application log can be accessed,

  • from a web browser by going to http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi?appname=hello_world.

  • by making a call to VAPIX API systemlog.cgi and filter on application name.

    curl --anyauth -u <username>:<password> http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi?appname=hello_world

Access the server report

The system report can be accessed,

  • from a web browser by going to http://<AXIS_DEVICE_IP>/axis-cgi/serverreport.cgi.

  • by making a call to VAPIX API serverreport.cgi.

    curl --anyauth -u <username>:<password> http://<AXIS_DEVICE_IP>/axis-cgi/serverreport.cgi

Proxy

To develop or run ACAP applications from inside a network with proxy, additional configuration is needed. More information about proxy and instructions on how to configure are available in the ACAP documentation Proxy page, or specifically in the Proxy in build time and Proxy in runtime sections.