We move the changes!
One minute video for summary the process.
Focused on value creation.
– Tommaso Carbonaro
Project #001 Modbus Studer binding on openHAB
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 is intended for software and IT developers for example:
- Final-users with IT and/or software engineering background willing to extend the monitoring functionalities on their Studer system, by running openHAB in a RaspberryPi.
- People wanting to combine bindings, for example (Fronius, Tesla, Samsung..etc).
- Companies making hardware, using Studer equipment in their product.
The implementaion of openHAB binding is not supported nor warranted by Studer.
This manual has been developed by Euclide Innovation.
1 What I need?
The components needed are splitted into two list: Studer’s devices and a compatible platform for running openHAB. The procedure for configuring Studer’s devices is the same for each devices on the family (Xtender, VarioTrack…).
-
Xcom-485iCHF449.00 -
Modbus cable RJ45-USB 100cmCHF29.99
2 Installing openHAB(ian)
As mentioned on first point, we will use as compatible openHAB platform the Raspberry: because of its low price, its small form factor and the low energy consumption, the Raspberry Pi is a quite popular 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.
2.1 Raspberry Pi (Prepackaged SD Card Image)
Flash, plug, wait, enjoy: the provided image is based on the Raspberry Pi OS Lite (previously called Raspbian) standard system. On first boot, the system will set up openHAB and the mentioned settings and tools. All packages will be downloaded in their newest version and configured to work without further modifications. The whole process will take a few minutes (around ~30 minutes), then openHAB and all other needed tools to get started will be ready to use without further configuration steps. openHABian is designed as a headless system, you will not need a display or a keyboard, just a computer/smartphone connected on the same network of your Raspberry Pi.
SETUP:
- Download the latest “openHABian” SD card image file
- Write the image to your SD card (with Raspberry Pi Imager or Etcher)
- 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)
- Be patient: in the meanwhile installation is running proceed to follow steps.
2.2 Finding IP address of Raspberry Pi
If you need to find the IP address of your Raspberry Pi, I suggest to use Fing: there is a desktop version and mobile version. I suggest to 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.
3 Configure & Connect
The Xcom-485i will made the bridge between openHAB (Raspberry Pi) and Studer’s devices: the device allows the integration of Studer’s protocol in advanced control applications using Modbus RTU 485, the universal communication protocol in the industrial environment.
-
Xcom-485iCHF449.00
3.1 Setup the Xcom-485i
No special configuration are needed on the Xcom-485i. The table above it’s just for reference: if you need more information about the Modbus protocol please check the documentation provided by Studer Innotec.
| 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 |
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:
3.3 Connect the Xcom-485i to Raspberry Pi
Once you configured the jumpers according to your cable, close the case of the Xcom-485i and connect it from the RJ45 port side “External” to our Raspberry Pi USB. Follow Studer’s Innotec rules for Xcom-485i position on Studer’s bus. If the Xcom-485i is the last device on your chain, must be put in “T” position on the switch for termination.
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:
Procedure step by step
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.
Please follow the steps on the right.
| Serial Port* | /dev/ttyUSB0 |
| 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 |
*Try to write “COM1” if you’re using a Windows
Procedure step by step
4.2 Add a Studer’s device (Things)
Each device of Studer’s bus will be a single things on the modbus binding of openHAB.
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 |
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.
| Things | Devices, like an Xtender, VarioTrack.. etc |
| Items | Values, like current, voltage.. etc |
5.1 Visualize values from a Studer’s devices
We will visualize the “Input Active Power” from our Xtender we added previously. The list of items available to be visualized is present here.
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.
6 replies on “Project #001 Modbus Studer binding on openHAB”
Hello,
very interesting project. WIll it be possible to write parameters to the Studer system in the future? I would like to use openhab not only for monitoring, but also for control of my energy storage system.
Best regards,
Michael
Hello,
Thanks Michael, it’s on the timeline providing writing function and an example, but anyway openHAB is opensource and anybody could implement it with some work on that. Keep following us 🙂
Hello Tommaso,
thank you for your answer. At the moment I´m happy to get openHAB running and monitoring my Studer System. Implementing own features or modifying the existing configuration would be very interesting but I think I have to get more skills in programming especially for openHAB
Hello,
i have already a studer system running, which uses the xcom-LAN-interface (XCOM-232i+MOXA). It works very well with the original studer app and the studer web-portal. Now i also want to use openHAB with my system and for my understanding is in this case the XCOM-485i mandatory. Is it possible to use the 485i beside the 232i? Or are there known problems regarding compatibilty?
Thanks and best regards,
Andreas
Hello Andreas,
Yes, you can keep both units. Be aware to connect the Xcom-485i at the end of line for Studer bus, next to RCC-02 for example. Up to 4 units RCC can be connected (Xcom-LAN, Xcom-232i, RCC-02/03..etc)
Hello Tommaso,
thank you for your reply. Great! I´m looking forward to start this project. 🙂