annotatePort - annotate instrument data stream on specified port of specified MOOS node

annotatePort nodeHost portName(s) note

The annotatePort utility sends a user-specified text annotation to the instrument service on the specified port(s) of the specified MOOS node; the instrument service then writes the annotation to the instrument log file as a SIAM message packet. The last argument, which is the notation, must be included in quotes (single or double) if the notation contains spaces. E.g. the following appends a note to the service on /dev/ttySX6:

% annotatePort localhost /dev/ttySX6 "Instrument cable knocked loose - reseated it"

The portName can be abbreviated as an integer, i.e. "/dev/ttySX1" can be abbreviated as simply "1", e.g.

% annotatePort surface 1 "Power service seems intermittent"

This utility may be run on the same host as the node, or on any networked host from which the node host is accessible. If run on the node's host, then nodeHost can be specified as "localhost" or simply "loc".

The following environment variables must be set:

• JAVA_HOME - location of Java installation, e.g. /j9 or /opt/java/jdk1.3.1
• JAVA - name of the JVM. E.g. on a Sidearm, JAVA should be set to j9. On a workstation with Sun's Java installed, JAVA could be set to java.
• SIAM_HOME - top of the SIAM directory tree
• SIAM_CLASSPATH - on a Sidearm, SIAM_CLASSPATH should be set to $JAVA_HOME/lib/jclMax/classes.zip:$JAVA_HOME/lib/prsnlmot.jar:$JAVA_HOME/lib/RXTXcomm.jar:$SIAM_HOME/classes.  On X86 system, SIAM_CLASSPATH should be set to $SIAM_HOME/classes

SEE ALSO

 listPorts