Эта страница является переводом страницы HS Server Pro. Перевод выполнен на 100%.

---

iRidi Pro Server (HS Server)

Installation and launch of iRidi Pro Server based on HS Server controller

The documentation was updated on 12.10.2023

General information

iRidi Pro Server (HS Server) - it is a software implementation of iRidi Pro Server, which is launched as a daemon or a console application on the controller HS Server.

The instructions in this article are suitable for working with the HS Server in products:

• iRidi Pro Server;
• iRidi Pro Server (Offline);
• KNX Integration Server;
• Bus77 Integration Server.

Replacing UMC Server with HS Server

Read more about safe replacing the UMC C3 platform with HS Server in the Replacing iRidium server UMC C3 with HS Server article.

Specification

See the current technical specifications in the article «HS Server».

First start

1 Connect the HS Server controller to the local power using the instructions.

2 Define the IP address of the HS Server controller with the help of iRidium Transfer app or a standard scanner of LAN (for example, Advanced Port Scanner).

3 Use this address to open the web-interface of server in web-browser:

• http://192.168.1.254:8888/ (set the address of your controller!)

The server receives the license and the project from the cloud but the developer (integrator) NOT the user must authorize on the server using the login and password on the iridi.com web site. Launch the server, open the web-interface and activate the server:

