Debugging RXTX

Debugging RXTX Bundle / Natives

Updated rxtx bundle supports various levels of java only and native debugs.

Java Debug Properties

Property	Type	Description
gnu.io.debug	boolean	Enables debug dumps on System.out from RXTXDriver and RXTXPort classes.
gnu.io.trace	boolean	Enables stacktraces on critical CommPortIdentifier, RXTXDriver and RXTXPort functions (e.g. openPort, close, initialize()).
gnu.io.log.mode	String	Use PRINT_MODE for enabling RXTXPort debug dumps (this forces Zystem logger to use System.out).
gnu.io.raw	boolean	flag for dumping raw IO with the port.
gnu.io.debug.lock	boolean	Flag for dumping IOLock increment/decrement (useful in case of RXTXPort.close() problems with IOLocked > 0).
gnu.io.debug.lock.threads	boolean	Flag for dumping IOLock caller Thread names.
gnu.io.debug.lock.trace	boolean	Flag for dumping IOLock caller stacktrace.
gnu.io.debug.read	boolean	Enable SerialInputStream.read related dumps (useful for checking blocked reads).
gnu.io.debug.read_results	boolean	Enable SerialInputStream.read verbose read dumps (useful for checking blocked reads).
gnu.io.debug.write	boolean	Enable SerialOutputStream.write related dumps (useful for checking blocked reads).
gnu.io.debug.events	boolean	Enable SerialPortEventListener (RXTXPort.sendEvent()) related dumps.
gnu.io.debug.verbose	boolean	Enable additional dumps in SerialPortEventListener handler and available().
gnu.io.cpi.debug	boolean	Enables CommPortIdentifier debug dumps.
mbs.comm.debug	boolean	Enables rxtx Activator / OSGi log debug.
mbs.comm.console	boolean	Enables console dumps for Activator / OSGi log.

Recommended Debug Settings for Bug Reporting

set/export RXTX_LOG=rxtx.log (in console before starting server)
set/export RXTX_DEBUG=1 (in console before starting server)
modify default.prs:
mbs.comm.debug = true
mbs.comm.console = true
gnu.io.debug = true
gnu.io.trace = true
gnu.io.log.mode = PRINT_MODE
gnu.io.raw = true

Native Debug Levels

Native code supports 5 levels of logging verbosity (verbose and trace are compiled optionally):

error: error messages (always dumped on system out)
warning: warning messages (always dumped on system out)
debug: most useful and non flooding dumps are printed on console (but not System.out/err). (Supported if compiled with DEBUG defined and RXTX_DEBUG is set)
verbose: not so important (flooding) dumps are printed on console (but not System.out/err). (Supported if compiled with DEBUG_VERBOSE defined and RXTX_VERBOSE is set)
trace: prints ENTER/LEAVE for most of the native functions (not on System.out/err). Should be used in case of jvm crashes mostly (Supported if compiled with TRACE define and RXTX_TRACE is set)
To enable one of the above debug levels you could export the following environment variables before starting Bosch IoT Gateway Software: RXTX_DEBUG, RXTX_VERBOSE, RXTX_TRACE or use RXTX_LOG to redirect all built-in (e.g. debug, verbose, trace) dumps into the specified log file.

If you export RXTX_VERBOSE, but native libs are not compiled with DEBUG_VERBOSE - no verbose dumps can be dumped. RC bundles have been compiled with -DDEBUG, so for default builds exporting RXTX_DEBUG variable before starting Bosch IoT Gateway Software will produce some relevant rxtx dumps (prefixed with "[rxtxSerial]").