annotatePort nodeURL portName notation


The annotatePort utility inserts a user-specified text annotation into an instrument service data stream. This is a convenient way to include notes about events that are contextually important to the data stream, but may not otherwise be captured.

The annotation is written to the instrument log file as a SIAM message packet. The annotation argument must be last; if it contains whitespace, it must be enclosed in quotes (single or double).


Option Description Values
nodeURL IP address or host name of SIAM node e.g.,
portName Name of instrument port (or alias) defined in siamPort.cfg /dev/ttyS8, COM1, /dev/tty.KeySerial1
annotation Note to include in data stream. -

Example output:

annotatePort localhost /dev/tty.KeySerial1 "Instrument bitten by land shark - may need recalibration"
Looking for node server stub at rmi://localhost/node
Got proxy for node service "org.mbari.siam.moos.deployed.MOOSNodeService"


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

For Sun JVM (e.g. linux, win32, mac OS)
SIAM_HOME top of the SIAM directory tree -
SIAM_CLASSPATH Path including all SIAM and supporting classes For MMC

For linux/win32

See Also