corascript Interpreter Reference

Most, but not all corascript commands are aimed at accomplishing some task in relation to a LoggerNet™ server. The connect command sets up the server context in which subsequent commands will operate until the end of the script is reached or until another connect command is processed. The following segment shows a sample use of the connect command:

connect               # the name of the command
  localhost           # specifies the server's host address
  --name="bilbo"      # specifies the logon name (optional)
  --password={baggins}  # specifies the password (optional)
  ;                   # marks the end of the command

Since this is the first command presented, let us examine it in closer detail. This command contains the following elements:

If the logon process is successful, the corascript interpreter will write a sequence simlar to the following to its output device followed by a carriage return and line feed.

+connect,"coralib3.dll 1, 3, 4, 57"

The plus sign ("+") at the beginning of the output indicates that the command was successfully executed. Notice that the command name is echoed following the plus sign. The rest of the line in quotes is the server version identification and comes from the LoggerNet™ server.

If the command had failed, the plus sign would have been replaced by a minus sign ("-") followed by a comma. The rest of the line of output would be devoted to explaining (as much as possible) the reason for the failure. For instance, if I had types localhostr instead of localhost, the following output would have been produced:

-connect,"Failure to locate host","11001"

Once a connection has been established, all subsequent commands will use that connection to accomplish their tasks. If the connection has failed or if the connect command was never issued, the subsequent commands will all fail. The connection established by the connect command will last until another connect command is processed, the script ends, or the connection to the server fails.

The following fragment shows the use of the send-program-file command:

send-program-file
  minas_tirith     # the station that is to receive the file
  "c:\logger programs\defend.dld"; #the file to send 

This command instruct the interpreter to send the datalogger program file "c:\logger programs\defend.dld" to the station named minas_tirith in the LoggerNet™ network map. If the command succeeds, the following output will be produced:

+send-program-file

Again, a failure would be indicated by a minus sign ("-") followed by the command name followed by a comma followed by text that attempts to explain the failure. For example, if the interpreter failed to open the specified file, the following results would be printed:

-send-program-file,"Unable to open the file" 

Some corascript commands can take quite a bit of time to execute. This is particularly true of commands that require the server to communicate with the datalogger. The interpreter will not respond to any input while it is executing a command (although it may buffer any character typed).

Once the LoggerNet™ server has sent a program file to a datalogger, it will either read table definitions back from the datalogger or it will extract information about data tables from the program file. The list of tables associated with the running program can be printed by executing the list-tables command. The following fragment illustrates this command's use:

list-tables
  minas_tirith; # the station name

Here is an example of the successful results of this command:

*list-tables,"minas_tirith"
{
"Public"
"Status"
"Table1"
}
+list-tables

This is an example of extended command output. Note that the first character in the response is an asterisk ("*") rather than a plus or minus sign. This means that the quoted content following the first output line contains extended information. The last line of the output prints the expected "+list-tables". Each line in the extended output names a table associated with the datalogger program. A detailed description of the data in a table can be obtained using the describe-table command.

The interpreter program can be stopped in one of two ways: the quit command (or one of its synonyms) can be processed, or the end of input will be encountered. The quit command is unique in that it has no output. It also has several synonyms such as bye and exit.

Here is the script presented in its entirety:

connect               # the name of the command
  localhost           # specifies the server's host address
  --name="bilbo"      # specifies the logon name (optional)
  --password=@{baggins@}  # specifies the password (optional)
  ;                   # marks the end of the command

send-program-file
  minas_tirith     # the station that is to receive the file
  "c:\logger programs\defend.dld"; #the file to send

list-tables
  minas_tirith; # the station name

quit;

Here are the successful results of each command:

 
+connect
+send-program-file
*list-tables,"minas-tirith"
{
"Public"
"Status"
"Table1"
}
+list-tables 

command := "add-account" 
   account-name 
   password
   access-level
   { device-addition }.
access-level := ("read-only" | "1000") |
                ("operator" | "2000") |
                ("manager" | "3000") |
                ("administrator" | "4000") |
                ("root" | "5000"). 

output := failure-output | success-output "\r\n".
failure-output := "-add-account," failure-reason.
success-output := "+add-account".
    

This command can produce the following failure reasons:

command := "add-device" device-type device-name anchor-code
           anchor-device-name.
device-type := string.
device-name := string.
anchor-code := "before" | "as-child" | "after".
anchor-device-name := string.

output := failure-output | success-output "\r\n".
failure-output := "-add-device," reason.
success-output := "+add-device".
    

The failure reason can have the following values:

# adds a root device to an empty network map.  The anchor code and
# anchor device name are required but have no significance
add-device com-port com1 before "";

# adds a datalogger as a child to the com port
add-device cr10 cr10 as-child com1;

# adds root devices after  and before the com port
add-device com-port com2 after com1;
add-device com-port com3 before com1;

command := command-name device-name file-name
           {"for-labels-only=" ("true" | "false")}.
command-name := "associate-program-file" |
                "associate-table-defs" |
                "associate-labels".

output := failure-output | success-output "\r\n".
failure-output := "-associate-program-file," failure-reason.
success-output := "+associate-program-file".
    

The failure-reason field can take on the following values:

The following example will read the final storage labels from the specified file without overwriting the currently associated file:

associate-program-file lgr c:\jon\logger\classic\demo.fsl
--for-labels-only:true;

    

command := "change-account" 
   account-name 
   password
   access-level
   { device-addition }.
access-level := ("read-only" | "1000") |
                ("operator" | "2000") |
                ("manager" | "3000") |
                ("administrator" | "4000") |
                ("root" | "5000"). 

output := failure-output | success-output "\r\n".
failure-output := "-change-account," failure-reason.
success-output := "+change-account".
    

The failure-reason field can take on the following values:

command := "change-classic-stat" device-name star-mode window window-val.
device-name := string.
star-mode := "A" | "B".
window := number.
window-val := string.

output := failure-output | success-output "\r\n".
failure-output := "-change-classic-stat," failure-reason.
success-output := "+change-classic-stat".
    

The failure-reason field can take on the following values:

The following is an example of the command to reset memory on a CR10X datalogger:

change-classic-stat cr10x A 5 98765;
-change-classic-stat,no response after value sent

command  := "clear-logs".
    

output         := failure-output | success-output "\r\n".
failure-output := "-clear-logs," reason.
success-output := "+clear-logs".
    

This command can produce the following failure reasons:

command := "clear-program" station-name.

output         := (failure-output | success-output) "\r\n".
failure-output := "-unlock-network," reason.
success-output := "+unlock-network".
    

The reason field can take on the following values:

command := "clock-check" device-name.

output := failure-output | success-output "\r\n".
failure-output := "-clock-check," failure-reason.
success-output := "*clock-check" "\r\n"
                  "{" "\r\n"
                  "\"" logger-time "\"," difference-msec "\r\n"
                  "}" "\r\n"
                  "+clock-check," ("clock checked" | "clock set").
logger-time := year "-" month "-" day " " hour ":" minutes ":" seconds
              "." milli-seconds.
year := 4{digit}.
month := 2{digit}. ; 0 < month <= 12
day   := 2{digit}. ; 0 < day <= 31
hour := 2{digit}.  ; 0 <= hour < 24
minutes := 2{digit}. ; 0 <= minutes < 60
seconds := 2{digit}. ; 0 <= seconds < 60
milli-seconds := 3{digit}. ; 0 <= milli-seconds <= 999 
difference-msec := int4. ; difference in milli-seconds

difference-msec is the number of milli-seconds difference between the datalogger clock and the adjusted server clock after the time was checked (or set). This is the result of subtracting the server time from the datalogger time. A negative value indicates that the datalogger clock is behind the server clock while a positive value indicates that the datalogger clock is ahead of the server clock.

If a clock set was pending on the server for the specified device at the time when this command was issued, thie results of this command may show that the device clock was set.

The failure-reason field can take on the following values:

*clock-check
{
"2000-07-19 09:28:02.975",-448
}
+clock-check,clock checked 
    

command := "clock-set" device-name [ "--server-time=" date-time ].

output := failure-output | success-output "\r\n".
failure-output := "-clock-set," failure-reason.
success-output := "*clock-set" "\r\n"
                  "{" "\r\n"
                  "\"" logger-time "\"," difference-msec "\r\n"
                  "}" "\r\n"
                  "+clock-set," ("clock checked" | "clock set").
logger-time := year "-" month "-" day " " hour ":" minutes ":" seconds
              "." milli-seconds.
