Setup Guide

Prerequisites

To successfully install and launch an OSGi Module you need to perform the steps in the order below:

Set the required system properties, if any (as described in the System Properties section).
Install and start all required bundles for the module, i.e. Perform the steps from the Installation section.
Perform, if required, runtime configuration of the module, i.e. set the Configuration Properties as described in the Configuration Properties section.

Installation

Automated Installation

The installation of the Serial and Parallel Module can be performed through execution of a Kit Manager installation script located in bin/pscripts:

"Comm (gnu.io) Bundle" (found in the file comm.txt)

To install the Serial and Parallel Module, type the following command in the console:

kitman.install "Comm (gnu.io) Bundle"

The kitman command group is exported by the Kit Manager Bundle. You may also write your own install scripts for easier installation (and start) of a certain set of bundles. The required bundles for the Serial and Parallel Module are listed in the Manual Installation section.

Manual Installation

If you want to install the Serial and Parallel Module without using the provided installation script follow the steps below:

Install the OS/architecture specific bundle from the list bellow
- Windows: COMM Windows Support Bundle
- Linux: COMM Linux Support Bundle
- OS X: COMM OSX Support Bundle
Install and start com.prosyst.mbs.comm.rxtx.jar

System Properties

Property	Type	Default Value	Description
mbs.comm.debug	boolean	"false"	If set to "true", the respective COMM (gnu.io) Bundle will print in the server's runtime console additional debug messages, mostly related to dealing with virtual ports.
mbs.comm.devices	String	"-"	Mandatory if you are using a Mac OS X Operating System and also required in some special cases - see COMM Windows Support Bundle and COMM Linux Support Bundle The value is a comma separated list of the names of the ports, which are dynamically allocated. Example: /dev/tty.SLAB_USBtoUART, /dev/tty.SLAB_USBtoUART0, /dev/tty.SLAB_USBtoUART1
comm.devices	String	"-"	Identical with mbs.comm.devices. Only used if mbs.comm.devices is not set, i.e. for compatibility with older properties files.
mbs.comm.console	boolean	"false"	Enable OSGi log console dumps for comm Log

For OS X: In order for the different controllers, that relay on COM port communication to be working, their corresponding COM ports must be set manually in the default.prs file in the comm.devices properties in the following format:comm.devices=<com port1>, <com port2>.

Environment Variables

Name	Description
RXTX_POLL_TO	Override default serial port polling timeout (10 ms). The valid range is [1..1000]. On slow hardware increasing the timeout will reduce the idle CPU usage for Java.
RXTX_LOCKDIR	Overrides the default locking directory (hard coded to e.g. "/var/lock" for Linux). If default or overridden lock directory is not writable, a fallback "/tmp" directory is used for locking. Lock dir is ignored on Windows.
RXTX_LOG	If set to a writable file, will log every message from rxtx native code in specified file. If log file is set, any available(compiled in) log level will be logged, regardless if they are enabled for printing or not.
RXTX_QUIET	If set, disables all console dumps from rxtx native code.
RXTX_DEBUG	If set, will enable debug messages from rxtx native code on console.
RXTX_VERBOSE	If set, will enable verbose debug messages from rxtx native code on console (if native was compiled with _DEBUG_VERBOSE_ defined).
RXTX_TRACE	If set, will enable function trace messages from rxtx native code on console (if native was compiled with _TRACE_ defined).
RXTX_NOTCDRAIN	If set, prevents using tcdrain() calls, in case of buggy system drivers.

Troubleshooting

No troubleshooting information is available for this module.