SIAM Configuration Guide

Configuration Files

SIAM is configured primarily through environment variables and Java Properties files. The following table describes the main SIAM configuration files' location and purpose:

Environment variables

The configuration of main SIAM environment variables is discussed in the Installation Guide.

siamPort.cfg

The file siamPort.cfg (SIAM_HOME/properties/siamPort.cfg) is a Java properties file for SIAM node configuration. The Java API documentation describes the syntax rules of properties files, but essentially they contain name=value pairs that define configuration parameters.

siamPort.cfg is conventionally organized in sections: port configuration, node configuration, platform-specific settings. However, no specific ordering is required. If duplicate property names exist, the last one (towards the end of the file) is used.

The sections below provide details about the various properties.

The examples directory contains a version of siamPort.cfg

Instrument Service Ports

/dev/ttys0:\
        /dev/ttys1:\
        /dev/ttys2:\
        /dev/ttys3:\
        /dev/ttys4:\
        /dev/ttys5:\
        /dev/ttys6:\
        /dev/ttys7:\
        /dev/ttys8:\
        /dev/ttys9:\
        /dev/ttys10:\
        /dev/tty.KeySerial1:\
        /dev/ttysX15:
		

Node Configuration Settings

Network Configuration Settings

Platform-Specific (MMC, FOCE, etc.)

FOCE

MMC

siam.log4j

The siam.log4j file is a configuration file for the log4j open source logging package. It may be used to determine what logging information appears in the SIAM application logs.

At runtime, the environment variable LOG4J_THRESHOLD sets the default logging output level, and is set by the script that runs the SIAM application. It may be overridden in siam.log4j. The configuratio file may also be used to format the debug output. A sample file appears below:

# For the general syntax of property based configuration files see the
# documenation of org.apache.log4j.PropertyConfigurator. See also
# http://www.vipan.com/htdocs/log4jhelp.html

#log4j.rootCategory=WARN, stdout, rolling, lf5
log4j.rootCategory=INFO, rolling

# Set logging level for specific packages 

# Recommend leaving the following loggers in DEBUG to aid in 
# diagnosis of bug SIAM-58 (EventManager loses track of DevicePacketAggregator
# listener)
#log4j.logger.org.mbari.siam.core.DevicePacketAggregator=DEBUG
log4j.logger.org.mbari.siam.core.EventManager=INFO
#log4j.logger.org.mbari.siam.devices.dummy.DummyInstrument=DEBUG

# CONSOLE APPENDER (stdout) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
#log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c %x - %m%n
log4j.appender.stdout.layout.ConversionPattern=%r %-5p %x %c{1} [%t]: %m%n

# ROLLING FILE APPENDER (rolling) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
log4j.appender.rolling=org.apache.log4j.RollingFileAppender
log4j.appender.rolling.File=${siam.node.log}
log4j.appender.rolling.layout=org.apache.log4j.PatternLayout
#log4j.appender.rolling.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c %x - %m%n
log4j.appender.rolling.layout.ConversionPattern=%r %-5p %x %c{1} [%t]: %m%n
log4j.appender.rolling.MaxFileSize=10000KB
log4j.appender.rolling.MaxBackupIndex=5

# LF5 APPENDER (lf5) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
log4j.appender.lf5=org.apache.log4j.lf5.LF5Appender
log4j.appender.lf5.MaxNumberOfRecords=10000

SIAM directs stdout and stderr to the siam application logs (SIAM_HOME/logs/nodeName-startDate); log4j also uses this log file for its rolling log appender, so the logs are rotated so they will not grow beyond some maximum size defined in siam.log4j. As can be seen in the example, it is possible to configure the debug level on a class by class basis, or use a common default value for all appenders.

siamEnv

The file siamEnv (found in the distribution as SIAM_HOME/native/arm-linux/top/etc/siam/siamEnv) may be used to configure key environment variables for the SIAM application. These settings may also be set in (or sourced from) .bashrc for user accounts used for SIAM administration. siamEnv also contains convenient aliases for frequently used commands, as well as options for the Java virtual machine used for SIAM.

# .bashrc

# Environment for SIAM applications
# Note that SIAM_HOME *must* be set prior to executing this script.

# Setup Java
. /j9/j9env
export JAVA=j9
export JAVA_OPTIONS="-mca:32 -mco:64 -mx:24576 -mo:1024 -moi:256"

export SIAM_BIN=$SIAM_HOME/bin/arm-linux
export SIAM_CODEBASE=http://`hostname`/codebase/

export PARENT_HOST=surface
export SIAM_CLASSPATH=$JAVA_HOME/lib/jclMax/classes.zip:$JAVA_HOME/lib/prsnlmot.jar:$JAVA_HOME/lib/RXTXcomm.jar:$SIAM_HOME/classes:/mnt/hda/codebase:$SIAM_HOME/jars/javax.jar:$SIAM_HOME/jars/gnu_getopt.jar:$SIAM_HOME/jars/jrendezvous.jar:$SIAM_HOME/jars/log4j-1.2.13.jar:$SIAM_HOME/jars/XModem.jar:$SIAM_HOME/jars/jddac-common.jar:$SIAM_HOME/jars/jddac-probe-j2me.jar:$SIAM_HOME/jars/backport-util-concurrent.jar:$SIAM_HOME/jars/rbnb.jar

# Set to TRUE if you want SIAM node app to start on reboot

export LOG4J_THRESHOLD=DEBUG
export SIAM_LOG4J=$SIAM_HOME/properties/siam.log4j

export PATH=.:$PATH:$SIAM_HOME/utils:$SIAM_BIN:/etc/siam:$HOME/bin

alias gosiam='cd $SIAM_HOME'
alias java=j9
alias ls='ls -F'
alias ll='ls -AlF'
alias dhcp=ifswitch-to-dhcp

export SIAM_AUTOSTART=TRUE

export ETHERNET_ADDRESS_PREFIX=134.89.37
export PARENT_LINK_ON_SCRIPT=
export PARENT_LINK_OFF_SCRIPT=
export SIAM_EXIT_SCRIPT=/etc/siam/postSIAM

System Files