This software is protected by United States copyright law and international
copyright treaty provisions. The installation and use of this software constitutes
an agreement to abide by the provisions of this license agreement.
Campbell Scientific grants you a non-exclusive license to use this software in
accordance with the following:
(1) The purchase of this software allows you to install and use the software on
one computer only.
(2) This software cannot be loaded on a network server for the purposes of
distribution or for access to the software by multiple operators. If the
software can be used from any computer other than the computer on which
it is installed, you must license a copy of the software for each additional
computer from which the software may be accessed.
(3) If this copy of the software is an upgrade from a previous version, you
must possess a valid license for the earlier version of software. You may
continue to use the earlier copy of software only if the upgrade copy and
earlier version are installed and used on the same computer. The earlier
version of software may not be installed and used on a separate computer
or transferred to another party.
(4) This software package is licensed as a single product. Its component parts
may not be separated for use on more than one computer.
(5) You may make one (1) backup copy of this software onto media similar to
the original distribution, to protect your investment in the software in case
of damage or loss. This backup copy can be used only to replace an
unusable copy of the original installation media.
This software may not be sold, included or redistributed in any other software,
or altered in any way without prior written permission from Campbell
Scientific. All copyright notices and labeling must be left intact.
Limited Warranty
The following warranties are in effect for ninety (90) days from the date of
shipment of the original purchase. These warranties are not extended by the
installation of upgrades or patches offered free of charge.
Campbell Scientific warrants that the installation media on which the software
is recorded and the documentation provided with it are free from physical
defects in materials and workmanship under normal use. The warranty does not
cover any installation media that has been damaged, lost, or abused. You are
urged to make a backup copy (as set forth above) to protect your investment.
Damaged or lost media is the sole responsibility of the licensee and will not be
replaced by Campbell Scientific.
Campbell Scientific warrants that the software itself will perform substantially
in accordance with the specifications set forth in the instruction manual when
properly installed and used in a manner consistent with the published
recommendations, including recommended system requirements. Campbell
Scientific does not warrant that the software will meet licensee’s requirements
for use, or that the software or documentation are error free, or that the
operation of the software will be uninterrupted.
Campbell Scientific will either replace or correct any software that does not
perform substantially according to the specifications set forth in the instruction
manual with a corrected copy of the software or corrective code. In the case of
significant error in the installation media or documentation, Campbell
Scientific will correct errors without charge by providing new media, addenda,
or substitute pages. If Campbell Scientific is unable to replace defective media
or documentation, or if it is unable to provide corrected software or corrected
documentation within a reasonable time, it will either replace the software with
a functionally similar program or refund the purchase price paid for the
software.
All warranties of merchantability and fitness for a particular purpose are
disclaimed and excluded. Campbell Scientific shall not in any case be liable for
special, incidental, consequential, indirect, or other similar damages even if
Campbell Scientific has been advised of the possibility of such damages.
Campbell Scientific is not responsible for any costs incurred as a result of lost
profits or revenue, loss of use of the software, loss of data, cost of re-creating
lost data, the cost of any substitute program, telecommunication access costs,
claims by any party other than licensee, or for other similar costs.
This warranty does not cover any software that has been altered or changed in
any way by anyone other than Campbell Scientific. Campbell Scientific is not
responsible for problems caused by computer hardware, computer operating
systems, or the use of Campbell Scientific’s software with non-Campbell
Scientific software.
Licensee’s sole and exclusive remedy is set forth in this limited warranty.
Campbell Scientific’s aggregate liability arising from or relating to this
agreement or the software or documentation (regardless of the form of action;
e.g., contract, tort, computer malpractice, fraud and/or otherwise) is limited to
the purchase price paid by the licensee.
PC400 Table of Contents
PDF viewers note: These page numbers refer to the printed version of this document. Use
the Adobe Acrobat® bookmarks tab for links to specific sections.
C.1-2. Communications Status Log Messages......................................... C-16
vi
Section 1. Introduction
PC400 is a software application used to set up, configure, and retrieve data
from Campbell Scientific dataloggers. This software application runs on
Windows XP, Windows Vista, and Windows 7 platforms.
PC400 software supports programming, communication, and data collection
for the “CRBasic dataloggers”, including the CR200/205, CR800, CR1000,
CR3000, CR5000, and CR9000. PC400 also supports the “Edlog
dataloggers”, such as the CR500, CR510, CR10, CR10X, 21X, CR23X, and
CR7 dataloggers, with mixed-array, table-data, and PakBus operating systems
where available for a particular datalogger. Communications technologies
supported include “direct connect” (or “RS-232” via local serial cable, short
haul modems, or other “transparent” links), telephone, TAPI, TCP/IP,
VHF/UHF radios, RF400-series spread spectrum radios, and multidrop
modems (MD9 and MD485).
PC400 is an ideal solution for users desiring easy-to-use reliable data
collection software over a single telecommunications medium, who do not rely
on scheduled data collection or graphical real-time displays.
1.1 PC400 Overview
1.1.1 Main Screen
The main screen for PC400 provides three tabs for communications functions
(Clock/Program, Monitor Data, and Collect Data), as well as buttons to
launch utilities for working with data files (View, Split, and CardConvert)
and for generating or editing datalogger programs (Short Cut, CRBasic, and
Edlog). There is also a button to launch the Device Configuration Utility (or
DevConfig). DevConfig is used to send new operating systems to dataloggers
and other devices, and to configure the settings in the dataloggers/devices.
These screens and utilities are also accessible from the PC400 menu, as are
other tools, such as a terminal emulator, PakBus Graph, and LogTool, a
program to view and store communication logs. Each application has its own
extensive help.
Two additional stand-alone utilities are installed with PC400 and can be
opened from the Windows Start menu, Programs | Campbell Scientific |
PC400 | Utilities. These utilities are Transformer and File Format Convert.
(CardConvert and Device Configuration Utility can also be opened from this
menu.)
Transformer is a utility to convert Edlog programs to CRBasic programs.
Conversions from CR10X to CR800 or CR1000, CR510 to CR800 or CR1000,
and CR23X to CR3000 are supported. File Format Convert is used to convert
data files from one format to another.
1-1
Section 1. Introduction
1.1.2 Clock/Program and the EZSetup Wizard
1.1.3 Monitor Data
Setting up the PC400 datalogger network is a relatively simple process with
the EZSetup Wizard, which guides you through the steps necessary to add and
enter settings for dataloggers. Once a datalogger is added to the list, you can
choose the Edit button to change those settings, again with the EZSetup
Wizard. Progress through the wizard is shown on the left side of the screen,
with steps for choosing a datalogger, defining the communications path
between the computer and the datalogger, fine tuning settings for the
datalogger (e.g., baud rate or security code), testing communications, checking
or setting the clock, and finally sending a program or associating an already
running program file.
Once you’ve added and connected to a datalogger, the Monitor Data tab
switches to a view that lets you monitor the latest values. These can either be
the input locations or variables being updated each execution of the datalogger
program or the latest data stored in the datalogger’s final storage memory.
For table-based (“TD”, “PB”, or CRBasic) dataloggers, this screen displays the
last record in final storage and updates it as new data is stored in the
datalogger. Note that this data is only for display purposes; it is not automatically stored to a file on the PC. For mixed-array dataloggers, only the
last array that was actually collected to a file is displayed and this data is not
automatically updated; you must manually initiate another collection.
The Monitor Data tab also lets you edit input locations, public variables, ports,
and flags.
1.1.4 Collect Data
Once a program is storing data in the datalogger you can collect a copy of that
data to a file on the PC. The Collect Data tab shows a list of the final storage
areas or tables in the datalogger. You can either retrieve the uncollected data,
appending it to a file on the PC, or you can retrieve all of the data from the
datalogger, overwriting the file on the PC if it already exists. (Any file in that
directory with the same name will be moved to the Windows Recycle Bin.) A
browse button lets you choose a folder and file name for the data.
1.1.5 View
View is also launched from a button on PC400’s main screen. View lets you
examine data files collected to the PC, and displays data in a tabular format by
record or array. A graph can be displayed to show an unlimited number of
traces.
1-2
1.1.6 Split
A button on PC400’s main screen launches Split, a stand-alone application
used to post process data files on the PC and generate reports. It can be used to
separate mixed-array data files into individual files based on the array ID,
merge data from multiple stations into one file, perform calculations, and
change date/time formats. Split can create reports or new files for input to
other data analysis and display applications, including html formats.
1.1.7 CardConvert
CardConvert is a utility to retrieve binary data from Compact Flash cards
containing CR1000 or CR3000 data, and convert the data to an ASCII file.
1.1.8 Short Cut
Short Cut is a datalogger program “generator.” You only need to select the
datalogger type, sensors, and desired outputs, and then Short Cut creates the
program file to send to the datalogger. Users don’t need to learn about the
individual programming instructions. Short Cut includes support for
multiplexers and a limited number of other peripherals, and it provides a
wiring diagram that you can print to leave in the field with the datalogger.
Section 1. Introduction
Short Cut can also be an excellent way to learn about new programming
languages. Users familiar with programming for Edlog dataloggers can
generate similar programs for CRBasic dataloggers to begin learning about
programming in CRBasic, as the CRBasic programs created by Short Cut can
be loaded directly into the CRBasic Editor for inspection or editing.
1.1.9 CRBasic Editor
The CRBasic Editor is also a program editor, but for the CRBasic dataloggers,
including the CR200/205, CR800, CR1000, CR3000, CR5000, and CR9000.
Instructions are included for declarations, data tables, measurements/control,
processing/math, operators, output, and program control. Extensive assistance
and program examples are provided in the Help.
1.1.10 Edlog
Edlog is a program editor, a software tool to create and modify datalogger
programs at the instruction level. Edlog supports the CR500, CR510, CR10,
CR10X, 21X, CR23X, and CR7 dataloggers, for any of their operating
systems, including mixed-array, table-data, and PakBus where available for a
particular datalogger. Instructions are included for sensor measurement,
intermediate processing, program and peripheral control, and output
processing. The built-in precompiler provides error checking and warns of
potential problems in the program. Edlog also gives access to other datalogger
settings, such as PakBus addresses, power-up settings, etc., that can be sent in
the datalogger program instead of entered via a keyboard/display.
1-3
Section 1. Introduction
1.2 What's New in Version 4?
Version 4.0 of PC400 includes a new data file viewer, View. View maintains
the ease of use of our previous data file viewer with enhanced capabilities,
including the ability to view an unlimited number of traces on a graph.
You also now have the ability to launch the Device Configuration Utility from
PC400's toolbar.
Starting in version 4.1 the CRBasic Editor has the capability to open a readonly copy of any file. This gives you the ability to open multiple copies of a
program and examine multiple areas of a very large program at the same time.
You can also now continue an instruction onto multiple lines by placing the
line continuation indicator (a single space followed by an underscore “_”) at
the end of the each line that is to be continued. Also, bookmarks in a CRBasic
program are now persistent from session to session.
The Device Configuration Utility has a new off-line mode which allows you to
look at the settings for a certain device type without actually being connected
to a device.
The ability to lock the timestamp column on the left of the data file has been
added to View. This keeps the timestamp visible as you scroll through
columns of data.
Split has a new “Time Sync to First Record” option that can be used with the
time-sync function to avoid blank lines at the start of the output file. Also, a
range of time values rather than a single time can now be entered in a Split
Copy Condition.
CardConvert can now be run from a command line without user interaction.
An option to provide feedback on PC400 has been added to the PC400
Toolbar’s Help menu.
1.3 Getting Help for PC400 Applications
Detailed descriptions of each application and tool are included in later sections
of this manual. Each application also has its own built-in help system. Context
sensitive help for an application can usually be accessed by moving the focus
to (clicking on) a particular item and pressing the F1 key or by selecting Help
from the application's menu.
If you are unable to resolve your problem after reviewing the above noted
resources, contact your Campbell Scientific Representative.
1.4 Windows Conventions
With the introduction of Windows, Microsoft has been working to establish a
standard for the operation of graphical user interfaces. There are numerous
conventions and expectations about the way a software program looks and
behaves running under Microsoft Windows. Campbell Scientific has adopted
as many of these conventions in PC400 as reasonable.
1-4
Section 1. Introduction
This manual describes a collection of screens, dialogs and functions to work
with dataloggers. As with most Windows based software there is almost
always more than one way to access the function you want. We encourage you
to look around and experiment with different options to find which methods
work best for you.
To keep this manual as concise and readable as possible, we will not always
list all of the methods for getting to every function. Typically each function
will have two methods and some will have as many as four.
The most common methods for doing things are:
Menus – Text menus are displayed at the top of most windows. Menu items
are accessed either by a left mouse click, or using a hot key combination (e.g.,
Alt+F opens the File menu). When the menu is opened, you can click on an
item to select it, or use arrow keys to highlight it and press the Enter key, or
just type the underlined letter.
By convention, menu items that bring up dialog boxes or new windows will be
followed by an ellipsis (…). Other items execute functions directly or can be
switched on or off. Some menu items show a check mark if a function is
enabled and no check mark if disabled.
Items with Program Focus – On each screen one button, text area, or other
control is selected at a time or “has the focus.” Focus is usually indicated when
the item is surrounded by a dotted line or is bolded. Pressing the tab key can
move focus from item to item. Typing changes a selected text edit box.
Pressing the space bar toggles a selected check box. A selected button can also
be activated by pressing the Enter key.
Buttons – Buttons are an obvious way to access a function. They are normally
used for the functions that need to be called frequently or are very important.
Clicking a button executes that function or brings up another window. Button
functions can also be accessed from the keyboard using the tab key to move
among items on a screen and pressing the Enter key to execute the button
function.
Right Click Menus – Some areas have pop-up menus that bring up frequently
used tasks or provide shortcuts. Just right click on an area and if a menu
appears, left click the menu item you want.
Hot Keys or Keyboard Shortcuts – Many of the menus and buttons can be
accessed using Hot Keys. An underlined letter identifies the hot key for a
button or function. To get to a menu or execute a function on a button hold
down the Alt key and type the underlined letter in the menu name or the button
text. On Windows XP, the hot key letters may not appear until after you’ve
pressed the Alt key.
Pop-Up Hints – Hints are available for many of the on-screen controls. Let
the mouse pointer hover over a control, text box or other screen feature and the
hint will appear automatically and remain visible for a few seconds. These
hints will often explain the purpose of a control or a suggested action. For text
boxes where some of the text is hidden, the full text will appear in the hint.
1-5
Section 1. Introduction
1-6
Section 2. System Requirements
2.1 Hardware and Software
PC400 is an integrated application of 32-bit programs designed to run on Intelbased computers running Microsoft Windows operating systems.
Recommended platforms for running PC400 include Windows XP, Windows
Vista, or Windows 7 because they offer the most stable operating
environments.
PC400 also requires that TCP/IP service be installed on the PC.
2-1
Section 2. System Requirements
2-2
Section 3. Installation, Operation and
Backup Procedures
3.1 CD-ROM Installation
The following instructions assume that drive D: is a CD-ROM drive on the
computer from which the software is being installed. If the drive letter is
different, substitute the appropriate drive letter.
1. Put the installation CD in the CD-ROM drive. The install application
should come up automatically. Skip to step 3.
2. If the install does not start, then from the Windows system menu, select
Start | Run. Type “d:\setup.exe” in the Open field or use the Browse
button to access the CD-ROM drive and select the setup executable. This
activates the PC400 Installation Utility.
3. Follow the prompts on the screen to complete the installation. The
installation will require a CD key. You will find this code printed on the
back of the jewel case for the original installation CD.
A shortcut to launch PC400 is added to your computer’s Start menu under
Programs | Campbell Scientific | PC400. If the default directories are used,
PC400 executable files and help files are placed in the C:\Program
Files\CampbellSci\PC400 directory.
Working directories will also be created under C:\Campbellsci for PC400’s
configurations and data files, user programs, and settings for the accessory
applications and utilities.
3.2 PC400 Operations and Backup Procedures
This section describes some of the concepts and procedures recommended for
routine operation and security of the PC400 software. If software and
computer systems were perfect, this section would not be necessary. However,
since this software is required to run with predictable results in the real world
on real computers, the following guidelines and procedures will be helpful in
minimizing possible problems that may occur.
3.2.1 PC400 Directory Structure and File Descriptions
3.2.1.1 Program Directory
As described in the installation procedures, all of the files for program
execution are stored in the C:\Program Files\Campbellsci\PC400 directory.
This includes the executables, DLLs, and most of the application help files.
This directory does not need to be included in back up efforts. PC400 and its
applications rely on registry entries to run correctly; therefore, any restoration
3-1
Section 3. Installation, Operation and Backup Procedures
of the program should be done by reinstalling the software from the original
CD.
3.2.1.2 Working Directories
In this version of PC400, each major application keeps its own working
directory. The working directory holds the user files created by the
application, as well as configuration and initialization (*.INI) files.
This scheme was implemented because we use the underlying tools and many
of the applications (the server itself, library files, datalogger program editors,
etc.) in a number of different products. By providing a common working
directory for each major application, we hope to make it easier to keep track of
files and information as you move from one product to another.
The following figure shows the typical working directories for PC400 if the
default options were selected during installation.
CRBasicEditor
Default directory for user’s CRBasic datalogger programs.
DevConfig
Default directory for Device Configuration Utility saved settings files.
EdlogW
Default directory for user’s Edlog datalogger programs .
Lib
Libraries of pre-compilers, templates and help files used by CRBasic
Editor, including the CR200/205 pre-compilers used by PC400’s
communications engine, and libraries of settings supported by devices
configured by the DevConfig application.
PC400
Default directory for data files.
PC400\SYS
PC400 working directory
communications server and should not be disturbed by the user
except when backing up the system. Tampering with these directories
or files can cause unpleasant consequences.
SCWin
Default directory for user’s datalogger programs created in the Short
Cut program generator.
– these files are controlled by the
3-2
SplitW
Default directory for user’s Split parameter files and resulting reports
and output files.
View
Default directory for View’s window settings.
Section 3. Installation, Operation and Backup Procedures
3.2.2 Backing up the Network Map and Data Files
As with any computer system that contains important information, the data
stored in the PC400 working directory should be backed up to a secure archive
on a regular basis. This is a prudent measure in case the hard disk crashes or
the computer suffers some other hardware failure that prevents access to the
stored data on the disk.
The maximum interval for backing up data files depends primarily on the
amount of data maintained in the datalogger memory. The datalogger’s final
storage is configured as ring memory that will overwrite itself once the storage
area or table is full. If the data is backed up more often than the oldest records
in the datalogger are overwritten, a complete data record can still be
maintained by restoring the data from the backup and then re-collecting the
newest records from the datalogger.
3.2.2.1 Performing a Backup
PC400 provides a simple way to back up the network map, the PC400 data
cache, and the initialization files for each of the applications. The network map
will restore all settings and data collection pointers for the dataloggers and
other devices in the network. The data cache is the binary database which
contains the collected data from the datalogger. Initialization files store settings
such as window size and position, configuration of the data display, etc.
From PC400’s menu, choose Network | Backup/Restore Network, and then
press Backup.
The backup file is named PC400.bkp and is stored in the
C:\CampbellSci\PC400 directory (if you installed PC400 using the default
directory structure). You can, however, provide a different file name if
desired.
3.2.2.2 Restoring the Network from a Backup File
To restore a network from a backup file, choose Network | Backup/Restore
Network. Select the *.bkp file that contains the network configuration you
want to restore, and press Restore. Note that this process DOES NOT append
to the existing network — the existing network will be overwritten when the
restore is performed.
3.2.3 Loss of Computer Power
The PC400 communications server writes to several files in the \SYS directory
during normal operations. The most critical files are the data cache table files
and the network configuration files. The data cache files contain all of the data
that has been collected from the dataloggers by the PC400 server. These files
are kept open (or active) as long as data is being stored to the file.
The configuration files contain information about each device in the datalogger
network, including collection schedules, device settings, and other parameters.
These files are written to frequently to make sure that they reflect the current
state and configuration of each device. The configuration files are only opened
as needed.
3-3
Section 3. Installation, Operation and Backup Procedures
If computer system power is lost while the PC400 server is writing data to the
active files, the files can become corrupted, making the files inaccessible to the
server.
While loss of power won’t always cause a file problem, having files backed up
as described above will allow you to recover if a problem occurs. If a file does
get corrupted, all of the server’s working files need to be restored from backup
to maintain the synchronization in the server state.
3.2.4 Program Crashes
If the communication server crashes, there is a possibility that files can be
corrupted (note, however, that corruption is much less likely with a program
crash than during a power loss, since the computer operating system remains in
control and can close the files left open by the failed program). If, after a
program crash, the server does not run properly, you may need to restore the
data from backup.
If you have problems restarting the PC400 server after a program crash or it
crashes as soon as it starts, make sure that the PC400 server has not left a
process running. You can check this by going to the Windows Task Manager
and selecting the Process tab. In the list of processes, look for the Toolbar or
one of the client applications. If one of these processes exists but the Toolbar
is not running, select this process and click “End Process”; you will be asked
to confirm the end process.
3-4
Section 4. The PC400 Main Screen
This section provides an overview of PC400, a detailed description of the communications
tabs and pull-down menus of the PC400 Main Screen, and an overview of PC400’s
troubleshooting tools.
4.1 Overview
To start PC400 go to the start menu of the computer and select the PC400 icon
under Start | Programs | Campbell Scientific | PC400. You can alternatively use
the shortcut on the desktop if you elected to create one during the installation
process.
PC400 offers an integrated main screen, with three tabs for basic
communications functions (Clock/Program, Monitor Data, and Collect Data),
and buttons from which to launch stand alone applications to work with data
files or create datalogger programs.
Setting up and configuring PC400 to communicate with dataloggers is done
with the EZSetup Wizard. This wizard appears automatically the first time you
run PC400. To add additional dataloggers, click the Add button on the main
toolbar to bring up the EZSetup Wizard again. Editing existing datalogger and
communications settings is also done through this wizard, via the Edit button.
4-1
Section 4. The PC400 Main Screen
PC400 supports the CRBasic series of dataloggers, including the CR200/205,
CR800, CR1000, CR3000, CR5000, and CR9000. PC400 also supports the
Edlog dataloggers (CR500, CR510, CR10, CR10X, 21X, CR23X, and CR7
dataloggers) using any of their mixed-array, table-data, or PakBus operating
systems.
PC400 supports one medium of communications for any given datalogger.
These media include “direct connect” via serial communications (or “RS-232”)
via local serial cable, short haul modems, or other “transparent” links,
telephone, TAPI, TCP/IP, VHF/UHF radios, RF400-series spread spectrum
radios, and multidrop modems (MD9 and MD485).
PC400 does not support parallel port communications, RF95T modems, or
multiple media (such as phone-to-RF). PC400 is designed to use PakBus
dataloggers and other PakBus devices in their default configurations; they are
not supported as routers.
In order to be easy to use, PC400 relies on user-attended communications. It
does not provide for automated scheduled data collection or automated clock
checks. It also doesn’t support remote connections from other PCs.
In addition to the communications functions, PC400 provides Split, View, and
CardConvert for working with data files, Short Cut for generating programs,
and Edlog and CRBasic Editor for more advanced datalogger program editing.
These tools are accessed via the buttons on the main screen or the pull-down
menu selections under the Tools menu item.
Help for each application is available from the Help menu item, or by moving
the focus to a control (by clicking on or tabbing to a control) and pressing F1.
To exit PC400, either click the [X] in the upper right hand corner of the main
screen, or select Exit under the File menu.
4.2 Clock/Program Tab and EZSetup Wizard
4.2.1 EZSetup Wizard
Dataloggers are added to the network with the EZSetup Wizard. This wizard is
also used to edit the settings for a datalogger after it’s been added. The
EZSetup Wizard is automatically displayed when PC400 is run for the first
time. It can also be opened by clicking the Add or Edit buttons.
4-2
Section 4. The PC400 Toolbar
The EZSetup Wizard starts as shown below.
Previous and Next buttons are provided to move through the wizard. Progress
is shown by the blue arrow next to each step displayed at the left. Help is
available from the Help button as well as the text displayed on the right side of
the screen itself.
In Communication Setup you select the datalogger type and give it a name that
will also become the default file name for data files collected from that
datalogger. The next step allows you to choose from the possible
communications media supported for that datalogger. PC400 will display the
serial ports (COM ports) known to your Windows operating system. PC400
fills in as many communications settings as possible and in many cases you can
use the default settings. It provides fields for user-entered communications
settings such as phone numbers and RF radio addresses. Help for entering
these settings is provided on the right side of each screen, by clicking the F1
key, or by pressing the Help button for each Wizard screen. You may also
want to consult the manual for that particular communications hardware.
Datalogger Settings are provided for fine tuning the connection to the
datalogger. The baud rate offered is typically the maximum baud rate
supported by that datalogger and communications medium; lower rates may be
required for cell phones or noisy telephone links. Enter a Security Code only if
the datalogger is configured – via the keyboard/display or settings in the
datalogger program – to use it.
Setup Summary provides a list of the settings entered. You can use the
Previous button to change these settings if necessary.
The Communications Test step allows you to test the communications link
before going any further. If the datalogger is not installed, you can skip this
and the next two steps.
If communication succeeds, you can move to the Datalogger Clock step where
you can check or set the datalogger’s clock to match the PC’s system time. If
the datalogger is in a different time zone, you can enter an offset in hour units.
4-3
Section 4. The PC400 Main Screen
The Send Program step allows you to send a program to the datalogger. This
may be a program you created with Short Cut, Edlog or the CRBasic Editor or
a program supplied by someone else. If it is a mixed-array datalogger, and the
datalogger is already running a program when you first connect to it, you
should associate the .DLD file so that PC400 will use the labels for input
locations and final storage. Dataloggers with table-based operating systems
(TD, PakBus, and CRx000) will know their program if one is running and will
provide table definitions that contain the labels. If you don’t have a program
for the datalogger you can skip this step and send a program later from the
Clock/Program tab.
If you connected to the datalogger during the EZSetup Wizard, when you leave
the wizard it will ask if you wish to stay connected.
4.2.2 Clock/Program Tab
Once you’ve added a datalogger, you may use other buttons on the
Clock/Program tab to delete it, edit its settings, or add another datalogger.
You must start with the Clock/Program tab to access either of the other two
communication functions tabs. While connected on the Clock/Program tab,
you may also change the datalogger clock or send or associate a new program.
Note that the default Max Time On-Line setting for most communications
links is zero (“0 d 00 h 00 m”), which means that PC400 will never hang up
until you click Disconnect. For telephone links, the default Max Time On-Line
setting is ten minutes in order to reduce the possibility of inadvertent and
expensive long distance or cellular telephone charges. There are, however,
other links that can result in expensive connection charges, such as digital
cellular links using TCP/IP that charge by the byte. Leaving the datalogger
connected also uses battery power, so if the datalogger power supply is not
recharged from a reliable source, it may discharge its battery below safe levels.
Be sure, therefore, that you do not leave the datalogger connected beyond the
time necessary to do the tasks you need to do.
4.3 Monitor Data Tab
Once you’ve added and connected to a datalogger, you can monitor the values
stored in the datalogger. If a program was sent to or associated with a
datalogger, or if table definitions were obtained from a table-based datalogger,
PC400 will, by default, show the input locations or public variables that have
labels associated with them. An example of such a display from a CR1000 is
below.
4-4
Section 4. The PC400 Toolbar
PC400 can also display final storage values. For mixed-array operating
systems in the CR10X family of dataloggers, these values will be displayed
only if the final storage data was collected from the datalogger, and only the
most recent values actually collected will be displayed. An example from a
CR10X-based weather station is below.
Note that, even though mixed-array dataloggers do not store record numbers
internally, PC400 assigns one and displays it with a date/time stamp. PC400
computes these values from the labels and settings it finds in the .DLD
program file for that array ID.
4-5
Section 4. The PC400 Main Screen
In the case of table-based dataloggers, PC400 will display the last record from
a final storage table and will automatically update these records as they are
stored in the datalogger’s memory. Note that PC400 does not automatically
collect this data to the data file. If you want a permanent record of the data,
you must collect it manually from the Collect Data tab.
There are also settings on the Monitor Data tab to change the number of
decimal places displayed, and the interval at which the data is updated.
You may find that your labels or the number of digits displayed are too long to
fit in the space provided. Using the mouse, you may put your cursor over the
border between the columns for the labels and values and drag it left or right to
make it easier to read. The column width is not preserved when PC400 is
closed and restarted. The table name, variable name (or input location name),
and data value also will be displayed momentarily as a popup hint if you hover
your cursor over a value for a few seconds.
In some cases, you may wish to edit input locations or public variables, for
example to change sensor offsets or control datalogger program execution. To
change input location or public variable values, double click on the number
itself until it turns yellow, then use the PC keyboard to enter a new value.
Alternately, you can right-click the value, select View Value, and edit the
value in the resulting dialog box.
When the Port/Flag button is selected, a window appears displaying the ports
and flags in the datalogger.
The state of a port or flag can be changed by clicking the LED icon to the left
of the field label. A black LED indicates that the port or flag is low; green
indicates that it is high. Custom labels can be assigned to the ports and flags
by placing the cursor within the label field and typing in a new label.
4-6
Section 4. The PC400 Toolbar
Program variables that are declared as Boolean can also be placed on this
display, for dataloggers that support data types. For these dataloggers, an Add
button is available that, when pressed, lists all of the tables in the datalogger.
When a table is highlighted on the left side of the window, any variables that
are declared as Boolean in the program will be displayed on the right side of
the window.
To return the Ports and Flags display to its original state, press the Defaults
button. This will reset all labels to their original names, update the number of
flags based on the currently running program (for CRX000 dataloggers), and
remove any Boolean values placed on the screen (for CRX000 dataloggers that
support data types).
Different datalogger models have a different number of ports and flags. The
Ports and Flags dialog box will display only those ports and flags available for
the datalogger type. Behaviors for each datalogger type are shown below.
•Mixed array dataloggers have a fixed number of ports and user flags that
are available. The ports and flags dialog box will display only those ports
and flags supported by the datalogger; no additional values can be added.
The Defaults button will reset any user-defined labels that have been typed
in.
•CR1000, CR3000, CR800, CR5000, and CR9000X dataloggers do not
have predefined flags. The first time a program is sent to the datalogger,
PC400 will look for a Public array with the name of Flag in the program.
If a Flag array is found, the declared flags will be added to the Ports and
Flags dialog box. The number of flags that will be added is limited by the
number of cells available on the Ports and Flags display. CR800,
CR1000, and CR3000 dataloggers have ports that can be toggled from this
display; they will be displayed in the first column and the remaining cells
will be available to display flags and other Boolean values in the program.
The CR5000’s and CR9000X’s ports cannot be controlled from this
display, so all cells will be available for Flags and Boolean values. For
these five dataloggers, pressing Defaults will reset all labels to their
original names, update the number of flags based on the currently running
program, and remove any Boolean values placed on the screen.
•CR9000 and CR200 dataloggers do not have ports that can be toggled
from this display. They also do not support the declaration of variables as
Boolean. They also do not have any predefined flags. The Ports and
Flags dialog will display one to three columns, depending upon the
number of flags defined in a Public array with the name of Flag in the
program. Pressing Defaults will reset all labels to their original names and
update the number of flags based on the currently running program.
4-7
Section 4. The PC400 Main Screen
NOTE
NOTE
Note that a control port must first be configured for output in the
datalogger program before it can be toggled on or off.
Consequently, if you select a port and it doesn't appear to
change, your program may not have the port configured for
output (refer to your datalogger operator's manual).The CR500
and CR510 have two control ports, but only one of the ports,
control port 1, can be configured for output. Therefore, control
port 2 cannot be toggled on or off. It is included on the display
so that you can monitor its status.
A Boolean variable is a variable that can have one of two states:
high/low, off/on, -1/0, true/false. Variables for CRBasic
dataloggers can be declared as Boolean with the Public or Dim
statement.
4.4 Collect Data Tab
If you have connected to a datalogger, PC400 enables the Collect Data tab to
provide for manual data collection. PC400 shows the possible final storage
areas for mixed-array dataloggers, and the tables stored in table-based
dataloggers.
Example of Collect Data tab for a mixed-array CR10X:
4-8
Section 4. The PC400 Toolbar
Example of a Collect Data tab for a table-based CR1000:
In either case, once a final storage area or table is selected you may either
collect the new data since the last time you collected it with PC400, in which
case PC400 appends the new data to the file if it exists, or you may collect all
of the data from that final storage area or table, in which case any file with the
same name is replaced. (The previous file is moved to the Windows’ Recycle
Bin, in case you select this option by mistake.)
4.5 Pull-down Menus
Access to almost all of the buttons and tabs on PC400’s screens is also
available via pull-down menus. Many of these are described in detail in other
sections.
4.5.1 View Menu
PC400 can display the user interface component text (for buttons, dialog
boxes, etc.) in an alternate language if a separate language package has been
installed. If a language package is installed on your machine, the View menu
will have a Languages entry and you will see the language in the subsequent
pick list. When a new language is chosen, the main PC400 user interface will
immediately reflect the change. Opened auxiliary applications will not reflect
the change until they are closed and reopened.
The main PC400 user interface and most auxiliary applications are capable of
displaying text for alternate languages. However, Split and Edlog do not have
alternate language support at this time.
4-9
Section 4. The PC400 Main Screen
NOTE
Available language packages are provided by Campbell
Scientific's international representatives or on the CSI website.
They are not included in a standard PC400 installation.
4.5.2 Datalogger Menu
4.5.2.1 Connect/Disconnect
This option provides the same function as the Connect/Disconnect button on
the main toolbar.
4.5.2.2 Update Table Definitions
When a table-based datalogger is first set up or when a new program is sent,
PC400 queries the datalogger for its table definitions. This information is used
when displaying data in the Monitor Data tab and when collecting data.
If a new program is sent by another user or by using some other program,
PC400 will not be aware of the changes in the datalogger's table definitions.
To update the table definitions for a datalogger, connect to that datalogger and
select Update Table Definitions from the Datalogger menu.
4.5.2.3 Station Status
Information about the datalogger program, the execution of the program,
battery voltage, internal temperature, etc. can be viewed from the Datalogger |
Station Status menu item.
4-10
The Station Status window is shown below:
Section 4. The PC400 Toolbar
NOTE
The window has three tabs. The Summary tab provides an overview of
important status information in the datalogger, including the information about
the datalogger model and its firmware, program details, program errors, battery
voltage levels, and card memory (if one is present).
Only the Summary tab is available for array-based dataloggers.
The Table Fill Times tab lists the tables in the datalogger, along with the
maximum number of records the table can hold, the estimated amount of time
that it will take the table to fill, and the estimated date and time that the table
will fill based on the time the datalogger program was downloaded and the
table size. A data table can be reset from this window by pressing the Reset
Tables button.
4-11
Section 4. The PC400 Main Screen
NOTES
No Table Fill Time Statistics will be shown for a CR200-series
datalogger, because they cannot be calculated for this datalogger.
For the CR10XTD, CR10XPB, CR510TD, CR510PB,
CR23XTD, and CR23XPB, the Time of Fill will not be shown
and you will not have the option to Reset Tables.
Resetting a table will erase the data in the datalogger and in the
data cache.
The Status Table tab lists all of the status table fields in the datalogger along
with their values. By default, all of the fields in the status table are displayed.
To select only certain status data to be viewed, press the Select Fields button.
This will display a list of the status data available in the datalogger. Select one
or more of the fields and then press OK. The current values will be displayed
in the table. If you select a cell within the status table and right click, a short
cut menu will be displayed. From this menu you can select fields or
view/modify a value (if it is a writable value).
Press Refresh to prompt PC400 to query the datalogger and update the values
again, Print to print the information being displayed, or Save to save the
information being displayed to a file. (Note that the Print and Save buttons are
not enabled for the Table Fill Times tab.)
Refer to individual datalogger manuals for a list of fields included in the status
table for each datalogger and a description of each.
By default, certain values in the Status Table are checked each time a program
is sent. If a problem is found during the status check, the Status Table will
pop-up along with a warning indicating the problem that has been identified.
Through the Tools | Options menu item, automatic status checks can also be
generated each time a connection to the datalogger is made and/or on a
specified interval. From this menu, the automatic status checks can also be
turned off completely.
4.5.2.4 File Control for CR5000, CR800, CR1000, CR3000, and CR9000
Dataloggers
CR5000, CR800, CR1000, CR3000, and CR9000 dataloggers have a built in
file system much like a computer hard disk. Multiple files can be stored in the
datalogger's memory or on a PC card, including data files and datalogger
programs. Note that unlike other dataloggers, these dataloggers retain in
memory programs that have been downloaded to them unless the programs are
specifically deleted or the datalogger memory is completely reset.
File Control is used to manage all the files on these dataloggers. File Control
is opened from a button on the PC400 toolbar or from the Datalogger | File
Control menu item.
4-12
Section 4. The PC400 Toolbar
NOTE
The File Control window displays a list of files stored on the datalogger's CPU,
PC card, or USR drive. The window on the left lists all of the data storage
devices available for the selected datalogger (CPU, CRD, or USR). Selecting a
device shows a list of the files stored there.
The USR drive is a user-created drive in the CR800, CR1000,
and CR3000 dataloggers. It can be set up by assigning a value to
the datalogger's UsrDriveSize setting in the Status table. This
drive must be set to at least 8192 bytes, in 512 byte increments
(if the value entered is not a multiple of 512 bytes, the size will
be rounded up).
The Run Options for a file indicate whether it is set to Run Now, Run On
Start-up, or both (Run Always). The currently executing program is indicated
by Run Now or Run Always. The file size is displayed, as well as the last time
the file was modified and whether or not the file is Read Only (R) or
Read/Write (RW). Note that the Size, Modified date, and Attributes may not
be available for all dataloggers.
There are several options to work with the files and directories on the
datalogger.
Send is used to transfer files from the computer to the datalogger. Clicking the
Send button brings up a standard file selection dialog box. A new file can be
chosen to send to the highlighted device.
Datalogger programs, data files, and other ASCII files can be sent to the
datalogger.
4-13
Section 4. The PC400 Main Screen
Format is used to format the selected device. Just like the formatting a disk
on a computer, all of the files on the device are deleted and the device is
initialized.
Refresh will update the list of files for the selected device.
Retrieve will get the selected file from the datalogger and store it on the
computer. A Save As dialog box comes up allowing you to specify the
directory and file name for the saved file.
Run Options brings up a dialog box that is used to control what program will
be run in the datalogger. Highlight a file, and then select the Run Options
button. From the resulting dialog box, select the run options.
Run Now
The Run Now run options are different for the different datalogger
types.
CR1000/CR3000/CR800 Series Datalogger Run Now Options
4-14
When Run Now is checked, the program is compiled and run in the
datalogger. You may choose to preserve existing data tables on the
datalogger's CPU if there has been no change to the data tables
(Preserve data if no table changed) or to delete data tables on the
CPU that have the same name as tables declared in the new program
(Delete associated data tables).
Section 4. The PC400 Toolbar
CAUTION
Neither of these options affects existing data files on a card
if one is being used. If a data table exists on the card that
has the same name as one being output with the new
program, the message will be returned "Data on Card is
from a different program or corrupted". Data will not be
written to the card until the existing table is deleted. Data
tables on the card that have different names than those
declared in the new program will be maintained and will not
affect card data storage when the new program is running.
When using the Preserve data if no table changed option, existing
data and data table structures are retained unless one of the following
occurs:
• Data table name(s) change
• Data interval or offset change
• Number of fields per record change
• Number of bytes per field change
• Number of records per table (table size) change
• Field type, size, name, or position change
To summarize, any change in data table structure will delete all tables
on the datalogger's CPU, regardless of whether or not the Preserve
Data option was chosen. If the Preserve Data option was chosen but
the datalogger was unable to retain the existing data, the following
message will appear in the Compile Results: Warning: Internal Data
Storage Memory was re-initialized.
CR9000(X)/CR5000 Datalogger Run Now Options
The Run Now options and behavior for the CR9000(X) and CR5000
dataloggers are different from the CR1000, CR3000, and CR800
Series dataloggers. Below is a dialog box for a CR5000 datalogger.
4-15
Section 4. The PC400 Main Screen
When Run Now is checked, the program is compiled and run in the
datalogger. All data tables on the CPU are erased. You have the
option of whether or not to erase data files stored on a card.
NOTE
Run On Power-up
The file will be sent with the Run On Power-up attribute set. The
program will be run if the datalogger loses power and then powers
back up.
Run Always
Run Now and Run On Power-up can both be selected. This sets the
program's file attribute in the datalogger as Run Always. The
program will be compiled and run immediately and it will also be the
program that runs if the datalogger is powered down and powered
back up.
Pressing Run Options to restart a stopped program in the CR1000, CR3000,
or CR800 displays a different dialog box. From the dialog box you choose
Restart Programto begin running the selected program immediately. You can
also select an option button to determine whether or not the data tables
previously created by the program are erased or retained. Note that you cannot
change the Run on Power-up option when restarting a program.
CR1000, CR3000, and CR800 Series Dataloggers -- A program
marked as "Run on power up" can be disabled when power is
first applied to the datalogger by pressing and holding the DEL
key.
Delete - Highlight a file and press the delete button to remove the file from the
datalogger's memory.
Stop Program halts execution of the currently running datalogger program.
4-16
For all dataloggers but the CR800, CR1000, and CR3000, note that all data
tables will be deleted. For a CR800, CR1000, or CR3000 select the option to
stop the program and retain the data files, or to stop the program and erase all
data files. The option to erase or retain data files includes those in internal
datalogger memory and on a card.
If a CR800, CR1000, or CR3000 program has been stopped, use the Run
Options to restart it. Once again, you will be able to choose whether to retain
or erase the data files. You can also choose a new program file to run.
Right Click Menu Options
When a file name is selected, pressing the right mouse button displays a menu
with the Retrieve File, Delete File, Rename File, Run Options, and Stop
Program options.
4.5.2.5 Terminal Emulator
Terminal Emulator does just that – it emulates a terminal connected to a
datalogger or communications device. Terminal emulator comes up showing a
blank screen. Clicking on Select Device shows a list of devices known to
PC400.
Section 4. The PC400 Toolbar
Selecting a device and baud rate, and then clicking Open Terminal causes
PC400 to attempt to connect with that device. If the device is a datalogger,
PC400 will call the datalogger over whatever communications link has been
established and will attempt to get a prompt from that datalogger. If the device
is a root device, such as a serial or COM port, PC400 simply opens that port at
the specified baud rate.
Terminal Emulator has several uses. If you open a COM port, you can use it to
set up devices that present their own menus, such as RF400 radios or NL100s.
See the manual for that particular device for information on how to navigate
the menus and what settings to choose.
4-17
Section 4. The PC400 Main Screen
Another potential use is to communicate with smart devices attached to the
datalogger. Some dataloggers allow a “pass-through” mode whereby you can
communicate through them to an attached SDI-12 sensor to set its address or
other parameters. See the manuals for the datalogger and sensor for the
relevant commands.
Troubleshooting communications devices is another use for Terminal
Emulator. When calling for support on these devices, an applications engineer
may ask you to use this method to manually dial through phone or RF
modems, for example.
You can close a connection to start another one by clicking the Close Terminal
button. You can close the Terminal Emulator itself by clicking the [X] button
in the upper right corner of the screen.
4.5.3 Network Menu
4.5.3.1 Add/Delete/Edit/Rename Datalogger
The Add, Delete, and Edit options perform the same functions as the buttons
on the main toolbar. The Rename Datalogger can be used to change the name
of a datalogger.
4.5.3.2 Backup/Restore Network
This function can be used to save a copy of the network map to a file, and then
to restore the network if necessary. The settings for all the devices in the
network will be saved.
A default is given for the directory and file name to be used for the backup or
restore. This can be changed by typing over the default directory and/or file
name or selecting the button to the right of the field containing the file name
and browsing to the desired directory and file name.
To backup the current network map, select the file name to which the backup
will be stored, and then press the Backup button. The network map will be
saved to the chosen file, and a message will appear indicating that the network
has been backed up.
To regenerate the network map from a backup file, select the name of the
backup file to restore from the dialog box, and then press the Restore button.
Note that this backup will replace the existing network (it does not add to the
existing network).
The backup/restore option will be disabled, if you are currently connected to a
datalogger. You must disconnect from the datalogger, before performing a
backup or restoring the network.
4.5.3.3 Computer’s Global PakBus Address
All nodes and routers, including dataloggers and the computer itself, in a
PakBus network must have a PakBus address no higher than 4094. Setting up a
PakBus network that provides peer-to-peer communications between the nodes
can be a complex task, so PC400 avoids this by setting up each PakBus
4-18
datalogger within its own PakBus subnetwork. Hence, each datalogger in a
PC400 network could, in fact, use the same PakBus address. However, even
though each PakBus datalogger has its own subnetwork, these dataloggers do
keep track of the PakBus addresses of other devices that communicate with
them, including PCs. Therefore, if more than one PC is communicating with a
single PakBus datalogger, it may be helpful to assign each PC its own PakBus
address. Keep in mind that, although PakBus devices keep their own routing
tables, they will communicate with any other PakBus device that has an
address >3999. Therefore, you may want to use different PakBus addresses for
each PC communicating with your PakBus dataloggers. This menu item
provides that access.
4.5.4 Tools Menu
4.5.4.1 Stand-alone Applications
Use these menu items to launch the stand-alone tools, including Split, View,
CardConvert, Short Cut, Edlog, and CRBasic Editor. Some users prefer using
the keyboard to the mouse, and the Alt-T keystroke provides this access. These
stand-alone applications are described in more detail in their own sections of
this manual.
Section 4. The PC400 Toolbar
4.5.4.2 Options
The following two options can be set:
1) Automatically Check Datalogger Status - This option allows you to
determine when the datalogger status is automatically checked. The
options include After Connection, After Program Send, and/or On
Interval.
The status values checked include the following: PakBus Address,
WatchDog Errors, Skipped Scans, Skipped Slow Scans, Skipped Records,
Variable Out of Bounds, Program Errors, Battery Voltage, Lithium
Battery, Number of times voltage has dropped below 12V, Number of
times voltage has dropped below 5V, Stack Errors, and Calibration Errors.
Note that not all status values are applicable to all dataloggers. Only those
status values applicable to the current datalogger will be checked.
If a problem is found during a datalogger status check, the status table will
pop-up along with a warning indicating the problem that has been
identified.
2) Show Hints - The Show Hints option is used to turn on/off the tool tips
that appear when your mouse hovers over a control (button or field).
When a check mark appears beside the menu item, the tool tips will be
displayed. When the check mark does not appear beside the menu item, no
tool tips will be displayed. This menu item is a toggle; select it to change
its state.
4-19
Section 4. The PC400 Main Screen
4.5.4.3 LogTool
Sooner or later in the real world, every communications link has some
problem. Sometimes these problems resolve themselves, such as when phone
lines are busy at first, but become available as other users complete their tasks.
When resolving communications problems is not straightforward, the LogTool
can let someone analyze the details of communications activity. The LogTool
is accessed from the Tools | LogTool menu item.
On the left side of the LogTool window, is a display of all devices known to
PC400. You can choose to show all messages or filter them to show only
certain devices or dataloggers. PC400 will also store these messages to log
files on the PC’s hard drive and will eventually overwrite these files to keep
them from growing forever. You can control the number and size of each log
file type with the Options | Log File Settings menu and dialog.
PC400’s communications engine creates four different types of message logs.
Transaction messages are the highest level, and show every action undertaken
by PC400. For example, if you’re monitoring a datalogger every second,
PC400 will show clock check messages each second. Many of the messages
displayed on this log are understandable and may provide some insight to the
processes going on behind the scenes when you monitor or collect data.
The other three logs are more technical in nature, but can be very useful to
Campbell Scientific support engineers. Communications messages show when
devices are activated, the settings passed to those devices, and their responses.
This log may include “status”, “warning”, and “fault” messages. The Object
State messages record the state of each software object behind the scenes in
PC400. The most detailed log is the low level log. A separate log is stored for
each root level device (each COM port, IP port or TAPI port). These logs
record every byte sent or received through that port. Interpreting all of these
logs requires knowledge of both Campbell Scientific protocols as well as other,
lower level protocols, and requires detailed knowledge of what is supposed to
4-20
be happening. Most users will only need to access these logs when requested to
do so by Campbell Scientific support personnel.
For more information on these logs see Appendix C.
4.5.4.4 PakBus Graph
PakBus Graph is a utility that graphically depicts the connections in a PakBus
datalogger network. It provides a look at PC400's PakBus routing table. In
addition, the utility can be used to change the settings of a PakBus device.
The window for PakBus graph is divided into three sections: the list of PakBus
devices, a graphical depiction of the PakBus network, and the log messages for
PakBus communication. The list of devices and the log can be toggled off by
clearing the Show List View and Show Log options, respectively.
Software servers are identified in PakBus Graph by the color green. Other
devices remain colorless unless they have been selected with the mouse cursor.
When selected, they are colored cyan.
The default PakBus address for PC400 is 4093. Other PakBus devices will be
shown by name and address, if known.
Section 4. The PC400 Toolbar
4.5.4.4.1 Selecting the PakBus Network to View
When PakBus Graph is opened, it is set to view the first PakBus network on
the computer on which the datalogger support software is running. If more
than one PakBus network is set up on the computer, the different networks can
4-21
Section 4. The PC400 Main Screen
be viewed individually by selecting a port name from the PakBus Network
drop-down list. If the PakBus ports set up in the software have been bridged,
the resulting single port will be named "__global__".
PakBus Graph also can be opened independently from the software toolbar, by
double-clicking the PakBusGraph.exe in the PakBusGraph directory (e.g.,
C:\Program Files\CampbellSci\PakBusGraph). If opened independently, the
host computer to which PakBus graph should connect can be selected from
File | Select Server on the PakBus Graph menu.
The Select Server option has the following settings:
Server Address - The name of the computer with which to connect. This
must be the valid name of an existing computer or a TCP/IP address (in the
form ###.###.###.### consisting of the IP network number, ###.###.###, and
the host number, ###).
User Name - Your user name on the software server.
Password - Your password for the software server.
The User Name and Password fields are required only if your server
administrator has set up security on your system.
4.5.4.4.2 Dynamic and Static Links
There are two types of links to PakBus dataloggers that the server recognizes:
static links and dynamic links. Static links (depicted using red lines) are the
communication links to dataloggers that have been set up in the software, but
which have not been confirmed by communicating with the datalogger(s).
You will see these dataloggers listed in the software's network map. Dynamic
links (black lines) are communication links to dataloggers that have been
confirmed. You may also see links to leaf node dataloggers that have not been
set up in the software, but which the server has "learned about" by querying
the PakBus network.
4.5.4.4.3 Viewing/Changing Settings in a PakBus Datalogger
If you right-click a device in PakBus graph, you will be presented with a
floating menu. From this menu, select Edit Settings to display a list of the
PakBus settings for the datalogger. Some of these settings are read-only, but
other settings can be changed. Click within the cell for a setting, enter a new
value, and then press return to make a change. If the change is accepted, the
cell will appear green. If the change was denied (which likely means the
setting is read-only), the cell will appear red.
4.5.4.4.4 Right-Click Functionality
There are several options available from the floating menu that is displayed
when you right-click a device (not all devices will have all settings):
Edit Settings - This option shows the PakBus settings of a device (see above).
4-22
Section 4. The PC400 Toolbar
Ping Node - This option will send a packet to the selected device to determine
if it is reachable in the PakBus network. The results of the ping will be
displayed in the Log Messages. Each ping message will include the size of the
packet sent, and the time of response from the pinged device. The last
message recorded will include summary information from the ping.
Verify Routing Table – This option will request the routing table from a
PakBus device.
Reset Node - This option will reset the routing table in a PakBus device.
Change PakBus Address (server only) - By default, the PakBus address of
the software server is 4093 (PC400) or 4094 (LoggerNet). This option lets you
change this default.
Search for Neighbors (server only) - When this option is selected, the
software server will broadcast a Hello Request every 5 seconds to search for
PakBus neighbors with which it can communicate. During this time, the
PakBus port is kept on-line.
Broadcast Reset (server only) - This option will reset the routing table in the
selected PakBus device, as well as any neighbors of the selected device that are
acting as routers.
Unlock Position – This option will unlock a device that has been locked into
position in PakBus Graph by dragging it to a new position on the screen. All
devices can be unlocked by selecting View | Unlock All Positions from the
menu.
4.5.4.4.5 Discovering Probable Routes between Devices
You can view the probable route that communication will take between two
PakBus devices by sequentially clicking on the two devices in Pakbus Graph.
The probable communication route will be highlighted in cyan. If the Show
Hop Metrics check box is selected, the graph will include the time, in
milliseconds, that communication takes between the two devices. The results
are also displayed in the Log Messages portion of the window.
4-23
Section 4. The PC400 Main Screen
4-24
Section 5. Split
Split is a tool that works with output data files (*.dat) collected from Campbell Scientific
dataloggers. It is used to post-process data from either mixed-array or table-based
dataloggers.
Split can create reports based on collected data by filtering data based on time or
conditions. It can generate statistics, perform calculations, reformat files, check for data
quality (limit testing), and generate tables with report and column headings. It can also
handle the time synchronization necessary to merge up to eight data files.
5.1 Functional Overview
Split is a tool to analyze data collected from Campbell Scientific dataloggers.
Its name comes from its function of splitting out specific data from a larger
data file. Originally, Split could only process mixed-array files, and it was
used to “split” the different arrays – typically different time intervals – of a file
into separate files (e.g., for hourly versus daily data).
In addition to splitting out mixed-array data, Split can filter output data based
on time or conditions, calculate statistics and new values, reformat files, or
check data quality (limit testing). Split can generate tables with report and
column headings, as well as time synchronize and merge up to eight data files.
Input Files (maximum of eight) are read by Split, specific operations are
performed on the data, and the results are output to a new Output File or a
printer. Split creates a parameter file (filename.PAR) that saves all of your
settings such as which data files are read, what operations are performed on the
data set, and where the final results will be saved. The parameter file may be
saved and used again.
Input Files must be formatted in Printable ASCII, Comma Separated ASCII,
Field Formatted ASCII, Final Storage (Binary) Format, Table Oriented ASCII
(TOACI1 or TOA5), Table Oriented Binary (TOB), or Raw A/D data (such as
the results of a burst measurement).
Split can be used to convert a file of one format to a different format. For
example, a Table Oriented ASCII file can be converted to the Comma
Separated ASCII format used in mixed-array datalogger data files. This is
useful to convert table-based data files to work with applications that were
written to work with mixed-array files.
Output files generated by Split can be Field Formatted (default), Comma
Separated ASCII, or Printable ASCII. Split can also create reports in ASCII as
well as html formats, or send them directly to a printer.
Split lends itself to experimentation. The processed data are displayed on the
screen, giving immediate feedback as to the effect of changes or new entries to
the parameter file. Split does not modify the original Input File.
5-1
Section 5. Split
5.2 Getting Started
The most common use of Split is to separate array data collected on a
particular interval from a data file containing data output at several different
intervals.
In the following example, hourly data are split from a data set that contains 15
minute, hourly and daily data. The data was collected from BirchCreek, a
CR10X datalogger. The CR10X was loaded with a program created by Edlog
named Birch.dld.
The 15 minute data, array 99, the hourly data, array 60, and the daily data,
array 24, are intermixed in the data file.
When Edlog compiled Birch.dld, it also created the Final Storage Label file,
Birch.fsl that lists the final storage locations for each data element.
5-2
Section 5. Split
5-3
Section 5. Split
NOTE
When you start Split a blank template similar to the one above is shown. This
template is used to enter the parameters that will define what data from the
input file to include in the output file. The parameters entered on this template
can be saved as a parameter file (*.PAR) and reused for other data.
On the INPUT FILE tab you only need to specify the input file name, copy
condition, and the data to select. Split allows start and stop conditions to be
specified but if they are left blank, the entire file will be read.
The name of the Input Data File can be typed in or the Browse button can be
used to select from available files. In this example BirchCreek.dat will be
selected as the input data file.
Selecting the data to copy is simplified by the use of the Birch.fsl file. From
the toolbar menu, click Labels | Use Data Labels. From the Data File Labels
pop-up, Select File is used to find Birch.fsl. When one of the Output Arrays is
highlighted, the Field Names of the data in that array are displayed.
In this example, a mixed array data file is processed and the Use
Data Labels feature uses an FSL file. When processing a tablebased datalogger file, change the file type to “Table-based data
file to use for labels” and select the table-based DAT file. Split
will use the header information from this file for its labels.
5-4
Section 5. Split
In this example we want the hourly data (note the Output Interval at the bottom
of the Data File Label window), so click array 60. To paste the desired values
from this array into the Select box, select the field names while holding down
the <ctrl> key. All of the values could be selected by clicking the first one and
holding the mouse button down, and dragging to the end. Once the values you
want have been selected click Paste.
5-5
Section 5. Split
Note that the cursor in the INPUT FILE(S) screen must be in valid paste area
(Copy or Select). If the cursor is in the File name box or in Start/Stop
condition, you will get the error message “Cannot Paste There”.
The Paste operation copied the numbers of each of the fields into the Select
box. Notice also that it pasted the Array ID into the copy condition: 1[60] tells
Split that in order to copy a line of data, the first value in that line must be 60.
Split uses the Array ID to discriminate between the hourly and daily data.
Now specify the Output File name. (Without one specified, Split will run and
display results but no output file will be created.) Click the OUTPUT FILE
tab. Type in “hourly” for the name of the output file. By default, Split will use
the file extension “PRN”, creating the output file: hourly.prn. Depending upon
the option chosen in the "If File Exists then" list box, an existing PRN file may
be overwritten, appended to, or saved under a new name.
The Labels option from the toolbar can also assist in labeling the output values.
Once again, choose LABELS | USE FINAL STORAGE LABELS and select
array 60 and all the field names. This time move the cursor to Line 1 of the
first column of labels on the OUTPUT FILE tab and press Paste. The labels
from the final storage file will be pasted into each of the columns. Split will
automatically break a label name into multiple rows at the "_" in a label name.
Maximum column heading width is one less than the number entered in the
Default Column Width field. However, entering a number in the Width row
for the column will set the column width for an individual column. Any FSL
labels that are too long for Split column headings will be shown in red. They
should be edited before running Split. To edit one of the labels, press the
<Enter> key or use a mouse to copy, cut, and paste. A Report Heading can
also be entered using the same editing technique.
5-6
Section 5. Split
For table based data files the timestamp is normally the first column and is a
quoted text string ("2002-02-26 10:30:00"). To display these timestamps in
the output you will need to change the column width for the first column to at
least 24. If the column width is too small to accommodate the value output,
the string will be highlighted in red and preceded by an asterisk, with the
words “Bad Data” in the lower right corner when the file is processed.
NOTE
To run Split, select RUN | GO. The hourly data will be split out and stored in
hourly.prn. The results are displayed on the screen as shown below.
When Split is running on large files, the line counters will update
only every 1000 lines.
Close the Run window. If you wish to save this parameter file for future
reports, choose FILE | SAVE. The file will be saved with a .PAR extension.
5-7
Section 5. Split
5.3 Split Parameter File Entries
5.3.1 Input Files
The name of the Input File is entered in the space to the right of the Browse
button. The default directory is the working directory for Split (if the default
installation directories were chosen, this will be c:\campbellsci\splitw). If the
input file is not in the default directory, use the Browse button to find the input
file.
In LoggerNet or PC400, mixed array datalogger files are stored in a simple
comma separated ASCII format; tabled-based datalogger files are stored in
TOA5 (a comma separated format with headers). Split can process Input files
from other software, but they must be formatted in Comma Separated ASCII,
Final Storage (Binary) Format, Field Formatted ASCII (Split default output
format), Printable ASCII, Table Oriented ASCII (TOACI1 or TOA5) or Raw
A/D data (refer to special Burst Mode instruction in your Campbell Scientific
datalogger manual).
Files stored in Table Oriented Binary (TOB) format are converted to Table
Oriented ASCII files when Split uses them. The converter runs in the
background when you run Split to create the output file. You cannot use the
Data Label browser to select the columns of data from a binary file. If you
want to use the Data Label browser you can open the file first using View,
which converts the binary file to ASCII and saves it under a new name, prior to
processing it with Split.
5-8
Section 5. Split
Split’s default output file, a field-separated ASCII format with a *.PRN file
extension, can be processed a second time if desired.
Table 5-1 provides an example of Comma Separated, Field Formatted,
Printable ASCII, and Table Oriented ASCII input file types. The data in the
various formats are identical. Each line of data represents an "Output Array",
starting with an Output Array ID (in this case 115). Each data point in the
Output Array is referred to as an "element". The element number is given in
the Printable ASCII format, and implied in the other formats. Data presented
in Table 5-1 is used for example purposes in the following sections.
TABLE 5-1. Comma Separated, Field Formatted, Printable ASCII, and
Element 1 = Output Array ID# (115)
Element 2 = Julian day (189)
Element 3 = hour, minute
Element 4 = average temperature in deg. F
Element 5 = average soil temperature in deg. F
Element 6 = average wind speed in mph
Element 7 = wind direction in degrees
Element 1 = Timestamp
Element 2 = Record Number
Element 3 = temperature in degrees F
Element 4 = minimum battery voltage
5-9
Section 5. Split
5.3.1.1 File Info
A maximum of eight input files may be processed by Split at one time.
Additional input files are added using the EDIT | ADD DATA FILE menu
option. Split looks for a file extension of .DAT if no extension is specified. If
the Input File does not exist, an error message is displayed when RUN | GO is
selected from the menu options.
For instance, to process two files named TEST.DAT and TEST_1.DAT the
user would select TEST.DAT and TEST_1.DAT as Input Files. Two blank
input file templates will be generated. To change from one template to the
other, click the appropriate tab on the bottom of the screen. Both templates
must be completed before Split will process the data. To merge different
output arrays from the same input file into one array, open the data file once
for each different array.
In most instances, Split automatically recognizes the type of data file it is
reading when using Auto Detect in the File Info field. However, there are two
exceptions for which you should choose the appropriate option manually:
• Reading Raw A/D Data from Burst Measurements
To read this type of data and convert it to ASCII, select Burst Format in
the File Info box. Once Burst Format is selected, the Number of Values
in Each Burst window in the Offset Menu will become accessible. Enter
the number of elements in each Burst. This number does not include the
array ID number or calibration data.
• Reading Data in Final Storage (Binary) Format
If the data is in binary format and Start and Stop Offsets are used, Final
Storage (Binary) Format must be selected in the File Info field. This tells
Split that the file must be decoded as Final Storage before counting the
bytes. If Offsets are not used, Auto Detect may be chosen and the file
will be processed correctly.
5.3.1.2 File Offset/Options
Start Offset
None
Select his check box to start reading the input file from the beginning.
Last Count
Each time Split runs a parameter file, it keeps track of the number of bytes
it read from the input file and saves this information in the parameter file.
Split can then start where it last left off. This is done by clicking the
Offsets button and selecting the Last Count option. This feature may be
used to process only the new data from a file in which new data are being
appended periodically to the data file.
5-10
Section 5. Split
CAUTION
When using the Last Count option, if the Start and Stop
Conditions are specified, they must exist in the newly
appended data or Split will never begin execution.
Because Last Count keeps track of the number of bytes in
the file, if you delete data from the beginning of a file, Last
Count will not work properly.
5-11
Section 5. Split
Specific
By selecting the Specific option and entering a number, Split will "seek"
that position in the file. This option saves time by starting (or stopping)
part way through a large data file. The number specifies the number of
bytes into the file to seek before processing data. A positive or negative
number can be entered. If the number is positive, Split will start reading
from the beginning of a file; if the number is negative, Split will start
reading from the end of a file. All characters, including spaces, carriage
returns, and line feeds, are counted.
In the following figure, Split will skip the first 256 bytes of data before it
begins processing the data in Input File.
5-12
Align Array
When using a specific start offset, the number of bytes specified may
cause Split to seek to the middle of a row. Selecting the Align Array
check box will cause Split to begin processing at the beginning of the next
row.
Section 5. Split
Stop Offset
This number specifies the number of bytes from the beginning of the file
that Split should stop processing the data file.
In the following figure, Split will skip the first 256 bytes of data before
beginning and stop execution on byte 1024.
Number of Values in Each Burst
When processing a burst data file, enter the total number of values recorded for
each Burst (this is the number of burst scans multiplied by the number of
channels per scan). This number does not include the array ID or calibration
data.
To break the results into a column for each channel, enter the number of
channels for the Break Arrays value (Output File Tab, Other button).
Midnight is 2400 hours
When programming mixed-array dataloggers, the Real Time instruction (P77)
has two different options for the midnight time stamp: midnight = 2400 of the
day just ending or midnight = 0000 of the day just beginning.
When processing mixed-array data files using time synchronization, select this
check box if the time stamp is midnight at 2400 of the day just ending. This
will ensure that Split processes the data file correctly.
5-13
Section 5. Split
Time Offset
This field specifies a time offset, in seconds, that should be applied to each
item on the Select line that uses the Date or Edate function to output a date.
The offset can be positive or negative. Each input file can have its own offset
(or no offset) for its Select line.
For example, with an input timestamp of “2008-10-09 10:25” and an offset of
3600, the timestamp output by Date(“yyyy-mm-dd hh:nn”;1;1;1;1) would be
“2008-10-09 11:25”.
This may be useful when adjusting for different time zones.
NOTE
The offset will not be applied to Date and Edate functions with
only two parameters. (The two-parameter mode is backwards
compatible with the original Date and Edate functions used in
older versions of Split.)
5.3.1.3 Start Condition
A starting point may be specified to begin processing data. If the Start
Condition field is left blank, Split will start processing data at the beginning of
the data file. The starting point can be any element within the array or a
combination of elements within an array.
NOTE
The font for Start Condition, Stop Condition, Copy, and Select
can be changed from the Options Menu.
The syntax can be expressed as:
where e
= the value of that element.
val
i
For example, the data in Table 5-1 contains seven elements per Output Array,
representing hourly data. Assume that this data file contains one month of
hourly data. To start processing data at 1500 hours on the first day, the Start
Condition is expressed as 3[1500], where 3 means the third element within the
array and 1500 is the value of that third element.
e
[vali]
i
= the position number of the element within the array
i
The element must match this start value exactly to trigger the start condition.
However, when starting based on time, you can enable the "Start-Stop
On/After Time" function to trigger the start of processing when the exact time
is found or at the first instance of data after that time has occurred. This option
is found on the Output tab, Other button.
5-14
Section 5. Split
NOTE
Table data files contain the time and date as a single quoted string at the
beginning of each data record. Split handles the dates as long as you
include a colon separator as a placeholder for each of the fields in the
timestamp. 1[Year]:1[Day of Year]:1[Time of Day]:1[Seconds]
See the examples below:
:1[60]:: Day of Year 60
1[2002]:1[60]:1[1250]: Year 2002, Day of Year 60, Time of Day 12:50
::1[1445]:1[30] Time of Day 14:45, Seconds 30
Logical “and” and “or” statements can be used when specifying the Start
Condition. A logical “and” statement means that all conditions must be true
for the statement to be true. Up to three conditions can be connected with
“and” statements. If too many “and” statements are used, an error message
will be displayed when you run Split.
The logical “or” statement means that if any of the conditions are true, then the
statement is true. Split allows up to six conditions to be connected with “or”
statements. Additionally, each “or” statement can contain up to three “and”
conditions. As with the “and” statements, if the maximum number of valid
statements is exceeded, an error message will be displayed.
These rules for logical statements also apply to the Stop and Copy Conditions.
An example of a simple logical “and” statement follows:
2[189]and3[1200]
Element two (the Julian day) must equal 189, and element three (the time in
hours/minutes) must equal 1200.
If the following “and” statement was used:
2[189]and3[1200]and4[92]and5[67]
an error would be returned because the maximum number of allowable “and”
statements has been exceeded.
A range can be specified for val
by putting ".." between the lower and upper
i
limit. For example:
2[189]and7[200..275]
In this example two conditions must be satisfied to start processing data. First,
the day of year must be 189, and second, element 7 must be between 200 to
275 degrees, inclusive.
5-15
Section 5. Split
5.3.1.3.1 Starting Relative to PC Time
Split has the ability to start relative to the current PC TIME (computer time).
This feature allows a .PAR file to be run on new data files without changing
the Start Conditions, provided the Input Data File is collected at a fixed
interval and Split is run at a fixed interval. For example, the same PAR file
could be run every day to display the last 48 hours of data without changing
the start conditions. For example, using a table based data file:
Start Condition = 1:1[-1]:1[1200]:1:
In this instance, Split will begin processing data when the date for both files is
one less than the current date (1:1[-1]:1[1200]:1:)and the time is 1200 (1:1[1]:1[1200]:1:).
As an expanded example, assume that LoggerNet or PC400 is used to append
data to an archive file. SplitR is executed using a desktop shortcut. In this
case the frequency of data collection and data reduction is the same. Time
values in the data file (day, hrmn, sec.) are different each time the data are
collected, but by telling Split where to Start reading relative to the PC clock,
the Start Conditions do not need to be changed. To accommodate variations in
the data collection and reduction frequencies, an interval in minutes or seconds
may be specified as shown in the examples below.
2[-0]:3[-60,5] tells Split to start at a timestamp in the data that is between 55
and 65 minutes prior to the current PC time (the closest 5 minute interval of the
current day that is less than the PC time minus 60 minutes). If you are
processing data stored at the top of the hour and the PC time is 1404, Split
calculates 1304 and looks for hour 1300 to start reading.
2[-3]:3[-120,60] tells Split to find the closest 60 minute interval that is less
than the PC time minus 3 days and 2 hours. If the PC time is the day of year
159, hour 0017, Split will start reading on data output at 2200 hours on day
155.
2[-3]:3[-120]:4[20,5] tells Split to find the closest 5 second interval that is less
than the PC time minus 3 days, 2 hours and 20 seconds. If the PC time is 27
seconds after noon on day 30, Split will begin reading on data output at 1000
hours and 05 seconds on day 27.
Split can also begin processing a file on a particular month and day. Use the
syntax :E[Month%Day]::, where E is the element that contains the Julian Day,
and Month and Day are either constants or a value related to PC time. For
example:
:2[-1%1]:: tells Split to begin processing on the first day of the previous
month.
:2[-0%15]:: tells Split to begin processing on the fifteenth day of the
current month.
:2[5%1]:: tells Split to begin processing on May 1.
This function can be used in both the Start and Stop conditions. It provides a
simple way to create a monthly report. For additional information, refer also to
Section 5.3.1.15.2 -- Using Time Synchronization While Starting Relative to
PC Time
5-16
Section 5. Split
CAUTION
NOTE
Split will not start reading if the exact specified starting
time cannot be found, unless you enable the "Start-Stop
On/After Time" feature. The interval (5 minutes, 60
minutes, and 5 seconds in the examples above) must be
evenly divisible into 60 minutes.
•If the start time is a certain number of days prior to the PC
time, the file will be processed beginning at midnight of the
day specified.
•To specify a start time in minutes from the current PC time,
you must also specify a day parameter of [-0]. Otherwise,
processing will begin at the first instance in the data file that
the minutes parameter equals the current minutes.
5.3.1.4 Stop Condition
The Stop Condition specifies when to stop processing data. This feature
allows segments of data to be removed from large data files. For instance, if a
data file contains one month of data and just one day is desired, the start and
stop values allow the user to get just that day’s data.
The Stop Condition is expressed with the same syntax as the Start Condition.
If the Stop Condition parameter is left blank, Split will execute until the end of
the file. As with the Start Condition, logical "and" and "or" statements can be
used when specifying the Stop Condition (Section 5.3.1.3), as well as stopping
based on PC time.
The array or record containing the Stop Condition is not included in the output
file. If the stop value is not found, Split will display a dialog box that gives the
option to select a new file and continue processing the data. This feature is
useful when data are contained in more than one data file.
The "Start-Stop On/After Time" function can be used with a Stop Condition.
This will stop processing of the file when the exact time is found or at the first
instance of data after that time has occurred. This option is found on the
Output tab, Other button.
The C and F commands alter the meaning of the Stop Condition.
The C option is used to combine data from two or more conditional arrays onto
one Split output line. A conditional array is one that is only output when a
defined event occurs.
Assume that two or more conditional Output Arrays with unique Output Array
IDs compose a test period, followed by an unconditional Output Array that
defines the end of a test. The unconditional "end of test" Output Array is at the
end of each test, but the conditional Output Arrays may or may not be present.
The data file is comprised of several of these tests.
5-17
Section 5. Split
As an example, let's look at a vehicle test application. The start of the test is
when the vehicle is turned on, and the end of the test is when the vehicle is
turned off. The conditional output arrays could be:
•monitoring the engine temperature and outputting data to a unique array
when the temperature exceeds a limit
• outputting data to a unique array when the brakes are applied
• outputting data when engine RPM exceeds a limit
The unconditional array data (the stop condition) would be output to a unique
array when the engine is turned off. By processing the data with Split using
the C option, the data collected during each test could be merged on to one
line, with blanks inserted if a set of data didn't exist (e.g., if the engine
temperature never exceeded the defined limit).
•An Input File must be set up for each array ID in the test. The first Input
File is configured on the Input File tab that appears when you open Split.
Additional Input Files are added by choosing Edit | Add Data File from the
Split menu. The same data file will be used as the Input File for each
array.
•Type in the array ID in the Copy field of the Input File tab for each array.
The array ID is the first element of a data file, so the line should read
1[123], where 123 is the actual array ID you want to process.
•In the Select field, type in the number for each element (data value) you
want to be output in the report.
•In the Stop Condition field, type in a "C," followed by the ID of your stop
condition array. If your "end of test" array was array ID 200, the Stop
Condition field would read: C,1[200]. This should be typed into the Stop
Condition fields of each array, including the "end of test" array.
Set up the Output File as you would for any Split process. If you are including
column headings, the arrays and elements will appear in the order they are
listed on the Input File tabs. That is, the first column will be Input File number
1, element number 1; the next column is Input File number 1, element number
2… Input File number 2, element number 1 follows in the column immediately
after the last element of Input File number 1.
This table contains four different output arrays: 100, 101, 102, and 200.
During the first test, data was output from all three conditional arrays (100,
101, and 102), with 200 signaling the end of the test. During the second test,
data was output from arrays 100 and 102. During the third test, data was
output from arrays 100 and 101.
To process these files using the C option, the parameter file would be set up as
follows (assuming the name of our data file is Data_1.DAT):
When Split is run, the resulting data file will look similar to Table 5-3. Each
line of data represents one test. Notice that blanks were inserted if the data set
(conditional array) did not exist.
5.3.1.4.2 Trigger on Stop Condition (F Option) Output of Time Series
The Trigger on Stop Condition, or F option, changes the function of the Stop
Condition when one or more Time Series functions (Section 5.3.1.11) are
contained in the Select field. When a Stop Condition is met, the time series
data is calculated and written to the output file. However, instead of stopping
at this point, processing resumes and time series data is output the next time
the Stop Condition is met. This continues until the end of file or until the user
stops Split manually.
The Trigger on Stop Condition is enabled by clicking Other… on the Output
Tab and checking the box next to the Trigger on Stop Condition field. When
the Trigger on Stop Condition is enabled, the function affects all files being
processed that have a Stop Condition specified. If multiple files are being
processed but it is desired that the function affect one or more⎯but not all⎯of
the files, the F option is used in the Stop Condition field of the files that you
want processed using the function. The syntax for the F option is: F,e
[vali].
i
A typical application for the Trigger on Stop Condition is to reduce days of
hourly data into daily summaries. A logical element to use for the Stop
Condition is time (hrmn). Assuming the third element of the hourly Output
Array is hrmn, and midnight is output as 0, the Stop Condition is entered as
3[0] (or F,3[0] if the F option is used). The Time Series processing is
performed over a day defined by midnight to midnight.
If only hourly Output Arrays were contained in the Input File, the Copy line
could be left blank. If other Output Arrays are present which need not be
included in the Time Series processing, a logical Copy condition would be the
Output Array ID of the hourly output.
The Trigger on Stop Condition functions the same for multiple Input files as it
does for a single Input File. If the option is enabled on several Input Files, and
the Stop Conditions do not occur at the same point in each file, when a file's
Stop Condition is met, its time series data are output and blanks are output for
data selected from the other Input Files.
Say, for example, that you were interested in the average value of the first data
point (element 2) for each test, in the data set listed in Table 5-2. The Input
File template would look like that shown in Table 5-4.
The Copy Condition tells Split which arrays should be used for the output data.
After the Start Condition is satisfied, and before the Stop Condition is met, the
Copy condition must be satisfied before any data will be processed according
to Select line instructions. If the Copy condition is left blank, all arrays are
processed between the Start and Stop values. Syntax for the Copy condition is
similar to the Start and Stop values mentioned above. Logical "and" and "or"
statements (see Section 5.3.1.3) can be used when specifying the Copy
condition.
For example, referring to Table 5-1, if only those hours during day 189 when
the temperature was above 90 and the soil temperature was below 62 is
desired, or, during day 189 when the average wind speed was below 21 while
the wind direction was between 255 to 265 is desired, the Copy condition
would be:
Only Output Arrays with hours 1300 and 1500, Table 5-1, conform to the
above Copy conditions.
The Copy Condition is used almost exclusively for mixed-array
dataloggers, except when time-syncing two or more data files.
See Section 5.3.1.15 Time Synchronization for additional
information.
Time Ranges
When specifying a Copy condition, a range of time values can be specified
instead of a single time. If the element being tested falls within the range, the
Copy condition is satisfied and the data is processed. A range is indicated by
entering two periods between the first and last values of the range.
Examples:
Table-based
With an entry of 1:1:1[600..1200]:1 in the Copy condition, Split will only
process the data file when the time is between 6:00 a.m. and 12:00 p.m.
(Since the timestamp for table-based dataloggers is all one string, each
portion of the timestamp (year, day, hour/minute, seconds) will use the
same element number. Colons are used to separate each portion. The
format is 1[year]:1[day]:1[hhmm]:1[seconds] (the number 1 was used
5-21
Section 5. Split
since, typically, the timestamp is the first element in the data string). In
this format, hhmm is the four-digit hour/minute.)
Array-based
With an entry of 1[30] and 2:3:4[600..1200]: in the Copy condition, Split will
only process the data file when the time is between 6:00 a.m. and 12:00 p.m.
(This assumes 2 is the year element, 3 is the day element, and 4 is the
hour/minute element.)
NOTE
5.3.1.6 Select
5.3.1.7 Ranges
Time ranges cannot be used with the time-sync function.
The Select line specifies which elements of an Output Array are selected for
processing and/or output to the specified Output File. The Select line becomes
operable only after the Start Condition and Copy condition are met, and before
the Stop Condition is satisfied. If the Select line is left blank, all elements in
output arrays meeting the Start Condition and Copy conditions are output to
the Output File.
Processing is accomplished through arithmetic operators, math functions,
spatial functions, and time series functions.
Element numbers may be entered individually (e.g., 2,3,4,5,6,7), or, in groups
(e.g., 2..7) if sequential. Range limits (lower to upper boundary conditions)
may be placed on elements or groups of elements specified in the Select or
Copy lines. For example, 3[3.7..5],4..7[5..10] implies that element 3 is
selected only if it is between 3.7 and 5, inclusive, and elements 4,5,6, and 7
must be between 5 and 10, inclusive.
If range limits are used in the Select condition, when Split is run, any data
which are outside of the specified range will be highlighted according to the
options chosen for the output file. Table 5-5 summarizes what each option
produces on the screen and in the output file if out of range data are
encountered. This type of range testing is a quick way to identify data
problems.
5-22
TABLE 5-5. Effects of Out of Range Values for Given Output Options
Section 5. Split
Output Option Screen Display* PRN File
Report = None; No
other options defined
(default)
bad values displayed in red and
preceded by asterisk; the text "bad
data" highlighted in a red box at
blanks inserted
for bad values
bottom right of screen
Report = File or Printer;
no other options defined
bad values displayed in red and
preceded by asterisk; the text "bad
blanks inserted
for bad values
data" highlighted in a red box at
bottom right of screen
Report = None;
replacement text (abc) in
"Replace bad data with"
field
Report = File or Printer;
comment in "Replace
bad data with" field
bad values displayed in red and
preceded by asterisk; the text "bad
data" highlighted in a red box at
bottom right of screen
bad values displayed in red and
preceded by asterisk; the text "bad
data" highlighted in a red box at
abc inserted in
place of bad
values
comment inserted
in place of bad
values
bottom right of screen
Report = None;
"Display only bad data"
option enabled
only lines with bad data are displayed;
bad values displayed in red and
preceded by asterisk; the text "bad
data" highlighted in a red box at
only lines with
bad data output;
blanks inserted
for bad values
bottom right of screen
RPT File or
Printer Output
N/A
bad values
preceded by
asterisk
N/A
bad values
preceded by
asterisk
N/A
Report = File or Printer;
"Display only bad data"
option enabled
only lines with bad data are displayed;
bad values displayed in red and
preceded by asterisk; the text "bad
data" highlighted in a red box at
bottom right of screen
only lines with
bad data output;
blanks inserted
for bad values
only lines with
bad data output;
bad values
preceded by
asterisk
*The Screen Display box must be checked; if not, no data will be displayed on the Split Run screen.
NOTE
In this instance, out of range data refers to data outside of the
specified output range. It is not to be confused with out of range
data generated by the logger.
5.3.1.8 Variables
Variables can be assigned names in the Select line. For example, x = 4-5∗(6∗
3.0) means that x is equal to element 6, times the number 3, times element 5,
subtracted from element 4. A numeric value is distinguished from an array
element by the inclusion of a decimal point. Variables must be declared before
they can be used in the Select line. A variable name must start with an alpha
character, can include numbers and must not exceed eight characters. Variable
names can start with the same character but they must not start with another
complete variable name (e.g., the variable XY is not valid if there is also the
5-23
Section 5. Split
variable X). A comma must follow each variable statement, as with all
parameters in the Select line. Once the variables have been declared they can
be used later in the Select line (i.e., x=4-5∗(6∗3.0), y=6/3,2,3,6,7,7∗x,6+y).
NOTE
Variables can be defined in the first four Input File’s Select
lines only, but may be used in subsequent Input File’s Select
lines.
Illegal operations (e.g., logarithm of a negative number) will cause Split to
store blanks for the Output. It is possible to get a run time error (error 0/1) if
the floating point math exceeds the limits of the PC.
5.3.1.9 Numerical Limitations
The greatest number that can be output is determined by the field width (Output
File tab). If the width is eleven or greater, the maximum number is 99,999,999;
for widths from eight through ten the maximum is 99,999; for widths less than
eight the maximum is 9999. If a column is not large enough for a value, it will
be stored as a 9,999, 99,999 or 99,999,999 based on the column width. In some
instances, such as when a column is not large enough for the date function, you
will see the text "bad data" on the Split Runtime window.
5.3.1.10 Mathematical Functions, Details, and Examples
TABLE 5-6. Split Operators and Math Functions
OPERATORS OPERATOR PRECEDENCE ORDER
(3 = high, 1 = low)
^ = raise to the power 3
x Mod y = Modulo divide of x by y 2
∗ / = multiplication, division 2
+ - = addition, subtraction 1
EXAMPLES OF SYNTAX FOR MATHEMATICAL OPERATORS
3∗5 multiply element 3 by element 5 3/5 divide element 3 by element 5
(3..5)/(8..10) same as 3/8, 4/9, 5/10
3+5 add element 3 to element 5
3-5 subtract element 5 from element 3
(3,9,5)-(8,7,10) same as 3-8, 9-7, 5-10
3∗2.0 multiply element 3 by a fixed number 2 2^3.0 raise element 2 to the third power
MATH FUNCTIONS
Abs(x) = Absolute value of x
Arctan(x) = Arc tangent of x (in degrees)
Cos(x) = Cosine of x (in degrees)
Exp(x) = Natural Exponent function (ex)
Frac(x) = Fractional portion of x
Int(x) = Integer portion of x
Ln(x) = Natural logarithm of x
Sin(x) = Sine of x (in degrees)
SpaAvg(x..y) = Spatial average of elements x through y
SpaMax(x..y) = Spatial maximum of elements x through y
SpaMin(x..y) = Spatial minimum of elements x through y
SpaSd(x..y) = Spatial standard deviation of elements x through y
Sqrt(x) = Square root of x
5-24
Section 5. Split
The following array of ASCII data will be used for all Mathematical function
examples.
0105 0176 1200 -07.89 55.10 12.45 270.5
Abs(x)returns the absolute, or positive value of element x.
Examples:
Abs(4) = 7.89
Abs(4∗5) = 434.74
Arctan(x)returns the arc tangent of element x in degrees.
Examples:
Arctan(7) = 89.788
Arctan(7/6) = 87.365
Cos(x)returns the cosine of element x in degrees.
Examples:
Cos(5) = .57215
Cos(5-6) = .73551
Exp(x)returns the exponential base e to the power of element x.
Example:
Exp(4) = .00037
Frac(x)returns the fractional value of the element x.
Examples:
Frac(4) = -.89
Frac(6+7) = .95
Int(x)returns the integer portion of the element x.
Examples:
Int(7) = 270
Int(5∗6) = 685
Ln(x)returns the natural log of element x.
Examples:
Ln(6) = 2.5217
Ln(7/6∗5/1) = 2.4337
Sin(x)returns the sine of element x in degrees.
Examples:
Sin(7) = -.99996
Sin(7-2+5) = .50603
Spatial functions, included under Mathematical functions, operate on a per
Output Array basis. The average, maximum, minimum, and standard deviation
of a specified group of elements within an array are calculated.
5-25
Section 5. Split
SpaAvg(x..y)returns the spatial average of elements x through y.
5.3.1.11 Time Series Functions, Details, and Examples
TABLE 5-7. Time Series Functions
TIME SERIES FUNCTIONS
Avg(x;n) = Average
Blanks(x;n) = Number of blanks in element
Count(x;n) = Number of data points in element
Max(x;n) = Maximum
Min(x;n) = Minimum
RunTotal(x;n) = Running total
Sd(x;n) = Standard deviation
Smpl(x;n) = Sample raw value
SmplMax(x;y;n) = Sample (y) on a maximum (x)
SmplMin(x;y;n) = Sample (y) on a minimum (x)
Total(x;n) = Totalize
WAvg(x;n) = Unit vector mean wind direction (in degrees)
NOTE: x can be an element or a valid expression. n is optional and is the number of arrays to include in the
function. Date and Edate can be used for the “n” in the Time Series functions to produce monthly output (see
Table 5-8 Special Functions).
Time Series functions are used to perform vertical processing on selected
elements, such as calculating the average of an element over a specified range
of data. Time Series results are output in three instances:
1. when a Trigger on Stop Condition (F option) is met
2. at the end of a data file (or within a range specified by Start and Stop
5-26
Conditions)
Section 5. Split
3. when an interval count is met
When the Trigger on Stop Condition (or F option) is used, any time series data
defined in the Select line is output each time the Stop Condition is met. Refer
to Section 5.3.1.4.2 for more information on the Trigger on Stop Condition.
Results which are output at the end of a file or a range of data are referred to as
Final Summaries. A typical select line that would produce a Final Summary is:
1,2,3,4,Avg(4)
This line would output values for elements 1 through 4 each time an array was
output. Additionally, an average value for element 4 would be calculated for
the entire file and output as the last line of data in the output file.
1,2,3,4,Avg(4;24)
NOTE
This line would output values for elements 1 through 4 each time an array was
output, and an average value for element 4 would be calculated every 24
th
array and output as an additional column in the file. An additional summary
would occur for an Interval Count if the count was not evenly divisible into the
number of output arrays present in the Input File. The summary, in this case,
is calculated from an incomplete interval count.
The date( ) function can be used for the interval in a time series function to
produce monthly output. Refer to the Monthly summary example in Section
5.3.1.12.
When Date and Edate are used within other functions they must
be used with the older format Date(doy;y) and Edate(doy;y)
instead of using the extended date functions. For example
AVG(1;Date(2;2002.0)). The decimal is needed to indicate a
fixed number. Numbers without the decimal are interpreted as
element IDs.
The interval count in a Time Series Function is optional and does not require a
decimal point. To determine the interval, Split counts the number of arrays
which meet the specified conditions (Stop, Start, and Copy). If the time
synchronize function is enabled, the Time Series functions remain
synchronized to the starting time even if a complete array is missing from the
input data. When elements are missing, the Time Series calculations are based
on the actual number of elements found.
Semicolons are used in Time Series functions to separate the elements or
expressions from the count which determines the interval. SmplMax and
SmplMin require two elements separated by a semicolon. The first is checked
for a maximum or minimum, while the second is sampled on the maximum or
minimum.
The following set of weather data from Mt. Logan in northern Utah gives a
total of seven elements each hour. This Field Formatted output, with title and
column headers, was generated by Split. These data are used in the following
examples of Time Series functions.
Blanks(x;n)returns the number of blanks or bad data in element x over a
Blanks(3) = 0 (no holes in data set).
Count(x;n)returns the number of data points (non blanks) in element x
Count(1) = 24 (24 data points in data set).
5-28
full data set or every nth value. Refer to Table 5-9 for
definition of blank or bad data. Example:
th
over a full data set or every n
value.
Example:
Section 5. Split
NOTE
Blanks and Count are functions designed for checking the
integrity of the data file. A common use for these two functions
is “100.*BLANKS(x;n)/BLANKS(x;n)+COUNT(x;n)” which
gives the percentage of holes (bad data) in the file.
Max(x;n)returns the maximum value of element x over a full data set
or every n
th
value.
Examples:
Max(5) = 17.12 (max WS for day)
Max(5;12) = 10.41 (max WS for 12 hours)
17.12 (max WS for 12 hours)
Min(x;n)returns the minimum value of element x over a full data set
or every n
th
value.
Examples:
Min(7) = 4.23 (min std. dev. of WS for day)
Min(3;8) = 55.33 (min temp for 8 hours)
59.79 (min temp for 8 hours)
55.22 (min temp for 8 hours)
RunTotal(x;n) returns a running total of element x for every line in the data
set. If an n
every n
th
value is specified, a running total will be output
th
value.
Example: RunTotal(5) =
5.85
14.12
21.87
29.47
39.88
48.87
:
:
:
166.76
182.38
199.50
211.36
211.36
Running total of hourly average wind speed provides up-tothe-hour wind run for that day. Because an n
th
value was not
specified, the Final Summary output, which is daily wind, is
the same as the "total" output.
Sd(x;n)returns the standard deviation of element x over a full data
set or every n
th
value.
Examples:
Sd(3) = 3.6593 (std. dev. temp for day)
Sd(3;8) = 1.011 (Sd temp for 8 hours)
1.1182 (Sd temp for 8 hours)
4.965 (Sd temp for 8 hours)
5-29
Section 5. Split
th
Smpl(x;n)returns a sample of element x every n
value.
Examples:
Smpl(4;8) = 23.98 (RH every 8 hours)
24.31 (RH every 8 hours)
37.13 (RH every 8 hours)
SmplMax(x;y;n)looks for a maximum value in element x and samples
element y when the maximum is found. If an n
th
value is
specified then it outputs the sample on a maximum every n
value, otherwise it outputs the sample on a maximum at the
end of file.
Examples:
SmplMax(5;(3)) = 55.48 (on max wind speed sample
temperature)
SmplMax(5;(3,6);8) = 56.57 307.3
60.93 317.5
55.48 338.7
(on max wind speed sample temperature and wind direction
every 8 hours)
th
SmplMin(x;y;n) looks for a minimum value in element x and samples
element y when the minimum is found. If an n
th
value is
specified then it outputs the sample on a minimum every n
value, otherwise it outputs the sample on a minimum at the
end of file. Examples:
SmplMin(3;5) = 11.86 (on min temp sample wind speed)
SmplMin(3; (5,6);8) = 8.99 317.7
5.458 312
11.86 351.6
(on min temperature sample wind speed and wind direction
every 8 hours)
th
Total(x;n)returns the total of element x over a data set or every n
value.
Examples: Total(5) = 211.36 (daily wind run)
WAvg(x;n)Returns the unit vector mean wind direction in degrees of
element x (wind direction in degrees) over a full data set or
every nth value.
Example:
WAvg(6) =
323.14 (mean wind direction for the day)
WAvg(6;4) =
333.41 (mean wind direction for 4 hours)
315.73 (mean wind direction for 4 hours)
306 (mean wind direction for 4 hours)
314.92 (mean wind direction for 4 hours)
341.03 (mean wind direction for 4 hours)
328.09 (mean wind direction for 4 hours)
th
5-30
5.3.1.12 Special Functions, Details, and Examples
TABLE 5-8. Split SPECIAL FUNCTIONS
Crlf = Insert carriage return line feed in Output File.
Date(“format”S;H;D;Y) = Convert day of year and time to a timestamp
with calendar date and time, where format uses
Windows conventions to specify output format.
S=seconds, H = HoursMinutes, D = Day, Y =
year. The output timestamp is quoted text.
Date can be used to create monthly time series
summaries.
Edate(“format”S;H;D;Y) = The same as the Date function except that the
output text is not quoted. EDate can be used to
create monthly time series summaries.
"Label"= Insert Comment in Output file. (Label is
anything within the quote marks.)
Line = Number of lines written to Output file.
smpl(.pa;n) = Page break such that n is the number of lines per
page for the printer or the .RPT file.
Section 5. Split
NOTE
PCdate or PCEdate = Used in a report header to print the current date.
WDQ(n) = Outputs the wind direction using an alphabetical
abbreviation, based on 8 quadrants .
WDQS(n)= Outputs the wind direction using an alphabetical
abbreviation, based on 16 quadrants .
The Mt. Logan data set is used for the Special Function examples. These
functions are helpful in converting time fields to formatted timestamps and
formatting the output. Since one of the main differences between mixed-array
data files and table based data files is the time format, these functions can be
used to convert between file types.
If you are processing the data file in multiple passes including
formatting of the date and time fields, you should put the date
processing in the final pass. Split cannot read all of the
timestamp formats that it can produce. For example, the quoted
timestamp in table based data files has a specific structure. Any
changes to the structure will make the timestamp unreadable for
Split.
Crlfreturns a carriage return and line feed where the Crlf is
placed in the parameter file.
Examples:
Smpl("Max Temp";24),Max(3;24),
Smpl(Crlf;24),Smpl("Max RH";24),Max(4;24)
= Max Temp 67.33
Max RH 38.8
5-31
Section 5. Split
The Crlf is placed after the maximum temperature 67.33 so
that the maximum RH is on the next line.
NOTE
A carriage return/line feed is recognized by Split as an element,
and may throw the column headers off in the output file.
"Label"returns a comment in the output file. This is a useful
formatting function when labels are desired on the same line
as the data. The label includes anything within the quote
marks, the quote marks are not output but must be in the
parameter file. The label cannot exceed the width of the
output column (default is eight characters). A maximum of
thirty (30) labels are allowed per Select line.
Make sure that the column widths are big enough for the
label to fit. Otherwise the output will indicate Bad Data.
Examples:
"Max Temp" =
Max Temp (outputs Max Temp
Max Temp 24 times)
.
.
.
Max Temp
WDQ(n)Outputs the wind direction using an alphabetical
abbreviation, based on 8 quadrants (N, S, E, W, NE, NW,
SE, SW). n is an element containing wind direction. For
example, if n = 182, S would be returned in the output file.
WDQS(n)Outputs the wind direction using an alphabetical
abbreviation, based on 16 quadrants (N, S, E, W, NE, NW,
SE, SW, NNE, ENE, ESE, SSE, SSW, WSW, WNW,
NNW). n is an element containing wind direction. For
example, if n = 111, ESE would be returned in the output
file.
Date("format"; S; H; D; Y) Converts a datalogger's time stamp to a
different format and encloses it in double-quotes (edate will
produce a date without quotes). "Format" is a string which
identifies how the date should be output. The "format"
string is similar to the date format used by Windows. See
the online help in Split to get a complete list of the format
parameters.
S is the element number that contains seconds; H is the
element number that contains hours/minutes; D is the
element number that contains day; and Y is the element
number that contains the year. A constant can be used in
place of any of the element numbers (the constant must be a
valid value for the type of date field and include a decimal
point; e.g., 2000.0 for the year). If only three elements are
5-33
Section 5. Split
specified, these will be assumed to be hour/minute, day, and
year.
When using the Date function for a table-based datalogger
(e.g., a time stamp in the format "2002-02-03 21:16:00"), if
the time stamp is the first element in the array, a 1 is used
for all of the time stamp elements (S; H; D; Y).
If "serial" is entered for the "format" string, a serial date will
be output. Other special functions are "hourarray" and
"dayofyear". Both of these are used when processing data
from table-based dataloggers so that the timestamps are
similar to that of mixed array dataloggers. Hourarray
changes a 0000 hourly timestamp to 2400, and dayofyear
produces a Julian Day.
In older versions of Split, the date( ) and edate( ) functions
were limited to converting the Julian day to a MM-DD
format, with a syntax of date(doy;y) where doy = the
element number for the day of the year; y = the element
number for the year. This older format is still supported.
NOTE
Split will mark the date as Bad Data if the time and date resulting
from the conversion will not fit in the specified column width.
The on-screen display and the report file will precede the date
with asterisks. In the .PRN output file, Split uses the Bad Data
string.
When Date and Edate are used within other functions they must
be used with the older format Date(doy;y) and Edate(doy;y)
instead of using the extended date functions as shown in the
table. For example AVG(1;Date(2;2002.0)). The decimal is
needed to indicate a fixed number. Numbers without the
decimal are interpreted as element IDs.
Date Format Examples
Assume that in a mixed array data file, element 2 is Year, element 3 is Day of
Year, element 4 is Hour/Minute, and element 5 is Seconds.
String Entered Output
date("mm/dd/yy, h:nn";5;4;3;2) "02/25/02, 4:10"
edate("mm/dd/yy, hh:nn";5;4;3;2) 02/25/02, 04:10
edate("dddd, mmmm d, yyyy";5;4;3;2) Monday, February 25, 2002
edate("'Date:' mmm d, yyyy";5;4;3;2) Date: Feb 25 02
If a time element is missing from a mixed array data file, use a valid constant
instead.
5-34
Section 5. Split
If processing a table-based data file, use a 1 for all time elements (assuming the
time stamp is the first element in the data file). For the examples above:
Notice that this last example essentially creates an array-type of timestamp.
NOTE
When processing a data file from a mixed array datalogger, if the
time stamp uses midnight as 2400 with "today's" date, the date
function will convert that time stamp to 0000 hours with
"tomorrow's" date. The “No Date Advance” function can be
used to stop the date from rolling forward (Other button, No
Date Advance check box).
The Date function can be used to produce a monthly summary of daily time
series data by using Date( ) for the interval in the time series function. This
will trigger time series output for the first day of each month. The syntax is
avg(7;date(3;2)), where you want to take a monthly average of element 7, and
the day of year is contained in element 3 and the year in element 2. If you
have data recorded on a once per minute or once per hour basis, it must first be
processed into a 24 hour summary for this function to produce the output
expected.
NOTE
When Date and Edate are used within other functions they must
be used with the older format Date(doy;y) and Edate(doy;y)
instead of using the extended date functions. For example
AVG(1;Date(3;2)). When used with table based data files the
format would be AVG(1;Date(1;1)).
above, except that the time stamp is not surrounded by
quotes.
5.3.1.13 Split Functions Example
When producing a monthly summary and outputting the month along with the
data, you might want to set up the value for the month as "month -1", to
correctly reflect the month that the data actually represents.
The following is a parameter file that operates on the Mt. Logan data with
several of the Split features being utilized. This first screen shows the input
file and the select criteria that were programmed. This example does
calculations based on temperature and wind speed to determine the wind chill.
5-35
Section 5. Split
5-36
Section 5. Split
The following screen shows the output file setup including the column
headings and the units.
This .PAR file produces a wind chill summary of the Mt. Logan Peak data set.
The formula for calculating wind chill is given as follows:
Te = 33-(h/22.066)
where
Te = Wind Chill equivalent temperature, degrees C
h = ((100V)
where
h = Kcal m
0.5
+ 10.45-V)(33-T)
-2
hr-1 wind chill index
v = wind speed in meters/second
T = temperature in degrees C
Note that at wind speeds between 0 to 4 mph (0 to 1.8 m/s), the wind chill
should be ignored because this formula results in wind chill temperatures that
are greater than the ambient temperature. The National Weather Service
includes wind chill in reports only when temperatures drop below 35°F (1.7°
1
The formula is for example purposes and is not endorsed by Campbell
C).
Scientific as a standard.
When this .PAR file is executed, the following output is displayed on the
screen.
5-37
Section 5. Split
Wind Chill Report from Mt. Logan
Temp
deg C
Wind Speed
m/s
H
Wind Chill
deg C
Wind Chill
deg F
14.756 2.6172 438.06 13.148 55.666
14.156 3.6967 489.58 10.813 51.463
13.806 3.4643 491.34 10.733 51.319
13.639 3.3972 493.4 10.64 51.151
13.65 4.6533 529.57 9.0005 48.201
12.961 4.0185 530.58 8.9547 48.118
13.306 4.2554 528.27 9.0596 48.307
14.511 2.9448 456.04 12.333 54.199
15.439 2.4397 414.97 14.194 57.55
16.161 2.066 383.21 15.633 60.14
16.3 2.6489 402.08 14.778 58.601
15.894 3.0463 425.2 13.731 56.715
16.117 3.7325 439.59 13.078 55.541
16.072 4.8812 468.26 11.779 53.202
16.833 3.7682 421.85 13.882 56.988
17.639 3.9694 405.59 14.619 58.314
18.972 3.5626 361.39 16.622 61.92
19.628 3.0208 331.76 17.965 64.337
19.217 3.1648 345.62 17.337 63.207
18.067 3.9157 393.08 15.186 59.335
15.467 5.2791 493.51 10.635 51.142
13.439 6.9821 584.71 6.5016 43.703
13.044 7.6526 607.86 5.4526 41.815
12.9 5.3014 566.29 7.3368 45.206
Reference
1
“Wind Chill Errors”, Edwin Kessler, Bulletin of the American Meteorology
Society, Vol. 74, No. 9, September 1993, pp 1743-1744.
5-38
5.3.1.14 Summary of Select Line Syntax Rules
•A fixed numeric value must include a decimal point "." or be in scientific
notation. There are some exceptions to this as noted below.
• Scientific notation has the format "mantissa E power of ten” (e.g., 3E5 = 3
• Element numbers are entered without a decimal point.
• Commas separate Select line parameters (e.g., 2,3,(3+4)/3.2,6).
• Two decimal points are used to select consecutive elements between
• A set is a group of two or more elements and/or expressions separated by
5
x 10
).
starting and ending elements (e.g., 3..6, refers to the elements 3,4,5, and
6).
commas and enclosed by parentheses. No member of a set can include
parentheses. Therefore, a set cannot include a set or a function as one of
its members. For example:
•A single expression can operate on a set of elements. For example, the
expression (3..6,8)/2.0 is the same as 3/2.0, 4/2.0, 5/2.0, 6/2.0, 8/2.0;
(3..6)/(2..5) is the same as 3/2, 4/3, 5/4, 6/5.
•The element or expression that is the argument of a math or Time Series
function, must be enclosed in parentheses. A range of elements can be
specified, resulting in as many outputs as elements (e.g., Avg(3..5,7) will
output 4 averages).
•Square brackets are used to enclose an allowable range for a value (e.g.,
3[3.6..12] ) to indicate that the allowable range for element 3 is from 3.6 to
12. Whole numbers within brackets do not require a decimal point. Table
5-5 explains how values outside the specified range are treated.
•The interval in a Time Series function is optional and does not require a
decimal point.
•Semicolons are used in Time Series functions to separate the elements or
expressions from the number that determines the interval. Sample on
maximum and sample on minimum require two elements or expressions
also separated by a semicolon.
5.3.1.15 Time Synchronization
The time synchronize function is useful when data is missing from a file or if
several files of data need to be merged together. The files are synchronized
according to time; any missing data in the file (or files) will be replaced with
blank data.
This function synchronizes according to day, hrmn (hour-minute), and/or
seconds. The syntax used to identify the time elements for array data is:
Referring to Table 5-1, to identify the day of year for a mixed-array data file,
type:
for hrmn type:
and seconds are expressed as:
A single colon is assumed to be between day and hrmn (e.g., 2[189]: means
day, :3[1200] means hours, and 2[189]:3[1200] means day and hour-minute).
When the time synchronize function is used, a time interval must be specified
in the Copy line of the first data file. For example, 4[60] in the Copy line will
create a synchronized file containing the data from the input files that occurred
every 60 minutes. If no time interval is specified in the Copy line then the time
[day]:ei[hrmn]:ei[seconds]
e
i
2[189]::
:3[1200]:
::4[5]
5-39
Section 5. Split
specified in the Start Condition becomes simply a starting time with no time
synchronization.
Typically, the starting time specified must actually be found in the input file
before the Start Condition is satisfied (e.g., if the input file starts at 1100 hrs
and 1000 hrs is entered for the starting time, with no day specified, Split will
skip over arrays until it reaches 1000 hrs the next day). However, the StartStop On/After Time function can be enabled (Output tab, Other button) to
trigger the start of processing when the exact time is found or at the first
instance of data after that time has occurred.
Table-based dataloggers
Because the time stamp for a table-based datalogger is all one string, and
therefore read by Split as one element, the syntax is somewhat different. All
elements in the time stamp are specified by a 1 (if the time stamp is the first
item in each row of data).
The 1s in the string identify the position of the time stamp in the line of data.
Each colon represents a portion of the time stamp. The format is
1[year]:1[day]:1[hour/minute]:1[seconds]. The colons in the time stamp must
be present or the function will not work correctly.
NOTE
Time synchronization can only be done for data from a single
year. It will not work over a year boundary.
Time elements can be identified without specifying a starting time (e.g., 2:3).
If you are working with only one file, Split will begin processing that file at the
first record in the file. If any gap in the data is found, blank data (or the
"Replace Bad Data With" text) and a carriage return line feed will be inserted
for each line of missing data. Note that Split will also detect a gap in data if,
for instance, you specify a start time of 2[92]:3 (start at Julian day 92) and your
hour/minute for day 92 starts at 9:30 a.m. The time between the start of the
day (0000) and 9:30 a.m. will be considered missing data. Blanks (or the
"Replace bad data with" text) and a carriage return line feed will be inserted at
the beginning of the PRN file for each "missed" output interval.
If you are working with two or more files, once Split starts processing the files
(based on the time of the first record of the first file), if no data exists for the
other file(s), blank data will be inserted.
If multiple input files are given specific starting times, Split starts the output at
the earliest specified starting time. In a PRN file, Blanks or the comment
entered in the “Replace bad data with” field are inserted for values from other
input files until their starting times are reached. In a RPT file only blanks are
used.
NOTE
When using time synchronization with a mixed array data file,
with a midnight time stamp of 2400, you will need to select the
Other button, “Midnight at 2400 hours” checkbox.
5-40
5.3.1.15.1 Time Synchronization and the Copy Condition
To use the time synchronize function, time element(s) must be specified in the
Start Condition. The user must also specify a time interval in the Copy
condition. For instance, if the original data had 15 minute outputs and you
only want hourly outputs, then an interval of 60 minutes must be specified
following the element number. This is entered as (assuming hrmn is element
number 3) “3[60]”. If time synchronization is specified in the Start Condition,
Split looks for the interval in a time element in the Copy condition. Only one
time interval is specified. This interval is the unit of time to synchronize each
file.
The interval can be given tolerance limits by following the interval with a
comma and the tolerance. For example, if 3 is the hrmn element, and the time
interval is 60 minutes +/-2 minutes, the syntax is 3[60,2].
Table based data files need to use the same time format as described in Section
5.3.1.3. You can specify the interval for time synchronization on table files as
::1[60]: which will give you an output interval of 60 minutes.
If the time synchronize function is enabled and data are missing at one or more
of the time intervals specified, then a blank (or the comment entered in the
“Replace bad data with” field) is output to the Output File. See Table 5-5.
Section 5. Split
5.3.1.15.2 Using Time Synchronization While Starting Relative to PC Time
Split tries to time-sync files to the top of the hour when starting relative to PC
time. If you are synchronizing files where the data output interval is not at the
top of the hour, you will need to specify an interval in the Copy Condition that
represents a window of time in which Split should look for the hour/minute.
For instance, if your data is output 50 minutes into a 60 minute interval (and
therefore, your time stamps are 50, 150, 250, 350...2350) your Start Condition
and Copy Conditions for the first file might look like the following:
Start Condition
2[-1]:3[50]:
Copy Condition
1[106]and3[60,10]
Where:
element 1 is the array ID
element 2 is the Julian day
element 3 is the hour/minute
The Start Condition directs Split to begin processing data when the time is one
day prior to the current PC time and when the hour/minute value is equal to 50.
The 1[106] in the Copy Condition specifies the array from which the data
should be copied. The 3[60,10] indicates that the interval for the time stamp is
60 minutes and designates a 10 minute time window on each side of the top of
the hour in which Split should look for the hour/minute data (10 minutes
before the hour, 10 minutes after the hour).
The second file's Copy Condition should include only the array from which to
copy the data. No interval is necessary.
5-41
Section 5. Split
5.3.2 Output Files
To create an Output File, click the OUTPUT FILE tab. The file is created on
the default drive or directory unless the file name is preceded with an alternative
drive or directory. Use the Browse button to change directories.
Split will assign this file an extension of .PRN if an extension is not specified by
the user. Whenever an Output file name is entered, regardless of extension, an
Output file is created only when the RUN | GO menu option is selected.
If the file name you have selected already exists, you can use the "If File Exists
Then" drop-down list box to determine what action Split will take. By default,
each time a PAR file is run the existing output files (PRN, RPT, and HTM) are
overwritten (Overwrite option). When Append is selected, the PRN file will
not be overwritten -- the new data will be added to the end of the existing file.
However, the RPT and HTM files will be overwritten. If Create New is
selected, Split will create all new files using the original file name and
appending an _0, _1, and so on to each subsequent run.
In Append mode, if an HTM or RPT file is needed with all the data, you will
need to run the PRN created by Split through the program a second time. If
the Output File name is left blank, Split does not write data to an Output File
on disk; rather, it will display the processed values on the screen if the Screen
Display box is checked. If Screen Display is not enabled, no data will be
displayed on the Split RUN screen.
CAUTION
The Output file name cannot be the same as the Input file
name. Split will display an error message if this condition
occurs.
Several output options may be specified to alter the default output to the file.
Some are located on the main OUTPUT FILE screen and some are made
available by pressing the Other button.
5-42
Section 5. Split
5.3.2.1 Description of Output Option Commands
File Format
There are five File Format options to choose from: No File, Field, Comma,
Printable, and Custom. If No File is chosen, then only the .PRN file is saved to
disk. The Field, Comma, and Printable options produce files formatted as Field
Formatted, Comma Separated, and Printable ASCII, respectively. An example of
each of these file types is given in Table 5-1 in the Input Files section.
The Custom file format uses the regional settings in the Windows operating
system to determine the decimal symbol and the separator used with data values.
In the Regional Settings for Numbers, the decimal symbol uses the character
specified in the Decimal Symbol field; the separator uses the character specified in
the List Separator field. These settings are typically found in Control Panel |
Regional Settings (or Options), Numbers tab. This allows users who are used to
the comma “,” as the decimal and the period “.” as a data separator to see the
output data in that format.
Default Column Widths
The Default Column Widths field is used to set the default width of the
columns. Valid entries are 6,7,8, and 9. The initial width is 8. High
Resolution Final Storage data requires a minimum column width of 8.
Entering a number in the Width row for each column overrides the default
settings and sets the width of individual columns. If this field is left blank, the
Default Column Widths field is used.
5-43
Section 5. Split
Screen Display
The Screen Display field controls writing the processed data to the screen. To
write to the screen, check the box. For faster execution, clear the box to omit
writing to screen. The data will then be written to the file only.
Report
A report, with page and column headings, can be sent to a file or printer.
There are three report options: File, Printer, HTML. One or more can be
selected. A report sent to a file has the extension of .RPT. If the report is sent
to a printer, the printer must be on-line. In all cases a .PRN output file is
created. A basic HTML file can be created containing the formatted report
data. The HTML file can be used as a display of the formatted data output in a
web browser.
NOTE
To remove page breaks in the HTML file, enable the “No FF”
option.
Other
The Other button provides access to the dialog box shown below.
5-44
Section 5. Split
It allows the following settings to be modified:
Replace bad data with - The text in the field, to the right of this option,
is entered into the .PRN output file data set if data are blank, bad, or out
of range. See Table 5-9 for definition of blank or bad data. Whatever
text string the user enters in the field will be entered if a blank or question
mark is in the data or if data are out of range. This option is useful when
the Output file is imported into a spreadsheet program, such as Excel.
TABLE 5-9. Definition of Blank or Bad Data for each Data File Format
File Format Definition of Blank or Bad Data
Printable ASCII ????
Comma Separated ASCII blank or any character except numeral or space
Field Formatted blank or "" (double quotation marks)
Only display lines with bad data – Outputs only those arrays containing
one or more Out of Range elements. If a report is generated, an asterisk
precedes the Out of Range value in the .RPT file.
Trigger on Stop condition – Changes the meaning of Stop Condition to
trigger Time Series processing output. The Stop Condition is included in
the Time Series processing if it satisfies the Copy line.
If the Trigger on Stop Condition is selected, a Time Series output will
occur each time the Stop Condition is met.
Start-Stop On/After Time – In most instances, Split will not start or stop
processing a file unless the exact start condition is found. However, when
starting or stopping based on time, you can enable Split's Start-Stop On/After Time option. This will trigger the start (or end) of processing
when the exact time is found or at the first instance of data after that time
has occurred (which meets other defined criteria in the PAR file).
Time Sync to First Record – This option is used with the time-sync
function. It allows you to set specific times in the Start Condition, but
have synchronization start at the first record in the file that meets the Start
Condition. This may avoid an output file that starts with blank lines.
For example, you have table-based data file(s) containing 15 minute data.
Your first data file starts on Sept 9th at 12:15 p.m. You want to time sync
the files and output only the data that occurs at midnight.
You need to specify ‘0’ for the hour/minute field in the Start Condition or
the output will contain the data that occurs each day at 12:15. Therefore,
you would use:
Start Condition = 1:1:1[0]:1
5-45
Section 5. Split
The Copy Condition determines the interval of your data. Therefore, to
output data that occurs every 24 hours, you would use:
Copy Condition = 1:1[1]:1:1
Because you have specified a time in the Start Condition, but not the day,
Split assumes the first day of the year. Therefore, by default, you will
have blank lines in your output file for each day from Jan 1
st
to Sept 9th.
Using the Time Sync to First Record option will avoid these blank lines.
Match files – This option compares two files of the same data. If good
data exists in one and not the other (question marks), then Split will fill
the OUTPUT file with the good data. This is used to get a more complete
record from an error ridden file (e.g., one recorded at freezing
temperatures by reading a tape twice and running both files through
Split).
CAUTION
For the Match files option to produce a correct Output File,
the differences between the two Input Files can only be
question marks. Both files must have the same Start
Condition or the beginning of both files must be the same.
Transpose file – Transposes the rows and columns of the input file. Only
one Input File can be transposed at a time and no Select options can be
specified. A maximum of 26 arrays are transposed per pass of Split.
To transpose a file containing more than 26 arrays, several passes are
required. Change the Output file name and Start Condition for each pass.
Split may then be used to merge the multiple files.
No FF – Suppresses form feeds and page breaks in RPT and HTML files.
When this option is selected, a header appears on the first page only. This
option is used for printing reports on continuous feed paper or for
displaying HTM files in a browser.
Break arrays - This option breaks up the Output Array into new arrays
that are #+1 elements in each new array. Split automatically assigns an
array ID number equal to the first element in the first array. Only one
Input File may be specified. Start, Stop, and Copy Conditions may be
specified, but the Select line must be left blank.
NOTE
The Break Arrays function works only for mixed array data. It is
typically used when processing data from burst measurements.
5-46
No Summary - When producing reports that include time series
processing based on an interval, sometimes that interval will not divide
evenly into the number of lines in the data file that is being processed.
For example, you may be processing one-minute data on a five-minute
interval, and the data file has 103 lines; thus, there are 3 lines of data "left
over" at the end of the report. By default, the summary (average, total,
maximum, etc., depending upon which time series function is being used)
of the left over values is printed at the bottom of the report following the
Time Series Heading. Enable the No Summary check box to omit the
Section 5. Split
summary of the left over values and the Time Series Heading from the
report.
No Date Advance - When processing a data file from a mixed array
datalogger, if the time stamp uses midnight as 2400 with "today's" date,
the date function will convert that time stamp to 0000 hours with
"tomorrow's" date. (This is because the algorithm used by the date
function is based on Windows' time format, and it does not support a
2400 time stamp.) For example:
Array ID Year Julian Day Hour/Minute Date Function Data Data
10 2002 151 2200 05/31/02 22:00 1.701 193.6
10 2002 151 2300 05/31/02 23:00 1.476 31.99
10 2002 151 2400 06/01/02 00:00 1.123 106.2
At Julian Day 151 (May 31) 2400 hours, the date function produces an
output of June 1 00:00 hours. The date can be stopped from rolling
forward by using the No Date Advance check box. The output will then
be similar to:
Array ID Year Julian Day Hour/Minute Date Function Data Data
10 2002 151 2200 05/31/02 22:00 1.701 193.6
10 2002 151 2300 05/31/02 23:00 1.476 31.99
10 2002 151 2400 05/31/02 00:00 1.123 106.2
Caution should be used when applying the date function and enabling or
disabling No Date Advance, since it is possible to produce an incorrect
date. For instance, using the above example if you were to enter the
following into your select line:
3,edate("hh:mm";4;3;2)
with the No Date Advance enabled, you would get the output:
No Dashes - When the No Dashes check box is selected, the dashed line that
typically appears under the column headings will not be displayed. This option
affects all output types (PRN, RPT, HTM, and printed page).
No Summary Heading - When processing data using time series functions
(see No Summary, above), select this option to prevent the Time Series
Heading and Column Headings from being printed at the bottom of the report.
5-47
Section 5. Split
5.3.2.2 Report Headings
The "left over" summary data will still be printed.
No Record Numbers from TOB Files - Split automatically converts TOB
(binary) files to ASCII prior to being processed. When this check box is
selected, the record numbers will not be included in the converted file. This
will affect the element numbers used for the Start, Stop, Copy, or Select fields
of the PAR (e.g., if a file has a timestamp, record number, and data value,
when this check box is selected the data value would be element 2. When the
check box is cleared, the data value would be element 3).
A report is output to a printer or file with the extension .RPT. Headings are
not included in the standard output to disk (.PRN or user named extension
output file). However, a report can be labeled with a header by entering text
into the Report Heading field. A report heading can have several lines, but it is
limited to a total of 253 characters including backslashes and carriage returns.
“\” characters break the report heading into multiple lines.
When Time Series functions are used in the Select field without an interval,
they appear as a final summary at the end of the report. They can be labeled
by entering a title into the Time Series Heading field at the bottom of the
Output File page. Time Series interval summaries cannot be assigned
individual titles directly, but you can use special functions such as "Label" and
"Crlf" to create column headings and special formatting.
5.3.2.3 Column Headings
5.4 Help Option
“PCDATE” within the Report Heading inserts the computer's current date
(Month-Day-Year). For the European format (Day-Month-Year), enter
“PCEDATE”.
Up to three lines per column can be entered as column headings. These
headings are limited to a length of one less than the Output field width.
Column headings associated with Time Series outputs are repeated for Final
Summaries if a title for the Final Summary is requested on the headings for
report line.
The number of digits to report to the right of the decimal point is entered in the
Decimal field and can be set independently for each column. The value output
will be rounded to the specified number of digits. Leave this field blank if you
do not want to round the data to a specific number of digits.
Column headings can be entered using Split’s Data Labels Function (Labels |
Use Data Labels).
On-line Help is available from any location in Split. Simply select the area of
Split in question and press <F1>. Split also offers a brief on-the-fly Help.
Place the cursor on the area of Split in question; after a moment a brief
description is displayed in the hint line of the Split window (bottom left).
5-48
5.5 Editing Commands
Split supports the Windows Cut, Copy, and Paste commands. Text from any
field in Split or other Windows applications can be Cut, Copied, or Pasted.
5.6 Running Split From a Command Line
Existing parameter files can be executed using Splitr.exe which is a "run-time"
version of the Split Report Generator. When Splitr.exe is run, the file is
processed as if the user chose Run | Go from the Split menu. Splitr.exe can be
executed by the Task Master, from a batch file, or from a Windows command
line prompt or shortcut.
5.6.1 Splitr Command Line Switches
Splitr has four switches that can be used to control how the executable is run.
5.6.1.1 Closing the Splitr.exe Program After Execution (/R or /Q Switch)
Typically when Split is run, after the file is processed the user must close the
Screen Display window. When Splitr.exe is run from a command line, the user
must also close the Screen Display window unless the /R switch is used.
Section 5. Split
The syntax for this switch is:
SPLITR LOGAN/R
where LOGAN is the parameter file name.
The /R switch should follow immediately after the parameter file name with no
space between the two. If a space is used, the following message will be
displayed "There was a problem opening the input file. File could not be
found or may be in use."
The /Q switch is similar in function and syntax to /R. However, if Split
encounters an error when processing the file, no message box is displayed that
requires user response (the exceptions are a disk space error or an internal error
with the Split executable). This option should be used with caution, since
there will be no indication of a problem if a file cannot be processed.
5.6.1.2 Running Splitr in a Hidden or Minimized State (/H Switch)
Splitr can be run in a minimized state, so that the Screen Display window does
not interrupt other processes on the computer. The syntax for running Splitr
minimized is:
SPLITR /H LOGAN
where LOGAN is the parameter file name.
The /H switch must be positioned after SPLITR but before the parameter file
name, and a space is required between the executable name and the switch.
5-49
Section 5. Split
5.6.1.3 Running Multiple Copies of Splitr (/M Switch)
Multiple copies of Splitr can be run at one time by using the /M switch. This
switch must appear immediately after Splitr. For instance, a batch file
containing the lines:
SPLITR /M Logan/R
SPLITR /M Sinks/R
will open two copies of Splitr and process the two files simultaneously.
NOTE
When using the /M switch in a batch file, you must begin each
line of the batch file that runs an instance of Splitr with the
"start" command. Otherwise, Windows will wait until the first
Splitr command has finished before proceeding to the next.
5.6.2 Using Splitr.exe in Batch Files
Batch files containing one or more Splitr command lines can be useful for
automating data processing. Batch files can be executed manually or by
setting them up in the Task Master.
Batch files process each command in succession, without waiting for execution
of a command to be completed before proceeding to the next unless they are
configured to do so. If multiple parameter files are being processed using
Splitr in a batch file, there are no conflicts because only one copy of Splitr can
be active at any one time (unless the /M switch is used. However, if other
commands are used along with Splitr (such as opening the file in a spreadsheet,
copying it to an archive directory, or appending it to an existing file) these
commands might be executed before Splitr finishes processing data.
The Windows Start /w (wait) command can be added to a batch file command
line to delay execution of the next command until the first command has
finished. The Start command has different arguments depending upon the
operating system you are using. Refer to your computer’s on-line help for
information on this command.
5.6.3 Processing Alternate Files
Splitr allows the user to select different input and/or output files for an existing
parameter file by entering them on the command line after the parameter file
name. For example:
“Splitr LOGAN.PAR/R TEST.DAT TEST.PRN”
Replaces the Input and Output file names in LOGAN.PAR, with TEST.DAT
and TEST.PRN, respectively.
A space must be used to separate command line parameters. Splitr uses as
many entries as exist on the command line. However, the command line has a
limit to the number of characters it can accommodate—this limit is operating
system dependent. The parameters must be in the following sequence: Input
file name, Output file name, Start Condition, Stop Condition, Copy Condition,
and Select.
5-50
Section 5. Split
If a parameter is to be left as it is in the parameter file, then space comma space
( , ) may be entered in the command line. For instance, if the parameter file
LOGAN.PAR contained TEST1.DAT as an input file name, the following
command line would leave the input file TEST1.DAT and change the output
file to TEST.PRN.
“SPLITR LOGAN/R , TEST.PRN”
5.6.3.1 Input/Output File Command Line Switches for Processing Alternate Files
The one caveat of using the command line to specify an alternate input and/or
output file name is that Split’s default options will be used with the alternate
file. For instance, by default, output files are written with field-formatted
columns. If the original PAR file specified a comma-separated output, that
option would be ignored and the and defaults would be used.
Command line switches can be used to control these options for the output and
input files. The switch is added immediately after the input or output file
name.
NOTE
In most instances, full path names to the Splitr executable and
the input and output file names must be used. In addition, if long
file names are used in the path, you may need to surround the
path and file name by double quotes.
Output File Options
These switches are entered after the output file name; e.g., Splitr Test.par/r
Input.dat Output.prn/P
/P Sends the output to a printer. This is the same as checking the Printer
box for the Report type on the Output File tab.
/R Creates a formatted RPT file. This is the same as checking the File
box for the Report type on the Output File tab.
/W Creates a simple HTML file. This is the same as checking the HTML
box for the Report type on the Output File tab.
/A Appends the output to the end of an existing file. This is the same as
selecting Append for the If File Exists option on the Output File tab.
/L Creates a new output file with a different name if a file exists. This is
the same as selecting Create New for the If File Exists option on the
Output File tab.
/O Turns the screen display off when Split is processing the PAR file.
This is the same as clearing the Screen Display check box on the
Output File tab.
/6..9 Sets the default width for all the columns in the report. This is the
same as entering a value in the Default Column Width field on the
Output File tab.
5-51
Section 5. Split
/[text] Sets the text that will be used in the place of bad data. This is the
same as the text string used in the Replace Bad Data field that is
found under the Other button of the Output File tab.
/M Compares two input files and creates an output file with a complete
data set comprised of both files. This is the same at the Match Files
option that is found under the Other button of the Output File tab.
The two input file names are separated with a comma but no spaces.
Example: Splitr Test.par/r Input1.dat,Input2.dat Output.prn/M
/S Writes the output file without a form feed command after each page.
This is the same as the No FF (form feed) option that is found under
the Other button of the Output File tab.
/G Outputs only the data marked as “bad” to the file. This is the same as
the Only Display Lines with Bad Data check box that is found under
the Other button of the Output File tab.
/0 Outputs the data in comma separated format. This is the same as
choosing the Comma option for the File Format.
/1 Outputs the data in printable ASCII format. This is the same as
choosing the Printable option for the File Format.
/2 Outputs the data using the Regional Settings of your Windows
operating system for the decimal indicator and data value separator.
This is the same as choosing the Custom option for the File Format
(this is the default option for the File Format field).
/F Conditionally outputs the data using the Trigger On Stop Condition.
This is the same as choosing the Trigger On Stop Condition option
that is found under the Other button of the Output File tab. A stop
condition must also be specified. The example below does not
specify a start or copy condition. These two fields are indicated by
the “space-comma-space” entries. Select line entries are also shown
in this example.
/T Transposes the rows and columns of a file. This is the same as
choosing the Transpose File option that is found under the Other
button of the Output File tab.
/D Enables the No Date Advance function, which keeps the date for
midnight from rolling to the next day. This is the same as choosing
the No Date Advance check box that is found under the Other button
of the Output File tab.
/N Suppresses the summary information when processing time series
5-52
data. This is the same as choosing the No Summary check box that is
found under the Other button of the Output File tab.
Section 5. Split
/H Removes the dashed lines from the heading of the RPT file. This is
the same as choosing the No Dashes check box that is found under
the Other button of the Output File tab.
/U Removes the record number from TOB files that are processed with
Split. This is the same as choosing the No Record Numbers from
TOB Files check box that is found under the Other button of the
Output File tab.
/E Begins processing the file, or stops processing the file, on or after the
Start or Stop condition when starting or stopping based on time (the
default is to start only if the exact start condition is found). This is the
same as choosing the Start -Stop On/After Time option that is found
under the Other button of the Output File tab.
Example: Splitr test.par input1.dat Output.prn/E 4[1450]: 4[1456]:
(where 1450 and 1456 are the start and stop times, respectively.
Colons are required to indicate a time value.)
/I Suppresses the time series heading and column heading information
when processing time series data. This is the same as choosing the
No Summary Heading check box that is found under the Other button
of the Output File tab.
/Bnnn Breaks a long array into multiple lines, where nnn is the number of
values to place on each line. This is the same as choosing the Break
Arrays check box that is found under the Other button of the Output
File tab.
Input File Options
These switches are entered after the input file name; e.g., Splitr Test.par/r
Input.dat/L Output.prn
/nnn Begins processing nnn bytes into the file. If /nnn..mmm is used, then
processing begins at nnn bytes into the file and stops at mmm bytes
into the file. This is the same as setting a specific Start and Stop
offset, which is found under the Offsets/Options button of the Input
File tab.
/L Begins processing the file at the byte value where processing last
stopped. If /L..mmm is used, then processing begins where it left off
and stops at mmm bytes into the file. This is the same as enabling
Last Count, which is found under the Offsets/Options button of the
Input File tab.
/Bnnn Specifies the file type as Burst data. nnn indicates the size of the
arrays. This is the same as selecting Burst Format for the File Info
field on the Input File tab.
/F Specifies the file type as Final Storage (binary) data. This is the same
as selecting Final Storage Format for the File Info field on the Input
File tab.
5-53
Section 5. Split
5.6.4 Processing Multiple Parameter Files with One Command
/M Changes the value for midnight to 2400 instead of 0000. This is the
same as selecting Midnight is 2400 Hours check box found under the
Offsets/Options button of the Input File tab.
where
PAR file: switch-test.par
Input file: input1a.dat
Output file: output.prn
Other outputs: Output.HTML
Start condition: on or after 1200
Stop condition: end of file
Copy condition: none
Elements: 1 through 6
Line
5.7 Log Files
More than one .PAR file can be executed with a single Splitr command line.
Each .PAR file and its associated parameters are separated from the next .PAR
file by a semicolon with one space on each side ( ; ). For example:
executes the LOGAN.PAR file on TEST.DAT and outputs the results to
TEST.PRN, then executes the SINKS.PAR file on TEST1.DAT and outputs
the results to TEST2.DAT. Execution of SINKS.PAR starts when the first
element in TEST1.DAT is 189.
Split maintains a log file each time Splitr is run. The main purpose of this log
file is to enable users running Splitr in command line mode to identify what
happened with each execution of Splitr. The file is named splitr.log and is
written to the Sys directory of the Split working directory. (By default, this is
C:\Campbellsci\Splitw\sys.) The file will grow to approximately 4-5K in size
and then be renamed to splitr.bak. (Any previous splitr.bak file will be
overwritten. Therefore, only two log files will be retained.)
If a second instance of Splitr is started when one is already running, another
log file, splitrunning.log, will be written. This file simply identifies the time
that the second instance of Splitr was started and that Splitr was already
running.
5-54
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.