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.


List of all commands
Programmatic Overview


Show LoggingStatus

Returns a multi-line response that shows the current status of all defined logging Sessions. Session status can be:


Parameters:

No parameters are available.


Response:
<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>

Show Sessions

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.


Parameters:

No parameters are available.


Response:
<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>

Show Session

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.


Parameters:

name=SessName The existing Session's name.


Response:
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

Set Session

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.


Parameters:

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:
  • Continuous
    Logs continuously, breaking the data into separate files of the specified duration.
  • Daily@hh:mm
    Starts every day at the specified hours (hh, from 00 to 23) and minutes (mm, from 00 to 59).
  • Once@YYYY/MM/DD/hh:mm
    Runs one time only, starting at the given Year (YY), Month (MM), Day (DD), hours (hh) and minutes (mm).
    Month range is 1 to 12.
    Day range is 1 to 31.
  • Manual
    Runs for the specified duration, starting when the user enables the Session. When finished, the Session automatically disables itself.
For those schedules that require dates or times, the formats must be as shown. An invalid date or time will cause the command to be rejected.
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.
The maximum duration is 1439 minutes for Daily sessions. For all other schedule types the maximum duration is 9999 minutes.
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'.
format=T00 This specifies the data format to use when writing files for this Session. Currently only 'T00' or 'Binex' files can be logged.
The default for a new Session is 'T00'.
Note that several format-specific parameters can be specified, as detailed below.

T00-Specific Parameters

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, 300 and 600. 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, 300 and 600. 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'.
Carrier Smoothing is not allowed if measInterval is 0.1, 0.2 or 0.5 seconds.

Binex-Specific Parameters

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, 300 and 600. The value can also be set to '0' or 'off' to disable measurement logging.
The default for a new Session is 15 seconds.
smoothCarrier=no Yes or no to indicate whether carrier phase measurements should be smoothed in measurement records. Defaults to no.
Carrier Smoothing is not allowed if measInterval is 0.1, 0.2 or 0.5 seconds.
7f02=no Yes or no to indicate whether measurements should be sent encoded as Binex record types 0x7f-02. Defaults to no.
7f03=no Yes or no to indicate whether measurements should be sent encoded as Binex record types 0x7f-03. Defaults to no.
7f03Dopplers=no Yes or no to indicate whether L1 Doppler information should be included in 0x7f-03 records. Defaults to no.
7f03Slips=no Yes or no to indicate whether Cycle Slip Count information should be included in 0x7f-03 records. Defaults to no.
7f03ClockOffsets=never Indicates when reciever clock offset information should be included in 0x7f-03 records.
  • never : Don't ever include clock offset information. This is the default value.
  • always : Include clock offsets in every 0x7f-03 record.
  • onRollover : Include clock offset information only when an internal clock rollover has occurred.
metaInterval=60 This is the interval (in seconds) between BINEX meta records. Valid values are: off, 0 (same as off), 60, 300, 900, 1800 and 3600. The default value is off.
metaSiteDesc=no Yes or no to indicate whether the Site Description string should be included in the meta records. Defaults to no.
metaStnID=no Yes or no to indicate whether the Binex Station ID should be included in the meta records. Defaults to no.
metaRcvrType=no Yes or no to indicate whether the Receiver Type should be included in the meta records. Defaults to no.
metaRinexRcvr=no Yes or no to indicate whether the Rinex Receiver Number should be included in the meta records. Defaults to no.
metaFirmware=no Yes or no to indicate whether the NetRS Firmware version should be included in the meta records. Defaults to no.
metaAntXYZ=no Yes or no to indicate whether the position of the antenna, as determined from a GPS position fix, should be included in the meta records, in ECEF-XYZ coordinates. Defaults to no.
metaAntOffset=no Yes or no to indicate whether the Antenna Offset should be included in the meta records. Defaults to no.
metaRinexAnt=no Yes or no to indicate whether the Rinex Antenna Number should be included in the meta records. Defaults to no.
sysStatusInterval=60 This is the interval (in seconds) between BINEX System Status records. Valid values are: off, 0 (same as off), 60, 300, 900, 1800, and 3600. The default value is off.