1. Input the login and password of the integrator account where you created the object with the server project
2. Select the service password to access the server settings. It is 2007 by default.
3. Then you will see the list of objects and server projects. Select the project which has to work on the server and click on it to download (skip this step if you didn't use iRidium Cloud yet).
4. In the server web-interface (the Cloud tab) you can download project for the server (Projects) or deactivate the server (Deactivate Server). At the server with an active Test Mode you can download projects from iRidium Transfer.

DHCP-server must be active on the router. In case of an error in obtaining an ip address, a static address is set: 192.168.77.77.

Changing IP address

Change the IP address of the controller to suit your net infrastructure. The settings are available in the server web-interface on the following page System > Network.

You can set:

• Dinamic address (DHCP) or
• Static address

DHCP address (given automatically):

Static IP address:

To save settings click Save go to the main page of the web-interface and click Reboot System. The web-interface will become available on the new address.

If you lose access to the web-interface use the instruction Reset to defaults, to return the default settings of IP address.

Server Update

1 Open the web-interface of server on the System > Info, tab and press the button Update.

2 To tick under Get latest version from the iRidium website (activated by default) and press UPDATE. From the iridi.com web-site the latest version of the server will be installed automatically.

If it is necessary, you can install a specific version of the server by linking to the update file. To do this, the tick should be removed from Get latest version from the iRidium website, you need to insert a link to download the file in the input field and press UPDATE

The link can be copied at iridi.com, in the section Downloads.

The web-server interface will become unavailable for a few minutes, then the upgraded server will start.

Do not turn off the power supply of the controller when the update process occurs! The update process may take up to several tens of minutes with a big database!

Reset to Default Settings

To reset the iRidi Pro Server (HS Server) controller to factory settings, use the instructions.

Trouble shooting

If you can not open the web-interface of the iRidi Pro Server (the server will not start, the web-interface does not work), follow the following steps given in this manual on emergency launch/update/downgrade of the software. To do it, connect to a device (controller) via SSH protocol is required.

Connecting to a Device (Controller) via the SSH protocol

1 Define the IP address of the controller in any convenient way (for example, with the help of iRidi transfer or a scanner of LAN).

2 Download and launch the following program PuTTY.

3 Make the following settings:

• Host Name (or IP address): <IP address of the iRidi Pro Server controller (HS Server)>
• Port: 22
• Connection Type: SSH

and click Open.

4 The console that appears enter:

• Login as: root
• root@XXX.XXX.XXX.XXX's password: iridi (password is not diplayed during entering)

5 If the login and password are entered correctly, you will see a welcome message IRIDI. A console line becomes available and with its help forced start, update and downgrade the server can be done.

Force start of server

1 Open the folder /iridiumserver/:
cd /iridiumserver/

2 Enter the command to start the server in the background (in this case, the server will not stop working when PuTTY stops working)
./iridium --force --hidden

3 If everything is successful, the server will start and be ready for work.

Update and downgrade of firmware

The following actions are done if all access to the server web-interface is lost. If there is no Internet access, use this manual Update and downgrade of firmware if there is no access to the Internet.

1 Download the latest version of the iRidi Pro Server (HS Server) to the root folder of the controller:
wget -O iridiumPro.ipk --no-check-certificate https://iridi.com/redirects/?go=iRidium_Server_HS_Server

2 Check the folder contents (make sure that the folder has .ipk file):
ls

3 Start installing a newer or the same version of server:
opkg install iridiumPro.ipk

Or downgrade the version to the older one:
opkg install --force-downgrade iridiumPro.ipk

If --force-downgrade key is not used when installing an older version, installation won't be done.

4 After installation the server starts automatically. The server is ready to work.

Update and downgrade of firmware if there is no Internet access

1 Install and start WinSCP:

• Click New Site folder and set:
• File Protocol: SCP
• Host name: <IP address of iRidi Pro Server (HS Server) controller>
• Port number: 22
• User name: root
• Password: iridi

Click Login.

2 Copy the file to install the HS Server (.ipk) to the root folder /root of the iRidi Pro Server (HS Server) controller, using WinSCP.

3 Check the contents of the root folder in the console line (make sure that the .ipk file is there):
ls

4 Start installing a newer or the same version of server:
opkg install <file-name>.ipk

Or downgrade the version to the older one:
opkg install --force-downgrade <file-name>.ipk

If --force-downgrade key is not used when installing an older version, installation won't be done.

5 After installation the server starts automatically. The server is ready to work.

Server Setting up

1 When the server is installed, you can start developing its configuration and logic: Server Project in iRidi Studio.

2 You have to upload the ready project to iRidi server: Launch of iRidi server configuration.

Setting Bus77 (TCP\IP) interface

By default, the Bus77 interface is activated and you can start working with Bus77 equipment without setting up:

1 On the tab System > Other make sure that the connection CAN 0 (TCP Port 30467) is activated (enabled by default) in the web-interface of the server.

2 In the iRidium Studio create a new Bus77 project: File> New > New Bus77 Project.

3 Connect and scan the Bus77.

4 Add the found devices to the Bus77 project.

If you deactivate the CAN 0 (TCP Port 30467) parameter on the web-interface, it will be impossible to connect to the Bus 77 bus by IP. This mode can be useful for restricting TCP connections to the bus during commissioning (scanning and setting the bus is possible only via TCP).

Setting Bus77 (CAN-bus) interface

To work with the Bus77 directly from the iRidium Server app via the CAN interface, it is necessary to:

1 To deactivate the parameter CAN 0 (TCP Port 30467) in the web-interface of the server, on the tab System > Other (enabled by default).

2 Create a new server project in the iRidium Studio: File> New > New Server Project.

3 Add the Bus77 driver to the project by importing devices from the application Bus77 Home or using Bus77 project in iRidium Studio.

4 Upload the ready server project to the iRidium Server application on the HS Server device.

Setting RS232 interface

The HS Server controller has a built-in RS232 port, which can be used, for example, for data exchange via Modbus RTU or Modbus ASCII protocol.

Below you will find an example of setting RS232 interface to work via Modbus RTU. Other protocols (drivers) are set the same way.

1 Create a new project for the iRidium Server in iRidium Studio: File> New > New Server Project...

2 Add Modbus RTU driver to the project:

3 Set connection parameters:

• Host: /oem/hal/232_port
• Update Time: time for data update in milliseconds
• Baud Rate: speed of data exchange, bit/s (depends on the settings of devices in the bus, typically 9600)
• Data Bits: number of data bits (depends on the settings of devices in the bus, typically 8)
• Parity: checking parity (depends on the settings of devices in the bus, typically None)
• Stop bits: number of stop bits (depends on the settings of devices in the bus, typically 1)
• Coil Write Function: type of Modbus-function to send binary data to the bus (it is determined by the presence of support of Modbus multiple function by devices in the bus)
• Holding Write Function: type of Modbus-function to send analogue data to the bus (it is determined by the presence of support of Modbus multiple function by devices in the bus)

Read manuals of other devices in the RS232 bus: set the same speed of data exchange on all devices, set the same parameters in Data Bits, Parity, Stop Bits. In addition to it, each device in the bus must have a unique ID (Device ID).

4 Set the required number of channels. Set Modbus RTU parameters in each channel:

• Device ID: ID of slave device
• Type: type of data (Coil, Discrete Input, Holding Register, Input Register)
• Address: address where data in a slave device are stored.

5 After it a project is set to send data via Modbus RTU.

Setting RS485 interface

The HS Server controller has a built-in RS485 port, which can be used, for example, for data exchange via Modbus RTU or Modbus ASCII protocol.

Below you will find an example of setting RS485 interface to work via Modbus RTU. Other protocols (drivers) are set the same way.

1 Create a new project for iRidium Server in iRidium Studio: File> New > New Server Project...

2 Add Modbus RTU driver to the project:

3 Set connection parameters:

• Host: /oem/hal/485_port
• Update Time: time for data update in milliseconds
• Baud Rate: speed of data exchange, bit/s (depends on the settings of devices in the bus, typically 9600)
• Data Bits: number of data bits (depends on the settings of devices in the bus, typically 8)
• Parity: checking parity (depends on the settings of devices in the bus, typically None)
• Stop bits: number of stop bits (depends on the settings of devices in the bus, typically 1)
• Coil Write Function: type of Modbus-function to send binary data to the bus (it is determined by the presence of support of Modbus multiple function by devices in the bus)
• Holding Write Function: type of Modbus-function to send analogue data to the bus (it is determined by the presence of support of Modbus multiple function by devices in the bus)

Read manuals of other devices in the RS485 bus: set the same speed of data exchange on all devices, set the same parameters in Data Bits, Parity, Stop Bits. In addition to it, each device in the bus must have a unique ID (Device ID).

4 Set the required number of channels. Set Modbus RTU parameters in each channel:

• Device ID: ID of slave device
• Type: type of data (Coil, Discrete Input, Holding Register, Input Register)
• Address: address where data in a slave device are stored.

5 After it a project is set to send data via Modbus RTU.

Setting HDL Buspro interface

HDL gateway is connection between LAN port and CAN port. When HDL gateway of the device is on, devices in the CAN bus can exchange data with devices in the Ethernet as if they were on the one side of the bus. UDP protocol used on the side of the Ethernet.

RS485 and LAN ports can be used to exchange data via HDL Buspro protocol.

Activating the HDL gateway via the web interface

HDL gateway is connection between LAN port and RS485 port: when HDL gateway of the device is on, devices in the RS485 bus can exchange date with devices in the Ethernet as if they were on the one side of the bus. UDP protocol used on the side of the Ethernet.

The easiest way to activate the mode of HDL gateway is to do it in the server web-interface in the following folder Network > SYSTEM > Other > Server working mode.

There must be no "HDL-BUS Pro (Serial)" and "HDL-BUS Pro (UDP)" drivers in the project.

In this case it is impossible to control HDL devices from iRidium Server application, as there are no require drivers in the project.

Filter of HDL-gateway

HDL gateway can filter sending commands in the bus by Subnet ID.
To use this function, do the following:

• enter the server web-interface and go to the System/Other tab

• set HDL value in the Server working mode field

• set Enable value in the the Gateway HDL filter field
• enter Subnet ID that is to be used for filtering in the Gateway HDL subnetid filter field.

When the sever gets data, it checks Subnet ID of a device, if it agrees with the one set in the filter, the server processes them, it the ID differs, the server ignores data.

Setting HDL Buspro on the side of RS485

1 Create a new project for the iRidium server in the iRidium studio: File> New > New Server Project...

2 Add HDL Buspro Network driver and the required number of HDL Buspro devices to the project:

3 Set the general parameters of the bus:

• Host: /oem/hal/485_port
• Baud Rate: 9600
• Data Bits: 8
• Parity: None
• Stop bits: 1
• Send Timeout: period to send data to HDL Buspro bus in milliseconds

4 Set parameters of each device in HDL Buspro bus.

• Subnet ID: number of subnet
• Device ID: unique ID of a device

Each device in the device subnet must have a unique ID (Device ID).

5 Set the parameters of each channel:

The most important parameters of Command and Feedback of HDL Buspro driver:

• Operation code: operation (command of HDL Buspro protocol)
• Option: option of operation
• Channel: channel of a multichannel device
• Parameter: parameter of a multifunctional device
• Need confirm: confirmation is required (it is recommended to set Disable)
• Use Timer: cyclic sending a command (true - turn on, false - turn off)
• Timer, s: period to send a cyclic command in seconds

Read the manual of HDL Buspro device to set the server correctly for data exchange.

6 After it the project is set to send data by HDL Buspro protocol via RS485 port.

Setting HDL Buspro on the side of LAN

1 Add HDL Buspro Network (UDP) driver and the required number of HDL Buspro devices to the project:

2 Set the general network parameters:

• Send timeout: a period to send data to HDL Buspro net in milliseconds
• Connect mode: way to connect to HDL Buspro net (Local - in the local net, Internet - with authorization with login and password, Remote Server - using HDL Remote Server)
• Broadcast: mask of IP addresses of broadcasting
• Fast Feedback: getting fast feedback without waiting for feedback from a real device
• Host: server IP address
• Port: server port
• Remote Server Priority: priority of remote server (true value is recommended)
• Login: login to access HDL Remote Server or the Internet
• Password: password to access HDL Remote Server or the Internet
• External Port: remote port
• Project Name: name of project
• Group Name: name of group

3 Set parameters of each device in HDL Buspro bus and parameters of each channel (the way it is described above).

4 After it the project is set to send data by HDL Buspro protocol via LAN port.

Activating HDL gateway with the help of script

Create an empty script file (JS icon on the top toolbar + New Script) and paste the script in it:

IR.AddListener(IR.EVENT_START, 0, function() 
{                                   
   var HDL_UDP = IR.GetDevice("HDL Buspro Network (UDP)"); //name of HDL Buspro (UDP) driver in your project
   var HDL_Serial = IR.GetDevice("HDL Buspro Network (RS485)"); //name of HDL Buspro (RS485) driver in your project
 
    if (HDL_UDP && HDL_Serial) { //check for drivers existence in project
      HDL_UDP.SetParameters({RouteDevice: HDL_Serial.Name});
      HDL_Serial.SetParameters({RouteDevice: HDL_UDP.Name});
   }; 
});

After you launch a project where HDL Buspro Network (UDP), HDL Buspro Network (RS485) drivers are set and that has a script you can use LAN port of HS Server controller as an interface to access HDL Buspro serial bus.

As HDL gateway provides logic connection of two types of buses (Ethernet/UDP and RS485), there is no difference which interface of the HS Server controller will use to control devices: commands and feedback will easily go through the gateway. It is enough to set channels in one of the two drivers.

Scanning Ethernet for HDL Buspro devices

iRidium Studio has a convenient function that saves time on adding each device to a project manually. iRidium Studio requests the status of all devices in Ethernet via HDL Buspro protocol, gets answers and saved the network configuration and parameters of each device in the project.

1 To scan the network, click Scanner/ Import button in Drivers panel, then click Scan HDL-Bus Pro Net:

2 After it scanning starts and found devices appear:

3 You can choose what devices to add or not to add to a project by ticking. After clicking OK the selected devices with all parameters are written in HDL Buspro Network (UDP) driver of the project.

If there is no HDL Buspro Network (UDP) driver in the project, it will be created automatically.

If HDL gateway is activated in the HS Server controller, then its LAN port is scanned all HDL Buspro devices located in RS485 bus will be found. To do it supply power to the controller and the devices.

Setting KNX interface

iRidi Pro Server (HS Server) controller can work as a KNX bus device: it can receive and send commands via the KNX TP1 interface.

iRidi Pro Server (HS Server) controller can also function as a KNX/IP gateway, i.e. to provide connection of Engineering Tool Software (ETS) with the bus and work as client via the KNXnet/IP protocol (only after setting-up)

Server as KNX device

iRidi Pro Server (HS Server) controller can connect to any remote KNX IP interface or gateway to control it by the KNXnet/IP protocol (UDP) through the network. But, if the HS Server is connected to the bus via KNX TP1, it is necessary to choose the bus communication using this particular interface.

1 Connect iRidi Pro Server (HS Server) to the KNX bus through the KNX TP1 interface

2 Save the project file in one of the formats: *.pr3, *.pr4, *,pr5, *.knxproj, *.csv. It is recommended to use Latin when giving the name to the project. The Windows language has to be the same with the project language to import names of group addresses correctly.

3 Create a new project for the iRidi Server in iRidi studio: File> New > New Server Project...

4 Press Scanner/ Import in the Drivers panel, Select your ETS project and import it. The list of available KNX IP interfaces and group addresses will be formed on the base of the ETS project.

5 After you import the project, change the driver setting Protocol to Serial - it is provides communication between iRidi Pro Server (HS Server) and the KNX TP1 interface. Settings of connection to KNX will change completely.

6 Set parameters:

• Host: /oem/hal/knx_port
• Baud Rate: 38400
• Data Bits: 8
• Parity: None
• Stop Bits: 1
• Physical Address: the physical address of iRidi Pro Server as a bus device

7 Now the setup is complete. When you start the project on the server the connection will be established to the bus via the TP1 interface, iRidi Pro Server (HS Server) will be shown as a bus device (it will have its physical address) although it will not have its own group addresses.

This setup will not provide work of the iRidi Pro Server (HS Server) in the mode of a KNX/IP gateway. You have to do the settings described below.

Read about the further setting up of the iRidi Server and the KNX driver in the following sections:

• Server project in the iRidi Studio
• iRidi for KNX

Server as KNX-device and KNX/IP gateway

After the special setting up iRidi Pro Server (HS Server) can perform functions of a KNX/IP gateway:

• it provides connection of ETS with the bus (it is searched and added to ETS as a KNX interface)
• it provides connection of clients to the bus by the KNXnet/IP protocol
• it provides transfer of multicast packets from other KNX IP interfaces to the bus (routing)

1 Connect the iRidi Pro Server (HS Server) to the KNX bus through the KNX TP1 interface

2 Create a new project for iRidi Server in iRidi studio: File> New > New Server Project...

3 Import and configure (see. the previous section) or manually the driver KNX Router (KNXnet/IP) / Serial (UMC) for communication of iRidi Pro Server (HS Server) with the bus via KNX TP1.

• Host: /oem/hal/knx_port
• Baud Rate: 38400
• Data Bits: 8
• Parity: None
• Stop Bits: 1
• Physical Address: the physical address of iRidi Pro Server (HS Server) as a bus device

4 Create an empty script file (JS icon on the top toolbar + New Script) and paste the script in it:

IR.AddListener(IR.EVENT_START,0,function() 
{
   var KNXSerial = "KNX Router (KNXnet/IP) / Serial (UMC)";   // name of KNX Serial driver in your project
 
   if(IR.GetDevice(KNXSerial)) { 
      IR.GetDevice(KNXSerial).SetParameters({ServerDevice: "KNX IP"});
   }
   IR.CreateDevice(IR.DEVICE_KNX_IP_SERVER, 
                  "KNX IP",
                  {Port: 3671, 
                  ClientDevice: KNXSerial
                  });
});

5 After the project is launched with the configured driver and script on the iRidi Pro Server (HS Server) you will be able to find the HS Server in ETS and use it as an interface to access the bus.

Server as KNX/IP gateway

There is an easier way to activate the KNX/IP gateway function without creating a driver or scripts (as described above). To do this, you need to activate the KNX/IP gateway mode in the web-interface in the following folder Network > SYSTEM > Other > Server working mode.

There must be no driver of "KNX Serial" type in the project.

The server can't work as a KNX device in this case.

Scanning and monitoring KNX bus

To monitor and scan the bus you need to set server as KNX/IP gateway.
After it launch ETS app to set and debug KNX devices and go to the Bus tab. Connect a required interface.

Scanning KNX bus

Scanning the bus allows to see devices connected to one bus of KNX network.
Go to the corresponding tab of the menu to do it:

Fill in Line Address field and select data transfer medium

Click Scan.
The server scans the bus and displays on the screen addressed of all devices connected to the bus.

If a device on the KNX bus with default settings is not found after scanning the bus via ETS5, change the device physical address in the driver settings (step 3) to other than 15/15/255.

Monitoring KNX bus

There are 2 types of monitoring in ETS

• monitoring of group operations;
• monitoring of the bus.

Monitoring of group operations allows to read the current state of a definite device and write a new value in it. To do it, go to the Group Monitor tab and click Start.

To read a value or to write a value to a device, enter the device address in the Group Address field.

When Read button is clicked, a value from a device in the bus appears in the table

To change this value, write a new value in the Value field and click Write.

Monitoring KNX bus with the help of ETS

iRidium Server Pro version 1.2.11 and later supports monitoring KNX bus with the help of Engineering Tool Software (ETS). To do it, activate KNX/IP-gate, as written in the manual Server as KNX/IP gateway.

1 Launch ETS. Go to the Diagnostics tab.

2 Next go to the Bus Monitor tab.

3 Select from the list the GatewayKNXServerIP interface that you want to monitor.

4 Click Start. You can see all data that go via the KNX/IP gateway in real time.

Testing the Server

Launching the project in test mode

Test mode allows you to upload and test the projects from the iRidi Studio without buying of license. When you upload the project to the server from the iRidi cloud it uses commercial or Trial license.

The project upload from the iRidi Studio to the server is provided by the iRidi Transfer program and the enabled test mode on the server.

In iRidi Transfer press Search button when the server are ready. As a result of the search you will see a new device in Transfer with the name <NAME> (Server)

Activate the option "Test Mode: ON" in the server settings to use it in the fully functional mode. You can see more information about the use modes in the section Licensing Policy.

Check if the Test Mode is activated by clicking a button in the bottom left corner.

With the activated Test Mode you can also test work of cloud projects and upload projects from iRidi Transfer (locally, without iRidi cloud).

Starting a Project in Test mode

To test the projects on end-users devices use the Trial Mode. It allows end-users to test projects for 60 days. You cannot prolong the trial period, but it is available for any new object in the cloud. After the trial period is over the client decides if he wants to buy iRidium license.

To activate the trial license:

• go to the personal account of integrator;
• select the required object from the list;
• go to the tab pro > MY PROJECTS > Licenses;
• activate a temporary license for 2 months "Get trial period (2 month)".

The trial license can be applied only once to one object, after 2 months it will stop working.

Only 1 server can be binding to an object. Do not upload the project from this cloud object to another server, this may lead to a lack of remote connection and other possible problems.

In order to unbind the server from the cloud object, firstly you should deactivate the server, and then upload the project to another server.

For more information about choosing and activating a license, see the article "Licensing policy iRidium".

Activation and deactivation of the server

Server activation and deactivation are described in the instructions:

• online server activation;
• offline server activation with a USB key.

Control from panels stopped working?

Eliminate possible license problems, if you suddenly lost control from the panels:

1 Make sure that the server is activated.

Activation of more than 1 server in one cloud project leads to malfunction of the remaining servers. The number of activated servers on the object can be seen in the personal account of integrator on the tab MY PROJECTS > Users and Panels. If it is necessary, you can deactivate an unnecessary server according to the instructions.

2 Make sure that the number of panels does not exceed the commercial license limit (details here).

3 Check the connection to the server with a trial license.
If the previous steps did not help you, activate trial license, to recover the server operation and describe your situation to technical support support@iridi.com, by specifying:

• server mode: cloud gate / direct connect;
• server type: umc / windows/ rpi;
• server hwid;
• server is activated by the account: integrator's email;
• server version;
• panels that have problems in the project:
  • panel hwid;
  • authorized user email;
  • version of installed application
• the name of the object in the personal account;
• additional files (if it is necessary): server log, screenshots, video recording, etc.