Name

samplePort

Synopsis

samplePort nodeURL portName [portName...]

Description

The samplePort utility triggers acquisition of a data sample from the instrument on the specified port(s) of the specified SIAM node; samplePort then displays the resulting data sample.

Options

Option Description Values
nodeURL IP address or host name of SIAM node e.g. 134.89.88.1, mooring.moos.mbari.org, localhost
portName Name of instrument port (or alias) defined in siamPort.cfg /dev/ttyS8, COM1, /dev/tty.KeySerial_1

Example output:

samplePort foce.mars.mbari.org /dev/ttyS8
SIAM version $Name:  $
Elmo Thruster Controller:
parentID=1726, recordType=1
devid=1728, t=1285734310478, seqNo=1697773, mdref=1377345
nBytes=36
0,0,6004140,3000,-2,-1,1285734310479

		

The data returned may also include parsed or processed data if the instrument service sampled has a built-in parser, for example:

name: motor1 string
encoderVelocity: 0 counts/sec
joggingVelocity: 0 counts/sec
statusRegister: 100680000 bit field (integer)
faultRegister: 12288 bit field (long)
turnSensorState: DISABLED state
turnSensorCount: -1 triggers
turnSensorTime: 1285734310479 ms
srString: 
Drive Read: ok
Drive Status: ok
Motor ON (MO): false
Reference Mode (RM): interpreter/user program
Motor Failure Latched: true
...

Environment

The following environment variables must be set:

Variable Description Example
JAVA_HOME location of Java installation
/j9, /opt/java/jdk1.3.1, etc.
JAVA Path to JVM command For MMC
$JAVA_HOME/bin/j9

For Sun JVM (e.g. linux, win32, mac OS)
$JAVA_HOME/bin/java
SIAM_HOME top of the SIAM directory tree -
SIAM_CLASSPATH Path including all SIAM and supporting classes For MMC
$JAVA_HOME/lib/jclMax/classes.zip:$JAVA_HOME/lib/prsnlmot.jar:$JAVA_HOME/lib/RXTXcomm.jar:$SIAM_HOME/classes

For linux/win32
$SIAM_HOME/classes

See Also