Build environment

Build environment#

This page assumes you are working on one of the supported Debian or Ubuntu versions. Other Linux distributions should work too, however installation of the build dependencies may vary.

Like with a regular nymea installation, all the required packages can be obtained from the same nymea repository that is used for nymea:core:

Currently supported versions#

Debian:

  • Debian 12 (“bookworm”)

  • Debian 13 (“trixie”)

Ubuntu:

  • Ubuntu 20.04 (“focal”)

  • Ubuntu 22.04 (“jammy”)

  • Ubuntu 24.04 (“noble”)

  • Ubuntu 26.04 (“resolute”)

For each repository, the following architectures are provided:

  • amd64

  • armhf

  • arm64

  • riscv64

Import the repository key#

The packages in the nymea repository are signed with nymea’s GPG key. Import it before adding the repository:

sudo curl -fsSL -o /etc/apt/trusted.gpg.d/nymea.gpg https://repository.nymea.io/repository.gpg

Optionally, the key fingerprint can be verified with:

gpg --show-keys --with-fingerprint /etc/apt/trusted.gpg.d/nymea.gpg

pub   rsa4096 2016-04-08 [SC]
      B1C8 9C2A E70D 2FC8 27DF  0BFF 457A 6EE4 A1A1 9ED6
uid                      nymea GmbH <developer@nymea.io>
sub   rsa4096 2016-04-08 [E]
sub   rsa4096 2016-04-08 [S]

Repository setup#

Choose the repository format for your distribution version.

Use the classic list format. Replace bookworm with the matching distribution codename: focal, jammy or noble.

sudo tee /etc/apt/sources.list.d/nymea.list > /dev/null <<EOM
deb http://repository.nymea.io bookworm main non-free
deb-src http://repository.nymea.io bookworm main non-free
EOM

Now the nymea SDK can be installed with this command:

sudo apt update
sudo apt install nymea-sdk

This will install nymea and all the development packages in order to build a nymea-plugin. It will also install QtCreator as the recommended IDE.

If you wish to use a different IDE, you may install the SDK with the following command instead:

sudo apt install --no-install-recommends nymea-sdk

In order to build existing plugins additional dependencies might be required. Those vary between plugins. All the required dependencies for building the main nymea-plugins repository can be installed with this command:

sudo apt build-dep nymea-plugins