Z-Way Manual

Preparation and Ways to Access the System

Installation on Raspberry Pi

Before you can use the RaZberry solution, you need to complete your gateway hardware and install the software.

Here are two ways to install and start Z-Way:

You may need to configure the Wi-Fi access point of your Raspberry Pi in order to allow direct wireless access.

Installation on other platforms using UZB

Unix-based Platforms

Let’s assume you already have shell access to your system. You can download a binary distribution from


Figure 3.1: Folder Content of Z-Way
Image rootfolder

and unpack it. The code can run on every place in the filesystem. Nevertheless, we recommend using /opt/z-way-server as the folder to store the codebase. The folder content looks as shown in Figure 3.1. For more information on the files and the file structure of Z-Way, please refer to Chapter 11.4.

Z-Way can then be started using the simple shell command from inside the Z-Way folder:

LD_LIBRARY_PATH=./libs ./z-way-server

Once the code is started, it is possible to access the standard user interface using


To use Z-Wave, the correct port of the Z-Wave transceivers virtual serial port must be configured. Please go to the user interface menu and open the app 'Z-WAY NETWORK ACCESS' as shown in Figure 3.2. for more information about Z-Way aps please refer to Chapter 6.

Figure 3.2: Z-Wave Network Access App
Image zwavenetwork

After checking the right virtual port created by the operating system, please configure this port name and save the settings. Now Z-Way should be up and running, and you may want to create a startup script to make sure Z-Way is running right after booting.


First, note that the Windows platform is only partly supported. There is a binary distribution for Windows, but it certainly lacks the level of testing required. Please use the binary Windows distribution at your own risk.

Figure 3.3: Z-Way Windows Setup Wizard
Image winsetup1

Install the MSI file and start it. You will see a nice wizard—see Figure 3.3 —guiding you through the setup process.

Figure 3.4: Z-Way Windows Installation
Image winsetup2

The files are installed on the folder of choice as shown in Figure 3.4.

Figure 3.5: Windows Hardware manager with new COM port
Image winsetup3

If the UZB stick is plugged into the system, there is a new COM port created for this stick. Figure 3.5 shows the Windows hardware manager with the new port. After passing the initial setup page, open the app 'Z-WAY NETWORK ACCESS' and double check the right COM port. Note that there is a very special syntax for the COM port '\\.\COM3' for serial port 3.

Figure 3.6 shows this dialog.

Figure 3.6: Z-Wave Network Access App with COM Port
Image winsetup4

Under Windows, Z-Way runs as a service. You find the service entry in the Windows Service Management as shown in Figure 3.7. This dialog also allows starting and stopping the service.

Figure 3.7: Z-Wave as Windows service
Image winsetup5

Local and Remote Access

Z-Way can be accessed in several ways:

Both the local access and the remote access using the find-service have their pros and cons as listed in Table 3.1:

Table 3.1: Comparison of Access methods
Access Advantage Disadvantage
Local IP Ethernet very fast, all data stays within own home no secure connection due to missing IP certificates, IP address must be known, no access from outside the home
Find Service worked independent of local network setting from everywhere, very safe due to complete end-2-end security depends on external service, more delays
Local IP WIFI very fast and secure another WIFI access point, no access from outside the home

The initial access to the user interface must be done using one of the local access routes. Once Z-Way is running, the first access to the interface asks for some basic setup such as the admin password and an email address to recover this password. Figure 3.8 shows this screen. The number provided in the title (1) is the unique Z-Way Platform ID of the device and it will be needed in the future to access the controller remotely using the find service.

...t Please remember this \textbf{Z-Way Platform ID }!}

The Image world on the upper right side allows changing the interface language from standard English to your chosen language. If your language is not yet available, you may want to consider contributing a translation. Please refer to Chapter 10.3 for details on how to do this.

Figure 3.8: Initial setup of the Z-Way User Interface
Image init1

The language selection can be used for the user interface from this time on, but it can be changed in Image smenu > My Settings.

Please note that the email address provided for email recovery will not be stored outside your controller, e.g. in a cloud service. This provides extra security but also means that certain processes like restore are a bit more complicated than is usual.

After completing the setup, a welcome screen will guide you through the system and introduce the basic user interface terms/dialogs.

It also offers buttons for direct access to the two most common actions right after installation:

After completing the setup, it is possible to access Z-Way using the find service, or install a native app for the mobile phone. Open the url


The dialog on this find service, as shown in Figure 3.10, is intentionally simple. It offers two ways to log in:

Figure 3.9: Login on local IP address
Image init2

Figure 3.10: Remote Login Screen
Image sh1

The menu option Logout in the setup menu of the user interface will terminate the session and return you to the login screen or the find service depending on how to log in. You can always force the termination of the find session by calling the URL


Security and Privacy

Security and privacy are of great importance. Z-Way tries to maximize security and privacy and will not compromise them in order to improve user experience and convenience.


... browser[*]
We recommend Chrome, Firefox, or Safari since we frequently see problems with MSIE.