Response:

For a Session with format=T00:
OK: Session name=SessName enable=yes  schedule=Continuous 
            duration=60 sessid=s daySubdir=no sessidSubdir=no 
            format=T00 measInterval=0.5 posInterval=5 smoothCode=no
            smoothCarrier=no

For a Session with format=Binex:
OK: Session name=SessName enable=yes schedule=Continuous 
            duration=2 sessid=b daySubdir=no sessidSubdir=no 
            format=Binex measInterval=1 smoothCarrier=yes 7f02=no
            7f03=yes 7f03Dopplers=yes 7f03Slips=yes
            7f03ClockOffsets=always metaInterval=60 metaSiteDesc=no
            metaStnID=no metaRcvrType=no metaRinexRcvr=no
            metaFirmware=no metaAntXYZ=no metaAntOffset=no
            metaRinexAnt=yes sysStatusInterval=600

Delete Session

Completely erases the specification for the named session. Can also be used to delete ALL sessions.


Parameters:

name=SessName The existing Session's name.
all=yes Delete ALL currently defined sessions.


Response:
OK: Session 'SessName' is deleted.

OK: All sessions are deleted.

Enable Session

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'.


Parameters:

name=SessName The existing Session's name.


Response:
OK: Session name=SessName enable=yes

Disable Session

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'.


Parameters:

name=SessName The existing Session's name.


Response:
OK: Session name=SessName enable=no

Show AutoDelete

This command returns the state of the AutoDelete controls. AutoDelete refers generically to two methods of managing logged data files. Every minute, the data logging directories are scanned to determine how much space is available for further logging. If insufficient space is found, data logging will be stopped. The user also has the option to enabled "autoDeletion" which deletes old files to reclaim space for further logging. There are two independent methods that can be used:

The response to Show AutoDelete shows the current setting of the Reserved space system and of any currently defined Pools. For each of these, the size and the autoDelete setting are shown.


Parameters:

No parameters are available.


Response:
AutoDelete Reserved=1,yes a=50,no Default=100,yes

Set AutoDelete

Modifies the state of the AutoDelete functions. See Show AutoDelete above for a detailed description of these functions. This command is used to create the complete set of controls for the Reserved Space AutoDelete function and for the Pool Management system.

The parameters for Set AutoDelete consist of one or more definitions of the form:

    Name = size , enable
Where:

For backward compatibility with older firmware versions, an abbreviated form of this command is available.

    Set Autodelete enable=yes
is equivalent to
    Set Autodelete Reserved=1,yes


Parameters:

Reserved=1,yes Settings for the Reserved Space controls.
The Size value must a non-zero, positive integer in megabytes.
The Enable value must be 'yes' or 'no'.
If Reserved settings are not given in Set AutoDelete, the default is one megabyte with no autoDelete.
k=50,no Settings for a named Pool (in this example, the k-pool).
The Size value must a non-zero, positive integer in megabytes.
The Enable value must be 'yes' or 'no'.
Named pools that are not explicitly defined, will not be created.
Default=100,yes Settings for the Default-Pool.
The Size value must a non-zero, positive integer in megabytes.
The Enable value must be 'yes' or 'no'.
If the Default-Pool is not explicitly defined, it will not be created.
enable=yes Backward compatible option. Enable is either 'yes' or 'no'.
If this option is used, then it must be the only parameter given.


Response:
OK: AutoDelete Reserved=1,yes a=50,no Default=100,yes

Show PowerSaveMode

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.


Parameters:

No parameters are available.


Response:
PowerSaveMode enable=no

Set PowerSaveMode

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.


Parameters:

enable=yes The desired new state for the control. Must be either 'yes' or 'no'.


Response:
OK: PowerSaveMode enable=yes

Show FailsafeWakeup

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.


Parameters:

No parameters are available.


Response:
FailsafeWakeup enable=yes interval=4 duration=10

Set FailsafeWakeup

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.


Parameters:

All three parameters must be specified.
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.


Response:
OK: FailsafeWakeup enable=yes interval=4 duration=10