1.2. Obtaining the SDK

The Proximie SDK can be obtained in one of two ways:

By installing the SDK packages from our public APT repository at https://apt.proximiestaging.com.

By downloading SDK release archives from our Sharepoint site.

1.2.1. APT-based Installation

The easiest way to set up a host environment for building with the Proximie SDK is to install the Proximie SDK, its dependencies, documentation and sample applications from our public APT repository; navigate to https://apt.proximiestaging.com and follow the instructions to add the repository to your system.

Note that if you are using our Docker image (see Environment), the APT repository is already configured within the image, so you can skip the above step when working within a Docker container.

You will then be able to install the SDK using APT - make sure to run sudo apt update after adding the repository to ensure your package manager is aware of the new packages.

If you are deploying a pre-built application, all you need is the runtime dependencies and Proximie SDK shared library; to install these, run:

sudo apt install pxsdk

If you are developing an application, you will need the C++ header files, CMake configuration files, etc. from the development package. This package also includes C++ sample applications, both pre-built and in source code form. To install these, run:

sudo apt install pxsdk-dev

Debug symbols for the SDK shared library can be installed with:

sudo apt install pxsdk-dbg

To install the Proximie SDK for Python, run:

sudo apt install python3-pxsdk

This will implicitly install the pxsdk package as a dependency, so you will have the SDK shared library, python bindings, and python sample applications.

Available packages are:

Package	Contents
`pxsdk`	Proximie SDK as a shared library, necessary for deployment of an application incorporating the Proximie SDK. This package also defines and depends on any other packages necessary at runtime. Included in this package is the `pxsdk` helper utility. Run `pxsdk --help` for more information.
`pxsdk-dev`	Development files for the Proximie SDK, including C++ headers, CMake configuration files, and other files necessary for building applications using the Proximie SDK. This package depends on `pxsdk`.
`pxsdk-dbg`	Debug symbols for the shared library installed by the `pxsdk` package.
`python3-pxsdk`	Proximie SDK for Python, including Python bindings and sample applications.

1.2.2. SDK release archives

Each release of the Proximie SDK is also made available as a downloadable archive, containing the SDK shared library, header files, CMake configuration files, sample applications, and other files necessary for building and running applications using the Proximie SDK.

Release archives can be accessed via our Sharepoint site, which is available on request.

Note that unlike the APT-based installation, Sharepoint has no way to determine your target operating system and architecture. As such, you should take care to download the version of the SDK that matches your target system. Available files are named:

px-core_<UBUNTU_VERSION>_<ARCH>_<BUILD_TYPE>_<SDK_VERSION>.tar.gz

where:

<UBUNTU_VERSION> specifies the target OS version (22.04 or 24.04)
<ARCH> specifies the target system hardware architecture (x86_64 or aarch64)
<BUILD_TYPE> specifies whether the archive includes debug symbols (DEBUG or RELEASE)
<SDK_VERSION> specifies the SDK release version, e.g. v0.16.1

For example, if you are building an application for Ubuntu 22.04 on an x86_64 architecture, and you don’t need debug symbols, you would download the archive named

px-core_22.04_x86_64_release_v0.16.1.tar.gz.

Release archives can be extracted to the location of your choice as follows:

tar -xzf <archive_name>.tar.gz -C <target_directory>