Glossary

This page is a glossary. It should give a short explanation of all terms used in the context of the OpenAPI for the AX Visio.

OpenAPI

The term OpenAPI is an umbrella term to sum up all things that are needed to build third party applications that can connect to an AX Visio binocular and use the exposed functionalities. E.g. it describes the OpenAPI Inside Application, the OpenAPI contexts, the topics exposed for the OpenAPI contexts, the OpenAPI documentation, the SO Comm SDK, the SO Comm Outside API Library, ...

SO Comm SDK

The SO Comm SDK is a set of libraries that can be included in Android applications. These allow to connect to an AX Visio and perform various actions. See SO Comm SDK for details.

SO Comm Outside API

The SO Comm Outside API is the main Java/Kotlin library to connect to an AX Visio. It handles the connection, usage of SO Contexts and publishing and subscribing to topics. Its API reference can be found here: SOCommOutsideAPI

SO Context

A SO Context contains a set of communication endpoints that are, from a usage point of view, related to each other, have similar needs for communication bandwidth and access control requirements. On Swarovski Optik devices SO Contexts can be provided by applications or system services, which might be used by several applications. On smartphones applications can use a SO Context, when it is provided by a Swarovski Optik device and the app has access to it.

All SO Contexts that are exposed for the OpenAPI are listed here: OpenAPI > Available Contexts

Use or release a context

Once the application established a connection with the AX Visio, you can use a specific SO Context. This allows your application to use the functionality provided by the context. If your application is finished, you can also release the context again.

Topics

Topics are unique paths to functionality and very similar to MQTT topics. They are bundled inside a specific SO Context. Topics are characterized as either in or out topics. TopicIns allow you to communicate from the smartphone to the AX Visio. TopicOuts allow to communicate from the AX Visio to the smartphone.

After connecting with the SO Comm Outside API library to the AX Visio and using a SO Context, you can start using topics. You can publish on a in topic and subscribe to an out topic.

OpenAPI Contexts

This name stands for the special OpenAPIContext and the OpenAPIContextBLE and the additional contexts that are available for third party applications that are using the OpenAPI. The full list of contexts is available at OpenAPI.

Inside vs Outside Applications

Inside applications run on the AX Visio binocular and can be activated by rotating the mode selection wheel. Outside Applications run on the users smartphone and connect via the SO Comm SDK to the binocular.

SO Comm MediaClient

The SO Comm MediaClient, or short MediaClient, is an additional library for picture and video handling around the SO Comm Outside API. It should be used instead of manually downloading picture or video data from the AX Visio.