System Commands
bottommask
Permalink to bottommaskbottommask [on | off | lolat,hilat]
The bottommask
command turns the bottom sphere mask on or off, or specifies the
latitude range over which the masking transitions from no masking to fully
masked. It is used to provide a faded transition to the “black hole” at the
bottom of the sphere where the projectors are not able to illuminate the
sphere. It can help reduce rough edges and moire patterns, at the cost of
decreasing the overall size of the illuminated sphere area.
exit
Permalink to exitThe exit
command closes the current client connection to the SOS system.
get_version_number
Permalink to get_version_numberThe get_version_number
command returns a string identifying the running version
of SOS.
get_database_date
Permalink to get_database_dateThe get_database_date
command returns a string containing the timestamp of
the SQLite database containing the SOS Data Catalog (the file path is
/shared/sos/database/sos_sqlite.db). An example of the timestamp format is
2015-03-05 17:27:47.087217857 -0700, which corresponds to March 5, 2015,
slightly after 5:27:47 PM in the Mountain Daylight Time zone (7 hours before
GMT).
get_filenames_in_directory
Permalink to get_filenames_in_directoryget_filenames_in_directory [directory_name]
The get_filenames_in_directory
command returns a list of the files in the
specified directory on the SOS system.
get_playlist_names_in_directory
Permalink to get_playlist_names_in_directoryget_playlist_names_in_directory [directory_name]
The get_playlist_names_in_directory
command returns a list of the playlist
files in the specified directory on the SOS system. If directory_name
is not
specified, the default playlist directory is used (~/sosrc). Note: Use of the
directory_name
argument is currently not supported.
get_state
Permalink to get_stateget_state [timestamp]
This command returns a list of the SOS state variables that have changed since the specified timestamp. It is intended to provide a simple and efficient polled interface for updating a user interface to SOS. It returns a list of {name value} pairs. Each pair is enclosed in curly braces, and the individual pairs are delimited by spaces. One of the pairs is a timestamp that can be used for future calls.
To use get_state
in a polling loop, first call it with a timestamp value of
0. It returns the current value for all the available state variables,
including the timestamp. Then when the returned time stamp is used in a future
call, only values that have changed are returned (including a new timestamp).
help
Permalink to helpThe help
command returns a brief summary of all the automation control
interface commands.
identify
Permalink to identifyidentify [on | off]
Note: This command is very likely to be discontinued.
The identify
command displays information on the sphere to identify the
individual projectors by name: P1, P2, P3, or P4.
shutdown
Permalink to shutdownThe shutdown
command shuts down the running SOS software on the system.
topmask
Permalink to topmasktopmask [on | off | lolat,hilat]
The topmask
command turns the top sphere mask on or off, or specifies the
latitude range over which the masking transitions from no masking to fully
masked. It is used to provide a faded transition to the “black hole” at the top
of the sphere where the projectors are not able to illuminate the sphere. It
can help reduce rough edges and moire patterns, at the cost of decreasing the
overall size of the illuminated sphere area.