Index of SIAM user documentation
Node service management
Service jar files and PUCKs
Instruments and ports
CPU, power, timekeeping, and communications
management
All utilities
MMC
and SIAM Users Guide
Node service management
enableSleep/disableSleep -
enable/disable sleep management on specified MOOS node
enableSleep nodeHost
disableSleep nodeHost
exitNode -
shutdown each instrument service and exit the SIAM application
exitNode nodeHost
listSubnodes
- list subnodes of specified MOOS node
listSubnodes nodeHost
node - start a
MOOS node service
node portalHost [verbosity]
nodeInfo - display basic information for
specified MOOS node and its subnodes
nodeInfo nodeHost
nodeStatus
- list diagnostic information for specified MOOS node
nodeStatus nodeHostname
Service jar files and PUCKs
catPuck - quickly identify the cotents of a
puck
catPuck portName
puckit - create "jar file" for instrument
service
puckit serviceClassName propertiesFile jarFile
readPuck - extract the contents of the puck
and store it in a local file
readPuck portName
writePuck - write service code and
metadata to the pucks non-volatile memory
writePuck jarFile portName [-id]
Instruments and ports
annotatePort - annotate instrument data
stream on specified port of specified MOOS node
annotatePort nodeHost portName(s)
cachePort - cache current property values,
or clear the cache, for service on specified node and port
cachePort nodeHost portName(s) [-clear]
conPort - acquire a console to a specific
port
conPort nodeHost portName
dpaView - manipulate DPA ports
DPA test and configuration tool
getfilter, setfilter, clearfilter -
manipulate telemetry
filters
getfilter nodeHostname deviceID
setfilter nodeHostname -types type(s) -skip interval deviceID
clearfilter nodeHostname deviceID
getLastSample - retrieve and display
latest data sample from instrument on specified port of specified MOOS
node
getLastSample nodeHost portName(s)
getLeases - list cpu and comms leases
established on specified node
getLeases nodeHostname
getMetadata - retrieve and display
metadata from instrument service on specified port of specified MOOS
node
getMetadata nodeHost portName(s)
getPackets - retrieve packets from
specified instrument service on specified host
getPackets nodeHostname [options] deviceID
Instrument Data Summaries and
Telemetry Subsampling
Instrument Service Properties
logView - Display packets from specified
SIAM log to stdout
logView [options] ISI-ID directory
portProperties - display properties
of device service on specified host and port MOOS node
portProperties nodeHost portName(s)
portStatus - display status of node
instrument port MOOS node
portStatus nodeHost portName(s)
powerDownPort - power down and isolate
an instrument port
powerDownPort portName
powerUpPort - power up and enable comms
on an instrument port
powerUpPort portName
restartPort - restart device
service
on specified host and port MOOS node
restartPort nodeHost portName(s)
samplePort - trigger acquisition and
display data sample from instrument on specified port of specified MOOS
node
samplePort nodeHost portName(s)
scanPort - load instrument service for
specified port on specified MOOS node
scanPort nodeHost portName(s)
Scheduling utilties
setProperty - set device service
properties to specified values on specified host and port
setProperty nodeHost portName(s)
shutdownPort - shutdown the service
on specified port(s) on specified MOOS node
shutdownPort nodeHost portName(s)
CPU, power, timekeeping, and
communications management
cpuAwake (alias "a") - Keep the CPU awake
(veto sleep mode), or schedule a wakeup in the future.
cpuAwake [when] [howLong] [-r rqstID] [nodeHost]
getLeases - list cpu and comms leases
established on specified node
getLeases nodeHostname
killj9 - kill j9 JVM parent process and children
killj9
killBIN -
"safe" and shutdown instruments, and prepare for node shutdown
killBIN node [-bkqrs][-D quitDelaySec][-H haltDelaySec]
lease - get a lease on the node's
communications link
lease
ricohRTC - get/set time maintained by the
Ricoh RTC; or interactively set its registers
ricohRTC [-i] [-s] [-t] [-a ] [-k <0|1>] [-m <12|24>] [-h]
switchBIN400V - get status of HV
switch, or toggle HV power to subnodes
switchBIN400V node portName [ON|OFF|channelON|channelOFF|ALLON|ALLOFF]
switchHiVoltage - enable the high
voltage converters on the MOOS Power System
switchHiVoltage nodeHost portName [ON|OFF]
suspend - put the CPU into suspend (sleep)
mode
suspend [-n] [-v] []
wakeup - wakeup suspended node(s) via Medusa
broadcast
wakeup bcastOrigin
All documented utilities
addService - add a service Jar file to
the service code directory for use with an ID only puck
addService jarFile
annotatePort - annotate instrument data
stream on specified port of specified MOOS node
annotatePort nodeHost portName(s)
auxTelem.sh - Shell script passed to
/etc/inittab to enable the secondary radio port as a Linux tty
auxTelem.sh [-d device] [-b baud] [-t timeout] [-s sleep_time]
binBackups - manipulate backup batteries
and capacitors in MOOS power system
binBackups node portName option
cachePort - cache current property values,
or clear the cache, for service on specified node and port
cachePort nodeHost portName(s) [-clear]
catJar - list the contents of a jar file
catJar jarFile [x]
catPuck - quickly identify the cotents of a
puck
catPuck portName
conPort - acquire a console to a specific
port
conPort nodeHost portName
cpuAwake (alias "a") - Keep the CPU awake
(veto sleep mode), or schedule a wakeup in the future.
cpuAwake [when] [howLong] [-r rqstID] [nodeHost]
dpaView - manipulate DPA ports
DPA test and configuration tool
enableSleep/disableSleep -
enable/disable sleep management on specified MOOS node
enableSleep nodeHost
disableSleep nodeHost
exitNode - shutdown each instrument service
and exit the SIAM application
exitNode nodeHost
getfilter, setfilter, clearfilter -
manipulate telemetry
filters
getfilter nodeHostname deviceID
setfilter nodeHostname -types type(s) -skip interval deviceID
clearfilter nodeHostname deviceID
getLastSample - retrieve and display
latest data sample from instrument on specified port of specified MOOS
node
getLastSample nodeHost portName(s)
getLeases - list cpu and comms leases
established on specified node
getLeases nodeHostname
getMetadata - retrieve and display
metadata from instrument service on specified port of specified MOOS
node
getMetadata nodeHost portName(s)
getPackets - retrieve packets from
specified instrument service on specified host
getPackets nodeHostname [options] deviceID
Instrument Service Properties
killj9 - kill j9 JVM parent process and
children
killj9
killBIN - "safe" and shutdown instruments, and prepare for node
shutdown
killBIN node [-bkqrs][-D quitDelaySec][-H haltDelaySec]
lease - get a lease on the node's communications link
lease
listPorts - list ports and services
associated with a specified MOOS node
listPorts nodeHostname
listServices - list the services that
have been added to a node using the addService command
listServices
listSubnodes
- list subnodes of specified MOOS node
listSubnodes nodeHost
listSwitches - list DPA power switches
associated with a specified MOOS node
listSwitches nodeHost
logPublish - publish contents of device
log to SSDS
logPublish logDirectory deviceID
logView - Display packets from specified
SIAM log to stdout
logView [options] ISI-ID directory
node - start
a MOOS node service
node portalHost [verbosity]
nodeInfo - display basic information for
specified MOOS node and its subnodes
nodeInfo nodeHost
nodeStatus - list diagnostic information
for specified MOOS node
nodeStatus nodeHostname
portal - launch a portal server
portal [options] [nodeHost [nodeHost2 [...]]]
portProperties - display properties
of device service on specified host and port MOOS node
portProperties nodeHost portName(s)
portStatus - display status of node
instrument port MOOS node
portStatus nodeHost portName(s)
powerDownPort - power down and isolate
an instrument port
powerDownPort portName
powerUpPort - power up and enable comms
on an instrument port
powerUpPort portName
puckit - create "jar file" for instrument
service
puckit serviceClassName propertiesFile jarFile
readPuck - extract the contents of the puck
and store it in a local file
readPuck portName
removeService - remove a service that
has been added to a node using the addService command
removeService UUID
restartPort - restart device service
on specified host and port MOOS node
restartPort nodeHost portName(s)
ricohRTC - get/set time maintained by the
Ricoh RTC; or interactively set its registers
ricohRTC [-i] [-s] [-t] [-a ] [-k <0|1>] [-m <12|24>] [-h]
samplePort - trigger acquisition and
display data sample from instrument on specified port of specified MOOS
node
samplePort nodeHost portName(s)
scanPort - load instrument service for
specified port on specified MOOS node
scanPort nodeHost portName(s)
Scheduling utilties
setProperty - set device service
properties to specified values on specified host and port
setProperty nodeHost portName(s)
shutdownPort - shutdown the service
on specified port(s) on specified MOOS node
shutdownPort nodeHost portName(s)
Instrument Data Summaries and
Telemetry Subsampling
suspend - put the CPU into suspend (sleep)
mode
suspend [-n] [-v] []
switchBIN400V - get status of HV
switch, or toggle HV power to subnodes
switchBIN400V node portName [ON|OFF|channelON|channelOFF|ALLON|ALLOFF]
switchHiVoltage - enable the high
voltage converters on the MOOS Power System
switchHiVoltage nodeHost portName [ON|OFF]
wakeup - wakeup suspended node(s) via Medusa
broadcast
wakeup bcastOrigin
writePuck - write service code and
metadata to the pucks non-volatile memory
writePuck jarFile portName [-id]