Merge pull request #111 from AxisCommunications/sync-20231120-1

sync 20231120 1

Author: pataxis

.github/workflows/manifest-schemas.yml

@@ -0,0 +1,32 @@
+name: Check manifest schemas format and release notes
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'docs/develop/manifest-schemas/*'
+      - '.github/workflows/manifest-schemas.yml'
+
+jobs:
+  manifest-schemas-release-notes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check manifest schemas format and release notes
+        run: |
+          base_path=docs/develop/manifest-schemas
+          release_notes_page=$base_path/index.md
+          new_schema_dummy_description=ADD-MANIFEST-SCHEMA-RELEASE-DESCRIPTION
+          ret=0
+
+          # Set +e to not having to handle the grep exit status
+          new_schema_found=$(grep "$new_schema_dummy_description" $release_notes_page || :)
+          [ -z "$new_schema_found" ] || {
+              printf '\n%s\n%s\n%s\n%s\n\n' \
+                "### One or more new manifest schemas found" \
+                "In file '$release_notes_page', replace string $new_schema_dummy_description" \
+                "with release notes." \
+                "Contact the responsible for the manifest schema update for information of the content of the new release."
+              ret=1
+          }
+          exit $ret

docs/api/_setup_apidocs.sh

@@ -111,7 +111,7 @@ replace_acap3_button() {
 #-------------------------------------------------------------------------------
 
 # Release settings
-apis="axevent axoverlay larod licensekey vdostream"
+apis="axevent axoverlay axserialport axstorage larod licensekey vdostream"
 
 # Version strings
 apiver_minor="${apiver#*.}"

docs/api/native-sdk-api.md

@@ -15,8 +15,10 @@ The ACAP Native SDK provides the following APIs:
 - [Cairo](#cairo)
 - [OpenCL](#opencl)
 - [Event API](#event-api)
+- [Edge storage API](#edge-storage-api)
 - [License Key API](#license-key-api)
 - [FastCGI](#fastcgi)
+- [Serial port API](#serial-port-api)
 
 ## Compatibility
 
@@ -238,6 +240,40 @@ The Axevent API was introduced in Native SDK 1.0.
 - [subscribe_to_events](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/axevent/subscribe_to_events)
   - The example code is written in C which subscribes to different predefined events.
 
+## Edge storage API
+
+Go to the [ACAP API Documentation](src/api/axstorage/html/index.html) for detailed functional descriptions of this API.
+
+The Edge storage API allows the application to save and retrieve data on mounted storage devices such as SD cards and NAS (Network Attached Storage) units. An application can only modify its own files on the storage device.
+An application can both send and receive events.
+
+### Compatibility
+
+The API supports products with the following chips:
+
+- ARTPEC-8
+- ARTPEC-7
+- ARTPEC-6
+- Ambarella CV25
+- Ambarella S5L
+- Ambarella S5
+- i.MX 6SoloX
+- i.MX 6ULL
+
+### Version history
+
+The Edge storage API was introduced in Native SDK 1.11.
+
+### Code Examples
+
+- [axstorage](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/axstorage)
+  - This application demonstrates the usage of axstorage APIs, offering the following functionality:
+    - List configured storage devices.
+    - Subscribe to events from all storage devices.
+    - Set up and utilize all available/mounted storage devices.
+    - Continuously write data to two files on all available storage devices.
+    - Automatically release any unmounted storage devices.
+
 ## License Key API
 
 Go to the [ACAP API Documentation](src/api/licensekey/html/index.html) for detailed functional descriptions of this API.
@@ -293,3 +329,32 @@ The FastCGI API was introduced in Native SDK 1.6.
 
 - [web-server-using-fastcgi](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/web-server-using-fastcgi)
   - This example is written in C and explains how to build an ACAP application that can handle HTTP requests sent to the Axis device, using the device's own web server and FastCGI.
+
+## Serial port API
+
+Go to the [ACAP API Documentation](src/api/axserialport/html/index.html) for detailed functional descriptions of this API.
+
+The Serial port API allows the application to configure and control the external serial port on selected Axis products.
+
+### Compatibility
+
+- The API supports the following standards:
+  - RS-232
+  - RS-422
+  - RS-485
+- The API is product dependent since not all Axis products are equipped with a serial port.
+- The API supports products with the following chips:
+  - ARTPEC-8
+  - ARTPEC-7
+
+### Version history
+
+The Serial port API was introduced in Native SDK 1.11.
+
+### Code Examples
+
+- [axserialport](https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/axserialport)
+  - This example details the creation of an ACAP application utilizing the axserialport API, showcasing the following actions:
+    - Enabling the serial port.
+    - Configuring parameters using the API.
+    - Establishing communication between two available ports in the Axis product using GLib IOChannel methods.

docs/api/src/api/axserialport/example_pelco-D/LICENSE

@@ -0,0 +1 @@
+Third Party Software Licenses

docs/api/src/api/axserialport/example_pelco-D/Makefile

@@ -0,0 +1,33 @@
+AXIS_USABLE_LIBS = UCLIBC GLIBC
+include $(AXIS_TOP_DIR)/tools/build/rules/common.mak
+
+PROG = axserialport_pelco_spectra_mini
+OBJS = $(PROG).o
+PKGS = glib-2.0
+
+CFLAGS += $(shell PKG_CONFIG_PATH=$(PKG_CONFIG_PATH) pkg-config --cflags $(PKGS))
+CFLAGS += -I../library
+CFLAGS += -Wall -O2
+
+LDFLAGS += -L../library
+LDLIBS  += $(shell PKG_CONFIG_PATH=$(PKG_CONFIG_PATH) pkg-config --libs $(PKGS))
+LDLIBS  += -laxserialport
+
+all:	$(PROG)
+
+$(PROG): $(OBJS)
+	$(CC) $^ $(LIBS) $(LDLIBS) $(LDFLAGS) -lgthread-2.0 -o $@
+	$(STRIP) $@
+
+cflags:
+	$(info $(CFLAGS))
+
+ldlibs:
+	$(info $(LDLIBS))
+
+ldflags:
+	$(info $(LDFLAGS))
+
+clean:
+	rm -f $(PROG) *.o core
+

docs/api/src/api/axserialport/example_pelco-D/README

@@ -0,0 +1,4 @@
+This code demonstrates how to use serial port API (axserialport)
+to control a Pelco Spectra mini PTZ camera connected to the serial port.
+
+Check the SDK documentation for more information about the serial port API.