year := 4{digit}.
month := 2{digit}. ; 0 < month <= 12
day   := 2{digit}. ; 0 < day <= 31
hour := 2{digit}.  ; 0 <= hour < 24
minutes := 2{digit}. ; 0 <= minutes < 60
seconds := 2{digit}. ; 0 <= seconds < 60
milli-seconds := 3{digit}. ; 0 <= milli-seconds <= 999 
difference-msec := int4. ; difference in milli-seconds

difference-msec is the number of milli-seconds difference between the datalogger clock and the adjusted server clock after the time was checked (or set). This is the result of subtracting the server time from the datalogger time. A negative value indicates that the datalogger clock is behind the server clock while a positive value indicates that the datalogger clock is ahead of the server clock.

The failure-reason field can take on the following values:

command         := "clone-table-area" device-name source-area-name
                   { option }.
option          := new-name-option | copy-option |
                   select-option | permanent-option.
new-name-option := "--new-name=" new-area-name.
copy-option     := "--copy-opt="
                   ("{at-record" file-mark-no record-no "}") |
                   ("{at-time" start-time-stamp "}") |
                   ("at-newest") |
                   ("none") |
                   ("{time-relative" interval [ interval-unit ] "}").
select-option   := "--select={" { column-name } "}".
permanent-option := "--permanent=" ("true" | "1" | "false" | "0").
           

output         := success-output | failure-output.
success-output := "+clone-table-area," new-table-name "\r\n".
failure-output := "-clone-table-area," reason "\r\n". 

The new-table-name parameter in the success output indicates the name of the new collect area and table that was created by the server. This value may differ from that specified by the command if the name specified by the command was not unique.

The reason parameter can take on the following values:

The following example creates a new collect area, control, based upon the Public table of a CR1000. The new table is going to be restricted in the columns. The new area will be permanent.

clone-table-area cr1000 public --permanent=true
  --select={export_address cbk_address cbk_interval} 
  --new-name="control";

    

The following example creates a temporary new collect area based upon one of the historical tables in a CR1000. All of the columns will be duplicated and the data will be back-filled from the original table starting at two hours back from the newest record in the source.

clone-table-area cr1000 one_min --new-name="one_min_temp"
   --copy-opt={time-relative 2 hour};

    

command := "connect" server-name
           [ "--name=" name ]
           [ "--password=" password ]
           [ "--server-port=" server-port ].

output  := success-output | failure-output.
success-output := "+connect,\"" server-name "\"" "\r\n".
failure-output := "-connect," reason "\r\n".
server-name := string. ; server-specified

The server-name field reported in the successfuly output string identifies the type of server to which the interpreter has connected. This string originates from the server and generally identifies the name of the server module (coralib3.dll) and its version (e.g. 1, 3, 4, 61).

The following failure reasons can be produced by this command:

The following shows a connect using the default options:

connect
  localhost; # server address
      

The following shows a connect using all options specified:

connect
  localhost       # server address
  --name=smeagol  # account name
  --password=gollum # password option specified
  --server-port=6789; # The server port
      

command := "create-backup-script" script-file-name.

output := error-output | success-output "\r\n".
error-output := "-create-backup-script," reason.
success-output := "+create-backup-script".
    

The following failure reasons can be produced by this command:

command := "create-fs-area" station-name new-area-name area-no.
station-name  := string.
new-area-name := string.
area-no       := "1" | "2".
    

output         := failure-output | success-output "\r\n".
failure-output := "-create-fs-area," reason.
success-output := "+create-fs-area".
    

The following failure reasons can be produced by this command:

command := "create-inlocs-area" device-name new-area-name
           input-location-id {input-location-id} ";".
input-location-id := "{" input-location-number
                     field-name "}".
input-location-number := uint2. ; 0 < input-location-number < 65535
field-name := string.

output := failure-output | success-output "\r\n".
failure-output := "-create-inlocs-area," reason.
success-output := "+create-inlocs-area".
    

the following failure reasons can be produced by this command:

create-inlocs-area lgr test1 {1 "inlocs1"} {2 {inlocs2}};

command   := "create-server-directory" path-name.
path-name := string.

output         := (success-output | failure-output) "\r\n".
success-output := "+create-server-directory".
failure-output := "-create-server-directory," failure-reason
                  [ "," server-failure-reason ].
failure-reason := string.
server-failure-reason := string.

server-failure-reason will be reported if the server transaction failed for some operating system related reason such as invalid path names or invalid operating system security privileges. The following values can be produced:

command                  := "create-snapshot" | "create-backup-file"
                            { option }.
option                   := file-name-option |
                            additional-files-option |
                            include-tables-option.
file-name-option         := "--file-name=" file-name.
additional-files-option  := "--additional={" { file-name } "}".
include-tables-option    := "--include-tables=" ("true" | "false").

The file-name and additional options both support wild-card formats where %a or %w can be specified. These wildcards refer to the application working directory and the server working directory respectively. In LoggerNet 3.1, the default application working directory will be c:\Campbellsci\LoggerNet\ and the server working directory will be c:\Campbellsci\LoggerNet\sys\bin\. These directories can differ depending on what application is hosting the server. In all cases, these paths will be relative to the server host computer's file system.

output         := error-output | success-output "\r\n".
error-output   := "-create-snapshot," reason.
success-output := "+create-snapshot," backup-file-name.
    

The following failure reasons can be produced by this command:

The following example will cause a snapshot with a server generated name to be created that will include the cache table files as well as additional client INI files.

create-snapshot --include-tables=true
  --additional={%a\sys\inifiles\*.*};

command := "create-table-area" station-name new-area-name.

output         := error-output | success-output "\r\n".
error-output   := "-create-table-area," reason.
success-output := "+create-table-area".
    

This command can produce the following failure reasons:

command := "data-query" station-name table-name begin-date end-date ";".
station-name := string.
table-name := string.
begin-date := time-stamp.  
end-date := time-stamp.   

output := success-output | failure-output "\r\n".
failure-output := "-data-query," reason.
success-output := "*data-query,\"" station-name "\",\"" table-name "\""
                  "\r\n{\r\n"
                  { record }
                  "}\r\n+data-query".
record := "\"" station-name "\","
          "\"" table-name "\","
          "\"" time-stamp "\","
          "\"" record-no "\","
          { register } "\r\n".
register := "\"" value-name "\","
            "\"" ldep-column-type "\","
            "\"" value "\"" [","]. ; a comma appears after all but the
                                   ; last value
value-name := column-name { "_" subscript }.
ldep-column-type := string.  ; SQL data type expression
value := number | integer | time-stamp | character.
time-stamp := year "-" month "-" day " " hour ":" minutes ":" seconds
              "." milli-seconds.
year := 4{digit}.
month := 2{digit}. ; 0 < month <= 12
day   := 2{digit}. ; 0 < day <= 31
hour := 2{digit}.  ; 0 <= hour < 24
minutes := 2{digit}. ; 0 <= minutes < 60
seconds := 2{digit}. ; 0 <= seconds < 60
milli-seconds := 3{digit}. ; 0 <= milli-seconds <= 999 
    

This command can produce the following failure reasons:

This example shows a query involving time format three without specifying the times:

data-query lgr_10t inlocs "20000718" "20000719";
      

The possible results of such a query are shown below. Note that each record would normally appear on one line. This example has been reformatted to enable it to appear on a printed page.

*data-query,,"lgr_10t","inlocs"
{
"lgr_10t","inlocs","2000-07-18 12:06:58.250","4857215","Flags_1",
"VARCHAR(1)","0","Flags_2","VARCHAR(1)","0","Flags_3","VARCHAR(1)",
"0","Flags_4","VARCHAR(1)","0","Flags_5","VARCHAR(1)","0","Flags_6",
"VARCHAR(1)","0","Flags_7","VARCHAR(1)","0","Flags_8","VARCHAR(1)",
"0","Ports_1","VARCHAR(1)","0","Ports_2","VARCHAR(1)","0","Ports_3",
"VARCHAR(1)","0","Ports_4","VARCHAR(1)","0","Ports_5","VARCHAR(1)",
"0","Ports_6","VARCHAR(1)","0","Ports_7","VARCHAR(1)","0","Ports_8",
"VARCHAR(1)","0","counter","FLOAT","271"
}
+data-query
      

In this example, we query a finasl storage table of a CR9000 for a second's worth of data:

data-query cr9000 table1 "20000718 7:29:59" "20000718 7:30";
      

Potential results from this command are shown below. Note that this output has been reformatted (extra line feeds have been added) so that all of the record can appear on thbe printed page. Line feeds have also been added between records.

