Development environment Setup

Follow the below listed instructions to easily set up your development environment.

Prerequisites

Before being able to start developing your own applications for AuterionOS(AOS) you have to make sure to satisfy the following requirements:

• Be part of the Auterion developer program.

• Have access to a PC running either Ubuntu or macOS.

• The App development workflow makes use of python3, pip and docker. Therefore, ensure that those tools are installed and available on your machine.

To deploy, test and run your applications you will also need a device running AOS:

• A Skynode (running AOS 2.7+) and/or an AINode (running AOS 1.0+).

Other linux distributions like Fedora or Arch, as well as Windows platforms may work, but are not officially supported.

Install Auterion CLI

Auterion Command Line Interface(CLI) was developed to enhance the entire Auterion application development process. This tool can be easily installed with the help of the python package installer (pip). Therefore, before running the next installation step, make sure that you have pip installed and running on your development system.

Ubuntu

pip3 install auterion-cli

macOS

pip3 install auterion-cli

Once the installation is completed, verify that the tool has been successfully installed and it is working properly by running the following command:

Ubuntu

auterion-cli --version

user@pc:~$ auterion-cli --version
1.3.0

If this is not the case, make certain that your local user directory ~/.local/bin is correctly added to your PATH.

macOS

auterion-cli --version

user@mac:~$ auterion-cli --version
1.3.0

If this is not the case, make certain that your local user directory ~/.local/bin is correctly added to your PATH.

It is also highly recommended to install pigz on your system. pigz is a parallel implementation of gzip and can significantly speed up compression of apps built with auterion-cli:

Ubuntu

sudo apt install pigz

macOS

brew install pigz

For a detailed explanation of Auterion CLI and its command reference, please refer to: Resources - Auterion CLI Reference

Docker setup

As mentioned in the prerequisites section, the application development workflow relies on docker. it is important that your machine is capable of running docker images for linux/arm64 platforms. Running ARM64 docker containers is possible on x86-64 platforms through the use of QEMU.

You can verify that this is the case on your development machine by running the following command:

docker run --rm -it --platform=linux/arm64 ubuntu:latest

If this command results in an error, make sure that Docker and QEMU are correctly installed and set up on your system.

Ubuntu

• Official docker installation guide: https://docs.docker.com/engine/install/ubuntu/
• Post-installation guide: https://docs.docker.com/engine/install/linux-postinstall/
• Install QEMU: https://www.qemu.org/download/#linux

  sudo apt install qemu binfmt-support qemu-user-static

• Setup docker to use QEMU:

  docker run --rm --privileged multiarch/qemu-user-static --reset -p yes

macOS

• Install Docker Desktop for macOS: https://docs.docker.com/desktop/install/mac-install/

Note that even when using an ARM64 platform for development, such as recent Macbooks, a QEMU installation is required. In this case it's because on of the third party build dependencies for AOS apps is currently only available for x86-64 platforms, which needs to be emulated on a Macbook or other ARM64 systems.

Now that you have a working development environment, head to the next section to learn how to connect to an AOS device.