Name

getMetadata

Synopsis

getMetadata nodeURL port [acilpsx]

Description

The getMetadata utility retrieves metadata from the instrument service on the specified port(s) of the specified SIAM node.

Options

Option Description Values
nodeURL IP address or host name of SIAM node e.g. 134.89.88.1, mooring.moos.mbari.org
portName Name of instrument port (or alias) defined in siamPort.cfg /dev/ttyS8, COM1, /dev/tty.KeySerial1
a,c,i,l,p,s,x Optionally return one or more specific metadata components (default is all)
  • a - components (default)
  • c - service cache
  • i - instrument state
  • l - log sample (for testing)
  • p - service properties (file defaults)
  • s - service attributes (current values)
  • x - service xml file

Example output:

					getMetadata localhost /dev/tty.KeySerial1 
					Looking for node server stub at rmi://localhost/node
					Got proxy for node service "org.mbari.siam.moos.deployed.MOOSNodeService"
					Requesting packet...components = 0x1f
					Packet received:
					
					parentID=999, recordType=0
					devid=1151, t=1285793339992, seqNo=0, mdref=0
					cause=just checking
					<SRVC_MD>
					commPowerPolicy=ALWAYS
					summaryTriggerCount=0
					rbnbCacheFrames=1024
					advertiseService=false
					frameworkVersion=$Name:  $
					svalue=2
					dataShelfLifeHours=-1.0
					serviceStatus=6
					diagnosticSampleInterval=1
					powerOnDelaySec=0
					locationName=
					peakCurrentMa=5000
					maxSummarySamples=0
					bvalue=1
					powerPolicy=ALWAYS
					sampleTimeoutMsec=1000
					dvalue=5.0
					parentID=999
					currentLimitMa=500
					extendedVersion=My extended version
					nominalCurrentMa=1000
					UUID=00000000-0000-0000-0000-000000000000
					errCacheLimit=5
					sampleSleepSec=30
					maxSampleTries=3
					strValue=six
					publisherHost=
					throwInitializeException=false
					longValue=4
					startDelayMsec=500
					defaultSkipInterval=0
					isiID=1151
					instrumentName=UNKNOWN
					rbnbArchiveFrames=102400
					registryName=Dummy
					timeSynch=false
					serviceName=Dummy
					className=org.mbari.siam.devices.dummy.DummyInstrument$Attributes
					packetSetSize=10
					sampleSchedule=R */30 */0 */0 */0 * * * * GMT *
					ivalue=3
					</SRVC_MD>
					<SVP_MD>
					#Persisted
					#Wed Sep 29 13:04:35 PDT 2010
					commPowerPolicy=ALWAYS
					summaryTriggerCount=0
					rbnbCacheFrames=1024
					advertiseService=false
					svalue=2
					dataShelfLifeHours=-1.0
					diagnosticSampleInterval=1
					powerOnDelaySec=0
					locationName=
					peakCurrentMa=5000
					maxSummarySamples=0
					bvalue=1
					powerPolicy=ALWAYS
					sampleTimeoutMsec=1000
					dvalue=5.0
					currentLimitMa=500
					nominalCurrentMa=1000
					UUID=00000000-0000-0000-0000-000000000000
					errCacheLimit=5
					sampleSleepSec=30
					maxSampleTries=3
					strValue=six
					publisherHost=
					throwInitializeException=false
					longValue=4
					startDelayMsec=500
					defaultSkipInterval=0
					isiID=1151
					instrumentName=UNKNOWN
					rbnbArchiveFrames=102400
					registryName=Dummy
					timeSynch=false
					serviceName=Dummy
					sampleSchedule=R */30 */0 */0 */0 * * * * GMT *
					packetSetSize=10
					ivalue=3
					</SVP_MD>
					
					<DEV_MD>
					does not provide instrument state information
					</DEV_MD>
					<DOC_MD>
					[xml here...]
					</DOC_MD>

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

listPorts