Configuring with the command-line interface

Advanced configurations are set using the command-line interface (see Connecting to the LI-570 for details). When the LI-570 is connected to a terminal emulator, the concatenated data stream begins scrolling up the display. This is normal Sampling Mode. If an SD card is installed in the LI-570, these data are saved to a file on the SD card.

Caution: When the LI-570 is in command-line interface mode, all data sampling is stopped, and the storage file is closed. All incoming data are lost while the LI-570 is in command-line interface mode.

• Press Ctrl + C to enter the command-line interface. You will see the command-line interface prompt > on the terminal emulator screen.
• Exit command-line interface by typing exit and pressing enter.

Caution: Changes made in the command-line interface are temporary. The command nvwrite stores the changes into memory, where they will be applied after the unit is restarted.

The Help menu

To see a list of available commands, use the help command by typing help and pressing enter.

Detailed help for all available commands and arguments are accessed within the command-line interface at the prompt (the flashing cursor indicator appearing to the right of the >) by typing the command help followed by the name of the command and pressing enter.

Summary of commands

Some of the commands are described below. Arguments are indicated with < and > characters, replace the angle brackets and the text with the parameter value. Arguments shown within square brackets [ and ] are optional.

help

Displays a list of command-line interface commands. The command word help followed by the name of another command displays detailed help for that command (e.g., help <command>)

Table 5‑1. The help command.

Command	Description
help	Displays commands available in the command-line interface.
<command>	e.g., help analog, help diagnostic, and so on.

exit

Type exit to leave the command-line interface and return to sampling mode.

Command	Description
exit	Leaves the command-line interface and returns to sampling mode.

analog

Analog inputs are not supported at this time.

diagnostic

Command	Description
diagnostic	Performs a self diagnostic on the LI-570.

digital

Digital inputs are not supported at this time.

expert

The expert command allows access to parameters that are not normally user-adjustable. Do not make changes without understanding the consequences.

Table 5‑2. The expert command.

Command	Description
expert	Enter or exit expert mode that includes extra commands.
enable	Enable expert command mode.
disable	Disable expert command mode.

gps

Show or set the GPS configuration. Use help gps for full argument list.

Table 5‑3. The gps command and arguments.

Command	Description
gps	With no arguments, displays the current settings.1 If there are multiple GPS receivers attached, all of the GPS outputs are formatted the same.
tag	Turns on GPS parameters tags.
untag	Turns off GPS parameters tags.
tagdelim	Specifies the delimiter to be placed after the tags.
<char>	The character to use as the tag delimiter.
space	Sets the tagdelim character to a space.
paramdelim	Specifies the delimiter placed after parameters.
<char>	The character to use as the delimiter.
space	Sets the paradelim character to a space.
date	Enable or disable GPS date. This value is redundant when the time tag function is used.
enable	Enable the date parameter.
disable	Disable the date parameter.
slash	Sets the format to yy/mm/dd.
dash	Sets the format to yy-mm-dd.
colon	Sets the format to yy:mm:dd.
space	Sets the format to yy mm dd.
none	Sets the format to yymmdd.
time	Enable or disable GPS time. This value is redundant when the time tag function is used.
enable	Enable the date parameter.
disable	Disable the time parameter.
slash	Sets the format to hh/mm/ss
dash	Sets the format to hh-mm-ss
colon	Sets the format to hh:mm:ss
space	Sets the format to hh mm ss
none	Sets the format to hhmmss
latlon	Set the format for latitude and longitude parameters.
enable	Enable the latitude and longitude parameters.
disable	Disable the latitude and longitude parameters.
pre	Sets the lat/lon format to Ndddmm.mmmmmm.
sep	Sets the lat/lon format to dddNmm.mmmmmm.
post	Sets the lat/lon format to dddmm.mmmmmmN.
alt	Enable or disable the altitude value of the GPS output.
enable	Enable the altitude parameter.
disable	Disable the altitude parameter.
speed	Enable or disable the speed value of the GPS output.
enable	Enable the speed parameter.
disable	Disable the speed parameter.
coarse	Enable or disable the coarse value of the GPS output.
enable	Enable the coarse parameter.
disable	Disable the coarse parameter.

log

Show or set the logging configuration. Use help log for full argument list. A new file is started every time the command line interface is exited.

Table 5‑4. The log command and options.

Command	Description
log	With no arguments, displays the current logging settings.
enable	Enable the data logging
disable	Disable the data logging
rate	Set the new log file rate values for rate. Options for <arg> are:
qhour	Starts a new file on the 15 minute mark.
hhour	Starts a new file every hour and half-hour.
hour	Starts a new file every hour.
day	Starts a new file at 00:00 every day.
week	Starts a new file at 00:00 every Sunday.
prefix	Set the prefix <arg> for generated files.
dir	Set the root directory <arg> name where files are stored.

missingdata

Show or set the missing data configuration for a port. Use help missingdata for the full argument list.

Table 5‑5. The missingdata command and options.

