nymea:core

nymea:core#

nymea:core is typically installed on a low-power machine in the local network, such as a Raspberry Pi, an embedded gateway or a small PC. nymea provides ready-to-use Raspberry Pi images and packaged builds for Debian and Ubuntu systems.

Debian GNU/Linux and Ubuntu#

nymea provides apt repositories for Debian and Ubuntu.

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

Install nymea:core#

Once the repository has been configured, update the package index and install nymea:core:

sudo apt update
sudo apt install nymea nymea-plugins

Once this command completes, nymea:core should be up and running.

Raspberry Pi#

The recommended way to install nymea on a Raspberry Pi is to use the nymea:core image in Raspberry Pi Imager. In the imager, select Other specific-purpose OS -> Home Automation -> nymea. The current image is based on Debian 13.

Write the image to an SD card, insert the card into the Raspberry Pi and connect the power supply. nymea:core starts automatically on boot.

Note

The Raspberry Pi images have SSH enabled by default with username nymea and password nymea. Change the credentials before using the system in a publicly accessible network.

After the first boot, continue with the first steps guide.

Manual installation on Raspberry Pi#

If the nymea Raspberry Pi image is not used, nymea:core can also be installed manually on Raspberry Pi OS using the apt repository.

Currently, the following Raspberry Pi models are supported:

  • Raspberry Pi 2

  • Raspberry Pi 3

  • Raspberry Pi 4

  • Raspberry Pi 5

  • Raspberry Pi Zero 2 W

For manual installation, use the Debian repository instructions above. Current Raspberry Pi OS based installations should use the Debian 13 trixie repository.

Yocto#

nymea:core can also be integrated into Yocto based images using the meta-nymea layer. The layer currently supports the following Yocto releases:

  • kirkstone

  • scarthgap

  • wrynose

Clone the matching branch of meta-nymea into your Yocto workspace and add it to your build configuration:

git clone -b wrynose https://github.com/nymea/meta-nymea.git
bitbake-layers add-layer meta-nymea

Replace wrynose with the Yocto release used by your build. After adding the layer, include the nymea packages in your image according to your product requirements.

Other distributions or architectures#

To install nymea:core on other distributions or architectures, nymea:core needs to be built manually from source. See the developer build documentation for instructions.

Joining the beta tests#

Note

Running experimental or testing builds of nymea is not recommended for users expecting a stable setup.

nymea provides three repository channels:

  • stable: The current stable release. This is the default repository described above.

  • landing: The next release candidate. This is where testing for new releases happens.

  • experimental: The current development channel. It can be unstable and may break a setup.

Landing and experimental repositories#

Choose the repository format for your distribution version.

Use the classic list format. Replace bookworm with the matching distribution codename.

Landing

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

Experimental

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

After adding or changing repository channels, run:

sudo apt update
sudo apt upgrade