1 Building the app with an overlay & branding
Patrick Schurig edited this page 2026-01-11 11:20:37 +01:00

Requirement

Download and install Qt 6 from qt.io (open source version) and install version 6.8.3 for Desktop and all additional libraries.

Building the app with an overlay & branding

Clone the nymea-app

git clone https://github.com/nymea/nymea-app.git
cd nymea-app
git submodule init
git submodule update

Next to the nymea-app folder you can extract the overlay

ls -l

nymea-app
nymea-app-energy-overlay

For building the nymea:energy app you can do following steps in the console:

cd nymea-app
mkdir -p build/deskrop-nymea-energy
cd build/

Configure the project with the overlay and the desired branding, you can also create your own.

qmake OVERLAY_PATH=../../nymea-app-energy-overlay/ BRANDING=nymea ../

Build the app

make -j$(nproc)

You can start the app in the build dir nymea-app/

nymea-energy-plugin-nymea

The energy manager is a special "energy" plugin which will be loaded from the energy experience (github.com/nymea/nymea-experience-plugin-energy).

It offers a dedicated JSON RPC API namespace designed for the nymea-app-energy-overlay. The build dependencies can be fetched from the debian/control file. Depending on the build environment (i.e. Ubuntu 24.04) you can find the overall build isntructions here: https://nymea.io/documentation/developers/build-env