Installation

macOS® Installation

For macOS®, an installer is provided that will set up CambrionixApiService to run as a daemon process. The service is configured to load on-demand when it’s configured, the listening port is attached to by launchd.

Due to how the Cambrionix Hub API runs, it requires User Account Control (UAC) interaction to be installed. This means that the installer cannot be run silently.

The installation can also perform all necessary steps to configure any installed versions of Python 2 and 3 and direct you to various example scripts.

Windows Installation

For Windows, a self-extracting installer is provided that will set up CambrionixApiService to run as a Windows service.

Due to how the Cambrionix Hub API runs, it requires User Account Control (UAC) interaction to be installed. This means that the installer cannot be run silently.

The installation can also perform all necessary steps to install and configure Python 2 and 3, and direct you to various example scripts.

Linux Installation

The Linux® package comes as a Debian package which you can install either via the GUI or from the command line using apt:

sudo dpkg -i /Downloads/cambrionix-api-setup-?????????.deb

You can also set the API to run in a persistent mode which will then run when you reboot your system this can be achieved by using the following command

sudo /usr/bin/CambrionixApiService --install --persistent

An armhf version has also been tested on oDroid and Raspberry Pi.

We currently do not have support for rpm files; if you require assistance, then you can obtain more information from the page below.

https://fedingo.com/how-to-convert-deb-to-rpm-files-in-linux/

USB Drivers

The USB drivers that are required to access Cambrionix hubs are included with most OS’s by default.

These drivers are included in the installer and can be installed by selecting the optional component during installation. The option will not appear if the necessary drivers are already present. However ,installation of these drivers does not complete until a Cambrionix charger is attached to the host machine. If you install the API and the USB drivers before the first time you connect a Cambrionix charger, then the API will not start, and you will need to reboot the host machine after connecting a Cambrionix hub that will trigger the completion of the USB driver installation, to ensure that the API service is correctly started.