Setup Guide

Prerequisites

There are no prerequisites for this module.

Installation

There are two ways to install the desired module components: through the Kit Manager or manually.

Automated Installation

The Kit Manager is a utility that enables you to automatically install a component or a group of components by executing a predefined install script.

To use the Kit Manager to install a component:

Go to the text console and make sure the Kit Manager bundle is available on your runtime.
Enter the kitman console command group to initiate the installation. Type
kitman.install "<kit_ID>"

where <kit_ID> is the ID of the component's install script. The following scripts for automated installation of the HomeConnect module are available:

"Modbus Serial" for the module's core functionality as well as the serial transport bundle and general communications bundle.
"Modbus TCP" for the module's core functionality as well as the TCP transport bundle.
"Modbus Simulator" for the module's core functionality, the TCP transport bundle and the Simulator bundles.

If you want to view or edit these scripts you can find them in the <sdk_home>/runtime/osgi/bin/pscripts directory.

Manual Installation

You can install only the needed bundles from the module taking into account their dependencies both from this module and from other modules as well. All the bundles for this module can be found in the /runtime/osgi/bundles directory.

In order to install the Modbus module, please install and start the following bundles:

Install and start the following bundles with the corresponding commands for the module's core functionalities:
fw.i -s com.prosyst.mbs.modbus.api.jar

fw.i -s com.prosyst.mbs.modbus.driver.jar

fw.i -s com.prosyst.mbs.modbus.manager.jar

fw.i -s com.prosyst.mbs.modbus.commands.jar
Install and start the following bundle with the corresponding commands to add the TCP transporting ability:
fw.i -s com.prosyst.mbs.modbus.transport.tcp.jar
Install and start the following bundles with the corresponding commands to add the serial and parallel module functionality:
fw.i -f com.prosyst.mbs.comm.rxtx-natives.linux_x86_generic.jar

For 32-bit Linux OS systems.

fw.i -f com.prosyst.mbs.comm.rxtx-natives.linux_x86_64_generic.jar

For 64-bit Linux OS systems.

fw.i -f com.prosyst.mbs.comm.rxtx-natives.macosx_x86.jar

For 32-bit Mac OS systems.

fw.i -f com.prosyst.mbs.comm.rxtx-natives.macosx_x86_64.jar

For 64-bit Mac OS systems.

fw.i -f com.prosyst.mbs.comm.rxtx-natives.win_x86.jar

For 32-bit Windows OS systems.

fw.i -f com.prosyst.mbs.comm.rxtx-natives.win_x86_64.jar

For 64-bit Windows OS systems.

fw.i -s -f -l com.prosyst.mbs.comm.rxtx.jar
Install and start the following bundle with the corresponding commands to add the Serial transporting ability:
fw.i -s com.prosyst.mbs.modbus.transport.serial.jar
Install and start the following bundles with the corresponding commands to use the Simulator:
fw.i -s com.prosyst.mbs.modbus.simulator.api.jar

fw.i -s com.prosyst.mbs.modbus.simulator.jar

fw.i -s com.prosyst.mbs.modbus.simulator.commands.jar

Configuration Properties

The Modbus Transport TCP Bundle registers a single ManagedService instance with PID mbs.modbus.transport.tcp.pid. Any change in this configuration affects only connections created or reopened after the changes are made. This configuration provides the following properties:

Name	Property	Type	Default Value	Description
Connection Keep Alive	connection.keep.alive	boolean	true	Whether to use the Keepalive mechanism provided by the OS. Allowed values: true false
Connection Timeout	connection.timeout	integer	5	Controls the timeout used when establishing a new connection. Measured in seconds. Allowed values are from 1 to 30.
Socket Timeout	socket.timeout	integer	10	Controls the socket timeout - the timeout used when executing a read operation. Measured in seconds. Allowed values are from 1 to 30.

Name

Property

Type

Default Value

Description

Connection Keep Alive

connection.keep.alive

boolean

true

Whether to use the Keepalive mechanism provided by the OS.

Allowed values:

true
false

Connection Timeout

connection.timeout

integer

Controls the timeout used when establishing a new connection. Measured in seconds.

Allowed values are from 1 to 30.

Socket Timeout

socket.timeout

integer

Controls the socket timeout - the timeout used when executing a read operation. Measured in seconds.

Allowed values are from 1 to 30.

Troubleshooting

No troubleshooting information is available for this module.