Skip to content

Latest commit

 

History

History
 
 

licensekey

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
app
app
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 

README.md

Copyright (C) 2021, Axis Communications AB, Lund, Sweden. All Rights Reserved.

A licensekey handler based ACAP application on an edge device

This README file explains how to build an ACAP application that uses the licensekey API.

Together with this README file, you should be able to find a directory called app. That directory contains the application source code which can easily be compiled and run with the help of the tools and step by step below.

This example illustrates how to check the license key status. A license key is a signed file which has been generated for a specific device ID and application ID. The ACAP Service Portal is maintaining both license keys and application IDs.

License key status i.e. valid or invalid is logged in the Application log.

Getting started

These instructions will guide you on how to execute the code. Below is the structure and scripts used in the example:

licensekey
├── app
│   ├── LICENSE
│   ├── licensekey_handler.c
│   ├── Makefile
│   └── manifest.json
├── Dockerfile
└── README.md
  • app/LICENSE - Text file which lists all open source licensed source code distributed with the application.
  • app/licensekey_handler.c - Application to check licensekey status in C.
  • app/Makefile - Build and link instructions for the application.
  • app/manifest.json - Defines the application and its configuration.
  • Dockerfile - Assembles an image containing the ACAP Native SDK and builds the application using it.
  • README.md - Step by step instructions on how to run the example.

How to run the code

Below is the step by step instructions on how to execute the program. So basically starting with the generation of the .eap file to running it on a device:

Build the application

Standing in your working directory run the following commands:

Note

Depending on the network your local build machine is connected to, you may need to add proxy settings for Docker. See Proxy in build time.

docker build --platform=linux/amd64 --tag <APP_IMAGE> .

<APP_IMAGE> is the name to tag the image with, e.g., licensekey-handler:1.0

Default architecture is armv7hf. To build for aarch64 it's possible to update the ARCH variable in the Dockerfile or to set it in the docker build command via build argument:

docker build --platform=linux/amd64 --build-arg ARCH=aarch64 --tag <APP_IMAGE> .

Copy the result from the container image to a local directory build:

docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build

The working dir now contains a build folder with the following files:

licensekey
├── app
│   ├── LICENSE
│   ├── licensekey_handler.c
│   ├── Makefile
│   └── manifest.json
├── build
│   ├── LICENSE
│   ├── licensekey_handler*
│   ├── licensekey_handler_1_0_0_armv7hf.eap
│   ├── licensekey_handler_1_0_0_LICENSE.txt
│   ├── licensekey_handler.c
│   ├── Makefile
│   ├── manifest.json
│   ├── package.conf
│   ├── package.conf.orig
│   └── param.conf
├── Dockerfile
└── README.md
  • build/licensekey_handler* - Application executable binary file.
  • build/licensekey_handler_1_0_0_armv7hf.eap - Application package .eap file.
  • build/licensekey_handler_1_0_0_LICENSE.txt - Copy of LICENSE file.
  • build/manifest.json - Defines the application and its configuration.
  • build/package.conf.orig - Defines the application and its configuration, original file.
  • build/param.conf - File containing application parameters.

Note

For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: Build, install, and run.

Install and start the application

Browse to the application page of the Axis device:

http://<AXIS_DEVICE_IP>/index.html#apps

  1. Click on the tab Apps in the device GUI

  2. Enable Allow unsigned apps toggle

  3. Click (+ Add app) button to upload the application file

  4. Select the newly built application package, depending on architecture:

    • licensekey_handler_1_0_0_aarch64.eap
    • licensekey_handler_1_0_0_armv7hf.eap

  5. Click Install

  6. Run the application by enabling the Start switch

The expected output

Application log can be found directly at:

http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi?appname=licensekey_handler

or by clicking on the "App log" link in the device GUI.

----- Contents of SYSTEM_LOG for 'licensekey_handler' -----


10:26:42.499 [ INFO ] licensekey_handler[0]: starting licensekey_handler
10:26:42.539 [ INFO ] licensekey_handler[14660]: Licensekey is invalid
10:31:43.058 [ INFO ] licensekey_handler[14660]: Licensekey is invalid

A valid license key for a registered application ID is only accessible through ACAP Service Portal.

Support for installing license key though device web page is available, if acapPackageConf.copyProtection.method is set to "axis" in the manifest.json file, by the following steps:

Goto your device web page above > Click on the tab Apps in the device GUI > Click on the installed licensekey_handler application > Install the license with the Install button in the Activate the license part

More instructions how to install a valid license key is found on Axis Developer Community.

License

Apache License 2.0