How to Install KNX API Server on Robustel EG5120

How to Install KNX API Server on Robustel EG5120

Overview

The Robustel EG5120 is a high-performance industrial edge computing gateway. Robustel is proud to be the first manufacturer globally to achieve official KNX API Server certification, providing a standardized, secure, and modern interface for KNX installation.

By deploying the KNX API Server via Docker on the EG5120, users can bridge traditional KNX bus systems with IoT cloud platforms and mobile applications using RESTful APIs and WebSockets. This guide helps you set up this world-first certified solution on your gateway.


What You'll Need

Hardware List

  • 1 x Robustel EG5120 Gateway
  • 1 x PC/Laptop (for SSH and file transfer)
  • Stable Internet Connection (Cellular, Ethernet, or Wi-Fi for downloading Docker dependencies)
  • Power Supply & Network Cables

Software / Firmware

  • RobustOS Pro: Version 2.4.0 or higher.
  • SSH Client: PuTTY, Windows PowerShell, or macOS Terminal.
  • File Transfer Tool: WinSCP or FileZilla.

Other Requirements

Important Note on Software Images

Disclaimer: The software images and links provided in this guide are currently Beta versions intended for testing and evaluation. For production environments, please always refer to the official release versions available on the Robustel website or Partner Portal.


Step-by-Step Configuration Guide

Step 1: Environment Preparation & Docker Installation

Before running the KNX server, the gateway must have the Docker engine installed.

  1. Establish SSH Connection:
    Connect to your gateway via Terminal or PuTTY:
ssh <username>@<device_ip_address>

  1. Add Docker Repository:
    Run the following to set up the official Debian-based Docker repo:
sudo apt update
sudo apt install ca-certificates curl -y
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

sudo tee /etc/apt/sources.list.d/docker.sources <<EOF
Types: deb
URIs: https://download.docker.com/linux/debian
Suites: $(. /etc/os-release && echo "$VERSION_CODENAME")
Components: stable
Signed-By: /etc/apt/keyrings/docker.asc
EOF
sudo apt update

  1. Install Docker Engine:
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y

  1. Verification
    Run the following command to check if the Docker daemon is active and running:
sudo systemctl status docker

Success: The output should show Active: active (running) in green text.

Step 2: Deploying the KNX API Server

  1. Transfer Files: Use WinSCP to upload thirdpartyapiArm64.tar, postgres-18-alpine.tar, and docker-compose.yml to /home/robustel/.
  2. Load and Tag Images:
cd /home/robustel
sudo docker load -i thirdpartyapiArm64.tar
sudo docker load -i postgres-18-alpine.tar

# Ensure the tag matches your docker-compose.yml
sudo docker tag itgesellschaft/elvis3rdpartyapi:arm64-v1.0.0 itgesellschaft/thirdpartyapidemo:arm64-v1.0.0
  1. Launch the Containers:
sudo docker compose up -d

If you see below log that means the KNX API server running success


Verification & Testing

1. Check Container Status

Run the following command to ensure both the API server and the database are "Up":

sudo docker compose ps

Success Look: You should see two containers listed with the status Up or Running.

2. Access the Web Interface

Open your web browser and enter:
https://192.168.0.1:8080/configuration/

Note: You may see a certificate warning; click "Advanced" and "Proceed" to continue. If the login page for the KNX API Server appears, the installation is successful.


Troubleshooting / FAQ

Q: I cannot connect to the Web UI on port 8080.
A: Check the gateway's firewall settings in the RobustOS Pro web interface. Ensure that port 8080 is not being blocked.

Also, verify the container is running by checking sudo docker compose logs.

Q: How do I update the application?
A: Stop the current services with sudo docker compose down, upload the new .tar files, load them, and run sudo docker compose up -d again.


Revision History

Version

Date

Author

Changes

1.0

2026-03-05

Hubery Zhang

Initial document creation.