*data-query,"cr9000","table1"
{
"cr9000","table1","2000-07-18 07:29:59.000","12864620","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","21","signme","FLOAT","0.358"

"cr9000","table1","2000-07-18 07:29:59.100","12864621","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","22","signme","FLOAT","0.375"

"cr9000","table1","2000-07-18 07:29:59.200","12864622","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","23","signme","FLOAT","0.391"

"cr9000","table1","2000-07-18 07:29:59.300","12864623","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","24","signme","FLOAT","0.407"

"cr9000","table1","2000-07-18 07:29:59.400","12864624","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","25","signme","FLOAT","0.423"

"cr9000","table1","2000-07-18 07:29:59.500","12864625","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","26","signme","FLOAT","0.438"

"cr9000","table1","2000-07-18 07:29:59.600","12864626","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","27","signme","FLOAT","0.454"

"cr9000","table1","2000-07-18 07:29:59.700","12864627","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","28","signme","FLOAT","0.469"

"cr9000","table1","2000-07-18 07:29:59.800","12864628","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","29","signme","FLOAT","0.485"

"cr9000","table1","2000-07-18 07:29:59.900","12864629","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","30","signme","FLOAT","0.5"

"cr9000","table1","2000-07-18 07:30:00.000","12864630","TRef_Avg",
"FLOAT","0","Ch_Avg_1","FLOAT","0","Ch_Avg_2","FLOAT","0","Ch_Avg_3",
"FLOAT","0","countme","FLOAT","31","signme","FLOAT","0.515" 
}
+data-query 
      

command := "delete-account" account-name ";".

output := failure-output | success-output "\r\n".
failure-output := "-delete-account," failure-reason.
success-output := "+delete-account".
    

This command will produce the following failure reasons.

command := ("delete-branch" | "delete-device") device-name ";".

output := failure-output | success-output "\r\n".
failure-output := "-" command-name "," failure-reason.
success-output := "+" command-name.
    

This command can produce the following failure reasons:

command := "delete-collect-area" station-name collect-area-name.

output := failure-output | success-output "\r\n".
failure-output := "-delete-collect-area," failure-reason,
success-output := "+delete-collect-area".
    

This command can produce the following failure reasons:

command := "delete-holes" station-name [ "--table-name=" table-name ] ";".
station-name := string.
table-name := string.

output := (success-output | failure-output) "\r\n".
success-output := "+delete-holes".
failure-output := "-delete-holes," failure-reason.
    

This command can produce the following failure reasons:

command := "describe-device-relations".

output         := failure-output | success-output "\r\n".
failure-output := "-describe-device-relations," reason.
success-output := "*describe-device-relations" "\r\n"
                  "{" "\r\n"
                  { "{" relationship "}" } "\r\n".
relationship := parent-type child-type [ slots depth ].
parent-type  := parent-type-name | parent-type-code.
child-type   := child-type-name | child-type-code.

This command can produce the following failure reasons:

*describe-device-relations
{
{0 com-port 2147483647 2147483647}
{0 tcp-com-port 2147483647 2147483647}
{0 tapi-port 2147483647 2147483647}
{CR10 SM 1 2147483647}
{CR10 rf95 1 2147483647}
{CR10X SM 1 2147483647}
{CR10X rf95 1 2147483647}
{CR500 SM 1 2147483647}
{CR500 rf95 1 2147483647}
{com-port CR10 2147483647 2147483647}
{com-port 21X 2147483647 2147483647}
{com-port CR7X 2147483647 2147483647}
{com-port CR10X 2147483647 2147483647}
{com-port CR500 2147483647 2147483647}
{com-port CR10T 2147483647 2147483647}
{com-port CR9000 2147483647 2147483647}
{com-port CR5000 2147483647 2147483647}
{com-port phone-modem 2147483647 2147483647}
{com-port rf95 2147483647 2147483647}
{com-port md9 2147483647 2147483647}
{com-port generic 2147483647 2147483647}
{com-port rf95t 2147483647 2147483647}
{com-port cr510 2147483647 2147483647}
{com-port cr510-td 2147483647 2147483647}
{com-port cr23x 2147483647 2147483647}
{com-port cr23x-td 2147483647 2147483647}
{com-port cr10x-td 2147483647 2147483647}
{com-port pakbus-port 2147483647 2147483647}
{com-port rf400 2147483647 2147483647}
{phone-modem phone-modem-remote 2147483647 2147483647}
{rf95 rf95-remote 254 2147483647}
{md9 md9-remote 255 2147483647}
{generic CR10 2147483647 2147483647}
{generic 21X 2147483647 2147483647}
{generic CR7X 2147483647 2147483647}
{generic CR10X 2147483647 2147483647}
{generic CR500 2147483647 2147483647}
{generic CR10T 2147483647 2147483647}
{generic CR9000 2147483647 2147483647}
{generic CR5000 2147483647 2147483647}
{generic phone-modem 2147483647 2147483647}
{generic rf95 2147483647 2147483647}
{generic md9 2147483647 2147483647}
{generic generic 2147483647 2147483647}
{generic rf95t 2147483647 2147483647}
{generic cr510 2147483647 2147483647}
{generic cr510-td 2147483647 2147483647}
{generic cr23x 2147483647 2147483647}
{generic cr23x-td 2147483647 2147483647}
{generic cr10x-td 2147483647 2147483647}
{generic pakbus-port 2147483647 2147483647}
{rf95t rf95t-remote 254 2147483647}
{cr510 SM 1 2147483647}
{cr510 rf95 1 2147483647}
{cr23x SM 1 2147483647}
{cr23x rf95 1 2147483647}
{tcp-com-port CR10 2147483647 2147483647}
{tcp-com-port 21X 2147483647 2147483647}
{tcp-com-port CR7X 2147483647 2147483647}
{tcp-com-port CR10X 2147483647 2147483647}
{tcp-com-port CR500 2147483647 2147483647}
{tcp-com-port CR10T 2147483647 2147483647}
{tcp-com-port CR9000 2147483647 2147483647}
{tcp-com-port CR5000 2147483647 2147483647}
{tcp-com-port phone-modem 2147483647 2147483647}
{tcp-com-port rf95 2147483647 2147483647}
{tcp-com-port md9 2147483647 2147483647}
{tcp-com-port generic 2147483647 2147483647}
{tcp-com-port rf95t 2147483647 2147483647}
{tcp-com-port cr510 2147483647 2147483647}
{tcp-com-port cr510-td 2147483647 2147483647}
{tcp-com-port cr23x 2147483647 2147483647}
{tcp-com-port cr23x-td 2147483647 2147483647}
{tcp-com-port cr10x-td 2147483647 2147483647}
{tcp-com-port pakbus-port 2147483647 2147483647}
{tcp-com-port rf400 2147483647 2147483647}
{phone-modem-remote CR10 1 2147483647}
{phone-modem-remote 21X 1 2147483647}
{phone-modem-remote CR7X 1 2147483647}
{phone-modem-remote CR10X 1 2147483647}
{phone-modem-remote CR500 1 2147483647}
{phone-modem-remote CR10T 1 2147483647}
{phone-modem-remote CR9000 1 2147483647}
{phone-modem-remote CR5000 1 2147483647}
{phone-modem-remote rf95 1 2147483647}
{phone-modem-remote md9 1 2147483647}
{phone-modem-remote generic 1 2147483647}
{phone-modem-remote rf95t 1 2147483647}
{phone-modem-remote cr510 1 2147483647}
{phone-modem-remote cr510-td 1 2147483647}
{phone-modem-remote cr23x 1 2147483647}
{phone-modem-remote cr23x-td 1 2147483647}
{phone-modem-remote cr10x-td 1 2147483647}
{phone-modem-remote pakbus-port 1 2147483647}
{phone-modem-remote rf400 1 2147483647}
{rf95-remote CR10 1 2147483647}
{rf95-remote 21X 1 2147483647}
{rf95-remote CR7X 1 2147483647}
{rf95-remote CR10X 1 2147483647}
{rf95-remote CR500 1 2147483647}
{rf95-remote CR10T 1 2147483647}
{rf95-remote CR5000 1 2147483647}
{rf95-remote md9 1 2147483647}
{rf95-remote cr510 1 2147483647}
{rf95-remote cr510-td 1 2147483647}
{rf95-remote cr23x 1 2147483647}
{rf95-remote cr23x-td 1 2147483647}
{rf95-remote cr10x-td 1 2147483647}
{rf95-remote rf95-remote 254 12}
{md9-remote CR10 1 2147483647}
{md9-remote 21X 1 2147483647}
{md9-remote CR7X 1 2147483647}
{md9-remote CR10X 1 2147483647}
{md9-remote CR500 1 2147483647}
{md9-remote CR10T 1 2147483647}
{md9-remote CR5000 1 2147483647}
{md9-remote cr510 1 2147483647}
{md9-remote cr510-td 1 2147483647}
{md9-remote cr23x 1 2147483647}
{md9-remote cr23x-td 1 2147483647}
{md9-remote cr10x-td 1 2147483647}
{rf95t-remote CR10T 1 2147483647}
{rf95t-remote cr510-td 1 2147483647}
{rf95t-remote cr23x-td 1 2147483647}
{rf95t-remote cr10x-td 1 2147483647}
{rf95t-remote rf95t-remote 254 12}
{pakbus-port cr10x-pb 2147483647 2147483647}
{pakbus-port cr510-pb 2147483647 2147483647}
{pakbus-port cr23x-pb 2147483647 2147483647}
{pakbus-port cr200 2147483647 2147483647}
{pakbus-port cr1000 2147483647 2147483647}
{tapi-port tapi-remote 2147483647 2147483647}
{tapi-remote CR10 2147483647 2147483647}
{tapi-remote 21X 2147483647 2147483647}
{tapi-remote CR7X 2147483647 2147483647}
{tapi-remote CR10X 2147483647 2147483647}
{tapi-remote CR500 2147483647 2147483647}
{tapi-remote CR10T 2147483647 2147483647}
{tapi-remote CR9000 2147483647 2147483647}
{tapi-remote CR5000 2147483647 2147483647}
{tapi-remote phone-modem 2147483647 2147483647}
{tapi-remote rf95 2147483647 2147483647}
{tapi-remote md9 2147483647 2147483647}
{tapi-remote generic 2147483647 2147483647}
{tapi-remote rf95t 2147483647 2147483647}
{tapi-remote cr510 2147483647 2147483647}
{tapi-remote cr510-td 2147483647 2147483647}
{tapi-remote cr23x 2147483647 2147483647}
{tapi-remote cr23x-td 2147483647 2147483647}
{tapi-remote cr10x-td 2147483647 2147483647}
{tapi-remote pakbus-port 2147483647 2147483647}
{tapi-remote rf400 2147483647 2147483647}
{cr10x-pb cr10x-pb 2147483647 2147483647}
{cr10x-pb cr510-pb 2147483647 2147483647}
{cr10x-pb cr23x-pb 2147483647 2147483647}
{cr10x-pb cr200 2147483647 2147483647}
{cr10x-pb cr1000 2147483647 2147483647}
{cr510-pb cr10x-pb 2147483647 2147483647}
{cr510-pb cr510-pb 2147483647 2147483647}
{cr510-pb cr23x-pb 2147483647 2147483647}
{cr510-pb cr200 2147483647 2147483647}
{cr510-pb cr1000 2147483647 2147483647}
{cr510-pb cr10x-pb 2147483647 2147483647}
{cr510-pb cr510-pb 2147483647 2147483647}
{cr510-pb cr23x-pb 2147483647 2147483647}
{cr510-pb cr200 2147483647 2147483647}
{cr510-pb cr1000 2147483647 2147483647}
{cr23x-pb cr10x-pb 2147483647 2147483647}
{cr23x-pb cr510-pb 2147483647 2147483647}
{cr23x-pb cr23x-pb 2147483647 2147483647}
{cr23x-pb cr200 2147483647 2147483647}
{cr23x-pb cr1000 2147483647 2147483647}
{cr1000 cr10x-pb 2147483647 2147483647}
{cr1000 cr510-pb 2147483647 2147483647}
{cr1000 cr23x-pb 2147483647 2147483647}
{cr1000 cr200 2147483647 2147483647}
{cr1000 cr1000 2147483647 2147483647}
{rf400 rf400-remote 2147483647 2147483647}
{rf400-remote CR10 2147483647 2147483647}
{rf400-remote 21X 2147483647 2147483647}
{rf400-remote CR7X 2147483647 2147483647}
{rf400-remote CR10X 2147483647 2147483647}
{rf400-remote CR500 2147483647 2147483647}
{rf400-remote CR10T 2147483647 2147483647}
{rf400-remote CR9000 2147483647 2147483647}
{rf400-remote CR5000 2147483647 2147483647}
{rf400-remote phone-modem 2147483647 2147483647}
{rf400-remote rf95 2147483647 2147483647}
{rf400-remote md9 2147483647 2147483647}
{rf400-remote generic 2147483647 2147483647}
{rf400-remote rf95t 2147483647 2147483647}
{rf400-remote cr510 2147483647 2147483647}
{rf400-remote cr510-td 2147483647 2147483647}
{rf400-remote cr23x 2147483647 2147483647}
{rf400-remote cr23x-td 2147483647 2147483647}
{rf400-remote cr10x-td 2147483647 2147483647}
{rf400-remote pakbus-port 2147483647 2147483647}
}
+describe-device-relations 

