Manual Modbus Studer Binding On Openhab v1.0.0
Manual Modbus Studer Binding On Openhab v1.0.0
Manual Modbus Studer Binding On Openhab v1.0.0
Date : 26.03.2021
Version : V1.0.0
Table of Contents
Preface ................................................................................................................................................... 3
1 What I need? .................................................................................................................................. 4
2 Installing openHABian ................................................................................................................... 4
2.1 Raspberry Pi (Prepackaged SD Card Image) ..................................................................... 4
2.2 Finding IP address of Raspberry Pi ........................................................................................ 5
Conclusion ........................................................................................................................................... 20
V1.0.0 2 / 20
Preface
Welcome to the official guide for using the binding of Modbus Studer into openHAB. The
purpose of this tutorial is to assist you on the first steps for make your own monitoring solution:
we are sure you will explore openHAB’s features for improve your Studer’s installation in the best
way possible. More information about openHAB here.
openHAB was developed for home appliances devices, Studer is now part of this big family
with many others devices. We will install openHAB in a Rasperry Pi 3 B+ for reading values from
your installation, the guide is mainly divided into three steps: setup materials needed, add a
Studer’s device and visualize values from devices.
This manual has been developed by Euclide Innovation. You could find more information in the
website: Euclide-Innovation.com
V1.0.0 3 / 20
1 What I need?
The components needed are splitted into two groups: Studer’s devices and a compatible
platform for running openHAB. The procedure for configuring a Studer’s device is the same for
each devices on the family (Xtender, VarioTrack…).
*Mandatory
2 Installing openHABian
As mentioned on first point, we will use as compatible openHAB platform the Raspberry:
because of its low price, small form factor and low energy consumption, the Raspberry Pi is a
quite famous platform for openHAB and will allow to create a nice monitoring solution.
For doing that, the community of openHAB has developed a self-configuring Linux system
setup, that it’s called openHABian, a special OS suitable for many different Raspberry Pi version.
SETUP:
• Download the latest “openHABian” SD card image file
• Insert the SD card into your Raspberry Pi, connect Ethernet (WiFi also supported) and
power on.
• Wait approximately 15-45 minutes for openHABian to do its magic. (Check the
progress in your browser into Raspberry Pi’s IP address)
• The system will be accessible by its IP or via the local DNS name openhabian (or
whatever you changed 'hostname' in openhabian.conf to)
V1.0.0 4 / 20
2.2 FINDING IP ADDRESS OF
RASPBERRY PI
If you need to find the IP address of your
Raspberry Pi, use Fing: there is a desktop
version and mobile version. Use your
mobile phone connected on the same
network of your Raspberry Pi for finding
the IP address.
Tips: for Linux you could use Angry Ip
Scanner.
Modbus Value
Addressing* 1 to 63
Baud Rate 9’600 bps
Parity Even
Protocol Modbus RTU only
Byte transmission 1 start bit
Electrical Interface RS-485 on 2 wires
Connector Type RJ-45
*The addressing must be kept from 1 to 63.
V1.0.0 5 / 20
3.2 PINOUT CONFIGURATION XCOM-485I
Open the Xcom-485i, there are two screws in the back case of the device. You need to
configure the jumpers according to your output cable. In case you’re using the cable
mentioned in the guide (Cable Modbus RJ45-USB) the pinout will be as the image on the right:
DEFAULT CONFIGURATION
V1.0.0 6 / 20
4 Install & Configure Modbus “Studer” binding
Nowadays Studer is integrated on openHAB (under Modbus binding): this allow you to visualize
some of the most important values for monitoring your installation without writing a line of code!
The complete list of info, that openHAB call “items” are available on the binding’s page here.
Once the installation of openHABian is finished (we left the installation in progress chapter 2.1
while we configured the Xcom-485i) you will able, with your computer connected on the same
network of your Raspberry Pi, to join into the first window of openHAB.
The web address is the IP you discovered on chapter 2.2, remember to add the port 8080 at
the end of the IP found.
IPaddressofyourRaspberryPi:8080
When you will be there, just follow the procedure step by step here described:
V1.0.0 7 / 20
3 – Confirm the skip
4 – Go to “Settings”
V1.0.0 8 / 20
6 – Add a new binding with the button “+”
V1.0.0 9 / 20
4.1 ADD THE XCOM-485I (MODBUS SERIAL SLAVE)
The first device required to configure and add into our Modbus Studer binding is the “slave” of
the system also called as bridge. In our case it’s the Xcom-485i.
V1.0.0 10 / 20
3 – Select “Modbus Serial Slave” for the Xcom-485i only
4 – Configure the Xcom-485i (see table below). Pay attention on “Parity”. Must be even.
V1.0.0 11 / 20
Serial Port* COM3
ID 1
Baud 9600
Stop Bits 1
Parity Even
Data Bits 8
Encoding RTU
Flow Control IN None
Flow Control OUT None
Time Between Transactions 35ms
*Choose your serial port communication, this might be different in your case.
*Try to write “/dev/ttyUSB0” if you’re using a Raspberry
This procedure can be applied for all the devices inside the Studer’s bus. Select devices type
(Xtender, VarioTrack..) on Step n°3 and choose the address on Step n°5. The address range of
devices is as follow:
Address Devices
1 Xcom-485i Modbus gateway (slave)
11 to 19 Each Xtender
21 to 35 Each VarioTrack
41 to 55 Each VarioString
61 BSP/Xcom-CAN
Table of address range for Studer devices
V1.0.0 12 / 20
2 – Thing on Modbus binding
3 – Look for the Studer’s devices you’d like to add. We’ll add an Xtender
Tip: write Studer on the search bar for a faster research.
4 – Choose the bridge (1), Modbus Serial Slave “Xcom-485i” (2), Click Done (3)
V1.0.0 13 / 20
5 – Rename your device (1), Select the address (2), Create the thing (3)
Tip: Renaming your device will help you to recognize it, useful if you have a lot of devices. I
will rename it “Xtender Studer (11)”.
Tip: For address of device refer to table above.
V1.0.0 14 / 20
5 Visualize data (items)
Here we are on the part where you can create and personalize your monitoring solution.
Before starting please keep in mind the table below as reference, this will help you trough the
guide for better understanding the terminology.
1 – Under the menu “Model” (1), click on “Create Equipment from Thing” (2)
2 – Click on Thing
V1.0.0 15 / 20
3 – Select the thing (device) you want to visualize
5 – Now we successfully added the values (items) from our device (thing).
V1.0.0 16 / 20
6 – Under menu “Pages” (1), select the page already available “Overview” (2)
7 – Create a Block (if not present)(1), add a Cells (2), create a cell (3)
V1.0.0 17 / 20
9 – List the items available (1), select the items to visualize (2), click “Pick ..”
10 – Once selected the items you want to visualize, click on save (1) and then run mode (2)
11 – Here (in run mode) you will have your items. Click on it to explore the built-in graphs
V1.0.0 18 / 20
12 – Here is the graph that will register your items every 5 seconds.
V1.0.0 19 / 20
Conclusion
We finished the tutorial for using the Studer binding into openHAB. From now the possibilities
you have are infinite, you have the white-paper for creating your own monitoring solution,
adding icons, wallpaper or combine two differents bindings available on openHAB for improve
your monitoring solution furthermore. We invite you to be part of the openHAB community for
exploring this open source family.
The use of this manual is under the responsibility of the end-user. This manual is neither designed
nor guaranteed for the supply of life support applications or any other critical application with
potential risks for human beings or for the environment. We shall assume no liability for patent
infringement or other third party rights involved in the use of this manual.
All contents (text, images, graphics, layout, etc.) on this manual belong to their respective
owners.
V1.0.0 20 / 20