Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit ef82fad

Browse files
author
Angelo Delli Santi
authored
Release notes 4.13 (#261)
1 parent c8c0228 commit ef82fad

File tree

3 files changed

+182
-12
lines changed

3 files changed

+182
-12
lines changed

docs/acap-sdk-version-3/develop-applications/vapix-access-for-acap-applications.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
layout: acap_sdk_version_3
33
parent: Develop applications
44
grand_parent: ACAP SDK version 3
5-
title: VAPIX access for ACAP applications - BETA
5+
title: VAPIX access for ACAP applications
66
nav_order: 4
77
---
8-
# VAPIX access for ACAP applications - BETA
8+
# VAPIX access for ACAP applications
99

1010
From AXIS OS 11.6, ACAP applications can acquire VAPIX service account credentials in runtime. With these credentials, the ACAP application can call a local virtual host to make VAPIX requests on the device. A username and a password with high complexity are created for every credential acquisition. These credentials are only valid on the local virtual host (127.0.0.12) and aren't stored in any file. It should only be kept in memory by the ACAP application.
11+
You can jump to the [Vapix](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/vapix) example or follow this guide for a more detailed walkthrough.
1112

1213
The following steps show how to get VAPIX credentials in an ACAP application.
1314

docs/axis-devices-and-compatibility/index.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,22 +73,31 @@ guide](https://www.axis.com/developer-community/product-interface-guide).
7373
Choose the appropriate SDK version based on what AXIS OS version you want
7474
supporting your ACAP application.
7575

76+
How do I know if my device supports a specific AXIS OS version? Please check
77+
the web page for download of [device software](https://www.axis.com/support/device-software).
78+
79+
> **Device Software** has previously been named **firmware**.
80+
81+
### ACAP Computer Vision SDK software compatibility
82+
7683
The **Image version** referred to in the
7784
table below is the Docker image release tag available from Docker Hub:
7885

79-
- [ACAP Native SDK](https://hub.docker.com/r/axisecp/acap-native-sdk/tags)
8086
- [ACAP Computer Vision SDK](https://hub.docker.com/r/axisecp/acap-computer-vision-sdk/tags)
8187

82-
The tag format is **`<image-version>-<architecture>-<container-distribution>`**.
83-
An example of a tag is `acap-native-sdk:1.5-aarch64-ubuntu22.04` where `1.5`
84-
maps to the image version.
88+
The tag format is `<image-version>-<architecture>-<sdk_type>`.
89+
In the tag examples below, `1.5` maps to the image version.
8590

86-
ACAP Release | ACAP Native SDK Image version<br>ACAP CV SDK Image version | Compatible with AXIS OS version
91+
- `axisecp/acap-computer-vision-sdk:1.5-aarch64`
92+
- `axisecp/acap-computer-vision-sdk:1.5-aarch64-devel`
93+
- `axisecp/acap-computer-vision-sdk:1.5-aarch64-runtime`
94+
95+
ACAP Release | ACAP CV SDK Image version | Compatible with AXIS OS version
8796
:------------| :---------------------------- | :-------------------------------------------
8897
4.0 | 1.0 | 10.7 and later
8998
4.1 | 1.1 | 10.9 and later
9099
4.2 | 1.2 | 10.10 and later
91-
4.3 | 1.3 | 10.12 and later
100+
4.3 | 1.3 | 10.12 (LTS)
92101
4.4 | 1.4 | 11.0 and later
93102
4.5 | 1.5 | 11.1 and later
94103
4.6 | 1.6 | 11.2 and later
@@ -97,11 +106,38 @@ ACAP Release | ACAP Native SDK Image version<br>ACAP CV SDK Image version | Comp
97106
4.9 | 1.9 | 11.5 and later
98107
4.10 | 1.10 | 11.6 and later
99108
4.11 | 1.11 | 11.7 and later
100-
4.12 | 1.12 | 11.8 and later
109+
4.12 | 1.12 | 11.8
101110

102-
How do I know if my device supports a specific AXIS OS version? Please check
103-
[firmware releases for supported
104-
products](https://www.axis.com/support/firmware).
111+
### ACAP Native SDK software compatibility
112+
113+
The **Image version** referred to in the
114+
table below is the Docker image release tag available from Docker Hub:
115+
116+
- [ACAP Native SDK](https://hub.docker.com/r/axisecp/acap-native-sdk/tags)
117+
118+
The tag format is `<image-version>-<architecture>-<container-distribution>`.
119+
An example of a tag is
120+
121+
- `axisecp/acap-native-sdk:1.5-aarch64-ubuntu22.04`
122+
123+
where `1.5` maps to the image version.
124+
125+
ACAP Release | ACAP Native SDK Image version | Compatible with AXIS OS version
126+
:------------| :---------------------------- | :-------------------------------------------
127+
4.0 | 1.0 | 10.7 and later until LTS
128+
4.1 | 1.1 | 10.9 and later until LTS
129+
4.2 | 1.2 | 10.10 and later until LTS
130+
4.3 | 1.3 | 10.12 (LTS)
131+
4.4 | 1.4 | 11.0 and later until LTS
132+
4.5 | 1.5 | 11.1 and later until LTS
133+
4.6 | 1.6 | 11.2 and later until LTS
134+
4.7 | 1.7 | 11.3 and later until LTS
135+
4.8 | 1.8 | 11.4 and later until LTS
136+
4.9 | 1.9 | 11.5 and later until LTS
137+
4.10 | 1.10 | 11.6 and later until LTS
138+
4.11 | 1.11 | 11.7 and later until LTS
139+
4.12 | 1.12 | 11.8 and later until LTS
140+
4.13 | 1.13 | 11.9 and later until LTS
105141

106142
## Forward compatibility
107143

docs/release-notes/4.13.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
layout: page
3+
parent: Release notes
4+
title: "4.13"
5+
nav_order: 15
6+
---
7+
8+
# ACAP version 4.13 – March 4, 2024
9+
10+
> **ACAP Computer Vision SDK delay**
11+
>
12+
> In AXIS OS 11.9 ACAP Computer Vision SDK applications built with ACAP
13+
> Computer Vision SDK 1.12 or earlier and has a dependency on library
14+
> libvdostream.so, directly or indirectly, as the setup in various
15+
> [acap-computer-vision-sdk-examples](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples)
16+
> instruct, will get a runtime error. This despite having run on AXIS OS 11.8
17+
> and earlier. An update of such an application will be required.
18+
>
19+
> An updated ACAP Computer Vision SDK is currently being worked on and more
20+
> information will come.
21+
22+
## Overview
23+
24+
The release contains:
25+
26+
- [ACAP Native SDK 1.13](#acap-native-sdk)
27+
- [Docker Compose ACAP 1.3.1](https://github.com/AxisCommunications/docker-compose-acap/tree/1.3.1)
28+
([Release notes](https://github.com/AxisCommunications/docker-compose-acap/releases/tag/1.3.1))
29+
30+
Code examples:
31+
32+
- [Code examples ACAP Native SDK v1.13](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/v1.13)
33+
([Release notes](https://github.com/AxisCommunications/acap-native-sdk-examples/releases/tag/v1.13))
34+
35+
Device Software:
36+
37+
- Minimum [AXIS OS](https://www.axis.com/support/device-software) version: 11.9
38+
39+
### New features
40+
41+
- Manifest schema [1.6.0](../develop/manifest-schemas/schema-field-descriptions-v1.6.0):
42+
- Add support for characters `$` and `\` in `apiPath` of the reverse proxy
43+
configuration.
44+
45+
```json
46+
"acapPackageConf": {
47+
"configuration": {
48+
"reverseProxy": [
49+
{
50+
"apiPath": "config/.+\\.cgi$",
51+
"target": "http://localhost:4567",
52+
"access": "admin"
53+
}
54+
]
55+
}
56+
}
57+
```
58+
59+
- Add optional field `$schema` that can point out a manifest schema to use
60+
for manifest validation and auto-completion. See how this can be done in
61+
[Setting up Visual Studio Code](../develop/setting-up-visual-studio-code.md#manifest-validation).
62+
- Allow strings in `requiredMethods` and `conditionalMethods` under `dbus` to contain `-`.
63+
64+
```json
65+
"resources": {
66+
"dbus": {
67+
"requiredMethods": [
68+
"com.axis.policykit-cert.certset.getpath"
69+
],
70+
"conditionalMethods": [
71+
"com.axis.policykit-cert.*"
72+
]
73+
}
74+
}
75+
```
76+
77+
### New tutorials and documentation
78+
79+
- A guide on how to create a Yolov5 model for Artpec-8 have been added to the [Axis model zoo](https://github.com/AxisCommunications/axis-model-zoo/blob/main/docs/yolov5-on-artpec8.md) repository.
80+
- Examples of object detection models have been added to the [Axis model zoo](https://github.com/AxisCommunications/axis-model-zoo)
81+
- A new section [User and group](../develop/application-project-structure#user-and-group) has been added to the documentation and explains **dynamic users** which is the recommended user to use.
82+
- A new section [Computer vision on device](../computer-vision-on-device/) has been added to the documentation, giving more insight into the computer vision capabilities and nuances of different Axis devices.
83+
84+
### Updates
85+
86+
## ACAP Native SDK
87+
88+
Supported architectures:
89+
90+
- armv7hf and aarch64, see [images on Docker Hub](https://hub.docker.com/r/axisecp/acap-native-sdk)
91+
92+
### Compatibility
93+
94+
Supported products:
95+
96+
- All products with chipsets: ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L and S5.
97+
98+
See also [compatibility information](../axis-devices-and-compatibility).
99+
100+
### Fixes
101+
102+
- A bug found in AXIS OS 11.8 where VAPIX APIs with anonymous access couldn't
103+
be accessed from an ACAP application has been fixed in AXIS OS 11.9.
104+
105+
### Updates
106+
107+
- The following APIs have been added to the ACAP Native SDK:
108+
- [Axparameter API](../api/native-sdk-api.md#axparameter-api) - Allows the application to save data and application settings so that they are not lost during a restart or software upgrade of the Axis product.
109+
- [Metadata Broker API](../api/native-sdk-api.md#metadata-broker-api) - Allows the application to consume metadata from another ACAP application running on the same device.
110+
- The feature [VAPIX access for ACAP applications](../develop/VAPIX-access-for-ACAP-applications) has two updates:
111+
- The D-Bus API moved from **Beta** to **General Availability (GA)** and is from AXIS OS 11.9 considered stable.
112+
- An example called [vapix](https://github.com/AxisCommunications/acap-native-sdk-examples/vapix) has been added to acap-native-sdk-examples. The example retrieves VAPIX credentials over D-Bus and makes calls to an VAPIX API.
113+
114+
### APIs supported in this release
115+
116+
API | Chip
117+
:-- | :--
118+
Video capture API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, S5L, S5
119+
Machine learning API | ARTPEC-8, ARTPEC-7, CV25, S5L
120+
Overlay API | ARTPEC-8, ARTPEC-7, ARTPEC-6
121+
Cairo | ARTPEC-8, ARTPEC-7, ARTPEC-6
122+
OpenCL | ARTPEC-8, ARTPEC-7
123+
Event API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5
124+
License Key API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5
125+
FastCGI | ARTPEC-8, ARTPEC-7, CV25, i.MX 6SoloX, i.MX 6ULL
126+
Edge storage API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5
127+
Serial port API | ARTPEC-8, ARTPEC-7
128+
Axparameter API | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5
129+
Metadata Broker API | ARTPEC-8, ARTPEC-7, CV25
130+
131+
Special API | Chip
132+
:-- | :--
133+
VAPIX APIs | ARTPEC-8, ARTPEC-7, ARTPEC-6, CV25, i.MX 6SoloX, i.MX 6ULL, S5L, S5

0 commit comments

Comments
 (0)