command := "describe-table" station-name table-name ";".
station-name := string.
table-name := string.

output := success-output | failure-output.
success-output := "*describe-table,\""
                  station-name "\","
                  "\"" table-name   "\","
                  interval-msec ","
                  table-size ","
                  table-original-size "\r\n"
                  "{" "\r\n"
                  { column-desc "\r\n" }
                  "}" "\r\n"
                  "+describe-table" "\r\n".
station-name := string.
table-name := string.
interval_msec := uint4.
column-desc := "\"" column-name "\" "
               column-data-type-code " "
               column-modifying-command " "
               "{" column-units "} "
               "{" column-process "} "
               "{" column-description "} "
               "{" { dimension-size } "}"
               piece-desc { piece-desc } "\r\n".
piece-desc := "{" start-linear-index num-elements "}".
column-name := string.
column-data-type-code := uint4.
column-modifying-command := uint4.
column-units := string.
column-process := string.
dimension-size := uint4.
start-linear-index := uint4.
num-elements := uint4.
failure-output := "-describe-table," reason "\r\n". 

This command can produce the following failure reasons:

*describe-table,"lgr_10t","inlocs",0,2,1
{
"Flags" 17 276 "" "" {8} {1 8}
"Ports" 17 276 "" "" {8} {1 8}
"counter" 8 276 "" "" {} {1 1}
}
+describe-table 

command := "disable-security"

output := failure-output | success-output "\r\n".
failure-output := "-disable-security," failure-reason.
success-output := "+disable-security".
    

This command can produce the following failure reasons:

command := "dump-classic-stats" device-name star-mode.
device-name := string.
star-mode := "A" | "B".

output := failure-output | success-output "\r\n".
failure-output := "-dump-classic-stats," failure-reason.
success-output := "*dump-classic-stats\r\n"
                  "{\r\n"
                  { "{" window " " value "}\r\n" }
                  "}\r\n"
                  "+dump-classic-stats".
window := number.
value  := string.
    

This command can produce the following failure reasons:

The following is an example of the command to dump the *A table for a CR10X:

dump-classic-stats cr10x A;
*dump-classic-stats
{
{ 1 0028 }
{ 2 0064 }
{ 3 0 }
{ 4 573441 }
{ 5 +2048.0 }
{ 6 +1940.0 }
}
+dump-classic-stats

command := "enable-security"

output := failure-output | success-output "\r\n".
failure-output := "-enable-security," failure-reason.
success-output := "+enable-security".
    

this command can produce the following failure reasons:

command := "exit" | "quit" | "bye".

This command, unlike any other command, produces no output.

command      := "file-control" logger-name file-command.
logger-name  := string.
file-command := compile-and-run-cmd |
                set-run-on-power-up-cmd |
                make-hidden-cmd |
                delete-file-cmd |
                format-device-cmd |
                compile-and-run-leave-tables-cmd |
                stop-program-cmd |
                stop-program-and-delete-cmd |
                make-os-cmd |
                compile-and-run-no-power-up-cmd |
                pause-cmd |
                resume-cmd |
                stop-delete-and-run-cmd |
                stop-delete-and-run-no-power-cmd |
                move-file-cmd |
                move-stop-delete-run-cmd |
                move-stop-delete-run-no-power-cmd |
                copy-file-cmd |
                copy-stop-delete-run-cmd
                copy-stop-delete-run-no-power-cmd.
compile-and-run-cmd := ("compile-and-run" | "1") program-name.
set-run-on-power-up-cmd := ("set-run-on-power-up" | "2") [ program-name ]. 
make-hidden-cmd     := ("make-hidden" | "3") file-name.
delete-file-cmd     := ("delete-file" | "4") file-name.
format-device-cmd   := ("format-device" | "5") device-name.
compile-and-run-leave-tables-cmd := ("compile-and-run-leave-tables" | "6")
                                     program-name.