Command	Description
missingdata	With no arguments, displays the missing data settings for all ports.
<port>	Serial port for applying arguments. Values for <port> are 1 - 4.
enable	Enable the missing data function for the serial port.
disable	Disable the missing data function for the serial port.
last	Use the last good data string as the missing data output.
notlast	Do not use the last good data string as the missing data output.
sub	Use <arg> as the substitute string for the missing data output. Spaces are allowed in <arg>.

nvwrite

Use to store a change to the configuration, for example.

Command	Description
nvwrite	Writes a parameter to non-volatile memory.

passthru

Show or set the serial passthru configuration. Use help passthru for full argument list.

Table 5‑6. The passthru command and data.

Command	Description
passthru	With no arguments, displays the serial passthru settings for all ports.
<port>	Serial port for applying passthru parameter commands. Values for <port> are 1 - 4.
enable	Enable the serial passthru on the specifed port.
exit	Shows or sets the exit character for the passthru function. All other characters will be passed on to the serial instrument. When the exit character is entered from the console port, the passthru session will exit and control will return to the data logger. Ctrl+D is the default character.
<char>	Key character used as the exit character. Enter control characters as ctrl+d or Ctrl+D
pgmupdate	The pgmupdate command temporarily disables the exit feature so that a firmware update can take place over the passthru port. Rebooting the data logger is required to exit passthru mode.

pgmupdate

Issue the pgmupdate command to temporarily disable the exit feature so that a firmware update can take place over the passthru port.

Command	Description
pgmupdate	Starts a modem session to install new firmware.

serial

Show or set the serial port configuration. Use help serial for full argument list.

Table 5‑7. The serial command and options.

Command	Description
serial	With no arguments, displays the serial settings for all ports.
<port>	Serial port for applying arguments. Values for <port> are 1 - 6. The first four ports are Inst 1 - Inst 4. Port 5 is GPS and Port 6 is Radio
enable	Enable the serial port to receive data for a serial instrument.
disable	Disable the serial port.
baud	Show or set the baud rate of the serial port
<baud>	Must be a valid standard serial baud rate.
now	Apply the change immediately. Otherwise it is applied on reboot.
parity	Show or set the parity of the serial port.
none	Set no parity.
odd	Set odd parity.
even	Set even parity.
now	Apply the change immediately. Otherwise it is applied on reboot.
gps	Configure the reception of data on the serial port to process GPS data in lines with other serial data.
enable	Turn on GPS processing.
disable	Turn off GPS processing.
tagged	Enable the serial channel tag for this port.
untagged	Disable the serial channel tag for this port.
tag	Use <arg> as the tag for this serial channel port.

setdate

This command sets the date for the data logger.

Command	Description
<date>	yy/mm/dd
gps	Set time and date with the next GPS update. GPS must be providing valid time and date data.

settime

Sets the time for the data logger.

Command	Description
<time>	hh:mm:ss; Must use 24-hour format.
gps	Set time and date with the next GPS update. GPS must be providing valid time and date data.

station

Configures the station tag.

Table 5‑8. The station command and options.

Command	Description
station	Configures the station tag.
enable	Enable the station tag display. Executes the tagged function.
disable	Disable the station tag display. Executes the untagged function.
enable	Turns on the station tag display. Executes the enable function.
disable	Turns off the station tag display. Executes the disable function.
tag	Use <arg> as the station tag.

systemreset

Command	Description
systemreset	Resets the software.

time

Command	Description
time	Shows the current date and time.

timetag

Show or set the timetag configuration. Use help timetag for all arguments.

Table 5‑9. The timetag and options.

Command	Description
timetag	With no arguments, displays the current timetag settings.
enable	Enable the timetag output in each line of output .
disable	Disable the timetag output.
showms	Controls the display of timetag millisecond resolution.
enable	Enable millisecond display.
disable	Disable millisecond display.

trigger

Show or set the trigger configuration.

Table 5‑10. The trigger command and options.

Command	Description
trigger	Show or set the sampling rate.
serial	Set the sampling rate in mS.
<rate>	mS between samples.
analog	Set the sampling rate for the analog inputs in mS.
<rate>	mS between samples.
type	Set the trigger type.
internal	Set trigger type to internal.
sync	Set trigger type to sync pulse trigger.
syncpps	Set trigger type to sync to GPS PPS signal; also calibrates the real-time-clock.
source	Set sync trigger source to one of the digital inputs2 If trigger is set to internal, the source parameter returns an error..
1	Trigger source is digital input 1.
2	Trigger source is digital input 2.

version

Command	Description
version	Displays the software version number that is running on the device.

Application programming interface

The LI-570 provides a method to simplify computer command automation. The method is a variation on the command-line interface and uses the same commands as the command-line interface, but is known as an Application Programming Interface (API). The difference is that the command is enclosed in curly braces { and } without a carriage return or line feed character. The open curly brace { instructs the LI-570 that a computer command is starting, and the close curly brace } indicates the end of the command. Once the close curly brace } is received the command is executed and the results returned within curly braces. The LI-570 API protocol is not compatible with the JSON protocol.