About

Goxis is a library designed to facilitate the development of ACAP (Axis Camera Application Platform) applications for AXIS cameras.

This library includes user-friendly wrappers for most APIs provided by the native SDK.

C-API Wrappers

Goxis organizes its functionality around several key areas of the native SDK, each encapsulated within its own package for ease of use:

• axevent - Event API for managing camera events.
• axoverlay - Overlay API, including support for Cairo, for drawing over video feeds.
• axparameter - Parameter API for managing camera parameters.
• axstorage - Edge Storage API for accessing and managing on-camera storage.
• axvdo - Video Capture API for handling video streams.
• axlarod - Larod API
• axlicense - License Key API for managing application licenses.
• axsyslog - Syslog for logging and diagnostics.

Additional Packages

Beyond the core API wrappers, Goxis also provides several additional packages designed to speed up the development process and enhance application capabilities:

• acapapp - Offers a high-level abstraction for quick and efficient ACAP application development.
• axmanifest - Aids in loading and parsing manifest files, simplifying application configuration and setup.
• dbus - Provides helpers for interacting with the D-Bus interface, including retrieving VAPIX credentials.
• vapix - Facilitates the use of the VAPIX API for interacting with camera functionalities.
• glib - Includes helpers for working with GLib, such as managing the main event loop.

Prerequisites

• Docker for building the ACAP applications
• goxisbuilder

Quickstart

go install github.com/Cacsjep/goxisbuilder@latest
goxisbuilder.exe -newapp

Examples

Located at this repo Examples

Module Installation

go get -u github.com/Cacsjep/goxis@latest

Whats the purpose of goxis AcapApplication?

The AcapApplication acts as a foundational abstraction layer designed to streamline the handling of common tasks such as syslog logging, managing the GObject main loop, and the manipulation of parameters and events.

Upon instantiation, AcapApplication undertakes several crucial steps::

• Manifest Parsing: It reads the manifest file to extract the application's name.
• Parameter Management: Initializes an axparameter instance, enabling the application to get, set, and remove parameters efficiently.
• Event Handling: Sets up an axevent handler to facilitate event processing.
• GMain Loop Preparation: Configures a GMain loop complete with signal handlers, ensuring robust event management.

AcapApplication offers access to a variety of powerful functionalities, such as::

• FrameProvider: Facilitates easy interaction with axvdo, streamlining video-related operations.
• OverlayProvide: Facilitates easy interaction with axoverlay related operations.
• StorageProvider: Offers straightforward access to the camera's storage, enhancing data management capabilities.
• app.IsLicenseValid(major_version int, minor_version int): Verifies the validity of the application's license for the specified version.
• app.Run(): Activates the GMain loop within the application, allowing for continuous operation.
• app.GetSnapshot(video_channel int): Captures and retrieves a JPEG snapshot from a given video channel.

and more ....

Create a new goxis application

Just use goxisbuilder tool for streamlined builds.

.\goxisbuilder.exe -newapp

Events

Most events are already declared in axevent. If you miss something, you can manually craft it, create a PR, or just ask! 😊 You can use the AXIS get_eventlist.py script (Native SDK Repo - AXIS) to get the XML list to see events that your device supports.

Tip

Use AXIS Meta Data Monitor to validate and determine if the desired event is triggered.

Namespace Considerations

It is crucial to set the correct namespace for each topic. Incorrect namespaces can cause issues in axevent C API mapping. Check carefully if multiple namespaces are involved, and ensure the correct setup.

Single Namespace Example: tnsaxis:CameraApplicationPlatform/ObjectAnalytics/xinternal_data

When there is only one namespace for all entries, ensure consistency across all topics. In this example, all entries use OnfivNameSpaceTnsAxis:

  NewTopicKeyValueEntrie("topic0", &OnfivNameSpaceTnsAxis, "CameraApplicationPlatform"),
  NewTopicKeyValueEntrie("topic1", &OnfivNameSpaceTnsAxis, "ObjectAnalytics"),
  NewTopicKeyValueEntrie("topic2", &OnfivNameSpaceTnsAxis, "xinternal_data"),

Multiple Namespace Example: tns1:Device/tnsaxis:IO/VirtualPort

When there are multiple namespaces, ensure subsequent entries after a path change use the correct namespace. For instance, VirtualPort uses the tnsaxis namespace:

   NewTopicKeyValueEntrie("topic0", &OnfivNameSpaceTns1, "Device"),
   NewTopicKeyValueEntrie("topic1", &OnfivNameSpaceTnsAxis, "IO"),
   NewTopicKeyValueEntrie("topic2", &OnfivNameSpaceTnsAxis, "VirtualPort"),

When creating new events, follow these patterns for namespace and topic consistency

// <tnsaxis:CameraApplicationPlatform>
// 	<ObjectAnalytics>
// 		<xinternal_data wstop:topic="true">
// 			<tt:MessageDescription IsProperty="false">
// 				<tt:Data>
// 					<tt:SimpleItemDescription Name="svgframe" Type="xsd:string"></tt:SimpleItemDescription>
// 				</tt:Data>
// 			</tt:MessageDescription>
// 		</xinternal_data>
// 	</ObjectAnalytics>
// </tnsaxis:CameraApplicationPlatform>
func CameraApplicationPlatformXInternalDataEventKvs(svgFrame *string) *AXEventKeyValueSet {
	return NewAXEventKeyValueSetFromEntries([]KeyValueEntrie{
		NewTopicKeyValueEntrie("topic0", &OnfivNameSpaceTnsAxis, "CameraApplicationPlatform"),
		NewTopicKeyValueEntrie("topic1", &OnfivNameSpaceTnsAxis, "ObjectAnalytics"),
		NewTopicKeyValueEntrie("topic2", &OnfivNameSpaceTnsAxis, "xinternal_data"),
		NewStringKeyValueEntrie("svgframe", svgFrame),
	})
}

type CameraApplicationPlatformXInternalDataEvent struct {
	SvgFrame string `eventKey:"svgframe"`
}