stop-program-cmd    := ("stop-program" | "7").
stop-program-and-delete-cmd := ("stop-program-and-delete" | "8").
make-os-cmd         := ("make-os" | "9") file-name.
compile-and-run-now-power-up-cmd := ("compile-and-run-no-power-up" | "10")
                                    program-name.
pause-cmd           := ("pause" | "11").
resume-cmd          := ("resume" | "12").
stop-delete-and-run-cmd := ("stop-delete-and-run" | "13") file-name.
stop-delete-and-run-cmd-no-power :=
   ("stop-delete-and-run-no-power" | "14") file-name.
move-file-cmd       := ("move-file" | "15") dest-file source-file.
move-stop-delete-run-cmd :=
   ("move-stop-delete-run" | "16") dest-file source-file.
move-stop-delete-run-no-power := 
   ("move-stop-delete-run-no-power" | "17") dest-file source-file.
copy-file-cmd       := ("copy-file" | "18") dest-file source-file.
copy-stop-delete-run-cmd :=
   ("copy-stop-delete-run" | "19") dest-file source-file.
copy-stop-delete-run-power-up-cmd :=
   ("copy-stop-delete-run-no-power" | "20") dest-file source-file.
dest-file           := file-name.
source-file         := file-name.
program-name        := file-name.
file-name           := [ device-name ] file.
device-name         := device ":".

output := failure-output | success-output "\r\n".
failure-output := "-file-control," reason.
success-output := "+file-control".
    

This command can produce the following failure reasons:

command := "find-logger-security-code" logger-name.

output         := success-output | failure-output "\r\n".
success-output := "*find-logger-security-code\r\n"
                  "{\r\n"
                  security-code
                  "}\r\n"
                  "+find-logger-security-code".
failure-output := "-find-logger-security-code," reason.
    

This command can produce the following failure reasons:

command := find-pakbus-neighbours port-name [ duration-msec ].
port-name := device-name.
duration-msec := uint4.

output         := success-output | failure-output "\r\n".
failure-output := "-find-pakbus-neighbours," reason.
success-output := "+find-pakbus-neighbours".
    

This command can produce the following failure reasons:

command := "get-collect-area-setting" device-name collect-area-name
           collect-area-setting-id.

output := failure-output | success-output "\r\n".
failure-output := "-get-collect-area-setting," failure-reason.
success-output := "*get-collect-area-setting\r\n"
                  "{\r\n"
                  formatted-setting ; see supported collect area settings
                  "}\r\n"
                  "+get-collect-area-setting".
    

This command can produce the following failure reasons:

The following example requests the tablesWritten setting from a classic datalogger final storage collect area. The tables names in the area are 108 and 112. Here is the input:

get-collect-area-setting lgr final_storage_1 1;

Here is one potential output from such a command:

*get-collect-area-setting
{
2
{108}
{112}

}
+get-collect-area-setting

command := "get-collection-state".

output := failure-output | success-output "\r\n";
failure-output := "-get-collection-status," failure-reason.
success-output := "*get-collection-status\r\n".
                  "{\r\n"
                  { station-info } "\r\n".
station-info := "{ {" station-name "} " station-scheduled
                "{" { " {" scheduled-table-name "}" } " } }".
station-name := string.
station-scheduled := bool.
scheduled-table-name := string. 
    

This command can produce the following failure reasons:

*get-collection-state
{
{ {cr9000} 0 { {Public} {Status} } }
{ {lgr} 1 { {ErrorLog} {InLocs} {Status} {TimeSet} } }
}
+get-collection-state

command := "get-device-setting" device-name setting-id.

output := failure-output | success-output "\r\n".
failure-output := "-get-device-setting," reason.
success-output := "*get-device-setting," setting-status "\r\n"
                  "{" "\r\n"
                  formatted-setting  ; (Section 4, “Supported Device Settings”)
                  "} "\r\n"
                  "+get-device-setting".
setting-status := "active" | "ignored".
    

Some device settings can be ignored under certain situations. For instance, the maxBaudRate setting for the CR10X-TD device type can be marked as ignored when the datalogger is created as a child to an RF95-TD. The setting-status field reports whether the setting is in this ignored state.

This command can produce the following failure reasons:

The following command requests the collection schedule setting from a datalogger:

get-device-setting lgr 5;

The results of this command could be:

*get-device-setting,"lgr",5
{
1 {19900101 00:00:00} 60000 10000 10 60000
}
+get-device-setting

command := "get-file" logger-name logger-file-name [ save-as-option ].
logger-name := string.
logger-file-name := [ logger-fs-name ":" ] file-name.
save-as-option := "--save-as=" local-file-name.
local-file-name := string.

output := success-output | failure-output.
success-output := "+get-file" "\r\n".
failure-output := "-get-file," reason "\r\n".
    

This command can produce the following failure reasons:

The following example shows the command to copy the file, readme.txt from the CPU device of a station named minas-tirith and to save that file locally into a file named "c:\temp\minas-tirith.txt":

get-file minas-tirith CPU:readme.txt --save-as=c:\temp\minas-tirith.txt

command := "get-lgrnet-setting" setting-id ";".
setting-id = string.  ; (Section 8, “Supported LgrNet Settings”)

output := failure-output | success-output "\r\n".
failure-output := "-get-lgrnet-setting," reason.
success-output := "*get-lgrnet-setting "\r\n"
                  "{\r\n"
                  formatted-setting 
                  "}\r\n"
                  "+get-lgrnet-setting".
    

This command can produce the following failure reasons:

The following command requests the value of the low level log settings:

get-lgrnet-setting 5;

It will return results similar to the following:

*get-lgrnet-setting
{
true 5 1200000
}
+get-lgrnet-setting

command := "get-pakbus-settings" pakbus-router-name pakbus-address 
           { setting-name }.
pakbus-router-name := string.
pakbus-address := uint2.
setting-name := string.

output := failure-output | success-output.
failure-output := "-get-pakbus-settings," reason.
success-output := "*get-pakbus-settings" "\r\n"
                  "{" "\r\n"
                  { "{{" setting-name "} {" setting-value "}}" }.
                  "}" "\r\n"
                  "+get-pakbus-settings".
setting-name := string.
setting-value := string.
    

This command can produce the following failure reasons:

The following output was generated from a command executed against a CR200:

get-pakbus-settings pkb 128;
*get-pakbus-settings
{
{{Company} {CSI}}
{{Model} {CR2xx}}
{{Version} {v0.2.01}}
{{PakCtrlCodes} {7,8,9}}
{{BMP5Codes} {9,21,23,24,26,27,28,29,30}}
{{MaxPktSize} {100}}
{{PakBusAddress} {128}}
{{RfInstalled} {424}}
{{RfNetAddr} {1}}
{{RfAddress} {1}}
{{RfHopSeq} {4}}
{{RfPwrMode} {RF_ON}}
{{Rf_ForceOn} {0}}
}
+get-pakbus-settings 

command := "get-phone-modem-info" modem-type-name.

output         := failure-output | success-output "\r\n".
failure-output := "-get-phone-modem-info," reason.
success-output := "*get-phone-modem-info\r\n"
                  "{\r\n"
                  "{" reset-string "}\r\n"
                  "{" init-string "}\r\n"
                  [ "custom\r\n" ]
                  "+get-phone-modem-info".
    

This command can produce the following failure reasons:

The following output results from the command executed against one of my custom phone modems:

get-phone-modem-info lucent;
*get-phone-modem-info
{
{&F}
{V1&C1&D2\J1}
custom
}
+get-phone-modem-info

command := "get-program-file" station-name { option }.
option  := ( "--use-cache=" ("true" | "false")) |
           ( "--file-name=" local-file-name ) |
           ( "--file-path=" local-file-path ).

output := failure-output | success-output "\r\n".
failure-output := "-get-program-file," failure-reason.
success-output := "+get-program-file".
    

This command can produce the following failure reasons:

The following command will retrieve the program from the station named "lgr" and place it in the cora_cmd working directory. The name of the file will be assigned by the server:

get-program-file lgr --file-path="c:\temp";

command := "get-program-stats" station-name
            ["--used-cached=" use-cached-value].

output         := success-output | failure-output.
success-output := "*get-program-stats\n"
                  "{\n"
                  [ "OS Version: {" os-version "}\n"]
                  [ "OS sig: " os-sig "\n" ]
                  [ "Serial No: " serial-no "\n" ]
                  [ "Power Up Prog: {" power-up-prog "}\n" ]
                  "Compile State: " compile-state "\n"
                  [ "Program Name: {" program-name "}\n" ]
                  [ "Program Sig: " program-sig "\n" ]
                  [ "Compile Time: " compile-time "\n" ]
                  [ "Compile Result: {" compile-result "}\n" ]
                  [ "Station Name: {" station-name "}\n" ]
                  "}\n"
                  "+get-program-stats".
