Programmatic Interface - Session Commands |
These commands are associated with setup and control of data logging Sessions.
Sessions are "templates" that describe the characteristics of a data logging process. The parameters include things like schedules, data logging rates, file naming options, etc. A Session can be Enabled or Disabled. Enabled Sessions will start logging data as their schedule dictates. Disabled Sessions are completely inactive. Multiple Sessions can be defined, and several can be active at the same time.
In addition to the Session definitions, data logging is affected by the AutoDelete function, the PowerSaveMode, and the FailsafeWakeup timer.
Returns a multi-line response that shows the current status of all defined logging Sessions. Session status can be:
<Show LoggingStatus> Session name=CORSA status=Logging file=/200311/06/TomsProto200311062300a.T00 Session name=Noon status=Pending Session name=Once status=Disabled Session name=man status=Completed <end of Show LoggingStatus>
Returns a multi-line response, listing the settings for ALL currently defined data logging Sessions. Note that the command 'Show Sessions' is different from 'Show Session' due to the final 's' character.
<Show Sessions> Session name=CORSA enable=yes schedule=Continuous duration=60 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=a daySubdir=yes sessidSubdir=no Session name=Noon enable=no schedule=Daily@23:15 duration=2 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=d daySubdir=no sessidSubdir=no Session name=Once enable=no schedule=Once@2003/10/29/15:24 duration=60 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=o daySubdir=no sessidSubdir=no Session name=man enable=no schedule=Manual duration=1 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=m daySubdir=no sessidSubdir=no <end of Show Sessions>
Returns a single line listing the parameter settings for the requested Session. Note that the command 'Show Session' is different from 'Show Sessions' due to the missing final 's' character.
name=SessName | The existing Session's name. |
Session name=SessName enable=yes schedule=Continuous duration=60 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=a daySubdir=yes sessidSubdir=no
Creates or modifies the settings for a data logging Session.
If the named Session is not currently defined, a new Session will be created using default values. Any other parameters supplied with this command will overwrite those defaults. The defaults are listed in the parameter listings below.
If the named Session is already defined, then its values become the defaults and any new parameters overwrite those settings. Thus, it is possible to make a small modification to an existing Session without completely specifying every last possible setting. For example:
Set Session name=Test enable=no
would change the enable state of the existing Session "Test", without touching any other settings.
The response to this command will always show the complete specifications for the named Session, regardless of whether all possible parameters were specified. The response always shows the entire state of the Session.
name=SessName | The Session's unique identifying name. This parameter must be specified. |
enable=yes | Enable can be 'yes' or 'no'. If yes, then the session can log data,
when its schedule allows. If no, then the Session cannot log data.
The default value for a new session is 'yes'. |
schedule=Continuous | Schedule determines when the session can be run. There are four
possible types:
The default schedule for a new Session is 'Continuous'. |
duration=60 | Duration is the data logging time for this Session, in minutes.
For Continuous logging Sessions, it describes the length of the
individual files.
The default value for a new Session is 60 minutes. |
format=T00 | This specifies the data format to use when writing files for
this Session. Currently only 'T00' files can be logged.
The default for a new Session is 'T00'. |
measInterval=15 | This describes the GPS measurement logging interval, in seconds.
Valid settings are: 0.1, 0.2, 0.5, 1, 2, 5, 10, 15, 30, 60, and 300.
The value can also be set to '0' or 'off' to disable measurement
logging.
The default for a new Session is 15 seconds. |
posInterval=60 | This describes the position logging interval, in seconds.
Valid settings are: 0.1, 0.2, 0.5, 1, 2, 5, 10, 15, 30, 60, and 300.
The value can also be set to '0' or 'off' to disable measurement
logging.
The default for a new Session is 60 seconds. |
smoothcode=no | Smoothcode is either 'yes' or 'no', and controls whether code phase
smoothing will be done on the logged measurements.
The default for a new Session is 'no'. |
smoothcarrier=no | Smoothcarrier is either 'yes' or 'no', and controls whether carrier
phase smoothing will be done on the logged measurements.
The default for a new Session is 'no'. |
sessid=a | The Session Identifier is a single, lower-case letter, which
is used as an identifying character in file names generated by this
Session.
The default for a new Session is 'a'. |
daySubdir=no | This value is 'yes' or 'no', and determines if files generated
by this Session will be placed in separate directories based on the
day of month.
The default for a new Session is 'no'. |
sessidSubdir=no | This value is 'yes' or 'no', and determines if files generated by
this Session will be placed in separate directories based on the
Session Identifier.
The default for a new Session is 'no'. |
OK: Session name=SessName enable=no schedule=Continuous duration=5 format=T00 measinterval=15 posinterval=60 smoothcode=no smoothcarrier=no sessid=t daySubdir=no sessidSubdir=no
Completely erases the specification for the named session. Can also be used to delete ALL sessions.
name=SessName | The existing Session's name. |
all=yes | Delete ALL currently defined sessions. |
OK: Session 'SessName' is deleted. OK: All sessions are deleted.
Enables the named session to log data when its schedule permits. This is equivalent to setting the 'enable' parameter for the named session to 'yes'.
name=SessName | The existing Session's name. |
OK: Session name=SessName enable=yes
Disables the named session. This prevents the Session from logging any data. This is equivalent to setting the 'enable' parameter for the named session to 'no'.
name=SessName | The existing Session's name. |
OK: Session name=SessName enable=no
Returns the state of the AutoDelete control. When enabled, AutoDelete automatically deletes old logged data files when available space for new files drops too low.
AutoDelete enable=yes
Modifies the state of the AutoDelete function. When enabled, AutoDelete automatically deletes old logged data files when available space for new files drops too low.
enable=yes | The desired new state for the control. Must be either 'yes' or 'no'. |
OK: AutoDelete enable=yes
Returns the state of the PowerSaveMode control. When enabled, The PowerSaveMode will shut off the NetRS when there are no active data logging Sessions, setting an alarm to wake up for future sessions.
PowerSaveMode enable=no
Modifies the state of the PowerSaveMode control. When enabled, The PowerSaveMode will shut off the NetRS when there are no active data logging Sessions, setting an alarm to wake up for future sessions.
enable=yes | The desired new state for the control. Must be either 'yes' or 'no'. |
OK: PowerSaveMode enable=yes
Returns the state of the FailsafeWakeup function. This affects the operation of the PowerSaveMode. When enabled, the FailsafeWakeup function will wake up the system at regular intervals, for a specified duration of time, regardless of whether there are any data logging Sessions scheduled. This provides a reliable way to ensure that a system cannot go to sleep forever due to an accident of scheduling.
FailsafeWakeup enable=yes interval=4 duration=10
Modifies the state of the FailsafeWakeup function. This affects the operation of the PowerSaveMode. When enabled, the FailsafeWakeup function will wake up the system at regular intervals, for a specified duration of time, regardless of whether there are any data logging Sessions scheduled. This provides a reliable way to ensure that a system cannot go to sleep forever due to an accident of scheduling.
enable=yes | Must be 'yes' or 'no'. |
interval=24 | Specifies the wakeup periodicity in hours.
The maximum interval is 24 hours. |
duration=10 | Specifies the number of minutes to stay awake at each interval.
The maximum amount is 60 minutes. |
OK: FailsafeWakeup enable=yes interval=4 duration=10