failure-output := "-get-program-stats," failure-reason. 

This command can produce the following failure reasons:

command := "get-table-defs" station-name [action-option] ";". 
action-option := "--action=" (merge-action | reset-action).
merge-action := "merge" | "1".
reset-action := "reset" | "2".

output := failure-output | success-output "\r\n".
failure-output := "-get-table-defs," failure-reason.
success-output := "+get-table-defs".
    

This command can produce the following failure reasons:

command      := command-name field-name [ "--swath=" swath ].
command-name := "get-variable" | "get-value" | "get-values".
field-name   := station-name "." table-name "." column-name
                [ "(" subscript { subscript } ")" ].
station-name := quoted-string.
table-name   := quoted-string.
column-name  := quoted-string.
quoted-string := ["\""] string ["\""].

output         := failure-output | success-output "\r\n".
failure-output := "-" command-name "," failure-reason.
success-output := "*" command-name "\r\n"
                  "{\r\n" values "\r\n}\r\n"
                  "+" command-name.
values         := { 10{ value ","} "\r\n".
    

This command can produce the following failure reasons:

The following command retrieves the serial numbers from a CR9000 status table:

get-values cr9000.Status.SlotSrlNbr --swath=12

The results of this command would be similar to the following output:

*get-values
{
1234, 1007, 1234, -1, -1, 0, 0, 0, 0, 0,
1234, 0
}
+get-values 

The following command on the same datalogger:

get-value cr9000.Status.SlotSrlNbr(2);

will yield results similar to the following:

*get-value
{
1007
}
+get-value

command := "identify-bmp3" device-name [ new-station-name ].
device-name := string.
new-station-name := string.

output := failure-output | success-output end-of-line.
failure-output := "-identify-bmp3," reason.
success-output := "*identify-bmp3\r\n"
                  "{\r\n"
                  bmp-version device-type serial-no station-name
                  "}\r\n"
                  "+identify-bmp3".
bmp-version := "bmpver=" integer.
device-type := "model-no=" string.
serial-no := "serial-no=" integer.
station-name := "station-name={" string "}".
    

This command can produce the following error reasons:

command := "identify-protocol" device-name 
           [ "--max-baud-rate=" max-baud-rate ].
device-name := string.
max-baud-rate := integer.

output := success-output | failure-output "\r\n".
success-output := "*identify-protocol\r\n
                  "{\r\n"
                  "{" protocol "}\r\n" 
                  [ "Device Type: " device-type ] "\r\n"
                  [ "PakBus Address: " pakbus-address ] "\r\n"
                  "}\r\n"
                  "+identify-protocol".
protocol := "classic" |
            "BMP1" |
            "BMP3" |
            "PakBus".
device-type := string.
failure-output := "-identify-protocol," reason.

The device type, if present, will be one of the values that can be used in the add-device command (see Section 2.2, “add-device”). The paklbus-address parameter will be present if the PakBus protocol was identified and, in the process, the address of the device was detected as well.

This command can produce the following failure reasons:

The following shows a possible output when the command is run against a CR9000 datalogger:

*identify-protocol
{
{BMP3}
CR9000
}
+identify-protocol 

command := "list-accounts".

output := failure-output | success-output "\r\n".
failure-output := "-list-accounts," failure-reason.
success-output := "*list-accounts\r\n"
                  "{\r\n"
                  { account "\r\n" }
                  "}\r\n"
                  "+list-accounts". 
account := "{{" account-name "} {" 
           account-password "} "
           access-level " {"
           { " {" device-addition "}" }
           "}".

The device-addition list is the list of devices for which the account is goven at least station-manager access level regardless of the overall access level associated with the account.

This command can produce the following failure reasons:

*list-accounts
{
{{jon} {password} 5000 {}}
{{tyler} {} 5000 {}}
}
+list-accounts

command := "list-bmp1-devices".

output := error-output | success-output.
error-output := "-list-bmp1-devices," reason.
success-output := "*list-bmp1-devices\r\n"
                  "{\r\n"
                  { device-descriptor "\r\n" }
                  "}\r\n"
                  "+list-bmp1-devices".
device-descriptor := "{{" device-name "}" bmp1-station-id "}".
    

This command can produce the following failure reasons:

The following output is generated from a simple network involving RF95T dataloggers.

*list-bmp1-devices
{
{{rf_base} 2}
{{logger1} 3}
{{logger2} 4}
}
+list-bmp1-devices

command := "list-collect-area-settings" station-name
           collect-area-name.

output         := failure-output | success-output "\r\n".
failure-output := "-list-collect-area-settings," reason.
success-output := "*list-collect-area-settings\r\n"
                  "{\r\n"
                  { collect-area-setting "\r\n" }
                  "}\r\n"
                  "+list-collect-area-settings".
collect-area-setting := setting-id "{\r\n"
                        setting-value "\r\n}".
    

This command can produce the following failure reasons:

The following example shows the echo of the input and the output of the command run against a classic datalogger's final storage collect area:

list-collect-area-settings cr23x final_storage_1;
*list-collect-area-settings
{
{1{
0

}}
{2{
1
}}
{3{
1
}}
{6{
comma-delimited-ascii
}}
{8{
logged-since-last
}}
{9{
1
}}
{10{
2
}}
{11{
2
}}
{12{
1
}}
{15{
1
}}
{16{
append
}}
{17{
%a\%s_%n.dat
}}
{18{
available
}}
{19{
table-ascii
}}
{20{
no-header
}}
{21{
C:\Campbellsci\LoggerNet-2.2\CR23X_final_storage_1.dat
}}
{22{
1
}}
{23{
30000
}}
{28{
ascii-without-header
}}
}
+list-collect-area-settings 

command := "list-collect-areas" station-name.

output := failure-output | success-output "\r\n".
failure-output := "-list-collect-areas," reason.
success-output := "*list-collect-areas," device-name "\r\n"
                  "{\r\n"
                  { record  "\r\n" }
                  "}\r\n"
                  "+list-collect-areas".
record := "\"" area-name "\"," persistence-code.
area-name := string.
persistence-code := 1{digit}. ; 1 <= persistence-code <= 4

The persistence-code value is an enumeration that indicates the potential lifetime of the collect area. The following values are defined:

This command can produce the following failure reasons:

command := "list-comm-ports".

output         := failure-output | success-output "\r\n"
failure-output := "-list-comm-ports," failure-reason.
success-output := "*list-comm-ports\r\n"
                  "{\r\n"
                  "{ " { "{" port-name "} {" port-friendly-name "} }\r\n" }
                  "}\r\n" 
                  "+list-accounts". 
    

This command can produce the following failure reasons:

*list-comm-ports
{
{ {COM3} {} }
{ {COM5} {USB Serial Port (COM5)} }
{ {COM6} {SC-USB  USB TO CS I/O ISOLATED INTERFACE (COM6)} }
}
+list-comm-ports

command := "list-countries".

output         := failure-output | success-output "\r\n".
failure-output := "-list-countries," failure-reason.
success-output := "*list-countries\r\n"
                  "{\r\n"
                  { "{" country-code "{" country-name "}\r\n" }
                  "}\r\n"
                  "+list-countries".
    

This command can produce the following failure reasons:

*list-countries
{
{1 {United States of America}}
{1 {Anguilla}}

... lots more country records ...

{996 {Kyrgyz Republic}}
{998 {Uzbekistan}}
}
+list-countries 

command := "list-device-default-settings" device-type
           { parent-device-type }.

output := failure-output | success-output "\r\n".
failure-output := "-list-device-default-settings," reason.
success-output := "-list-device-default-settings\r\n"
                  "{\r\n"
                  { setting-info "\r\n" }
                  "}\r\n"
                  "+list-device-default-settings".
setting-info := setting-id " " setting-status " "
                [ "{" setting-value "}" ].
setting-value := string.
setting-id := integer.
setting-status := "unknown" | "known" | "ignored" | "unpredictable".
setting-value := string.

The default setting value will only be listed if the associated setting-status is marked as known. The syntax of the setting value will be the same as that expected by the set-device-setting command (see Section 2.91, “set-device-setting (all versions)”) and produced by the get-device-setting command (see Section 2.34, “get-device-setting (all server versions)”).

This command can produce the following failure reasons:

The following example shows the echo of the input and printed output from querying the default settings for a PakBus port device connected directly to serial port:

list-device-default-settings pakbus-port com-port;
*list-device-default-settings
{
2  known {0}
3  known {1008}
4  known {0}
22  known {1}
70  known {9600}
71  known {60}
72  known {0}
79  known {201}
}
+list-device-default-settings 

The entire parent type list does not need to be specified all the way to the root level device types. For instance, the following command shows the default settings for a PakBus port object created as a child to a phone modem:

list-device-default-settings pakbus-port phone-modem;
*list-device-default-settings
{
2  known {0}
3  known {1008}
4  known {0}
22  known {1}
70  known {9600}
71  known {60}
72  known {1}
79  known {201}
}
+list-device-default-settings

Note that the input in this example skipped over the remote phone modem that would normally be required and also omitted any mention of any parents to the phone modem. Also note that the default code for the pakbusIsDialedLink setting (see Section 4.56, “pakbusIsDialedLink (72)”) is different in this context.

command := "list-device-settings" device-name.

output := failure-output | success-output "\r\n".
failure-output := "-list-device-settings," reason.
success-output := "*list-device-settings\r\n"
                  "{\r\n"
            ; see Section 4, “Supported Device Settings”
                  { setting-id "\r\n" }
                  "}\r\n"
                  "+list-device-settings".
    

This command can produce the following failure reasons:

*list-device-settings
{
1
2
3
4

 ... more setting identifiers ...

38
}
+list-device-settings

command := "list-devices".

output         := (failure-output | success-output) "\r\n".
failure-output := "-list-devices," reason.
success-output := "*list-devices\r\n"
                  "{\r\n"
                  { device-record "\r\n" }
                  "}\r\n"
                  "+list-devices".
device-record  := "{{" device-name "} "
                  device-id " "
                  device-type-code " "
                  indentation "}".

This command can produce the following failure reasons:

list-devices;
*list-devices
{
{{com1} 29358 com-port 0}
{{pkb1} 6334 pakbus-port 1}
{{gold} 19169 cr10x-pb 2}
{{cr205-1073} 18467 cr200 2}
{{CR1000} 26500 cr1000 2}
{{cr205-205} 11478 cr200 2}
{{CR23X} 15724 cr23x 1}
{{com2} 41 com-port 0}
{{PhoneBase} 24464 phone-modem 1}
{{mendon-rem} 5705 phone-modem-remote 2}
{{mendon} 28145 CR10X 3}
{{logannw-rem} 23281 phone-modem-remote 2}
{{logannw} 16827 CR10X 3}
}
+list-devices 

command := "list-files" station-name.

output         := (success-output | failure-output) "\r\n".
failure-output := "-list-files," explanation.
success-output := "*list-files\r\n"
                  "{\r\n"
                  { file-desc \r\n" } 
                  "}\r\n"
                  "+list-files\r\n".
file-desc      := "{" file-name "}" 
                  [ "rn=" run-now-attr ]
                  [ "pu=" run-on-power-up-attr ]
                  [ "ro=" read-only=attr ]
                  [ "size=" file-size-attr ]
                  [ "last-changed=" last-changed-attr ]
                  [ "paused=" paused-attr].
run-now-attr   := "true" | "false".
run-on-power-up-attr := "true | "false".
read-only      := "true" | "false".
file-size      := number.
last-changed-attr := logger-date-string. 
paused-attr    := "true" | "false".
    

This command can produce the following failure reasons:

The following example input echo and command output lists the contents of a CR1000 file system.

list-files cr1000;
*list-files
{
{CPU:TableDef.tdf} rn=false pu=false ro=false size=2599 last-changed={"2004-04-05 06:29:02"}
{CPU:Directry.Dir} rn=false pu=false ro=false size=0 last-changed={"1980-00-00 00:00:00"}
{CPU:simple.CR1} rn=false pu=false ro=false size=547 last-changed={"2004-03-24 11:49:34"}
{CPU:B11973_1.CR1} rn=false pu=false ro=false size=674 last-changed={"2004-03-24 11:42:46"}
{CPU:lights-auto.CR1} rn=true pu=true ro=false size=1966 last-changed={"2004-03-29 14:16:38"}
}
+list-files 

command := "list-holes".

output         := (success-output | failure-output) "\r\n".
failure-output := "-list-holes," reason.
success-output := "*list-holes\r\n"
                  "{\r\n"
                  { hole-description "\r\n" }
                  "}\r\n"
                  "+list-holes".
hole-description := "{" station-name "} {" table-name "} "
                    begin-record-no " " end-record-no.
station-name := string.
table-name := string.
begin-record-no := uint4.
end-record-no := uint4.
    

This command can produce the following failure reasons:

*list-holes
{
{lgr} {106} 26244502 26247280
{lgr} {106} 26247495 26247834
{lgr} {106} 26247871 26247885
}
+list-holes 

command := "list-pakbus-networks".

output         := (error-output | success-output) "\r\n".
error-output   := "-list-pakbus-networks," reason.
success-output := "*list-pakbus-networks\r\n"
                  "{\r\n"
                  { pakbus-router-name "\r\n" }
                  "}\r\n"
                  "+list-pakbus-networks".
    

This command can produce the following failure reasons:

The following output shows the results of having one PakBus router.

*list-pakbus-networks
{
pkb1
}
+list-pakbus-networks

command := "list-pakbus-nodes" pakbus-router-name.

output         := (error-output | success-output) "\r\n".
error-output   := "-list-pakbus-nodes," reason.
success-output := "*list-pakbus-nodes\r\n"
                  "{\r\n"
                  { node-descriptor "\r\n" }
                  "}\r\n"
                  "+list-pakbus-nodes".
node-descriptor := pakbus-address router-address 
                   worst-case-response-interval
                   "{" [ network-map-name ] "}".
pakbus-address := uint2.
router-address := uint2.
worst-case-response-interval = uint4.  ; milli-seconds response
network-map-name := device-name.
    

This command can produce the following failure reasons:

The following example shows the echo of the input and the resulting output of the command.

list-pakbus-nodes pkb1;
*list-pakbus-nodes
{
{1 1 1000 {CR1000}}
{131 131 1000 {gold}}
{205 205 1000 {cr205-205}}
{1073 1073 1000 {cr205-1073}}
}
+list-pakbus-nodes 

command := "list-phone-modem-types".

output         := failure-output | success-output "\r\n".
failure-output := "-list-phone-modem-types," reason.
success-output := "*list-phone-modem-types\r\n"
                  "{\r\n"
                  { "{" phone-modem-type-name "}\r\n" }
                  "}\r\n"
                  "+list-phone-modem-types".
    

This command can produce the following failure reasons:

The following example lists a sample output for this command.

*list-phone-modem-types
{
{3Com EtherLink III LAN+33.6 MODEM}
{3COM US ROBOTICS SPORTSTER 9600 to 56K MODEMS}
{<default modem>}
{<default pre-fax 2400 baud (or less) modem>}
{ACE TECHNOLOGIES PCMCIA 14.4 Data and Fax modem}
{ACEEX 9600}
{ACER 14.4 Data and Fax modem}
{APEX DATA MULTICARD 14.4K PCMCIA FAX MODEM & ETHERNET ADAPTER}
{AT&T Paradyne 14.4 Modem}
{AT&T Paradyne 19.2 Modem (model 3910)}
{AZTECH HCF 56K MODEM}
{BANKSIA}
{BOCAMODEM 14.4K}
{BOCAMODEM 28.8K}
{BOCAMODEM Internal 9624}
{CARDINAL 14.4 Fax Modem}
{COMPAQ 14.4 & 28.8 PCMCIA DATA FAX}
{COMPAQ 33.6 Modem}
{DELL INTERNAL MODEM}
{DIGICOM SYSTEMS INC SCOUT(PLUS)}
{DIGITRAN ES144FVM INTERNAL MODEM}
{EIGER EFX1440P PCMCIA MODEM}
{FUJITSU Fax Modem}
{GATEWAY 2000 TELEPATH}
{GATEWAY 2000 TELEPATH II}
{GATEWAY 2000 TELEPATH PCMCIA}
{GVC 28.8 MODEM}
{GVC INTERNAL FAX MODEM}
{HAYES ACCURA 9600, 14.4 & 28.8 MODEM}
{HAYES OPTIMA 9600 - 33.6 MODEM}
{HAYES ULTRA 9600}
{IBM PERSONAL SYSTEM/2 INTERNAL DATA/FAX}
{IMAGINATION 14.4 MODEM}
{INFOTEL 14.4 POCKET MODEM}
{INFOTEL PCMCIA CARD MODEM}
{INTEL 14.4/FAX PCMCIA CARD MODEM}
{INTEL 2400EX ( Also works for 9600 & 14.4 )}
{INTEL 96/96i 144/144i 96/96e 144/144e MODEMS}
{INTEL SATISFAXTION 200 MODEM}
{INTEL SATISFAXTION 400 MODEM}
{lucent}
{lucent2}
{MAXTECH 14.4 Fax MODEM}
{MAXTECH 33.6 Fax MODEM}
{MEGAHERTZ (C596FM) Internal Fax MODEM}
{MEGAHERTZ (CCXJEM3288) PCMCIA CARD MODEM}
{MEGAHERTZ (XJ1144 or CC3144) PCMCIA CARD MODEM}
{MEGAHERTZ (XJ1560) PCMCIA CARD MODEM}
{MEGAHERTZ (XJ2288) PCMCIA CARD MODEM}
{MEGAHERTZ (XJ3388R) PCMCIA CARD MODEM}
{MICROCOM 14.4}
{MOTOROLA CELLULAR TELEPHONE MODEM}
{MOTOROLA Internal 28.8 MODEM}
{MOTOROLA ModemSurfr 56K}
{MOTOROLA UDS V.3225}
{MULTITECH 14.4 MODEL MT1432MU}
{MULTITECH 14.4 MODEL MT1932ZDX or ZPX}
{MULTITECH MT224-B4 (Firmware Revision #3.06)}
{NETCOMM Roadster 144P Modem}
{NEW MEDIA PCMCIA 14.4 DATA/FAX MODEM}
{NOTEWORTHY PCMCIA FAX MODEM}
{ORIGO33.6 Fax MODEM}
{P.M.B  L'AVANCE MODEM 14.4 FAX MODEM}
{PACE LINNET 32}
{PACE MICROLIN FX 32+}
{PACKARD BELL 2400, 9600 & 14.4 FAX MODEM}
{PC LOGIC 14.4 INTERNAL FAX MODEM  (Made by Carnel Modems)}
{PRACTICAL PERIPHERALS  9600 - 33.6 MODEMS}
{ROCKWELL HCF 56K MODEM}
{SMARTONE 14.4 & 28.8 FAX MODEMS}
{SUPRA 14.4 & 28.8 FAX MODEM}
{THUNDER LINK MODEM}
{TOSHIBA T144PF4 PCMCIA CARD MODEM}
{US ROBOTICS SPORTSTER 9600 to 56K MODEMS}
{US ROBOTICS WORLDPORT 14.4 POCKET MODEM}
{VIKING NetLink 33.6 PCMCIA MODEM}
{WinBook XP Fax Modem}
{Xircom PCMCIA Modem}
{ZEOS NEW MEDIA PCMCIA 14.4 DATA/FAX MODEM}
{ZOLTRIX 14.4 FAX MODEM}
{ZOOM 9600 & 14.4 MODEMS}
{ZyXEL U-1496 MODEM}
}
+list-phone-modem-types

command     := "list-recent-errors" device-name.
device-name := string.

output          := failure-output | success-output "\r\n".
failure-output  := "-list-recent-errors," reason.
success-output  := [ extended-output ] "+list-recent-errors".
extended-output := "*list-recent-errors\r\n"
                   "{\r\n"
                   { message }
                   "\r\n}\r\n".
message := "\"" stamp "\",\""
                device-name "\",\""
                severity "\",\""
                details "\"\r\n".
stamp   := year "-" month "-" day " " hour ":" minute ":" second
           [ "." sub-seconds ].
device-name := string.
severity := "W" | "F".
details  := string.
    

This command can produce the following failure reasons:

command := "list-server-discs".

output         := (success-output | failure-output) "\r\n".
failure-output := "-list-server-discs," reason.
success-output := "*list-server-discs\r\n" 
                  "{\r\n"
                  { drive-spec "\r\n" }
                  "}\r\n"
                  "+list-server-discs".
drive-spec     := "{ \""  root-path "\" "
                      drive-type " "
                      drive-size " "
                      drive-free-space " }".
root-path      := string.
drive-type     := "fixed" | "removable" | "cdrom" |
                  "remote" | "ramdisc".
drive-size     := int8.
drive-free-space := int8.
    

This command can produce the following failure reasons:

*list-server-discs
{
{ "A:\" removable 0 0 }
{ "C:\" fixed 40369639424 20875821056 }
{ "E:\" cdrom 42186752 0 }
{ "F:\" remote 3894870016 1506869248 }
{ "H:\" cdrom 0 0 }
{ "J:\" remote 54334582784 25876692992 }
{ "K:\" remote 27166502912 26775986176 }
{ "N:\" remote 54334582784 25876692992 }
{ "O:\" remote 3894870016 1506869248 }
{ "P:\" remote 3894870016 1506869248 }
{ "Q:\" remote 3894870016 1506869248 }
{ "Z:\" fixed 789594112 782257152 }
}
+list-server-discs

command := "list-server-files" [ "--path=" path-to-list ]
           [ "--list-parent=" list-parent-opt ].
path-to-list := string.
list-parent-opt := ("true" | "1") |
                   ("false" | "0").

output         := (success-output | failure-output) "\r\n".
failure-output := "-list-server-files," reason.
success-output := "*list-server-files,\"" full-path \" end-of-line
                  "{\r\n"
                  { element "\r\n" }
                  "}\r\n"
                  "+list-server-files.
element   := "{ {" name "} " element-type
             " {" creation-date "} "
             [ "{" last-write-date "} " size " " ]
             "}".
name          := string.
element-type  := "file" | "directory".
creation-date := timestamp.
last-write-date := timestamp.
file-size     := int8.
    

This command can produce the following failure reasons:

The following example shows the echo of the command input and the output.

list-server-files;
*list-server-files,"c:\campbellsci\loggernet-2.2"
{
{ {.} directory {20030801 10:51:31.466} }
{ {..} directory {20030801 10:51:31.466} }
{ {Cardserv.vxd} file {20030829 10:53:48.737} {20010329 10:18:18} 6936 }
{ {Logs} directory {20031006 09:36:08.844} }
{ {RTMC} directory {20030801 10:51:31.516} }
{ {SYS} directory {20030801 10:51:31.466} }
}
+list-server-files 

command := "list-stations".

output         := (success-output | failure-output) "\r\n".
success-output := "*list-stations\r\n"
                  "{\r\n"
                  { station-desc "\r\n"}
                  "}\r\n"
                  "+list-stations".
station-desc   := "{{" station-name "} broker-id "}".
station-name   := string.
broker_id      := uint4.
failure-output := "-list-stations," explanation.
    

This command can produce the following failure reasons:

*list-stations
{
{{gold} 2}
{{cr205-1073} 4}
{{CR1000} 6}
{{cr205-205} 9}
{{CR23X} 11}
{{__Statistics__} 12}
}
+list-stations

command := "list-tables" broker-name.

output         := (success-output | failure-output) "\r\n".
success-output := "*list-tables," station-name "\r\n"
                  "{\r\n"
                  { "\"" table-name "\"\r\n" }
                  "}\r\n"
                  "+list-tables".
table-name := string.
failure-output := "-list-tables," reason "\r\n"
    

This command can produce the following failure reasons:

*list-tables,"lgr_10t"
{
"ErrorLog"
"InLocs"
"SawTooth"
"Status"
"TimeSet"
}
+list-tables

command := "list-tapi-modems" | "list-tapi-lines".

output         := (failure-output | success-output) "\r\n".
failure-output := "-" command-name "," failure-reason.
success-output := "*" command-name "\r\n"
                  "{\r\n"
                  { "{" modem-name "}\r\n" }
                  "}\r\n"
                  "+" command-name.
    

This command can produce the following failure reasons:

*list-tapi-modems
{
{Sportster 14400 V.42bis}
}
+list-tapi-modems 

command := "lock-network".

output         := failure-output | success-output "\r\n".
failure-output := "-lock-network," reason.
success-output := "+lock-network  \"release the lock using unlock-network\"".
    

This command can produce the following failure reasons:

command       := "logger-query" station-name table-name file-name
                 query-mode [format-option] [format-flag]
                 [use-same-table-option].
query-mode    := date-range | record-range | most-recent |
                 all-since-last | all | start-at-record.
date-range    := "date-range" begin-stamp end-stamp.
record-range  := "record-range" begin-record-no end-record-no.
most-recent   := "most-recent" count.
all-since-last := "all-since-last".
all           := "all".
start-at-record := "start-at-record" begin-record-no.
format-option := "--format="
                 ("TOA5" |
                  "TOACI1" |
                  "TOB1" |
                  "LDXP" |
                  "custom-csv" |
                  "csixml").
format-flag  := uint4.
use-same-table-option := "--use-same-table=" bool.

output         := failure-output | success-output "\r\n".
failure-output := "-logger-query," failure-reason.
success-output := "+logger-query," records-processed.

    

This command can produce the following failure reasons: