KSM 500databook

KSM-500 Databook
This is the January 2009 release of the KSM-500 Databook (HW/BK/R/0001 | 5 Jan. 2009). The KSM-500 Databook
comprises data sheets for KSM-500 tools and chapters on Installing KSM-500, Building IRIG-106 PCM frames and so on. All
controlled documents contained in the KSM-500 Databook are issued by date. The following is a list of the controlled
documents contained in the KSM-500 Databook and their issue dates. (KSM-500 Databook ordering code: DOC/MAN/018)
Data sheets
KSM-500 tool Issue date | reference number
kDiscover 1.0 5 Jan. 2009 | DST/T/076
kFlashCardXID 1.3 5 Jan. 2008 | DST/S/035
kProgram 1.6 27 Nov. 2008 | DST/U/019
kQuicklook 2.0.1 5 Jan. 2009 | DST/U/021
kSetup 1.6 27 Nov. 2008 | DST/U/017
kTimeseed 1.2 5 Jan. 2009 | DST/T/084
kValidate 2.0 5 Jan. 2009 | DST/T/005
kWorkbench 2.0.1 5 Jan. 2009 | DST/T/100
X-Report 2.0 5 Jan. 2009 | DST/T/006
X-Validate 2.0 5 Jan. 2009 | DST/T/004
KSM-500 Databook chapters

KSM-500 chapter Reference number | issue date
Installing KSM-500 QD/HW/SPF/R/0001 | 28 Jul. 2008
Building IRIG-106 QD/HW/SPF/R/0002 | 29 Jul. 2008

PCM frames
Running batch files QD/HW/SPF/R/0003 | 9 Jan. 2008

and interpreting
messages
Introduction to QD/HW/SPF/R/0004 | 9 Jan. 2008

KSM-500
See “Revision histories” on page 105 for details of revisions

to controlled documents since the last release.
i
About this publication
This book gives a technical overview of the KSM-500 suite of tools, for flight data configuration, acquisition and reporting. It
contains the following sections:
• Introduction to KSM-500 introduces the KSM-500 suite of tools, explaining key concepts and design goals.
• Installing KSM-500 describes how to install the KSM-500 suite of tools
• Data sheets contains data sheets for all the KSM-500 tools.
• Building IRIG-106 PCM frames describes how to build PCM frames in kSetup.
• Running batch files and interpreting messages describes how to run batch files and interpret MsgML messages.
• Revision Histories outlines the revision history of the KSM-500 Databook
• Appendix gives lists of Abbreviations and Receiving Inspection and Warranties.
The information in this publication is provided for reference only. All information contained in this publication is believed to be
correct and complete. ACRA CONTROL shall not be liable for errors contained herein nor for incidental or consequential
damages in connection with the furnishing, performance, or the use of this material. All product specifications, as well as the
information contained in this publication are subject to change without notice.
This publication may contain or reference information and products protected by copyrights or patents and does not convey any
license under the patent rights of ACRA CONTROL, nor the rights of others. ACRA CONTROL does not assume any liability
arising out of any infringements of patents or other rights of third parties.
ACRA CONTROL makes no warranty of any kind with regard to this material, including but not limited to, the implied warranties
or merchantability and fitness for a particular purpose.
All world rights reserved. No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way,
including but not limited to, photocopy, photograph, magnetic or other record, without the prior written permission of ACRA
CONTROL.
X-Report uses Xalan C++ and Xerces C++ ©Apache. See “Apache software license information” on page 111.
Contact details
ACRA CONTROL INC ACRA CONTROL LTD
44145 Airport View Drive Landscape House
Hollywood, MD 20636 Landscape Road, Dublin 14
USA Ireland
Phone: (301) 373-9220 Phone: +353-1-2951264
Fax: (301) 373-9223 Fax: +353-1-2951265
Email: info@acracontrol.com Email: mail@acracontrol.com
Website: www.acracontrol.com Website: www.acracontrol.com
Suggested Reading Paths
Managers or other personnel requiring a brief overview of the features of KSM-500 “Introduction to KSM-500” on page 1
Engineers requiring a technical overview of MsgML and CmdML “Running batch files and interpreting
messages” on page 101
Engineers requiring a technical overview of Building IRIG-106 PCM frames “Building IRIG-106 PCM frames” on
page 79
Engineers requiring a technical overview of any or all tools in KSM-500 “Introduction to KSM-500” on page 1
“Data sheets” on page 7
Engineers responsible for installing any of the KSM-500 suite of tools “Installing KSM-500” on page 3
Engineers wishing to know the revision history of the KSM-500 Databook “Revision histories” on page 105
ii
ACRA Table of Contents
C O N T R O L
Chapter 1 Introduction to KSM-500 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Chapter 2 Installing KSM-500 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Chapter 3 Data sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
kDiscover 1.0 Generates HTML inventory of KAM-500 equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
kFlashCardXID 1.3 Initializes CompactFlash® cards and extracts logged data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
kProgram 1.6 Verifies and programs configuration data in KAM-500 modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
kQuicklook 2.0.1 Views real-time data, or replays archived data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
kSetup 1.6 User interface for setup of KAM-500 system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
kTimeseed 1.2 Sets the time on an RTC/002 or RTC/003 (RTC/00x) module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
kValidate 2.0 Validates XidML 2.41 files with respect to ACRA CONTROL equipment . . . . . . . . . . . . . . . . . . . . . . . . .55
kWorkbench 2.0.1 Integrated environment from which KSM-500 tools can be launched . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
X-Report 2.0 Extracts data from XidML 2.41 files and generates a report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
X-Validate 2.0 Validates a XidML file with respect to the XidML schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Chapter 4 Building IRIG-106 PCM frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Chapter 5 Running batch files and interpreting messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Chapter 6 Revision histories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Appendix Abbreviations, glossary and warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
iii
This page is intentionally blank
ACRA Chapter 1Introduction to KSM-500
C O N T R O L
This section provides an overview of the design philosophy KSM v2, which had many features bundled into one large
and architecture of KSM-500. application.
Introduction A modular approach

KSM-500 (KAM System Manager) is a suite of software tools Software tools included in the KSM-500 suite are modular in
from ACRA CONTROL, which fulfills a wide range of design. This provides many advantages including the
requirements for those involved in design, definition and following:
implementation of airborne FTI and ground station systems.
• You may include software tools from other vendors with
In practical terms, KSM-500 is a collection of software KSM-500
utilities, each one addressing specific user requirements. • Better error reporting, since implementation of software
Thus, KSM-500 provides utilities to facilitate the verification of utilities as stand-alone modules facilitates a more focused
airborne FTI system and ground station configurations, in and meaningful expression of error messages
addition to facilities for reporting, archival and retrieval of test
The modular design approach also provides many benefits to
results and system configurations.
ACRA CONTROL, including the following:
In terms of airborne FTI system setup features, KSM-500
• KSM-500 tools can be developed, tested and distributed
provides the ability to do the following:
independently, facilitating more robust and focused
• Set up all configurable aspects of FTI instrumentation software utilities which better meet user requirements
parameters • Simplification of the software release cycle, since only
• Set up data output streams, including PCM, Ethernet and software utilities which have been updated need to be
CAIS data packages tested and documented upon each software release
• Carry out pre-flight checks on parameters
Each of the software utilities included in KSM-500 may be run
• Configure and control airborne logging of data to storage
from the command line or graphical interface. KSM-500
media such as CompactFlash® cards, solid state recorders
provides explicit support for grouping batches of calls to
and rugged tape recorders
KSM-500 tools into one XML file—called a CmdML file
In terms of ground station functionality, KSM-500 provides the (pronounced ‘Command ML’ file). This format is described in
ability to do the following: “Running batch files and interpreting messages” on
page 101.
• Carry out extraction of data from storage media
• View and log data to hard disk in real time
• Post-process logged or extracted data, including data An example of KSM-500 in action
conversion With a KSM-500 system connected and powered up the
KSM-500 views user requirements in terms of tasks, where a following sequence of tools can be run to generate a XidML
task is a specific mission, project or test. Hence, all aspects 2.0 file and an HTML report summarizing the system
of a particular task are grouped and stored together. This configuration.
means that the KSM-500 suite of tools assumes that user kSetup
requirements are based on the concept of tasks.
kSetup creates and defines Tasks representing KAM-500
KSM-500 has evolved from KSM v2, from ACRA CONTROL. instrumentation, allowing users to visualize a Task through a
However, instead of using XID or XML files for expression of standard windows tree view and construct a Task with DAUs
system setup and configuration information as KSM v2 did, and modules.
KSM-500 uses the open XidML 2.0 standard (available at
http://www.xidml.org). This has the following advantages: X-Report
• XidML 2.0 is an open standard, and provides scope for the Generates HTML reports using style sheets
storage of configuration of all equipment from multiple The XidML 2.0 file which is generated by kSetup can be
vendors together in one file subsequently modified via XML editing tools or via manual
• XidML 2.0 is XML-based, which is the de-facto standard for editing.
description of data archival
• XidML 2.0 provides support for many advanced system Instead of running each tool separately, it is possible to call
configuration features, and is extensible to easily include the KSM-500 tools through the use of standard DOS-style
support for new and additional features batch (BAT) files.
KSM-500 takes a modular approach to the implementation of Each of the KSM-500 tools can generate an output message
its functionality. All of the tools included in the KSM-500 suite file—called a MsgML (pronounced “Message ML”) file, which
of software are stand-alone, independent utilities—unlike contains the output messages generated by the utility. As the
MsgML file is an XML file, its contents can be transformed
QD/HW/SPF/R/0004 | 9 Jan. 2008 1

into a variety of other presentation forms, such as HTML (for
use within a HTML client), an MS Word document or an MS
Excel spreadsheet.
X-Report is a freeware software utility which

generates reports from XidML 2.0 files, using
style sheets to describe the specific formatting
required.
From proprietary XID and XML-based

tools to XidML-based tools
The suite of tools in this databook embody the fact that
KSM-500 has moved away from a single software package,
bundling a variety of functions together, to a collection of
independent tools—each of which is based on an interface to
XidML 2.0 files.
This allows each individual tool to be documented and
distributed separately—allowing the user to install,
understand and upgrade each tool on a "need-to-use" basis.
It also enables ACRA CONTROL to provide its
customer-base with diverse value-added tools more quickly
and with virtually no interoperability implications for other
tools in the KSM-500 suite.
In parallel with the above change of design philosophy for
KSM-500, KSM-500 has moved away from using proprietary
XID and XML files to describe system configuration
information to now use the open XidML 2.0 standard format.
The main advantage of this change for the end-user is that
XidML 2.0 configuration files are vendor neutral and provide
scope for description of complete system setup in one file,
which may be read/written by each of the KSM-500 tools as
appropriate.
Directory structures
See “Directory structure” on page 4 of the KSM-500
Databook for a description of the directory structures for
KSM-500.
2 QD/HW/SPF/R/0004 | 9 Jan. 2008

ACRA Chapter 2
C O N T R O L Installing KSM-500
This section describes how to install KSM-500 and describes the directory structure.
Installing KSM-500
To install KSM-500, a PC running windows is required. The minimum specification is listed below. Data will compile faster if
system memory is above the minimum requirements.
System requirements
To run KSM-500, the following minimum PC specification is required:
Operating system Windows® 2000 or XP
Processor 1GHz Intel® Pentium® 4
Hard-disk 40GB
RAM 512MB
Input device Keyboard; mouse (if using GUIs)
Screen 1024 x 768 (if using GUIs)
To get the most from KSM-500, ACRA CONTROL recommends the following PC specification:
Operating system Windows 2000 or XP
Processor 2.8GHz Intel Pentium 4
Hard-disk 80GB
RAM 1024MB
QD/HW/SPF/R/0001 | 28 Jul. 2008 3

Installing KSM-500
To install KSM-500, insert the KSM-500 CD into the drive. The KSM-500 CD browser appears:
Click Install Software -> Install KSM-500. Follow the on-screen instructions to complete the installation.
Installing Adobe Acrobat®

KSM-500 ships with many documents and data sheets in Adobe PDF format. To view these, Adobe Acrobat must be installed.
This program is available on the distribution CD in the Adobe directory.
To install Acrobat Reader, insert the KSM-500 CD into the drive. The KSM-500 CD browser appears.
Click Install Software -> Install Acrobat Reader. Follow the on-screen instructions to complete the installation.
Alternatively, the latest version of Adobe Acrobat may be downloaded from www.adobe.com.
Directory structure
For simplicity, KSM-500 tools install into directories as shown in the following table. The %root% represents the starting location
specified in the installation process.
For a given tool <tool> the following locations are used:
Location Description
%root%\acra\<tool>.exe Location of executable tool
%root%\acra\<tool> Location of binaries for tool
Also, there are a number of locations that are used by tools that work together on a task file or its outputs:
By default KSM-500 opens a separate directory for each task and stores files associated with that task (such as XidML, logged
files, and Quicklook panels) in that directory. This allows problem tasks to be easily sent to ACRA CONTROL if required.
The recommended convention is: c:\acra\tasks\MyTask.xml
%root%\acra\database Location of KSM v2 database
%root%\acra\kProgram\cache Single location for EEPROM cache used by

kProgram
%root%\acra\kProgram\log Location of legacy log files: kc.log,

report.log, db2pcm.log
%root%\acra\tasks\<task> Location of task directories
%root%\acra\<tool>\MsgML\<tool>_msgml.xml Last log for tool
4 QD/HW/SPF/R/0001 | 28 Jul. 2008

%root%\acra\<tool>\MsgML\Archive\<tool>_msgml_<date_time>.xml Archived logs for tool
%root%\acra\<tool>\CmdML\<tool>_cmdml.xml Last CmdML file for tool
Example
Running kProgram produces the following outputs: MsgML, CmdML and EEPROM images.
Output Location Comment
MsgML \%root%\acra\kprogramxid\MsgML\kprogramxid_msgml.xml Upon startup of a tool the current MsgML file (if it exists) will be
"aged", that is, copied and renamed with its date and time as read
from the file attributes.
This aged file will be moved to the folder:
\%root%\acra\kProgram\MsgML\Archive
The existing msgml file will then be overwritten on the next run.
CmdML \%root%\acra\kprogramxid\CmdML\kprogramxid_cmdml.xml This file contains the settings used on the last run.
EEPROM \%root%\acra\cache\... The files in this directory are used by kProgram.

listings
QD/HW/SPF/R/0001 | 28 Jul. 2008 5

ACRA Chapter 3
C O N T R O L Data sheets
This section contains data sheets for all tools in KSM-500.

The following data sheets are included:
• “kDiscover 1.0” on page 9
Generates HTML inventory of KAM-500 equipment
• “kFlashCardXID 1.3” on page 17

Initializes CompactFlash® cards and extracts logged data
• “kProgram 1.6” on page 25

Verifies and programs configuration data in KAM-500
modules
• “kQuicklook 2.0.1” on page 31

Views real-time data, or replays archived data
• “kSetup 1.6” on page 39

User interface for setup of KAM-500 system
• “kTimeseed 1.2” on page 49

Sets the time on an RTC/002 or RTC/003 (RTC/00x)
module
• “kValidate 2.0” on page 55

Validates XidML 2.41 files with respect to ACRA
CONTROL equipment
• “kWorkbench 2.0.1” on page 61

Integrated environment from which KSM-500 tools can be
launched
• “X-Report 2.0” on page 67

Extracts data from XidML 2.41 files and generates a report
• “X-Validate 2.0” on page 73

Validates a XidML file with respect to the XidML schema
7
KSM-500 KSM/STE/001
kDiscover 1.0
Generates HTML inventory of KAM-500 equipment
DESCRIPTION
kDiscover automatically identifies and lists all KAM-500
hardware that is powered-up and connected to the PC
through an Ethernet or SAM/DEC programming link.
Details of instrumentation such as serial number, part
reference, and automatically generated names are stored in
the output HTML.
There are two naming conventions—long and short—for
instruments.
FEATURES
• Detects connected hardware and automatically generates
an HTML inventory
• Generates inventory listings for KAM-500 hardware
• Supports Ethernet and SAM/DEC configuration links
APPLICATIONS
• Lists connected data acquisition hardware
HTML
Report
kDiscover
kDiscover operation
5 Jan. 2009 | DST/T/076 9

Selection guide and ordering information
Selection Paths
Data Acquisition Software → KSM-500
Ordering Information
Part Number Description
KSM/STE/001 kDiscover ships as part of the KSM-500 suite of tools; kDiscover queries a KAM-500 system
connected to the PC and produces an HTML inventory
Revision History
Revision Differences Status
kDiscover 1.0 First release Recommended for new programs
Related Products
Module Details
-- --
Related Documentation
Document Details
DOC/MAN/018 KSM-500 Databook
Data sheet text and specifications are subject to change without notice. © 2009 ACRA CONTROL. All rights reserved.
ACRA CONTROL INC, 44145 Airport View Drive, Hollywood, MD 20636, USA, Phone: (301) 373-9220, Fax: (301) 373-9223, Email: info@acracontrol.com
ACRA CONTROL LTD, Landscape House, Landscape Road, Dublin 14, Ireland, Phone: +353-1-2951264, Fax: +353-1-2951265, Email: mail@acracontrol.com
www.acracontrol.com
10 5 Jan. 2009 | DST/T/076

Overview
Requirements: Configuration link to the hardware. Hardware must be powered on.
Inputs: CmdML file (or equivalent command line or GUI options)
Output: HTML
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/076 11

Using kDiscover
kDiscover can be run from either the GUI or the command line. It supports both CmdML and command line arguments.
kDiscover will detect a DAU connected to a PC via the configuration link. kDiscover generates names for DAUs and modules
based on the selected naming convention.
1 3
4
2
No. Setting Type Default Command line Optional Description
Report File String None -T No Output report file

1
Naming Radio Button Long -N:L Yes Naming scheme used for the names
2
Convention -N:S in the XidML file
Long naming convention
Short naming convention
Configuration Select from: SAM/DEC -L:P No Determines the configuration link that
3
Link SAM/DEC or -L:E<ip address> kDiscover will use to interrogate
Ethernet connected hardware
IPAddress String None See Configuration This is required if IP address of Ethernet module
4
Link configuration link
used is Ethernet
Verbosity High High -V:H Yes High: generates all messages

5
Medium -V:M Medium: generates Errors and
Low -V:L Warnings
Low: generates Errors
CmdML File String None -C Yes Specifies CmdML file the tool will use
6
Display Next All All -G Yes Determines display of tool next time
7
Time Progress it is run
None
Naming conventions
kDiscover supports both long and short naming conventions. These conventions are applied to the HTML file. The following
table describes how each element name is generated and an example for each.
Convention Format Example

DAU Instrument
Short D<link id><dau id> D002
Long D<link id><dau id> D002
Instrument
Short <dau name>S<slot> D001S4
Long <dau name>S<slot>_<part reference> D001S4_ETH001B
12 5 Jan. 2009 | DST/T/076

Legend
<part reference> = The ACRA CONTROL part reference name truncated by removing KAD, KAM and all ‘/’ s. Example:
KAD/DEC/003 becomes DEC003. The part reference is the name of the instrument.
<slot> = Instruments DAU slot.
<link id> = link instance number.
<dau id> = DAU identification number.
Getting the most from kDiscover

Ensure all DAUs are powered up and the configuration link is connected. The ENC/004, BCU/001 and BCU/101 controllers are
supported over the SAM/DEC link, but the Ethernet link is restricted to BCU/101 controllers in this version of kDiscover. If
modules do not have their serial numbers stored in their EEPROM, the Serial Number column will display ‘Undefined’. The
Module Type column will display the module's type number if the module does not have an iDefML file. The long naming
convention scheme will have Unknown rather than the abbreviated part reference. Figure 2 shows a sample HTML report file
when connected to a master and slave chassis.
Figure 2: Sample HTML report file
5 Jan. 2009 | DST/T/076 13

kDiscover messages
Level Message code Message
Info 50001 No CAIS DAUs connected to CAIS controller <name>.
Error 50003 No DAU found.
Warning 50010 No template files found in the directory <directory>.
Error 50014 Failed to read serial number from hardware module <type number>.
Error 50018 Insufficient memory.
Error 50024 No instrument found.
Error 50025 No DAU found.
Error 50035 Failed to process DAU <name>.
Error 50039 Internal error.
Error 50040 Internal XML processing error.
Error 50041 Instrument not connected to a DAU.
Info 50046 Writing the file <file>.
Info 50047 Processing.
Info 50053 <scheme> naming scheme has been selected.
Info 50108 Hardware detected.
Info 50113 Examining hardware.
Info 50114 Searching for hardware.
Info 50120 Instrument <name> is connected to <dau>.
Info 50121 Found a <part reference> instrument, name <name> in DAU <name>, slot <slot>.
Info 50122 Found a <part reference> DAU, name <name>.
Info 50123 File <file> cannot be written to.
Error 50130 Module in <dau type> <dau id> slot <slot> has an invalid type number <type number>.
Error 50131 Module in <dau type> <dau id> slot <slot> has an invalid serial number.
Error 50133 Module in <dau type> <dau id> slot <slot> has an invalid type number.
Error 50134 Module in <dau type> <dau id> slot <slot> has invalid EEPROM value settings.
Error 50135 Module in <dau type> <dau id> slot <slot> has invalid configuration register settings.
Error 50136 Unable to locate Ethernet programming module.
Error 50140 Failed to modify the file <file>.
Error 50143 Failed to read configuration file <file>.
Error 50144 Hardware not detected.
Error 50146 Configuration link to dau <dau id> failed.
Error 50147 Configuration link not initialized.
Error 50148 Failed to read configuration from dau <location>.
Error 50149 Failed to read configuration from module <location>.
Error 50150 Module in <dau type> <dau id> slot <slot> has failed its bit walk test.
Warning 50152 Module in <dau type> <dau id> slot <slot> is not supported.
Error 50154 Invalid IP Address specified <ip address>.
Error 50155 Failed to open SAM/DEC device.
14 5 Jan. 2009 | DST/T/076

Error 50156 Failed to initialize SAM/DEC device.
Error 50163 Failed to load resource string dll, <name>.
Warning 50164 Module type <type number> not supported.
Info 50080 Report file generated.
Error 50081 Errors in report file generation process.
Error 50082 System error generating <html file name> Error occurred when processing <command line>.
Error 50083 XidML file <file name> is not valid.
Error 50084 Style sheet <file name> is not valid.
Error 50085 Error generating <html file name>.
5 Jan. 2009 | DST/T/076 15

www.acracontrol.com
16 5 Jan. 2009 | DST/T/076

KSM-500 KSM/STE/001
kFlashCardXID 1.3
Initializes CompactFlash® cards and extracts logged data
DESCRIPTION
kFlashCardXID performs two main tasks:
• Initializes CompactFlash cards with an ACRA CONTROL
specific disk format for use with KAM/MEM/003/C and
KAD/MEM/004 memory modules
• Extracts logged data for future analysis and processing.
The output formats are:
• MATLAB (Level 5 MAT-File, Level 4 MAT-File)
• ASCII (decimal, hexadecimal, octal)
• Raw data file
• Video (MPEG-2 Transport Stream file)
FEATURES
• Initializes CompactFlash cards for use with MEM/003/C
and MEM/004
• Extracts logged data from CompactFlash cards and
converts it to MATLAB or ASCII format
• Supports storage of data logging strategy file on
CompactFlash card
• Supports extraction of logged data into a raw data file for
archiving
• Supports extraction of video data
ASCII
Strategy
kSetupXID kProgramXID file
Raw data
file
kFlashCardXID
kFlashCardXID
Initialization
Extraction
MPEG-2
Transport
Stream
file
KAM syst em wit h MAT-File

KAM/MEM/003/C or
KAD/MEM/004
module
One example of where kFlashCardXID operates in the workbench flow
5 Jan. 2008 | DST/S/035 17

Selection Paths
KSM/STE/001 kFlashCardXID ships as part of the KSM-500 suite of tools; initializes CompactFlash cards and
extracts logged data
Revision History
kFlashCardXID 1.3 XidML 2.2 compliant Recommended for new programs
kFlashCardXID 1.2 First release Not recommended for new programs
Related Products
Module Details
gVideo Real-time video decompression software for GSX-500
Document Details
www.xidml.org XidML 2 Handbook
www.xidml.org For more information on XidML
www.acracontrol.com
18 5 Jan. 2008 | DST/S/035

Overview
Requirements: Recommended PC
Supported OS: Windows NT, 2000, XP
FAT32 formatted CompactFlash cards
Inputs: Initialization Extraction
CompactFlash card ACRA CONTROL-formatted CompactFlash card with logged
data
ACRA CONTROL strategy file ACRA CONTROL strategy file
Output: Initialization Extraction
ACRA CONTROL-formatted CompactFlash card MATLAB or ASCII or raw data files
Benchmarks Initialization Time (4GB CF card) Extraction Time (4GB CF card)
KAM/MEM/003/C (over KAD/MEM/004 KAM/MEM/003/C KAD/MEM/004
USB 2.0) (over USB 2.0)
25mins 18mins MATLAB: 50mins 90mins
ASCII: 90mins 120mins
Raw data: 25mins 60mins
Using kFlashCardXID
kFlashCardXID can be run from the command line or from a batch file. It supports both CmdML and command line arguments.
10
Initialize Card String None -A:IN No Initialize CompactFlash card

1
Extract Data String None -A:EX No Extract data from the card
2
3
Data Source String None -D<data source> No Removable drive, or Ethernet (IP
address of the memory module), or
raw data file (full name and path)
Strategy File String None -S<file name> No Name and path of the ACRA
4
CONTROL strategy file
-S”Use file on the To use the file stored on the card
card”
5 Jan. 2008 | DST/S/035 19

5
Initialization String All zeroes For data The bit pattern to initialize the card
Pattern (0x00) initialization with
-P:0 only All zeroes (0x00)
-P:1 All ones (0xFF)
Output Format String MAT5 For data Output format for extracted data
6
extraction MAT-File 5
-O:mat5 only
MAT-File 4
-O:mat4 ASCII dec
-O:dec ASCII hex
-O:hex ASCII oct
-O:oct Raw data file
-O:raw MPEG-2 Transport Stream
-O:video
Output String kFlashCardXID -o For data Output directory for extracted data
7
Directory \Output extraction
only
Verbosity Select High Yes High: generates all messages

8
from: -V:H Medium: generates Errors and
High -V:M Warnings
Medium -V:L Low: generates Errors
Low
CmdML File String None -C Yes Specifies CmdML file the tool will use
9
Display Next Select All -G Yes Determines display of tool next time it
10
Time from: is run
All
Progress
None
1
Initializing a CompactFlash card
A CompactFlash card must be initialized with an ACRA CONTROL format. Select Initialize Card to initialize the card.
2
Extracting CompactFlash data
To extract logged data from the CompactFlash card, select Extract Data.
3
Using kFlashCardXID with Ethernet
To use kFlashCardXID via Ethernet, you need to specify the IP Address of the memory module. Port 4097 should not be
blocked by a firewall on your system as it is used to communicate with the memory module.
UDP protocol should be supported by your system and Windows Sockets 2 should be installed.
The speed and faultlessness of operating via Ethernet largely depends on the business of your network, so avoid using
kFlashCardXID on congested networks. Ideally, you would only have a memory module and kFlashCardXID “talking” on the
network.
4
Using the Strategy file
Your system must include an up-to-date strategy file, which is generated by kProgramXID. The strategy file is essential for
processing logged data. This file documents the layout of the logged data on the CompactFlash card.
At initialization, kFlashCardXID 1.2 stores the specified strategy file on the CompactFlash card. During extraction the strategy
file on the card will be picked by default. Alternatively, choose a different strategy file to extract logged data.
5
Setting the initialization pattern
Some cards like Sandisk have much better performance when initialized with 0s, others need 1s for optimum performance.
20 5 Jan. 2008 | DST/S/035

Future versions of kFlashcardXID will allow you to choose the pattern that suits your card best. kFlashCardXID 1.3 only
supports the “All zeroes” pattern.
6
Setting output format
The output format can be either a MAT-File, ASCII, raw data file or an MPEG-2 Transport Stream File.
MATLAB® File Format

Level 4 MAT-Files are compatible with MATLAB v.4 and earlier versions. Due to licensing issues, some free software
applications accept these files only.
Level 5 MAT-Files files are compatible with MATLAB v.5 and later.
When an event is exported into a MAT-File (Level 4 or 5), a new folder containing different MATLAB files for each of the logged
parameters is generated in the output directory. Once the parameter has been loaded into MATLAB, it is treated as a 1 row x N
samples matrix.
ASCII File Format

One ASCII file is created for each event. The ASCII file can be can be edited using a text editor such as Microsoft Notepad or
more advanced applications such as Microsoft Excel.
Raw data File Format

The raw data file contains a binary image of the whole card, including all system areas (Boot Sector, FAT etc.). Please note, that
if created on a FAT32 volume, the raw data file cannot exceed 4GB due to limitations of FAT32. There is no such limitation on
NTFS which supports files greater than 4GB.
MPEG-2 Transport Stream File Format

Each video parameter should be named <ParameterName>_VIDEO. If there is more than one video parameter sourced from a
video module then subsequent parameters are named <ParameterName>_Video_<Number> where number ranges from 1
to one less than number of video parameters sourced from the module.
e.g. if there are 100 parameters sourced from a video module, and the first one is nemed “Camera_VIDEO”, then the
subsequent parameters are nemed “Camera1_VIDEO_1”, “Camera1_VIDEO_2” to “Camera1_VIDEO_99”.
Note: kSetup allows the number of video parameters for each video module to be specified in the “#Words” field in the VID/103
module setup screen. These parameters are created automatically by kSetup.
Getting the most from kFlashCardXID

If the configuration of a KAM-500 system is changed after the CompactFlash card is initialized, the strategy file should be
regenerated and the card reinitialized to update the strategy file on the card. Alternatively, reinitialization is not necessary if a
correct strategy file is used for extraction of logged data.
Only one strategy file may be used for each CompactFlash card.
Use the Raw data file feature to create backup or archive copies of logged data on your hard drive. At a later stage data can be
extracted from a raw data file in exactly the same way as from a CompactFlash card.
You can extract all events automatically if you set “Display Next Time” to “None”. This will instruct kFlashCardXID to bypass the
Extract Data dialog and start the extraction straight away. For example, the following command can be used to extract all events
from the command line:
kFlashCardXID.exe -A:EX -D”192.168.1.30” -S"Use file on the card" -GNone
Use a USB 2.0 card reader for better performance.
5 Jan. 2008 | DST/S/035 21

Use the popup menu (available via right mouse click) in the Extract Data dialog to select/deselect all events, invert selection or
select a range of events. This may be helpful if you have a lot of events logged on the card.
Selection guide
kFlashCardXID 1.3 is the fourth version of this tool, it supports both KAM/MEM/003/C and KAD/MEM/004.
kFlashCardXID messages
Level Unique Message (US default)

code
Error 70001 Failed to process command line options.
Error 70002 Action is not specified.
Error 70003 Initialization pattern is not specified.
Error 70004 Data source is not specified.
Error 70005 Strategy file is not specified.
Error 70006 Strategy file <file name> does not exist.
Error 70007 The selected strategy file is located on the CompactFlash card that is about to be initialized. This file will be erased
before initialization is complete.
Error 70008 Output format is not specified.
Error 70009 Output directory is not specified.
Error 70010 Invalid output directory <directory name>.
Error 70011 Failed to open drive <drive name>.SYSTEM REPORTED: <error description>.
Error 70012 Drive <drive name> is not a removable drive.
Error 70013 The data source is not open.
Error 70014 Failed to position to sector <sector number>.SYSTEM REPORTED: <error description>.
Error 70015 Read error at sector <sector number>. SYSTEM REPORTED: <error description>.
Error 70016 Write error at sector <sector number>.SYSTEM REPORTED: <error description>.
Error 70017 Non-standard sector size <sector size>. Only media with 512-byte sectors are supported.
Error 70018 The file system on the CompactFlash card is not FAT32. Please reformat the card with FAT32.
Error 70019 Root directory on the CompactFlash card is not located at the beginning of the data area (expected at cluster
<cluster number>, but found at cluster <cluster number>. Please reformat the card.
Error 70020 Cannot access the selected drive. Please make sure that a CompactFlash card reader is connected to your PC
and there is a CompactFlash card in it.
Error 70021 Invalid argument <argument name> in function <function name>.
Error 70022 Selected file is too big to be stored on the card.
Error 70023 Cannot open file <file name>.
Error 70024 Failed to transfer file <file name> to the card (transferred <number of bytes> bytes instead of <number of bytes>
bytes).
Error 70025 Cannot create file <file name>.
Error 70026 No file found on the card.
Warning 70027 Failed to lock the selected drive. The drive may be in use by another application.
Error 70028 Failed to parse strategy file <file name>. Please make sure you are using the correct strategy file.
22 5 Jan. 2008 | DST/S/035

code
Error 70029 Failed to start data extraction for the selected output format.
Error 70030 Operation interrupted by the user.
Error 70031 Event <event number> is corrupted. The number of stored data words does not match the expected <number of
words> words. This problem could have occurred due to a power down at the time when memory module was
writing to the CompactFlash card.
Error 70032 Invalid file name <file name>.
Info 70034 Querying the card...
Warning 70035 No data logged on the card.
Info 70038 Total number of memory blocks on the card: <number of blocks>.
Info 70040 Number of usable memory blocks: <number of blocks>.
Error 70041 Internal error: <error description>
Info 70042 Initialization complete.Time taken: <time> Number of available memory blocks: <number of blocks> Maximum
storage time: <time>
Warning 70045 Event <event number>: one or more blocks of data were not written to the card prior to the current block <block
number>. This problem could have occurred due to logging too fast.
Warning 70046 Event <event number> (start block <block number>, end block <block number>) is not a valid event.
Warning 70047 Event <event number> is incomplete: block <block number> was not fully written. This problem could have
occurred due to a power down at the time of memory module writing to the CompactFlash card.
Info 70048 CompactFlash card statistics: Total memory: <size> MBMemory used: <size> MBPercentage usage: <usage>%
Info 70049 Extraction complete. Time taken:<time>
Warning 70050 Possible data corruption on the card: event counter is not consecutive (last counter was <event counter>, new
counter is <event counter>).
Warning 70051 Event <event number>, block <block number>: frame <frame number> is bad (<syncword> is not a proper
syncword).
Error 70052 Invalid data source <data source name>.
Error 70053 You cannot extract data from a raw data file into another raw data file.
Error 70055 Read error at sector <sector number> (<number of bytes> bytes expected, <number of bytes> bytes read).
Error 70056 Write error at sector <sector number> (<number of bytes> bytes expected, <number of bytes> bytes written).
Error 70060 Memory module reported: write failed
Error 70061 Memory module reported: read failed
Error 70062 Memory module reported: CompactFlash card fault occurred
Error 70063 Memory module reported: current operation timed out.
Error 70064 Unknown card type <card type> in the memory module.
Error 70065 The memory module is being initialized at the moment and therefore cannot be accessed. Please power the
module down, or try again later.
Error 70066 Memory module failed to start initialization.
Error 70067 Failed to start initialization. <Reason>
Error 70068 Failed to read <number of sectors> sectors from the card, starting from sector <sector number>. <Reason>
Error 70069 Failed to read sector <sector number> on the card. <Reason>
Error 70070 Failed to write sector <sector number> on the card. <Reason>
Error 70071 NETWORK COMMUNICATION ERROR: <error description>.
Warning 70072 The Boot Sector on the CompactFlash card seems to be corrupted. Overwriting it with a backup copy...
Warning 70073 Received unexpected sector number <sector number>.
Warning 70074 Received duplicate sector number <sector number>.
Info 70075 Reading sectors <start sector>-<end sector>: connection quality is <quality >%
Info 70076 Retrieved <file name> from the card.
Warning 70077 Failed to retrieve Readme File from the card. <Reason>
Error, 70078 Failed to retrieve Strategy File from the card. <Reason>
Warning
Warning 70079 Received reply from an unknown source: <IP address>:<port number>
Warning 70080 Received incomplete reply (<number of bytes> bytes expected, <number of bytes> received).
Warning 70081 Bad response received.
Info 70082 Received non-operating response <respone>
Info 70083 Unexpected Sequence Number in the reply (expected <sequence number>, received <sequence number>).
Error 70084 Cannot obtain the status of the memory module. No connection?<Reason>
Warning 70086 There is a partition table on the card. Removing it...
Info 70087 Detected <card name>
5 Jan. 2008 | DST/S/035 23

code
Error 70088 Unable to open file <filename> for write.
Error 70089 Unable to write to file <filename>.
Error 70090 Unable to open file <filename> for append.
Error 70091 There are no video parameters listed in strategy file <filename>. Please make sure you are using the correct
strategy file.
www.acracontrol.com
24 5 Jan. 2008 | DST/S/035

KSM-500 KSM/STE/001
kProgram 1.6
Verifies and programs configuration data in KAM-500 modules
DESCRIPTION
kProgram can verify and program instrumentation based on
task information expressed in XidML. It preserves previous
calibration data, adjusting module cache images using
existing values.
kProgram verifies that the data throughput and sequencing
requirements described can be realized on the available
instrumentation, and then programs the modules.
Programming is not performed if the verification step fails.
The IP address programming option is enabled if the XidML
file contains a module that allows its IP address to be set
through Ethernet. You can select the module to program but
cannot specify the IP address; the IP address is read from
the XidML file.
IP address programming can be performed in interactive or
silent mode. Silent mode does not prompt for user interaction
FEATURES and does not perform verification or conflict checking.
• Verifies that configuration can be realized in the hardware For GUI applications, the XidML input file is prepared using
• Programs hardware kSetup.
• Uses XidML 2.41
• Configures IP addresses on ETH/101 and BCU/105
modules
APPLICATIONS
• Programs hardware with the information defined in the
XidML task file
Augmented
XidML
task file
EEPROM
kCompile listings
kSetup kQuicklook
kProgram Controller
kQuicklook
sequence
One example of where kProgram operates in the workbench flow
27 Nov. 2008 | DST/U/019 25

Selection Paths
KSM/STE/001 kProgram ships as part of the KSM-500 suite of tools; kProgram verifies and programs
instrumentation based on task information in the database
Revision History
kProgram 1.6 Supports: additional modules, see “Supported modules” Recommended for new programs
on page 29; XidML 2.41 and IP Address programming for
ETH/101 and BCU/105 modules; includes programming
support for the ADC family of modules, BCU/101/B,
BCU/101/C and BCU/105/B
kProgram 1.5 Supports additional modules including Panavia and CAN Not recommended for new programs
bus monitoring modules; see “Supported modules” on
page 29
kProgram 1.4 Supports KAD/ETH/101, KAD/FBM/103/B, Not recommended for new programs
KAM/MEM/003/E, KAD/ADC/117/E12, and
KAM/TCG/102/C
kProgram 1.3 Supports XidML 2.41 Not recommended for new programs
kProgram 1.2.2 Supports ADC/013/E, ADC/116/10V, ADC/116/10VNE, Not recommended for new programs
ENC/106, and RTC/003
kProgram 1.2 First release Not recommended for new programs
Related Products
Module Details
kQuicklook Views real-time data, or replays archived data
kSetup User interface for setup of KAM-500 system
Document Details
www.acracontrol.com
26 27 Nov. 2008 | DST/U/019

Overview
Inputs User configuration using XidML format as an input
Outputs Binary images for instrumentation
MsgML file
System requirements
Operating system Windows® 2000 SP4 or XP SP2
Hard-disk 40GB
RAM 512MB
Operating system Windows 2000 SP4 or XP SP2
Hard-disk 80GB
RAM 1024MB
27 Nov. 2008 | DST/U/019 27

Using kProgram
kProgram can be run from the command line or from a batch file. It supports both CmdML and command line arguments.
3
4
5
8
9
No. Setting Type Default Command Optional Description

line
Task String None -T<FileName> No The name of the XidML file to be programed
1
Choose Action Radio Program -A:P Yes Selecting Program: Verifies the task and
2
button programs the hardware
-A:V Selecting Verify Task: Verifies the task only
-A:I Selecting Program IP Address: Programs the
requested IP address
Mode String Interactive -S:I Yes Selecting Interactive will prompt the user
3
-S:S during IP address programming.
Selecting Silent will not prompt the user and
does not validate the new IP address
Module String None -M<Module Yes Selects the module to have its IP address
4
Name> programmed
IP Address None None None Yes Displays the IP address to program

5
Configuration Selection As -L:SDX Yes Selects SAM/DEC

6
link configured -L:STD Selects the link which is currently specified in
per task the task file

7
Medium -V:M Medium: generates Errors and Warnings
Low -V:L Low: generates Errors
CmdML file String None -C Yes Specifies CmdML file the tool will use
8
Display next All All -G Yes Determines display of tool next time it is run
9
time Progress
None
Getting the most from kProgram

kProgram can verify multiple-format tasks and program the hardware with the resulting module cache images. When verifying
large formats, computation time can be reduced by adding more RAM to the PC.
Refer to the ETH/101and BCU/105/B data sheets for programming the IP address on modules.
28 27 Nov. 2008 | DST/U/019

Supported modules
kProgram 1.6 supports the following modules:
KAD/ADC/001 KAD/ADC/014/D/25m KAD/BCU/101 KAD/MBI/001

KAD/ADC/002/C/100m KAD/ADC/021 KAD/BCU/101/B KAD/MBI/001/B
KAD/ADC/002/C/10V KAD/ADC/021/RT KAD/BCU/101/C KAD/MBI/102
KAD/ADC/002/C/1V KAD/ADC/105 KAD/BCU/102 KAD/MDC/001
KAD/ADC/003 KAD/ADC/105/B KAD/BCU/105/B KAD/MDC/002
KAD/ADC/005 KAD/ADC/106 KAD/BIT/101 KAD/MDC/103
KAD/ADC/006 KAD/ADC/106/B KAD/CBC/101 KAD/MEM/004/4G
KAD/ADC/008 KAD/ADC/106/C KAD/CBM/101 KAD/MEM/004/B/12G
KAD/ADC/009/QB100 KAD/ADC/109/B/QB120 KAD/CBM/102 KAD/MEM/004/B/24G
KAD/ADC/009/QB350 KAD/ADC/109/B/QB350 KAD/CDC/002 KAD/MEM/004/B/4G
KAD/ADC/009/S1 KAD/ADC/109/B/S1 KAD/CDI/101 KAD/MEM/004/B/6G
KAD/ADC/009/S2 KAD/ADC/109/B/S2 KAD/DAC/001 KAD/MSB/001/B
KAD/ADC/009/S4 KAD/ADC/109/C/QB120 KAD/DAC/002 KAD/MSB/003
KAD/ADC/010/C KAD/ADC/109/C/QB350 KAD/DEC/003 KAD/MSB/003/B
KAD/ADC/011/B/10V KAD/ADC/109/C/S1 KAD/DPI/002 KAD/MSB/103
KAD/ADC/011/B/40V KAD/ADC/109/C/S2 KAD/DSI/002 KAD/MSB/103/B
KAD/ADC/011/C/10V KAD/ADC/109/S1 KAD/DSI/003 KAD/PBM/002
KAD/ADC/011/C/40V KAD/ADC/113 KAD/DSI/003/B KAD/RTC/003
KAD/ADC/012/B/100m KAD/ADC/116/10V KAD/DSI/004/28V KAD/SDC/001
KAD/ADC/012/B/10V KAD/ADC/116/10VNE KAD/DSI/105 KAD/SDC/002/90V
KAD/ADC/012/B/40V KAD/ADC/116/1V KAD/EBM/101 KAD/SDI/001
KAD/ADC/012/C/100m KAD/ADC/117 KAD/ENC/004 KAD/SDI/103
KAD/ADC/012/C/10V KAD/ADC/117/B KAD/ENC/005 KAD/SIG/101
KAD/ADC/012/C/1V KAD/ADC/117/B/E12 KAD/ENC/005/B KAD/TCG/001
KAD/ADC/012/C/40V KAD/ADC/117/E12 KAD/ENC/005/B/RS KAD/TCG/001/B
KAD/ADC/013/B KAD/ADC/117/EC1 KAD/ENC/006/HA1 KAD/TCG/001/C
KAD/ADC/013/C KAD/ADC/118/100m KAD/ENC/006/X1 KAD/TDC/002/C
KAD/ADC/013/D KAD/ADC/118/10V KAD/ENC/006/X2 KAD/TDC/002/D
KAD/ADC/013/E KAD/ADC/118/1V KAD/ENC/006/X5 KAD/TDC/002/D/10m
KAD/ADC/014/B/100m KAD/ADC/120/100m KAD/ENC/106 KAD/TDC/005
KAD/ADC/014/B/10V KAD/ADC/120/10V KAD/ETH/001/B KAD/TDC/006
KAD/ADC/014/B/1V KAD/ADC/120/1V KAD/ETH/001/C KAD/TDC/006/RT
KAD/ADC/014/C/100m KAD/ARI/001 KAD/ETH/101 KAD/UAR/001
KAD/ADC/014/C/10V KAD/ARI/001/B KAD/FBM/102 KAD/UAR/002
KAD/ADC/014/C/1V KAD/ARI/103 KAD/FBM/103 KAD/UAR/002/B
KAD/ADC/014/D/100m KAD/BCU/001 KAD/FBM/103/B KAD/UAR/002/C
KAD/ADC/014/D/10V KAD/BCU/001/B KAD/LDC/101/10k KAD/UAR/102
KAD/ADC/014/D/1V KAD/BCU/001/CX KAD/LDC/101/5k KAD/UAT/101
27 Nov. 2008 | DST/U/019 29

KAD/UTL/102 KAM/DEC/002 KAM/MEM/003/E KAM/TCG/102/C
KAD/VDC/001 KAM/DSI/002 KAM/MEM/103 MKM/ADC/014/R1
KAD/VID/103 KAM/FBM/001 KAM/MSB/001 MKM/ADC/014/R2
KAM/ADC/004 KAM/FBM/001/B KAM/PBM/001 MKM/BCU/101
KAM/CDC/001 KAM/MEM/003 KAM/RTC/002 MKM/UAR/102
KAM/CDC/001/C KAM/MEM/003/B KAM/SBM/001
KAM/CDC/101/300 KAM/MEM/003/C KAM/TCG/102
KAM/CDC/101/6K KAM/MEM/003/D KAM/TCG/102/B
kProgram 1.6 provides limited support for some modules.
kProgram messages
Info 20001 Task <task name> was verified successfully.
Error 20002 Task <task name> failed verification.
Info 20003 Task <task name> programmed successfully.
Error 20004 Task <task name> failed to program.
Info 20005 Task <task name> was translated successfully.
Error 20006 Task <task name> failed translation.
Error 20007 Shunt format < number > is not up-to-date. This file will be ignored.
Error 20008 IP Address Programming failed.
Error 20009 Network not available.
Error 20010 Compatible network interface not available.
Error 20011 IP address <ip address> already exists. Please choose a unique address or remove existing module from the
network.
Info 20012 Place the module in IP address programming mode.
Info 20013 Remove the module from its IP address programming mode. The network connection will be momentarily
disconnected before being reconnected.
Info 20014 Do you wish to verify the new IP address?
Error 20015 IP address < ip address > was not found, programming was not successful.
Info 20016 IP address < ip address > was found, programming was successful.
Info 20017 Programming terminated by user.
Error 20018 Invalid IP address entered.
Info 20019 Verify if IP address was terminated by user.
Info 20020 Starting to program IP address: < ip address >.
kProgram 1.6 produces the above MsgML messages. See Interpreting MsgML in the KSM-500 Databook for a list of messages
common to all KSM-500 tools.
As kProgram 1.6 is based on tools previously available in KSMv2, it has only limited support for MsgML. For further information
such as the location of log files for kProgram, see Directory structure in the KSM-500 Databook.
www.acracontrol.com
30 27 Nov. 2008 | DST/U/019

KSM-500 KSM/STE/001
kQuicklook 2.0.1
Views real-time data, or replays archived data
APPLICATIONS
• Viewing real-time data
• Replaying real-time data
DESCRIPTION
kQuicklook consists of four applications:
• Quicklook Realtime reads data and displays it
• Quicklook Replay records and replays streamed data
• Quicklook Setup configures graphic displays
• Quicklook Editor creates custom graphic displays
kQuicklook is a stand-alone program that allows real-time
data to be viewed on a user-defined display using an
independent output format for each parameter viewed.
Display styles include dials, graphs and numbers. kQuicklook
also allows playback of recorded data.
kQuicklook is designed for data analysis and processing in
FEATURES real-time.
• Configurable data display

• Real-time data streamed through SAM/DEC/007 or
Ethernet
• Logs and replays data
• Customizable display screens
• IENA decommutation support
• Support for XidML 2.41
• Support for CompactFlash®
...
kSetup kQuicklook
kQuicklook
kProgram
One example of where kQuicklook operates in the workbench flow
5 Jan. 2009 | DST/U/021 31

Selection Paths
KSM/STE/001 kQuicklook ships as part of the KSM-500 suite of tools; XidML based software tool for viewing
real-time data and replaying archived data
Revision History
kQuicklook 2.0.1 Incorporates a number of important bugfixes - see release Recommended for new programs
notes for details
kQuicklook 2.0 Supports XidML 2.41 for viewing real-time data and replaying Not recommended for new programs
archived data
kQuicklook 1.1 First release Not recommended for new programs
Related Products
Module Details
SAM/DEC/007 KAM-500 programming interface with IRIG-106 PCM decoder
ETH/001 KAM-500 100 Base TX Ethernet interface for programming and data acquisition
MEM/004 KAM-500 CompactFlash card module with Ethernet interface
MEM/003/C KAM-500 CompactFlash card module with removable CompactFlash media
KSM-500 KSM-500 suite of tools
Document Details
TEC/NOT/027 An overview of the IRIG-106-96 Ch. 4 standard
TEC/NOT/038 Using the KAD/ETH/001/B
DOC/DBK/001 KAM-500 Databook
www.acracontrol.com
32 5 Jan. 2009 | DST/U/021

Overview
Requirements: SAM/DEC/007 or Ethernet port
Input: Task name

Instrument name
Acquisition format
Package name
Action
Output: Display of real time data

Replay of logged data
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/U/021 33

Using kQuicklook
Select a Task and a Choose Action radio button from the kQuicklook interface.
5
6
5
10
11
To set up IENA decommutation, select a task that has an Ethernet module and IENA packet(s) associated with it. Ethernet
package frame will now become available in the Package drop-down list. Select the Ethernet frame name and proceed as
usual. For more information on how to set up and use IENA decom in kQuicklook see the Quicklook User Manual.
kQuicklook can be run from the command line or from a batch file. It supports both CmdML and command line arguments.
Setting Type Default Command line Optional Description
Task String None -T No Acts on the given Task name as input.

1
Instrument String None -I <Instrument name> No Specifies one of the DAU controller
2
("X-DAU-Controller-PCM-1.2"), PCM Transmitter
("X-Module-PCM-Out-1.2") or Ethernet Transmitter
("X-Module-Ethernet-1.1") instruments contained in
the Task file.
Format String None -F <Acquisition format No Specifies the acquisition format of the item selected
3
number> in the Instrument field.
Package String None -P <PCM frame name> No Selects a package to use with a task.
4
-P <Ethernet frame
name>
Action String None -A:RLT No Launches Quicklook Realtime.

5
Action String None -A:SET No Launches Quicklook Setup.

6
Action String None -A:REP No Launches Quicklook Replay.

7
Action String None -A:ED No Launches Quicklook Editor.

8
Verbosity High High -V:H Yes High: generates all messages.

9
Medium -V:M Medium: generates Errors and Warnings.
Low -V:L Low: generates Errors.
10
34 5 Jan. 2009 | DST/U/021

Display All All -G Yes Determines display of tool next time it is run.
11
next time Progress
None
Package String None -Y:P Specifies a package type of selected Package.

Type -Y:E P - PCM package
-Y:M E - Ethernet/IENA package
M - Memory module package
This setting is not available in the GUI.
Getting the most from kQuicklook

In this section, we create a kQuicklook setup. Once
kProgram has finished programming, the encoder will
automatically start outputting PCM data. kQuicklook offers a
full graphical display of charts, graphs, display units and other
visual representations. In this section we will set up several
display formats. This section assumes you have a
programmed system with a built frame, with a BCU/001,
ADC/005, DSI/002 and TCG/001.
Setting up kQuicklook
1. Select a Task you have defined in kSetup.
2. Select an Instrument you have defined in kSetup.
3. Select a Format you have defined in kSetup.
4. Select a Package you have defined in kSetup.
4. Click OK.
5. Select the Quicklook Setup radio button.
6. Click OK.
Configuring 4 Frame RT display with DSI/002 channel
7. Right-click Real time display.
data
8. Click Append.
9. Select a frame from the list in the Real time displays 1. Double-click 4 Frame RT display in the kQuicklook
dialog box. setup window.
10. Click Append. 2. Select DSI2_0_J6_CTR1 from the channels panel on the
11. Click OK. right of the kQuicklook setup window.
3. Double-click panel Frame 2 in the 4 frame RT display
dialog box.
4. Using the Ctrl key, select DSI2_0_J6_CTR2 and
DSI2_0_J6_CTR3 from the channels panel on the right
of the kQuicklook setup window.
dialog box.
6. Using the Shift key, select the remaining DSI/002
channels from the channels panel on the right of the
kQuicklook setup window.
dialog box.
Configuring 1 Frame RT display with ADC/005 channel

data
1. Double-click 1 Frame RT display in the kQuicklook setup
window.
2. Select the ADC/005 channels from the channels panel
on the right of the kQuicklook setup window, use the Ctrl,
and Shift keys to select multiple channels.
3. Double-click in the Frame 1 panel in the 1 frame RT
display dialog box.
8. Click OK.
5 Jan. 2009 | DST/U/021 35

Configuring 12 display units Viewing 1 Frame real-time display
1. Double-click 12 display units in the kQuicklook setup 1. Select Display - Window - 1 Frame RT display.
window.
2. Select ADC5_0_J4_Ch0 from the channels panel on the
2. Click Go.
right of the kQuicklook setup window.
3. Double-click the Display unit 1 panel in the 12 display
units dialog box. The real-time data is displayed in graphical form.
4. Repeat for the other eleven required channels.
Viewing data with kQuicklook

1. Right-click BCU/001. Viewing 4 Frame real-time display
2. Select Quicklook.
1. Select Display - Window - 4 Frame RT display.
3. A blank demonstration board is launched, with no data.
2. Click Go.
4. Verify the FS LED icon is green.
A green FS LED indicates correct major frame The real-time data is displayed in four panels on the
synchronization. A green ID LED indicates correct minor demonstration board.
frame synchronization.
36 5 Jan. 2009 | DST/U/021

Viewing 12 real-time display units
1. Choose Display - Window - 12 display units.
2. Click Go.
The real-time data is displayed in twelve panels on the

demonstration board.
For further information on using kQuicklok, see the Quicklook
User Manual.
5 Jan. 2009 | DST/U/021 37

kQuicklook messages
Level Message Code Message
Error 40001 Task name not supplied
Error 40002 Instrument name not supplied
Error 40003 Format name not supplied
Error 40004 Package name not supplied
Error 40005 Failed to create directory <directory name>
Error 40006 Cannot find file <file name>
Error 40007 Cannot open file <file name>
Error 40008 Failed to generate XML file <file name>
Error 40010 Unknown task <task name>
Error 40013 Failed to process command line options
Error 40016 Not enough memory
Error 40017 Unknown action <action name>
Error 40018 Task <Task name> does not contain any data transmission instruments
Error 40019 Instrument <Instrument name> does not exist
Error 40020 Format <Format number> does not exist
Error 40021 Task <Task name> does not contain any data transmission packages
Error 40022 Package <Package name> does not exist
www.acracontrol.com
38 5 Jan. 2009 | DST/U/021

KSM-500 KSM/STE/001
kSetup 1.6
User interface for setup of KAM-500 system
DESCRIPTION
kSetup creates and defines Tasks representing KAM-500
instrumentation. The Task Explorer enables you to visualize a
Task through a standard windows tree view and construct a
Task with DAUs and modules.
The Module Setup panel enables you to define module and
parameter settings.
Each module is described in a corresponding KSM-500 data
sheet. It is possible to construct IRIG-106 PCM frames by
selecting the FrameBuilder icon on an encoder screen.
This data sheet shows you how to navigate the kSetup GUI,
and provides instructions for creating a Task.
FEATURES
• Creates Tasks and allows Task information to be added,
removed and defined
• Navigates through a Task hierarchy from DAU to module
• Builds packages and frames
• Provides online data sheets and interactive pinouts
• Supports XidML 2.41
APPLICATIONS
• FTI systems
...
kQuicklook
kSetup kProgram kQuicklook
One example of where kSetup operates in the workbench flow
27 Nov. 2008 | DST/U/017 39

Selection Paths
KSM/STE/001 kSetup ships as part of the KSM-500 suite of tools; user interface for setup of KAM-500 system
Revision History
kSetup 1.6 Supports MEM/103, SDI/103, BCU/105/B and XidML 2.41 Recommended for new programs
kSetup 1.5 Supports additional modules including Panavia and CAN Not recommended for new programs
bus monitoring modules; see “Supported modules” on
page 47
kSetup 1.4 Supports KAD/ETH/101, KAD/FBM/103/B, Not recommended for new programs
KAM/MEM/003/E, KAD/ADC/117/E12, and KAM/TCG/102/C
kSetup 1.3 Supports XidML 2.41 Not recommended for new programs
kSetup 1.2.2 Supports ADC/013/E, ADC/116/10V, ADC/116/10VNE, Not recommended for new programs
ENC/106, and RTC/003
kSetup 1.2 Additional module support Not recommended for new programs
kSetup 1.1 First release Not recommended for new programs
Related Products
Module Details
SAM/DEC/007 KAM-500 programming interface with IRIG-106 PCM decoder
KSM-500 KSM-500 suite of tools
Document Details
TEC/NOT/027 An overview of the IRIG-106-96 Chapter 4 standard
www.acracontrol.com
40 27 Nov. 2008 | DST/U/017

Overview
Inputs User configurations; XidML configurations
Outputs User configuration in the XidML file
System requirements
Operating system Windows® 2000 SP4 or XP SP2
Hard-disk 40GB
RAM 512MB
Operating system Windows 2000 SP4 or XP SP2
Hard-disk 80GB
RAM 1024MB
27 Nov. 2008 | DST/U/017 41

Using kSetup
kSetup is a graphic interface for configuring KAM-500 hardware. This section identifies the areas of the kSetup interface.
1 4 5 7
3
6
Menu and Standard toolbar: You can access menu items in this panel. See “Using Menu and Standard toolbars” on page 43.
1
Task Explorer: Multiple Tasks and modules can be navigated using Task Explorer. See “Using Task Explorer” on page 43.
2
Status bar: Information on the current software process is displayed in the status bar. See “Viewing the Status bar” on page 44.
3
Acquisition Cycle toolbar: You can set the acquisition cycle for Ethernet acquisition from the edit box and view the current
4
acquisition rate. See “Using the Acquisition Cycle toolbar” on page 44.
Module Setup panel: You can configure module parameters and channels in this area. This is the only section of the interface which
5
changes with each module. See “Using the Module Setup panel” on page 45.
Module Setup functions: kSetup functions can be accessed using these buttons, this is part of the Module Setup area. See “Using
6
Module Setup functions” on page 44.
Module information panel: Information on the module you are configuring is displayed in this panel, this is part of the Module Setup
7
panel. See “Viewing the Module Information panel” on page 45.
Message Server: All messages generated from kSetup are displayed in the Message Server. kSetup does not support MsgML. The
8
Message Server is always running in a separate interface from kSetup.
42 27 Nov. 2008 | DST/U/017

1 Using Menu and Standard toolbars Right-click an icon to see the setup options for that Task or
hardware.
The Standard toolbar shows all options in kSetup.
1.1 1.2
New Task: Launches a new Task in Task Explorer.

1.1
Open Task: Opens an existing Task and displays it in Task

1.2 Explorer.
Task Explorer displays the following icons:
Creating new Tasks • represents a Task

A Task is a representation of your hardware system, which is • represents a DAU
displayed in Task Explorer. This can include multiple DAUs in
multiple setups. kSetup displays a system configuration as a • represents a blank user-slot
Task. All Tasks can be navigated in Task Explorer. To create a • represents an installed module
new Task:
• Select File - New. Adding modules
A new Task is displayed in Task Explorer. To add a module in a module slot:
1. Click the plus icon beside the DAU icon.
Opening Tasks 2. Right-click a user-slot.
To open an existing Task:
1. Select File - Open.
2. Select the XidML file you require in the file open dialog
box.
3. Click Open.
You can navigate the Task in Task Explorer.
Saving Tasks
To save a Task:
• Select File - Save.
Deleting Tasks
To delete a Task:
1. Right-click on the Task in the project tree.
2. Select Remove Task.
3. Select Change Module.
4. Select the tab of the module type.
Adding hardware
To add hardware:
1. Right-click on the Task in the project tree.
2. Select Add Hardware.
3. Select the chassis you require from the list.
2 Using Task Explorer

Task Explorer displays a hierarchical tree structure of
installed DAUs and modules. This means the software setup
can mirror your hardware setup. Defined Tasks can be
navigated in Task Explorer.
• Click the plus sign beside a Task or hardware to view

more of the hierarchy.
5. Select a module.
6. Click OK.
The new module is displayed in Task Explorer.
27 Nov. 2008 | DST/U/017 43

Removing modules Setting an acquisition cycle
To remove a module: You can set an acquisition cycle in two ways:
1. If closed, click the plus icon beside the DAU icon. • Using the Acquisition Cycle toolbar.
2. Right-click the module icon. • Setting the acquisition cycle using Frame Builder.
3. Select Remove Module. See Solving inconsistent frames and Building IRIG-106 PCM
4. Click Yes to remove the module. frames in the KSM-500 Databook.
The module is removed in Task Explorer.
Setting an acquisition cycle using the
Copying and pasting modules toolbar
To copy a module: You can set the acquisition cycle using the acquisition cycle
toolbar. To set the acquisition cycle:
1. Right-click a module icon.
2. Select Copy Module. 1. Type a value in the Acquisition Cycle edit box at the top
of kSetup.
The module configuration is saved as an XML file.
2. Select a unit from the drop-down list box.
To paste a copied module:
The acquisition rate is displayed.
1. Right-click a blank user-slot.
ACRA CONTROL recommends that the acquisition cycle
2. Select Paste Module.
chosen should not be greater than 1s. If an acquisition cycle
The module is displayed in Task Explorer. greater than 1s is chosen, the following warning appears:
Setting up modules
To configure a module:
1. Right-click a module icon or double-click a module

in Task Explorer.
2. Select Module Set-up.
The Module Setup is displayed in the Module Setup panel.
For information on setting up specific modules, see the
respective KAM-500 data sheet.
5 Using Module Setup functions
3 Viewing the Status bar Setup functions vary for each module. The default functions
are listed below.
The Status bar shows the last message generated by kSetup.
5.1 5.2 5.3 5.4 5.5 5.6
4 Using the Acquisition Cycle toolbar
The Acquisition Cycle toolbar displays the acquisition rate
and lets you edit the acquisition cycle. For further information,
see Building IRIG-106 PCM frames in the KSM-500 Save: Saves changes you have made to module
5.1
Databook. configuration.
Cancel: Cancels changes you have made to module
5.2
4.1 4.2 4.3 4.4 configuration.
Defaults: Returns Module properties to their default
5.3
settings.
Close: Closes the Module Setup panel.
. 5.4
Name Value Description
Data Sheet: Launches a .pdf data sheet for the selected
Acquisition 120µs Enter the required acquisition cycle 5.5
4.1 module. See “Viewing module data sheets” on page 44.
Cycle edit to 1s to achieve the required acquisition
Pin Out: selecting this button displays the pin out wiring
box rate. 5.6
information for the selected hardware. See “Viewing
Acquisition µs, ms, Select the units for the acquisition connector pin information” on page 45.
4.2
Cycle list box s cycle.
Acquisition The Acquisition Rate is displayed
4.3
5.5 Viewing module data sheets
Rate edit box and cannot be edited.
Acquisition Hz, Select the units for the Acquisition Data sheets provide details on KAM-500 hardware. To view
4.4 data sheets:
Rate list box kHz rate.
• Click Data Sheet.
The data sheet pdf opens.
44 27 Nov. 2008 | DST/U/017

5.6 Viewing connector pin information 6.4
Major Frames per Acquisition Cycle: Displays the
acquisition rate of the module. This is only displayed in Data
Use the Connector Information screen as an aid when wiring Acquisition modules.
connector pins for KAM-500 modules. When you move the
mouse across pins in the picture of the connector pinout 5.6.5 , 7 Using the Module Setup panel
a description of the pin that the pointer is over appears in the
The Module Setup panel is where you configure settings of
Pin Description panel 5.6.7 . The pin’s name, number, wiring each module. The Module Setup panel varies for each
color, I/O, pin description and channel are also displayed. module. This section explains the function of the fields and
buttons which are common to all data acquisition modules.
The parameters tab is for parameter setup.
5.6.1 5.6.2
All module properties are displayed in rows and columns on
the Module Setup panel. There may be additional tabs at the
top of Module Setup properties for channels and so on. For
more information on configuring a specific module, see the
5.6.3 5.6.4 respective KAM-500 data sheet.
5.6.5 7.1
7.2
7.3
5.6.6
5.6.7
Column heading: The title of the column
7.1
Filter row: Filters displayed data.

7.2
5.6.8
Module Configuration panel: Displays configurable
7.3
module properties.
KAD Connector tab: Displays connector pin information
5.6.1 for KAD modules. 7.2 Filtering rows
KAM Connector tab: Displays connector pin information
5.6.2 for KAM modules. You can reduce the number of displayed items according to
search criteria. To filter rows:
Pin drop-down list: Select a pin number from the
5.6.3 drop-down list to display information on that pin. 1. Append any text to “*” in the filter row.
2. Press Enter.
Pin Name: Shows the pin name.
5.6.4 The display shows parameters that have matching text in that
Connector pin interactive display: Move the mouse over
column. You can use '*' as a wild card to indicate "any text".
5.6.5 a pin to display connector pin information.
Sorting rows
Wiring Color: Colors of the wire of the selected pin.
5.6.6 You can choose how information in rows is to be displayed.
To sort rows:
Pin Description: Brief description of the function of the
5.6.7 connector pin. 1. Right-click the module configuration panel.
Close: Closes the Connector Information window 2. Select Sort.
5.6.8
This displays the Sort dialog box. You can sort by numeric
value, in ascending or descending order.
6 Viewing the Module Information panel
Editing columns
The information displayed in the information panel is detected
by kSetup from installed hardware. This information is not To edit an entire column:
editable. 1. Click the column heading to select the column.
2. Type a value in the editable first row.
3. Press Enter.
The value is placed in the entire column
Use the Shift and Ctrl keys to select multiple

6.1 6.2 6.3 6.4
cells in a column. Changing the value of one
.
selected cell changes the value of all selected
cells.
DAU: Displays the part number of the DAU the module is
6.1
installed in.
Slot: Displays which slot in the DAU the module is installed
7.3 Editing Module Setup panel cells
6.2
to.
In the Module Setup panel, data is displayed in a cell with
Module: Displays the part number of the selected module. three different background colors:
6.3
27 Nov. 2008 | DST/U/017 45

• Gray background - data is read only.
• Yellow background - information only.
• White background - data can be changed.
You can copy and paste multiple cells by

highlighting cells, then select Ctrl + C to copy
cells, select Ctrl + V to paste cells.
To change the contents of a cell, click on the

cell, and type the new entry. Press Enter or
de-select the cell to make the change. If an
entry is invalid, the cell content will not be
changed.
Resizing the module configuration panel 7. Select Next.

To resize the display of the module properties shown in the
module configuration panel:
1. Right-click the configuration panel.
2. Select Autosize.
The module properties spreadsheet is displayed at its
minimum size.
Getting the most from kSetup

The following section shows how to create a Task, add a
DAU, add a module to the DAU and set up an IRIG-106 PCM
frame.
1. Add a Task.
8. Select Next.
2. Add a DAU - the encoder is automatically configured in

your selected DAU.
9. Select Finish.
3. Add an analog module. Use kProgram to verify and program the Task. Use
4. Double-click the encoder module icon to activate the kQuicklook to view data from the Task.
encoder.
5. Click Frame Builder to start Frame Builder.
6. Select a Create new frame option.
46 27 Nov. 2008 | DST/U/017

Supported modules
kSetup 1.6 supports the following modules:
KAD/ADC/001 KAD/ADC/014/C/1V KAD/ADC/120/10V KAD/ENC/006/X1
KAD/ADC/002/C/100m KAD/ADC/014/D/100m KAD/ADC/120/1V KAD/ENC/006/X2
KAD/ADC/002/C/10V KAD/ADC/014/D/10V KAD/ARI/001 KAD/ENC/006/X5
KAD/ADC/002/C/1V KAD/ADC/014/D/1V KAD/ARI/001/B KAD/ENC/106
KAD/ADC/003 KAD/ADC/014/D/25m KAD/ARI/103 KAD/ETH/001/B
KAD/ADC/005 KAD/ADC/021 KAD/BCU/001 KAD/ETH/001/C
KAD/ADC/006 KAD/ADC/021/RT KAD/BCU/001/B KAD/ETH/101
KAD/ADC/008 KAD/ADC/105 KAD/BCU/001/CX KAD/FBM/102
KAD/ADC/009/QB100 KAD/ADC/105/B KAD/BCU/101 KAD/FBM/103
KAD/ADC/009/QB350 KAD/ADC/106 KAD/BCU/101/B KAD/FBM/103/B
KAD/ADC/009/S1 KAD/ADC/106/B KAD/BCU/101/C KAD/LDC/101/10k
KAD/ADC/009/S2 KAD/ADC/106/C KAD/BCU/102 KAD/LDC/101/5k
KAD/ADC/009/S4 KAD/ADC/109/B/QB120 KAD/BCU/105/B KAD/MDC/001
KAD/ADC/010/C KAD/ADC/109/B/QB350 KAD/BIT/101 KAD/MDC/002
KAD/ADC/011/B/10V KAD/ADC/109/B/S1 KAD/CBC/101 KAD/MDC/103
KAD/ADC/011/B/40V KAD/ADC/109/B/S2 KAD/CBM/101 KAD/MEM/004/4G
KAD/ADC/011/C/10V KAD/ADC/109/C/QB120 KAD/CBM/102 KAD/MEM/004/B/12G
KAD/ADC/011/C/40V KAD/ADC/109/C/QB350 KAD/CDC/002 KAD/MEM/004/B/24G
KAD/ADC/012/B/100m KAD/ADC/109/C/S1 KAD/CDI/101 KAD/MEM/004/B/4G
KAD/ADC/012/B/10V KAD/ADC/109/C/S2 KAD/DAC/001 KAD/MEM/004/B/6G
KAD/ADC/012/B/40V KAD/ADC/109/S1 KAD/DAC/002 KAD/MSB/001/B
KAD/ADC/012/C/100m KAD/ADC/113 KAD/DEC/003 KAD/MSB/003
KAD/ADC/012/C/10V KAD/ADC/116/10V KAD/DPI/002 KAD/MSB/003/B
KAD/ADC/012/C/1V KAD/ADC/116/10VNE KAD/DSI/002 KAD/MSB/103
KAD/ADC/012/C/40V KAD/ADC/116/1V KAD/DSI/003 KAD/MSB/103/B
KAD/ADC/013/B KAD/ADC/117 KAD/DSI/003/B KAD/RTC/003
KAD/ADC/013/C KAD/ADC/117/B KAD/DSI/004/28V KAD/SDC/001
KAD/ADC/013/D KAD/ADC/117/B/E12 KAD/DSI/105 KAD/SDC/002/90V
KAD/ADC/013/E KAD/ADC/117/E12 KAD/EBM/101 KAD/SDI/001
KAD/ADC/014/B/100m KAD/ADC/117/EC1 KAD/ENC/004 KAD/SDI/103
KAD/ADC/014/B/10V KAD/ADC/118/100m KAD/ENC/005 KAD/SIG/101
KAD/ADC/014/B/1V KAD/ADC/118/10V KAD/ENC/005/B KAD/TCG/001
KAD/ADC/014/C/100m KAD/ADC/118/1V KAD/ENC/005/B/RS KAD/TCG/001/B

KAD/ADC/120/100m
KAD/ADC/014/C/10V KAD/ENC/006/HA1 KAD/TCG/001/C
27 Nov. 2008 | DST/U/017 47

KAD/TDC/002/C KAD/UAR/002/C KAM/CDC/101/300 KAM/MEM/103
KAD/TDC/002/D KAD/UAR/102 KAM/CDC/101/6K KAM/MSB/001
KAD/TDC/002/D/10m KAD/UAT/101 KAM/DEC/002 KAM/TCG/102
KAD/TDC/005 KAD/UTL/102 KAM/MEM/003 KAM/TCG/102/B
KAD/TDC/006 KAD/VDC/001 KAM/MEM/003/B KAM/TCG/102/C
KAD/TDC/006/RT KAD/VID/103 KAM/MEM/003/C
KAD/UAR/001 KAM/ADC/004 KAM/MEM/003/D
KAD/UAR/002 KAM/CDC/001 KAM/MEM/003/E
KAD/UAR/002/B KAM/CDC/001/C KAM/RTC/002
kSetup messages
kSetup 1.6 does not output any messages to the MsgML file. However it does output legacy messages to the KSM-500
Message Server.
www.acracontrol.com
48 27 Nov. 2008 | DST/U/017

KSM-500 KSM/STE/001
kTimeseed 1.2
Sets the time on an RTC/002 or RTC/003 (RTC/00x) module
DESCRIPTION
kTimeseed is a stand-alone utility that sets the time of an
RTC/00x module in a KAM-500 DAU. The time can be
user-specified or synchronized to the PC with an accuracy
within one second.
A single RTC/00x module is time seeded and it can be
specified through the GUI or CmdML options. kTimeseed
retrieves the system controller configuration, seeds the time
into the system and reprograms the controller with the
original configuration.
kTimeseed does not support time seeding in a CAIS or a
FEATURES SLAVE DAU.
• Seeding of time in systems using RTC/00x
• RTC/00x time can be user-specified
• RTC/00x can be synchronized with PC time
• Ethernet and SAM/DEC/007 support
APPLICATIONS
• Seeding of time in systems using RTC/00x
MsgML
file
kTimeseed
One example of where kTimeseed operates in the work flow
5 Jan. 2009 | DST/T/084 49

Selection Paths
KSM/STE/001 kTimeseed ships as part of the KSM-500 suite of tools; kTimeseed sets the time on an RTC/00x
module
Revision History
kTimeseed 1.2 Fixes the MEM/004 extra event logging issue found on Recommended for new programs
some CompactFlash® cards during time seeding
kTimeseed 1.0 First release Not recommended for new programs
Related Products
Module Details
RTC/003 Real-time clock generator with memory status outputs
RTC/002 Real-time clock generator for KAM-500 systems
Document Details
www.acracontrol.com
50 5 Jan. 2009 | DST/T/084

Overview
Requirements: Configuration link to hardware, hardware must be powered on
Input: CmdML file (or equivalent command line or GUI options)
Output: MsgML file
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/084 51

Using kTimeseed
kTimeseed can be run from the GUI or command line. It supports both CmdML and command line arguments. Specifying the
KAM-500 slot will speed up the execution time.
2
1 5
6
7
8
3
9
10
11
4
12
13
14
Configuration Select from: SAM/DEC -L:P No Determines the configuration

1
Link SAM/DEC -L:E<ip address> link that kTimeseed will use to
or Ethernet interrogate connected hardware.
IPAddress String None See Configuration This is required if IP address of Ethernet module.
2
Link configuration link
used is Ethernet.
Module Radio Automatic -M:AUTO No Searches for an RTC/00x

3
Selection button module and time seeds the first
one it finds.
-M:MAN Manual option time seeds the
specified RTC/00x.
Slot String None -J<slot> Yes, it is required if The slot that the module is in.
4
the manual option
in Module
Selection is
specified.
Choose Action Radio Synchronize -S:PC No Synchronizes the module to the

5
button to PC Time PC time.
-S:TIME Sets the time from the specified
time options listed below.
Year String PC times year -Y<year> No, if the Time Numeric value for year.
6
option of Choose
Action is specified;
otherwise ignored.
Month String PC times -O<month> No, if the Time Numeric value for month.
7
month option of Choose
otherwise ignored.
Day of Month String PC times day -N<day of month> No, if the Time Numeric value for day of month.
8
of month option of Choose
otherwise ignored.
52 5 Jan. 2009 | DST/T/084

Hours String PC times -U<hours> No, if the Time Numeric value for hours.
9
hours option of Choose
otherwise ignored.
Minutes String PC times -I<minutes> No, if the Time Numeric value for minutes.
10
minutes option of Choose
otherwise ignored.
Seconds String PC times -E<seconds> No, if the Time Numeric value for seconds.
11
seconds option of Choose
otherwise ignored.
Verbosity High High -V:H Yes High: generates all messages.

12
Medium -V:M Medium: generates Errors and
Low -V:L Warnings.
Low: generates Errors.
CmdML file String None -C Yes Specifies CmdML file the tool
13
will use.
Display next All All -G Yes Determines display of tool next

14
time Progress time it is run.
None
Getting the most from kTimeseed

Ensure the DAU is powered on and the configuration link is connected. The RTC/00x can only be time seeded in a
MASTER KAM-500 DAU. kTimeseed only supports the BCU/101 controller family.
5 Jan. 2009 | DST/T/084 53

kTimeseed messages
51003 Error Failed to load time to the RTC/00x module.
51009 Error No RTC/00x module found in the MASTER KAM-500 DAU.
51010 Error No RTC/00x module found in the requested slot <slot number>.
51011 Error No RTC/00x module found in the requested KAM-500 DAU <dau_id> and slot <slot number>.
51013 Error Failed to save the controller format <format number> to file <file name>.
51014 Error Failed to reprogram the controller format <format number>.
51015 Error Failed to program the time seeding format.
51016 Error Failed to erase the time seeding format.
51017 Error Invalid year specified, <year>.
51018 Error Invalid month specified, <month>.
51019 Error Invalid day specified, <day>.
51020 Error Invalid hour specified, <hour>.
51021 Error Invalid minute specified, <minute>.
51022 Error Invalid seconds specified, <second>.
51024 Error Invalid slot specified <slot number>.
51025 Error Failed to set time in template file <file name>.
51052 Info Removing the controller file <file name>.
51053 Info PC time is <date and time>.
51054 Info Starting to time seed the RTC/00x module in KAM-500 DAU <dau number> slot <slot number>.
51055 Info Found multiple RTC/00x modules, only one will be time seeded.
51056 Info kTimeseed has executed without errors.
51057 Info Synchronizing time.
51058 Info RTC/00x module has been time seeded.
51080 Warning Failed to seed time, retrying.
51113 Info Examining hardware.
51114 Info Searching for hardware.
51136 Error Unable to locate ethernet programming module.
51144 Error Hardware not detected.
51146 Error Configuration link to dau <dau id> failed.
51147 Error Configuration link not initialized.
51148 Error Failed to read configuration from dau <location>.
51149 Error Failed to read configuration from module <location>.
51150 Error Module in <dau type> <dau id> slot <slot> has failed its bit walk test.
51163 Error Failed to load resource string dll, <name>.
See Interpreting MsgML in the KSM-500 Databook for a list of messages common to all KSM-500 tools.
www.acracontrol.com
54 5 Jan. 2009 | DST/T/084

KSM-500 KSM/STE/001
kValidate 2.0
Validates XidML 2.41 files with respect to ACRA CONTROL equipment
DESCRIPTION
kValidate is a KSM-500 software tool for validating a XidML
file with respect to the XidML schema. It ensures that the
XidML file can be used to program a KAM-500 system. It will
not check rules concerning parameter placement in packages
or the sequence in which parameters are transmitted.
kValidate automatically runs X-Validate to check that the file
is well formed prior to validation.
kValidate provides a detailed fault report in MsgML format. It
can be launched as a stand-alone tool or called from
kWorkbench in the same way as all other KSM-500 tools.
FEATURES
• Calls X-Validate to ensure XidML 2.41 files are valid and
well formed
• Performs range validation on all XidML instrumentation,
packages and parameters
• Verifies that the XidML file complies in all respects with the
requirements for ACRA CONTROL instrumentation
• Provides detailed feedback on file errors in MsgML format
APPLICATIONS
• XidML validation of third-party, database-to-XidML
conversions
• XidML validation of hand crafted XidML files
XidML
kValidate
kProgram
One example of where kValidate operates in the workbench flow
5 Jan. 2009 | DST/T/005 55

Selection Paths
KSM/STE/001 kValidate ships as part of the KSM-500 suite of tools; kValidate validates XidML 2.41 files with
respect to ACRA CONTROL equipment
Revision History
kValidate 2.0 Supports XidML 2.41 Recommended for new programs
kValidate 1.0 First release Not recommended for new programs
Related Products
Module Details
-- --
Document Details
www.acracontrol.com
56 5 Jan. 2009 | DST/T/005

Overview
Inputs: Existing XidML to be validated
Outputs: MsgML file (containing list of errors, warnings, and information)
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/005 57

Using kValidate
kValidate can be run from the GUI or command line. It supports both CmdML and command line arguments. kValidate will
validate the file and write the results to an MsgML file.
Task file String N/A -T<FileName> No The name of the XidML file to be validated
1

2
3
Display All All -G Yes Determines display of tool next time it is run
4
next time Progress
None
Getting the most from kValidate

kValidate must be run to ensure instrumentation settings are compatible with ACRA CONTROL equipment. X-Validate will also
be automatically run by kValidate to ensure that the XidML file is logically correct. For information on messages that are
generated by X-Validate see the X-Validate data sheet. kValidate 2.0 will not check rules concerning parameter placement in
packages or the sequence parameters are transmitted.
58 5 Jan. 2009 | DST/T/005

kValidate messages
Info 16000 Starting to check <the file>
Info 16001 File <Name> is valid with respect to ACRA CONTROL equipment
Warning 16002 The <Name> is longer than the 15 characters recommended for <the object>
Warning 16003 A serious error has occurred.
Error 16004 <The XidML setting> is not allowed in <an object>.
Error 16005 <The named> Parameter cannot be sourced from <the instrument>.
Error 16006 <The named> Parameter cannot be sent to <the instrument>.
Error 16007 The VendorMap <value> specified in parameter <name> is not valid for the referenced instrument name.
Error 16008 In Parameter <name>, <the name> is an invalid value for the <VendorMap> on the referenced
<instrument>.
Warning 16009 Instruments with part reference <value> are not modules that are supported by ACRA CONTROL
Error 16010 The slot number <value> for the <instrument> is not valid for the DAU.
Error 16011 The slot number <value> on the <specified DAU> is being used by a <specified instrument> and <another
specified instrument>.
Error 16012 The physical characteristics of instrument <name> are incompatible with the slots in <the specified
instrument>.
Error 16013 <The value> is not within the allowed range ('<first value>' to <last value>) for the <setting in the
instrument>.
Error 16014 The value '<specified> for element <name> in <my object> must be set to <the specified value>.
Error 16015 The referenced object <name> in element '<name> in the <specified parameter> is not one of the allowed
<types>.
Error 16016 <The specified value> is not within the allowed <set of values> for <the setting> in <the specified
instrument>.
Error 16017 The specified element appears an <illegal amount of> times in <the specified instrument>. The minimum
number of times this element can occur at this location is the <minimum allowed> value.
Error 16018 The <specified> element appears an <illegal amount of> times in <the specified instrument>. The
maximum number of times this element can occur at this location is the <maximum allowed value>.
Error 16019 Values for the <specified> elements in <the specified instrument> must be set in groups of <allowed
values> and each of the values in a given group must be the same.
Error 16020 The type of parameter <name> is incompatible with the input parameter <name> in the <specified>
algorithm.
Error 16021 There are <an incorrect number of> parameters specified for the <specified> algorithm. The number must
be between the <minimum allowed value> and the <maximum allowed value>.
Error 16022 An error occurred while loading information for modules with a part reference of <specified value>.
Error 16023 Couldn't load module definitions.
Error 16024 The <value> in the <specified element> of <specified instrument> is not a valid number.
Error 16027 Couldn't load module definition for the <specified module>.
5 Jan. 2009 | DST/T/005 59

www.acracontrol.com
60 5 Jan. 2009 | DST/T/005

KSM-500 KSM/STE/001
kWorkbench 2.0.1
Integrated environment from which KSM-500 tools can be launched
DESCRIPTION
kWorkbench provides a flow-style interface for configuring,
programming and viewing ACRA CONTROL hardware.
kWorkbench offers two distinct process flows. You can define
hardware setup using kSetup, program hardware using
kProgram, and then acquire and view PCM and IENA data
using kQuicklook. kWorkbench can generate reports using
X-Report.
XidML file and HTML report files can be viewed by clicking
the respective icons. kWorkbench uses the standard
Windows file association to view these files.
FEATURES
• Enables tools to be used with minimum user-input
• Clearly shows the optimum order in which tools should be
launched
• Groups and orders tools by function
• XidML 2.41 compliant
APPLICATIONS
• Launching KSM-500 tools
kWorkbench interface
5 Jan. 2009 | DST/T/100 61

Selection Paths
KSM/STE/001 kWorkbench ships as part of the KSM-500 suite of tools; kWorkbench provides an integrated
environment from which KSM-500 tools can be launched
Revision History
kWorkbench 2.0.1 Includes a number of bug fixes Recommended for new programs
kWorkbench 2.0 Supports XidML 2.41 Not recommended for new programs
kWorkbench 1.0 First release Not recommended for new programs
Related Products
Module Details
kSetup User interface for setup of KAM-500 system
X-Report Extracts data from XidML 2.41 files and generates a report
kProgram Verifies and programs configuration data into KAM-500 modules
kQuicklook Views real-time data, or replays archived data
Document Details
www.acracontrol.com
62 5 Jan. 2009 | DST/T/100

Overview
Inputs1: Not applicable
Outputs1: Not applicable
1. See data sheets for individual KSM-500 tools for details of running each tool from the command line.
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/100 63

Using kWorkbench
kWorkbench is a graphic interface which streamlines the process of configuring KAM-500 hardware. This section identifies the
areas of the kWorkbench interface.
1 2
3
4 11
12
5
13
6 14
7 15
8
16
17
9
10
No. Setting Type Default Description
1
Task String None Chooses an existing task.
2
Configuration Select from: SAM/DEC Determines the configuration link that will be used to
Link SAM/DEC interrogate connected hardware.
or Ethernet
3
Host IP String 0.0.0.0 IP address of the PC. Needed for topology identification
over Ethernet.
4
IP Address String 0.0.0.0 IP address of Ethernet module (if available).
5
Program Button N/A Launches kProgram in order to program configuration data
into KAM-500 modules.
6
Setup Button N/A Launches kSetup, the user interface for the setup of the
KAM-500 system. kSetup creates Tasks and allows Task
information to be added, removed and defined.
7
XidML file Button N/A Displays the XidML file generated upon configuration.
8
Verify Button N/A Verifies that the task is correctly set up.
Report Button N/A Generates an inventory report from the XidML file.
9
HTML Report Button N/A Displays the report generated when the Report button is
10
clicked.
64 5 Jan. 2009 | DST/T/100

No. Setting Type Default Description
Quicklook Button N/A Launches Quicklook Editor to enable creation of custom

11
Editor graphic displays.
Quicklook Button N/A Launches Quicklook Setup to enable configuration of

12
Setup graphic displays.
QuickLook Button N/A Launches Quicklook Realtime to read and display data.
13
Realtime
Quicklook Button N/A Launches with Quicklook Replay to record and replay
14
Replay streamed data.
Instrument String First available instrument of type: For kQuicklook, specifies PCM controller
15
X-DAU-Controller-PCM-1.2 ("X-DAU-Controller-PCM-1.2") instrument, PCM transmitter
X-Module-PCM-Out-1.2 ("X-Module-PCM-Out-1.2") instrument, or Ethernet
X-Module-Ethernet-1.1 transmitter ("X-Module-Ethernet-1.1") instrument contained
in the Task file.
Format String N/A For kQuicklook, specifies the acquisition format of the item
16
selected in the Instrument field.
Package String First available frame for the For kQuicklook, specifies the package or PCM frame to use
17
selected task from the Task file based on the values of the Instrument and
Format selections.
Getting the most from kWorkbench

Each tool will generate its own messages and MsgML file. See data sheets for individual tools for more details.
kWorkbench messages
Error 41001 <Filename> file seems to be corrupted.
Error 41002 The option Task has no value.
Error 41003 File <Filename> does not exist.
Error 41004 File <Filename> is not a correct XidML 2.41 file.
Error 41005 Task <Filename> does not contain any PCM instruments.
Error 41006 Instrument <Instrumentname> does not exist.
Error 41007 Format <Formatnumber> does not exist.
Error 41008 Package <Packagename> does not exist.
5 Jan. 2009 | DST/T/100 65

www.acracontrol.com
66 5 Jan. 2009 | DST/T/100

KSM-500 KSM/STE/001
X-Report 2.0
Extracts data from XidML 2.41 files and generates a report
DESCRIPTION
X-Report generates reports from XidML 2.41 files using XSLT
stylesheets. X-Report offers three report generation options,
Inventory, Parameters and Others. The Inventory option
allows the generation of inventory reports from XidML 2.41
files, listing the hardware with serial numbers. The
Parameters option allows the generation of reports from
XidML 2.41 files, listing all parameters within a task. The
Others option lets you choose a user-defined stylesheet to
generate bespoke reports.
FEATURES
• Generates HTML reports from XidML 2.41 files
• Vendor-neutral report generator
• Output is configurable through XSLT stylesheets
• Choice of predefined report options
• Stylesheet templates available on xidml.org
APPLICATIONS
• Generate Inventory, Parameter or user-defined reports
from XidML files
Style sheet
HTML
XidML
Report
X-Report
One example of where X-Report operates in the workbench flow
5 Jan. 2009 | DST/T/006 67

Selection Paths
KSM/STE/001 X-Report ships as part of the KSM-500 suite of tools; X-Report extracts data from XidML 2.41 files
and generates reports
Revision History
X-Report 2.0 Supports XidML 2.41 Recommended for new programs
X-Report 1.1 Supports XidML 2.1 Not recommended for new programs
X-Report 1.0 First release Not recommended for new programs
Related Products
Module Details
kDiscover Generates HTML inventory of KAM-500 equipment
Document Details
www.acracontrol.com
68 5 Jan. 2009 | DST/T/006

Overview
Input: XidML 2.41 file

Stylesheet file
Output: HTML file
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/006 69

Using X-Report
X-Report can be run from the command line or from a batch file. It supports both CmdML and command line arguments.
Figure 1: Examples of HTML reports which can be generated by X-Report
Task String None -T No Acts on the given Task name as input

1
Report Select from: Inventory -SInventory No This is the report type to be generated. Inventory
2
Type Inventory -SParameters and Parameters are predefined report types.
Choose Others to select a user-defined
Parameters -S<filename>
stylesheet.
Others
Report String .\Report.htm -O<filename> Yes Output report file

3
File

4
CmdML String None -C Yes Specifies CmdML file the tool will use
5
file
6
next time Progress
None
70 5 Jan. 2009 | DST/T/006

The following is a list of the report options available:
Report Description
Inventory Lists the module names, serial numbers, module types and slots for each DAU in the XidML 2.41 input file.
Parameters Lists parameters and their units, data format, range and source.
Others Selecting Others allows an alternative stylesheet to be used when generating the report.
Getting the most from X-Report

With X-Report you can write stylesheets so that they generate reports specific to your project requirements. Each stylesheet
generates one file and overwrites files of the same name created earlier. See xidml.org for examples.
X-Report messages
Error 60001 XidML file <filename> is not valid
Error 60002 Stylesheet file <filename> is not valid
Info 60003 Using stylesheet <file name>
Error 60004 Error generating <html file name>
Error 60005 System error generating <html file name>. Error occurred when processing <command line>
See Running batch files and interpreting messages in the KSM-500 Databook for a list of messages common to all KSM-500
tools.
5 Jan. 2009 | DST/T/006 71

www.acracontrol.com
72 5 Jan. 2009 | DST/T/006

KSM-500 KSM/STE/001
X-Validate 2.0
Validates a XidML file with respect to the XidML schema
DESCRIPTION
X-Validate performs two types of checks:
It first checks that the file is well-formed and valid XML. A
valid XML document is a well-formed XML document which
also conforms to the rules of a schema, the relevant schema
here being XidML 2.41. A well-formed XML document is a
document that conforms to the XML syntax rules. Examples
of some rules are: XML elements must have a closing tag;
XML tags are case sensitive; XML elements must be properly
nested. All error messages related to this check are returned
by X-Validate using the message code 15000.
The second check that X-Validate performs is XidML logic
checks, which cannot be checked by the schema. These
checks include unique parameter names, elements such as
FEATURES instrument, algorithm, and package, which must be
instantiated if referenced. Related elements such as
• Provides vendor-neutral validation of XidML 2.41 files
maximum and minimum must be valid. Messages reported if
• XML and XidML validation checks performed
these checks fail are covered by message codes after 15000
• Both GUI and command line interface
(see “X-Validate messages” on page 76).
APPLICATIONS
• X-Validate is used to validate a XidML file
XidML
X-Validate
kProgram
One example of where X-Validate operates in the Workbench flow
5 Jan. 2009 | DST/T/004 73

Selection Paths
KSM/STE/001 X-Validate ships as part of the KSM-500 suite of tools; X-Validate is a generic XidML validator
Revision History
X-Validate 2.0 Supports XidML 2.41 Recommended for new programs
X-Validate 1.1 Supports more modules Not recommended for new programs
X-Validate 1.0 First release Not recommended for new programs
Related Products
Module Details
kProgram Verifies and programs configuration data into KAM-500 modules
Document Details
www.acracontrol.com
74 5 Jan. 2009 | DST/T/004

Overview
Inputs: Existing XidML to be validated
Outputs: MsgML file (containing list of errors, warnings and information)
System requirements
Hard-disk 40GB
RAM 512MB
Hard-disk 80GB
RAM 1024MB
5 Jan. 2009 | DST/T/004 75

Using X-Validate
X-Validate can be run from the command line. It supports both CmdML and command line arguments.
1
Task file String None -T<filename> No The name of the task file to be validated

2
3
4
next time Progress
None
Getting the most from X-Validate

X-Validate can be run with kValidate to ensure a task file is valid XML, XidML compliant and valid for use with ACRA CONTROL
systems.
X-Validate messages
Messages will be displayed in the following format: <MessageCode> <Message>
Message 15000 will contain additional information in the following format:
Parsing Error
Error Code: <Parsing Error Code>
File position: <File Position>
Line number: <Line Number>
Line position: <Line Position>
In file: <FileName>
In text: <Text>
Reason: <Reason>
Error 15000 Error detected when loading and validating <File Name> <Descriptive string>.
Error 15002 The <Object Type>1 <Object Name> is referenced in <Object Type> <Object Name>, but not
instantiated.
Error 15003 The InterConnect <Name> is instantiated only once and does not refer to a DataLink.
Error 15004 The InterConnect <Name> occurs more than once in a module.
76 5 Jan. 2009 | DST/T/004

Error 15005 The value <Element Value> contained in element <Max Element> at <Location> must be greater than
the value <Element Value> in element <Min Element> at <Location>.
Error 15006 The value of Element Occurrences at <Location> cannot be accommodated in frame.
Error 15007 The value of Element <Element Name> at <Location> is greater than the value of <Element Name> at
<Location>.
Error 15008 The SFID Minor Frame Offset in package <Package Name> cannot be accommodated in the minor
frame size.
Error 15009 Overlapping Element found in package <Package Name>. These are: <Element Name> and <Element
Name>.
Error 15010 Parameter <Element Name> in package <Package Name> goes beyond end of frame.
Error 15011 Parameter <Element Name> in package <Package Name> is outside frame limit.
Error 15012 The value <Bit Pattern> of <Element> in Package <Package Name> must be less than the number of
bits <Number Of Bits> in the parameter.
Error 15013 The value contained in <Element> at <Location> does not fit in the range <Value> in <Element> at
<Location> to <Value> in element <Element> at <Location>.
Info 15014 Main File <File Name> is well-formed XidML.
Warning 15015 The <Object> <Name> is instantiated but not referenced.
Info 15016 Checking file <File Name> is valid XML.
Info 15017 Main file <File Name> is well-formed XML.
Info 15018 Checking XML file <File Name> is valid XidML.
Info 15019 The Parameter <Parameter Name> has no Destination section, so it cannot be used anywhere.
Error 15020 The combination of Parameter <Parameter Name>, Instrument <Instrument Name> and Package
<Package Name> is not a unique destination.
Warning 15021 The content parameter location <Content Parameter Name> is defined in package <Package Name>,
but no parameter is either sourced or sunk to this location.
Warning 15022 The parameter <Parameter Name> has package <Package Name> declared as a destination, but is not
used in <Package Name>.
Error 15023 The offset of parameter <Parameter Name> within the package <Package Name> could not be
determined.
Error 15024 The size of parameter <Parameter Name> in package <Package Name> could not be determined.
Error 15025 Occurrence value <Number Of Occurrences> for <Location> does not divide evenly into package size of
<Number Of Bits> bits.
Error 15026 Occurrence value <Number Of Occurrences> for <Location> is invalid.
Error 15027 No Location found for Parameter <Parameter Name> in content of package <Package Name> -
parameter placement cannot be validated.
Error 15028 No valid value for <Element Name> was found in package <Package Name>.
Warning 15029 Package <Package Name> has no sub-frame synchronization strategy. One of the following must be
added: SFID, URC, or SyncWordComplement.
Error 15030 Message gaps of <Message Gap Size> msec in Package <Package Name>can't be achieved as they
exceed the package rate of <Package Rate>Hz.
Error 15031 The value <Bit Pattern> of <Element> in package <Package Name> is not a valid bit pattern.
Error 15032 The SFID Minor Frame Offset in package <Package Name> is not specified.
Error 15033 Parameter <Parameter Name> in package <Package Name> goes over the end of a Minor Frame.
Error 15034 Parameters <Parameter Name> and <Parameter Name> in package <Package Name> refer to the
same CAIS address:\n”” DAU ID: <DAU ID_VALUE>, Page Address: <Page Address Value>, Address:
<Address Value>.
5 Jan. 2009 | DST/T/004 77

Error 15035 Package <Package Name> has a mode code value, a source and destination; it can only have source or
destination.
Error 15036 Package <Package Name> has a mode code value but no source or destination defined.
Error 15038 The <Object Type> <Object Name> is referenced in <Referencing Object Type> <Referencing Object
Name>, but not enabled.
Error 15039 The <Object Type> <Object Name> is instantiated but not enabled.
Warning 15040 There are multiple packages with different package rates defined, rates may be incompatible. Packages
are: <Package Name 1> <Package Rate 1>….<Package Name n> <Package Rate n>.
Error 15041 The parameter <Parameter Name> has an ActualSampleRate of <Sample Rate Value> which is less
than the MinimumSampleRate <Minimum Sample Rate Value> in its <Xpath Locator> section.
Error 15042 For parameter <Parameter Name>, the interconnect <Interconnect Name> used in instrument
<Instrument Name> should be the same as the datalink in package <Package Name>.
Error 15043 Package <Package Name> has no SyncWord.
1. Object list refers to the following: Package, DataLink, Parameter, Algorithm and Instrument.
www.acracontrol.com
78 5 Jan. 2009 | DST/T/004

ACRA Chapter 4
C O N T R O L Building IRIG-106 PCM frames
This chapter describes how to build PCM frames in kSetup.
Frame Builder
Frames and parameters can be viewed by the default standard display or by parameter frame display.
The following two methods can be used to alternate between the two views:
• Select the View button on the toolbar.

• Right-click in the frame display area, and select Parameters.
Default standard display
QD/HW/SPF/R/0002 | 29 Jul. 2008 79

Parameter frame display
Defining a PCM frame

To launch Frame Builder, click the button in kSetup.
Where there is an existing frame attached to this encoder, this frame is displayed. If not, the Frame Wizard is displayed.
80 QD/HW/SPF/R/0002 | 29 Jul. 2008

From here the new frame can be created in one of three ways:
• Defining all frame characteristics manually
• Defining parameter transmission details
• From an existing frame
Defining frame characteristics manually

Select this to create a frame using a structure you already have. Specify the shape and other characteristics of the frames. After
the frame is created, parameters can be changed using defined commutations.
1. Type a name for the frame and then click Next.
A dialog box opens allowing you to define characteristics of the frame.
No. Setting Type Range Description
Words/Minor Integer 1 to 65535 Shows the minor frame index of the first occurrence of this
Frame parameter in the frame. It is set when the parameter is placed.
Minor Integer 1 to 8192 Sets the number of minor frames in a major frame.
Frames/Major
Frame
Bits Per Word Integer 4 to 64 Default number of bits per word can be changed for particular
words later on.
Parity Selection 3 choices ODD, EVEN or NONE.
Fill Pattern Hexadecimal Hexadecimal value Bit pattern that is transmitted during parts of the frame where no
with a trailing 'h' parameter has been defined.
QD/HW/SPF/R/0002 | 29 Jul. 2008 81

Bit Rate Integer 1 to 20,000,000 Values may be quantized depending on the encoder module.
Justification Boolean Left, Right When a parameter is placed in a word that is larger than the
parameter, it can be left justified (MSB of parameter = MSB of
word) or right justified (LSB of parameter = LSB of word) by
default.
Synchronization Selection 27 choices Hexadecimal pattern that is the sync word, this can be any
Pattern pattern with a trailing 'h'.
Auto Barker Code Boolean Checked, Unchecked Automatically sets the URC pattern to the Barker code when the
synchronization bits field is changed.
Synchronization Read only Info The synchronization mask is used in conjunction with the
Mask synchronization word when receiving a frame. It allows you to
mask parts of the synchronization word.
For example, suppose a frame had a synchronization word of
0xFAF320, if you use a synchronization mask of 0x0000FF then
Frame Builder would lock on any word in the frame that matched
0xFAF3nn, where n is any value. This is useful if part of the
synchronization word varies between minor frames.
Synchronization Integer 4 to 64 Number of bits in the synchronization word.

bits
PCM Code Selection 16 choices Code used for bit transmission, the options are dependent on the
modules used.
Choices are: NRZ-L, RZ, BIØ-L, NRZ-S,
NRZ-M, DBIØ-M, DBIØ-S, BIØ-M, BIØ-S, DM-M, DM-S,
RNRZ-L(11), RNRZ-L(13), RNRZ-L(15), RNRZ-L(17)
Invert DCLK Boolean YES, NO Shifts the data clock in phase by 180°.
Invert PCM Boolean YES, NO Shifts the PCM by 180°.
Synchronization Button N/A Displays the SubFrame Strategy dialog box.

Strategy
2. When you are finished defining frame characteristics, click the Synchronization Strategy button.
The SubFrame Strategy dialog box opens.
82 QD/HW/SPF/R/0002 | 29 Jul. 2008

Use SFID Selection Checked, unchecked Inserts an SFID count in each minor frame.
Start Value Integer Integer in range 0 to Used for the SFID in the first minor frame.
2BitsPerWord
Increment Integer Value added to the SFID in each minor frame; this can be
negative.
Word Index Integer 0 to number of words Location of the SFID; 0 is the first word in the minor frame.
per frame
MSB Boolean First, Last Sets whether the most significant bit of the SFID is transmitted
first or last.
Use URC Boolean Checked, unchecked Inserts a unique recycling code in the major frame.
Pattern Selection 27 choices Hexadecimal pattern that is the sync word, any pattern with a
trailing 'h'.
Auto Barker Boolean Checked, unchecked Automatically sets the URC pattern to the Barker code when the
Code URC bits field is changed.
Bits Integer 4 to 64 Sets the number of bits in URC.
Minor Frame Selects the minor frame in which the URC appears.
Number of the minor frame.
Word Index Word in which the URC appears. 0 is the first word.
Word number.
Use FCC Boolean Checked, unchecked Inverts the synchronization pattern once or more often in the
major frame.
FCC Boolean FCC, FAC Choose FCC to invert a single syncword in the major-frame.
Choose FAC to invert every second syncword in the
major-frame.
Minor Frame Integer Selects the minor frame in which the inverted syncword
appears.
Number of the minor frame.
3. When you are finished setting values, click Ok.

4. From the Frame Builder wizard, click Finish to view the frame.
The standard frame displays.
5. Save the frame.
Defining parameter transmission details

Select this if you want to define the frame based upon parameter characteristics such as sample rate and bits per parameter.
Frame Builder builds a frame such that the actual sample rates in the frame match the sample rates you have asked for as
closely as possible.
1. Type a name for the frame.
2. Click the defining parameter transmission details radio button and then click Next.
The Frame Wizard displays a spreadsheet view of all parameters in the system.
QD/HW/SPF/R/0002 | 29 Jul. 2008 83

Enabled Boolean Yes, No This value can only be changed for parameters that are not placed in the frame. To
change this for a placed parameter, first remove it from the frame.
Once a frame has been created, if a parameter is not enabled (value is NO) then it
cannot be placed in the frame in any way.
In the frame wizard, a parameter which is not enabled is ignored by auto-place. It will
also be ignored when a frame is being defined automatically from parameters
transmission details.
To use a parameter in a frame, select the parameter, click in the Enabled column, set to
Yes.
Desired Rate The desired rate can only be set when creating (or regenerating) a frame from the
transmission details option. Once set, the desired rate cannot be changed for that
parameter. This value is used by Frame Builder when automatically constructing a
frame.
To set the desired sample rate for a parameter, select the parameter, click in the
Desired rate column and type the desired sample rate.
When Frame Builder builds the frame it will try to achieve this sample rate.
3. When you are finished setting values, click Next.

A dialog box opens allowing you to set frame characteristics. You can also indicate what frame characteristics Frame
Builder can alter in order to achieve the sample rates you have requested.
The fields which control the frame dimensions and word size can be determined automatically in the course of building the
frame or they can be set manually.
84 QD/HW/SPF/R/0002 | 29 Jul. 2008

Words/Minor Frame Boolean Checked, Selecting Auto makes Frame Builder choose an optimal number of
unchecked words/minor frame to achieve the sample rates requested.
Minor Frames/Major Frame Boolean Checked, Selecting Auto makes Frame Builder choose an optimal number of
unchecked minor frames/major frame to achieve the sample rates requested.
Bits per Word1 Boolean Checked, Frame Builder sets the width of each sub-frame to the width of the
unchecked parameter in that sub-frame.
Select Auto to let Frame Builder choose the optimal number of bits
per word.
Bit rate Boolean Checked, A value in the range 1 to 20,000,000 depending upon the encoder
unchecked module. Some encoders only allow 8,000,000. Values may be
quantized depending on the encoder module.
Select Auto to make Frame Builder choose an optimal number
bit-rate to achieve the sample rates requested.
Auto Place parameters Boolean Checked, Frame Builder constructs the frame and displays the standard frame
unchecked display.
Check the Auto-Place parameters check box then click Finish.
1. Note that setting Bits per Word allows optimal usage of bandwidth but may lead to problems at the ground-station if it is not set to
accommodate differing sub-frame widths. If this is checked, the Words/Minor Frame and Minor Frames/Major Frame check boxes cannot be
set to auto or manual independently of each other.
4. When you are finished setting values, click Next.

Frame Builder constructs the frame and displays the standard frame display.
Defining a frame from an existing frame

Select this option if you want to use an existing frame as the basis of your new frame.
1. Type a name for the frame.
2. Click the from an existing frame radio button and then click Next.
A screen displays a list of defined frames.
QD/HW/SPF/R/0002 | 29 Jul. 2008 85

3. Select the frame you want to use and then click Finish.
Frame Builder creates a new frame with the same frame characteristics as the one you have selected. It also checks the
parameter names in the current setup. Any names that match ones already in the selected frame are placed in the same
location as the matching parameter.
If no frame exists, kSetup returns a message box stating that you cannot use this option as there are no other frames in the
system.
Menu bar
This is the menu area of IRIG-PCM MAP dialog box.
File menu
This is the IRIG-PCM MAP File menu.
No. Description
Regenerate: Removes the current frame and generates a new frame from scratch using the Frame Builder wizard
Restore: Deprecated
Save: Saves the current frame
Properties: Displays the properties of the frame
Delete Frame: Disconnects and/or deletes an existing frame
Export: Produces a text file
86 QD/HW/SPF/R/0002 | 29 Jul. 2008

No. Description
Save As: Saves the current frame under a different name
Close: Closes the dialog box
Edit menu
This is the IRIG-PCM MAP Edit menu.
No. Description
Remove: Removes selected cells from frame
Search: Deprecated
Font: Select required font for frame
Undo: Undoes last action
Clear Frame: Clears frame of all selected parameters
View menu
This is the IRIG-PCM MAP View menu.
No. Description
Zoom In: Makes cells larger
QD/HW/SPF/R/0002 | 29 Jul. 2008 87

No. Description
Overview:
Launches a small window, which can be used to navigate the larger frame.
To view a specific part of a frame, select Overview from the Edit menu bar.
The OverView window opens with a small view of the entire frame. Click in this window and drag the black rectangle in the window.
The Graphic frame display in Frame Builder displays that area of the frame.
Zoom Out: Makes cells smaller
Parameters: Switches between parameter view and frame view
Frame menu
This is the IRIG-PCM MAP Frame menu.
No. Description
Auto-Place: Automatically places all the parameters based on parameter attributes
Setup: Displays the frame setup dialog box
Horizontal Placement:
How selected parameters are placed in the frame depends on whether Horizontal has been selected.
Similarly when the wizard is executed, the way in which subcommutated parameters are automatically placed, depends upon the
setting of Horizontal Placement.
When Horizontal Placement is on, successive subcommutated parameters are placed in successive sub-frames.
When Horizontal Placement is off, successive subcommutated parameters are placed in successive minor-frames.
88 QD/HW/SPF/R/0002 | 29 Jul. 2008

Toolbar
This area has buttons for Frame Builder tools.
No. Button Description

Regenerate Removes the current frame and generates a new frame from scratch using the Frame Builder wizard
Frame:
Save Frame Saves current frame
Cut Parameter Cuts a selected parameter row
Undo Undoes last action in Frame Builder
Auto-Place Automatically places all the parameters based on parameter attributes
Views Switches between parameter view and frame view
Size up the Makes cells larger

cells
Size down the Makes cells smaller
cells
Overview Opens a small window, which can be used to navigate the larger frame.
To view a specific part of a frame, select Overview from the toolbar.
The OverView window opens with a small view of the entire frame. Click in this window and drag the black
rectangle in the window.
The Graphic frame display in Frame Builder displays that area of the frame.
Save As Saves the current frame under a different name
Delete Frame Disconnects and/or deletes an existing frame
QD/HW/SPF/R/0002 | 29 Jul. 2008 89

Graphic frame display
This area shows a graphic representation of the frame. Here, parameters can be placed and moved, and the sub-frame widths
of the frame can be altered on a sub-frame by sub-frame basis.
No. Description
Sub-frame To change sub-frame widths:

number By default all sub-frames are the same width as the default bits per word defined during frame creation.
To change the widths of the sub-frames:
1. Double-click on the sub-frame heading in the Graphic frame display.
2. Type the new sub-frame width and then click Ok.
Modifying frames
To modify a frame that has already been defined, click the button in kSetup’s encoder.
Frame Builder starts with the Frame Display window and shows the frame as currently defined. You can now move and change
parameters as desired.
Modification How to
Placing parameters To place a parameter in a frame:

1. Select a parameter in the Frame Builder configuration panel.
2. Ensure that it is not already placed in the frame and check that the commutation is set correctly.
3. Click an appropriate word location in the Graphic frame display.
The parameter appears in the frame.
4. Repeat for each required parameter.
All instances of the parameter are placed at the same time. If the parameter cannot be placed, an error message
is displayed.
Placing parameters To auto-place parameters:

automatically 1. Right-click in the Frame Builder parameters form.
2. Select AutoPlace.
All parameters are automatically placed in a frame.
Moving parameters To move a parameter:

1. Click on it in the frame display.
2. drag it to the new location.
All instances move together.
Clearing frames To clear a frame of all placed parameters:

1. Select Edit.
2. Select Clear Frame.
90 QD/HW/SPF/R/0002 | 29 Jul. 2008

Modification How to
Disconnecting a frame To disconnect a frame:
1. Enter Frame Builder for another frame and then click .
2. Select the frame to be disconnected and then click .
Copying a frame
To copy a frame, select and then assign a name to it.
Creating a new frame There are two ways to create a new frame; you can regenerate the existing frame (which will overwrite your
existing frame), or you can make a frame in a copy of your current frame.
Regenerating a frame To regenerate a frame, select File -> Regenerate.

A new frame is created.
Copying an existing To copy an existing frame without overwriting your existing frame:
frame 1. Select File -> Save As, to make a copy of your existing frame.
2. Select File - Regenerate.
A new frame is created in the copied frame.
Saving a frame To save a frame:

Select File -> Save
1
Deleting frames The current frame cannot be deleted.
To delete a frame:
1. Close the current frame.
2. Select file -> delete frame.
The frame is now deleted.
1. A saved frame which is connected to an encoder must be disconnected before deletion.
Frame Builder parameters page

This area is a spreadsheet that lists all parameters available in the system. The transmission details of each parameter can be
changed from here.
Like spreadsheets elsewhere in kSetup, an entire column can be selected by clicking on the column title. When multiple cells
are selected, typing a value inserts it in all selected cells.
Chassis, module, and parameter attributes cannot be changed in Frame Builder. Exit Frame Builder and change these in
kSetup as normal.
Placed Info N/A Shows if a parameter is placed or not.
Word Index Info N/A Shows the word index of the first occurrence of this parameter in the frame. It is
set when the parameter is placed.
QD/HW/SPF/R/0002 | 29 Jul. 2008 91

Real Rate Selection 22 choices The actual sample rate can only be changed for parameters that are not placed
in the frame. If you want to change this for a placed parameter, first remove it
from the frame. The value is a drop-down list of sample rates that the frame
structure supports. There is a direct correspondence between actual sample rate
and commutation.
Commutation Selection 23 choices Commutation can only be changed for parameters that are not placed in the
current frame. If you want to change commutation of a placed parameter, first
remove it from the frame.
The value is a drop-down list of commutations that the frame structure supports.
There is a direct correspondence between actual sample rate and commutation.
Filter row
This is on the top of each column. It can be used to reduce the number of displayed items according to some search criteria.
Type any text into the filter row and press the Enter key. The display shows any parameters that have matching text in that
column. You can use '*' as a wild card to indicate "any text".
Commutation panel
The commutation panel is where you can set the commutation rate of parameters.
Commutation and real rate can only be changed for parameters that are not placed in the current frame. If you want to change
commutation of a placed parameter, first remove it from the frame.
Commutation Selection 23 choices Commutation can only be changed for parameters that are not placed in
the current frame. If you want to change commutation of a placed
parameter, first remove it from the frame.
The value is a drop-down list of commutations that the frame structure
supports. There is a direct correspondence between actual sample rate
and commutation.
Parameters list
You can filter listed parameters in the parameters panel.
Go To
To aid navigation of large frames, you can ‘go to’ a parameter selected in the Graphic frame display, and view that parameter in
the Frame Builder configuration panel.
To go to a parameter: right-click the selected parameter in the Graphic display frame and select Go To. The parameter is
selected in the Frame Builder configuration panel.
Setting advanced parameter settings

By default, all parameters are displayed in the same way. Using the Advanced check box, extra details for each parameter can
be defined including the following:
• Control how parameters are broken up across transmission words
• Control which bits of a parameter are transmitted
• Change the leading bit of a parameter from the default
92 QD/HW/SPF/R/0002 | 29 Jul. 2008

To set advanced parameter settings, at the Frame Builder frame display, select the Advanced check box at the bottom of the
frame.
In this mode an extra five columns are visible. The basic six columns are still visible and have the same meaning as before.
Color Selection Standard Adds color to parameter rows to identify minor frames in a large major frame
Windows display.
colors To change color:
1. Select a parameter (or multiple parameters using Shift and Ctrl).
2. Right-click in a minor frame.
3. Select Color from the pop-up menu.
4. Select a color from the Color options box.
5. Click Ok.
The selected color is displayed in the Color column of the minor frame.
Start Bit The Start Bit, Stop Bit, and TX Bits columns control the number of bits of a
Stop Bit parameter that are transmitted in the frame.
Tx Bits A source module has an intrinsic parameter size. For an analog module this is
typically 16 bits. For some other modules it can be 12 or even 32 bits.
When placing a parameter in the frame, you can choose how many bits to
transmit and which bits they are. The Tx Bits column defines the number of bits
transmitted. This is not the same as the "bits per word" or sub-frame width. For
example, a 16-bit parameter can be transmitted in two sub-frames of 8 bits each.
Or a 12-bit parameter can be transmitted in a 16-bit word with 4 pad bits.
By default, Frame Builder always picks the MSBs for transmission. This can be
changed by setting the Start bit and Stop bit for the parameter.
Finally, the bit order can be controlled by setting the start bit to be lower than the
stop bit.
Start Bit1 Sets the first transmitted bit.
Stop Bit2 Sets the last transmitted bit.
Fragmentation Integer, This advanced feature allows control over how a parameter is transmitted when it
integer is larger than the sub-frame (or bits per word) of the frame. In this field you can
enter a list of numbers.
You can control how parameters are broken up for transmission in the
fragmentation column. For example, to fragment a 16-bit parameter into two
transmission words in two 8-bit halves, enter a value 8,8
Each integer represents the number of bits placed in a single word; commas are
used to separate multiple words. Each number represents the bits paced in a
sub-frame.
1. Note that if the first transmitted bit is greater than the stop bit then the parameter is transmitted MSB first. The number of bits transmitted
in the frame is represented as ((Start Bit)-(Stop bit) + 1). The LSB is bit 0.
2. Note that if the last transmitted bit is greater than the start bit then the parameter is transmitted LSB first. The number of bits transmitted
in the frame is represented as ((Start Bit)-(Stop bit) + 1).
QD/HW/SPF/R/0002 | 29 Jul. 2008 93

Setting fragmentation
This advanced feature allows control over how a parameter is transmitted when it is larger than the sub-frame (or bits per word)
of the frame. In this field you can enter a list of numbers.
You can control how parameters are broken up for transmission in the fragmentation column. For example, to fragment a 16-bit
parameter into two transmission words in two 8-bit halves, enter a value 8,8.
Each integer represents the number of bits placed in a single word; commas are used to separate multiple words. Each number
represents the bits paced in a sub-frame.
Setting fragmentation for 16-bit parameter in a 16-bit sub-frame

• Set the fragmentation column to 16
The transmission looks like the following:
Param1
Setting fragmentation for a 16-bit parameter and 12-bit sub-frames

• Set the fragmentation to 12,4
Param1

Param1
Bits are right justified within the cells if you select right justification when creating the frame.
Setting fragmentation for16-bit parameter and 10-bit sub-frames with odd parity
When setting the fragmentation you ignore the parity.
Param1
• Set the fragmentation to 4,4,4,4

P1
94 QD/HW/SPF/R/0002 | 29 Jul. 2008

Solving inconsistent frames
Some existing frames may be inconsistent with the acquisition cycle.
Use one of the following three ways to solve a frames inconsistency with the acquisition cycle:
• Set the acquisition cycle time from an existing frame. See “Making Frame Builder determine the acquisition cycle” on
page 97.
• Allow the frame and the acquisitions cycle to differ. See “Allowing frame and acquisition cycle to differ” on page 96.
• Allow Frame Builder to define a valid frame setting to match the acquisition cycle. See “Setting the acquisition cycle using
Frame Builder” on page 95.
Setting the acquisition cycle using Frame Builder

To make the parameter sample rate consistent with the acquisition cycle, use the frame wizard.
1. Click Frame -> Setup.
The Frame Setup dialog box opens.
2. Click Find valid frame setting.

The suggested Frame Settings dialog box opens.
QD/HW/SPF/R/0002 | 29 Jul. 2008 95

3. Click the filter row of the Remaining Bits column and type 0.
4. Click Calculate.
5. Click the top frame row with the least remaining bits.
6. Click Apply.
7. Click OK in the Valid frame Settings dialog box.
8. In the Frame Builder wizard, click File -> Save.
9. Click File -> Close.
The Major frame period is now compatible with the acquisition cycle.
Allowing frame and acquisition cycle to differ

To allow the acquisition cycle and the frame to differ:
1. Click Frame -> Setup.
2. Click the Allow Frame and Acquisition Cycle to differ radio button.
The frame generated differs from the acquisition rate.
96 QD/HW/SPF/R/0002 | 29 Jul. 2008

Making Frame Builder determine the acquisition cycle
To make the parameter sample rate consistent with the acquisition cycle, use the frame wizard.
1. Select Frame -> Setup.
2. Click the Set Acquisition Cycle Time from this Frame radio button.
3. Click Ok.
The Frame Setup dialog box closes.
4. In the Frame Builder window, select File -> Save.
5. Select File -> Close.
The frame has now been selected with a different sample rate from the acquisition cycle.
Defining additional PCM frames

As stated above all frames must have the same acquisition cycle time, therefore they must have the same target cycle
frequency.
The target cycle frequency of the first frame added to a system becomes the Primary target cycle frequency for the system.
When adding subsequent frames, the target cycle frequency of each frame is checked against the primary target cycle
frequency. If it deviates, the following alert is displayed at the bottom of the main window:
QD/HW/SPF/R/0002 | 29 Jul. 2008 97

Choosing valid settings
If the frame target cycle frequency deviates from the primary target cycle frequency, the Invalid Secondary Frame panel and the
Find valid frame setting button are visible.
Invalid Secondary
Frame panel
If frame settings are changed and this causes the target cycle frequency to be the same as the primary target cycle frequency,
then the Invalid Secondary Frame panel disappears.
Set Acquisition Cycle Boolean Checked, To make the system's primary target cycle frequency the target cycle
Time from this Frame unchecked frequency for this frame.
Allow Frame and Boolean Checked, This allows a difference between the frame's target cycle frequency and the
Acquisition Cycle to unchecked primary target cycle frequency.
differ
Find valid frame Button N/A You can find a solution to the situation by changing the settings, such as the
setting frame dimensions, and/or the bit rate to find valid settings:
1. Select the Valid Settings button.
2. Choose the appropriate settings in the dialog box.
98 QD/HW/SPF/R/0002 | 29 Jul. 2008

Suggested frame settings
When you click Calculate, the program cycles through possible frames attempts to find settings that would give the frame a
target cycle frequency equal to the primary target cycle frequency. The bit rate must be valid for the encoder module to which
the frame is attached.
The possible frame settings are displayed in the spreadsheet. A particular group of settings can be applied to the frame by
selecting the relevant line in the spreadsheet and clicking Apply.
In the following table Frame Size is the total number of bits in the frame. You can control the search by checking the Auto
checkbooks beside the Bits Per Minor, Baudrate, and Omit Invalid Frames fields. The search can also be controlled by the
Max Bits to search field.
Settings Spreadsheet N/A Settings spreadsheet comprises the following:

Valid: These settings can be applied to the current frame.
Baudrate: Bit rate.
Total Bits: The total number of bits in a compliant frame.
Extra Bits/Minor: (Total Bits - Starting Bits)/(Minor Frames/Major Frame)
Extra Words/Minor: (Extra Bits/Minor)/(Bits Per Word + Parity)
Words Per Minor: Starting Words/Minor + Extra Words/Minor
Remaining Bits: (Extra Bits/Minor) - (Extra Words/Minor * (Bits Per Word + Parity))
Baudrate Boolean Checked, On: Find baudrate which gives the frame a compliant target cycle frequency.
Auto unchecked Off: Baudrate is not changed while searching for compliant settings.
Bits Per Boolean Checked, On: Cycle through possible frame sizes, which are larger than or equal in size to
Minor Auto unchecked the current frame.
Off: Bits per minor are not changed while searching for compliant settings.
Omit Boolean Checked, On: Only frame sizes which are divisible by the current Minor Frames/Major frames
Invalid unchecked are returned.
Frames Off: All possible frame sizes larger than the current frame size are returned. Those
sizes that are not divisible have N/A in some of the fields.
Max bits to Integer This is the maximum number of bits which are added to the current frame size
search when the system is attempting to find valid settings by cycling through frame sizes.
QD/HW/SPF/R/0002 | 29 Jul. 2008 99

Bits/Word Integer The extra bits added to the current frame size are divided by this (in conjunction
with the parity) to determine the number of extra words which are added to the
frame.
Parity Selection 3 choices The parity of the extra words. Parity can be Odd, Even or None.
Total Bits Integer The total number of bits in the frame.
Reset Button N/A Clear the spreadsheet. Restore the initial settings.
Applying changes
If the selected setting is valid and the Remaining Bits is 0, then these settings are applied immediately to the frame. In this case
changing the frame setup is simply a case of changing the number of words/minor frame and/or the bit rate.
If however the Remaining Bits is not 0, do the following:
1. Click Apply.
2. Click Ok in Frame Setup.
A message box states how many bits/word must be applied.
3. Re-enter Frame Setup.
4. Increase Words/Minor Frame by 1.
5. Change Bits/Word to the noted value from step 1.
6. Click Ok in Frame Setup.
100 QD/HW/SPF/R/0002 | 29 Jul. 2008

ACRA Chapter 5
C O N T R O L Running batch files and interpreting messages
This chapter describes how to run batch files and interpret MsgML messages.
CmdML
CmdML is an XML schema that is used to express how options for tools can be set. All tools which support options use CmdML
files. CmdML files are specific to each tool. All options supported by a tool are contained within the Cmd tags. It is also possible
to use CmdML to change the message level of messages generated by each tool. For example, some error messages may be
critical under some circumstances and not critical under other circumstances; if not critical, the level can be set to warnings or
info. Levels can be changed by setting the Level tag to the desired new level for a particular message code. Each message
generated by a tool must have a default Message Level (Fatal, Error, Warning or Info), and this will be used when the Message
Level is not defined in the CmdML file.
Message codes for each tool are listed in the data sheet for that tool. Standard message codes are listed in the section “MsgML
messages common to all tools” on page 104.
The following is an example of a CmdML file, xReport_cmd.xml:
<xReport>
<Cmd>
<Task>myTask.xml</Task>
<Display Next Time>All</Display Next Time>
<StyleSheet>Instruments.xsl</StyleSheet>
<Report>myInstruments.html</Report>
</Cmd>
<Messages>
<Message Code=1001>
<Level>Info</Level>
</Message>
</Messages>
</xReport>
To use a CmdML file with a tool the -C switch must be used, for example:
xReport.exe -CxReport_cmd.xml
QD/HW/SPF/R/0003 | 9 Jan. 2008 101

CmdML options common to all tools
Task String None -T No Acts on the given Task name

as input
Verbosity Select from: High Yes High: generates all messages

High -V:H Medium: generates Errors
Medium -V:M and Warnings
Low -V:L Yes Low: generates Errors
CmdML file String None -C Yes Specifies CmdML file the tool
will use
Display next time Select from: All -G Yes Determines display of tool
All next time it is run
Progress
None
Running the tools - CmdML and switches

Running from the command line
Many tools require very little user input and can be run from batch files or automated scripts. The few inputs required can be
defined as either traditional command line switches or in XML files called CmdML files.
All tools can be started from the command line as follows: with a CmdML file, with command line switches or without any
switches. CmdML settings and switches are case-sensitive.
Running without CmdML or switches

When a tool is started with no switches it displays the GUI with default options.
The CmdML options are automatically saved to the file <tool>_cmd.xml upon exiting the GUI.
Running with CmdML or switches

When a tool is started with a CmdML file, the tool will accept the settings from the file.
Alternatively, the tool can be started with command line arguments corresponding to the switch settings.
If both CmdML and switches are used the CmdML file has precedence.
Switches
Most tools support a number of command line switches. These are used to set particular options available to the tool.
To use switches type the tool name followed by the option(s).
EXAMPLE:
kProgram -TmyTask -V:M Running from within a batch file
Paths that include spaces between words must be enclosed in quotation marks (").
Most tools can be run from within a batch file. To avoid displaying the GUI on tools that support one, turn off the GUI option by
specifying the “Display next time” option as “None” when the tool is run from a batch file.
EXAMPLE:
The following example examines a XidML file and generates an HTML report listing all hardware and serial numbers using a
single batch file. The example shows the comparison between the use of switches and CmdML.
myReport.bat
xReport.exe -TmyTask -GNone -SInstruments.xsl -OmyInstruments.html
Alternatively, CmdML can be used to simplify the syntax of the batch file by using a CmdML file.
Here the CmdML options for both tools are combined into a single file. Each tool will only interpret its CmdML
section and ignore the rest.
102 QD/HW/SPF/R/0003 | 9 Jan. 2008

myReport.XML
<xReport>
<Cmd>
<Task>myTask.xml</Task>
<Display Next Time>None</Display Next
Time>
<StyleSheet>Instruments.xsl</StyleSheet>
<Report>myInstruments.html</Report>
</Cmd>
</xReport>
Once the CmdML is created it can be used by each tool within the batch file.
myReport.bat
xReport.exe -CmyReport.xml
Interpreting MsgML
As tools run they generate messages to their individual message list boxes (which can be turned off when starting the tool).
These messages are logged to MsgML log files and displayed in a Message list box. These messages report errors, warnings
and progress information as discussed below. The verbosity level determines the messages displayed in the Message list box.
All messages are logged to MsgML log files. These logged files may be particularly important when tracking tools running as
batch files.
MsgML is an XML schema which is used to express how messages generated by tools are logged. All tools that provide
message logging only support MsgML log files. A separate log file is generated for each tool.
The following is an example of a MsgML log file.
<xReport>
<StartTimeDate>16:16:05-2004-12-16</StartTimeDate>
<Build>
<ToolVersion>1.0</ToolVersion>
<BuildDate>2004-12-15</BuildDate>
</Build>
<Phase "Opening files">
<Message Code=601001>
<Text>The file, Instruments.xsl, does not exist.</Text>
<Level>Error</Level>
</Message>
</Phase>
<EndTimeDate>16:16:08-2004-12-16</EndTimeDate>
</xReport>
Each tool reports to its own MsgML file. The MsgML file is overwritten each time the tool is started. When the tool is finished
running, the MsgML file is copied to an archive directory. The current time and date stamp is appended to the name of the
MsgML file.
A MsgML file typically comprises the start time and date, build information including the version number, and the date the tool
was built. The phase indicates the particular stage the tool is at. Each phase contains at least one message. Each message has
three components: a message code, text, and level. The message code is a unique number for each message. The text is a
human readable description of the message. The level indicates whether the message is an error, warning, or information.
Finally, there will be an end time and date stamp indicating when the tool completed its execution.
QD/HW/SPF/R/0003 | 9 Jan. 2008 103

There are three classifications of message levels:
Error Indicates that the message is an error. In general, an error indicates that a tool has come across a problem.
Example: Unable to communicate with solid state recorder using comms link
Warning Indicates that the message is a warning. In general, a warning indicates that there may be an issue but that the tool can
continue.
Example: Excitation not defined
Info Indicates that the message is information.

Example: Process terminated successfully
As the log file is an XML file, it is possible to transform the file into a desired report using style sheets. It is
possible that X-Report could be used to generate a report with an appropriate style sheet.
MsgML messages common to all tools
Message code Default level Message
00000 Info Operation completed successfully
00001 Info Options used are <option list>
00002 Info File <file name> has been created
00003 Warning File <file name> has been over-written.
00004 Error File <file name> does not exist
00005 Error File <file name> cannot be created
00006 Error File <file name> exists, but cannot be over-written
00007 Error The option <option> has no value
00008 Error The option <option> is invalid
00009 Error Mandatory option <option> has not been specified
00010 Error Unable to open file <file name>
00011 Error Unable to open task <task name>
00012 Error No action was specified
00013 Error Operation failed to complete
00014 Error Directory <directory> does not exist
00015 Error Command line option <Option> cannot be combined with other options
00016 Info Option <Option> has value of <value>
00017 Error System error: <information> - program halting
00018 Info Program stopped by user
00019 Error Out of memory - program halting
00020 Info Operation completed with errors
Legacy tools and their logs

Some tools, such as kProgram, are implemented using KSMv2 tools. This means that KSMv2 tools do not support MsgML
message reporting, but may generate their own log files. Data sheets for tools indicate whether MsgML is supported or not.
Future versions of KSM-500 tools will use MsgML to report all messages.
104 QD/HW/SPF/R/0003 | 9 Jan. 2008

ACRA Chapter 6
Revision histories
C O N T R O L
This chapter outlines the revision history of the KSM-500 Databook.
Controlled documents revision history

The following documents have been added since the last release of the KSM-500 Databook.
• kProgram 1.6
• kSetup 1.6
The following documents have been removed since the last release of the KSM-500 Databook.
• kProgram 1.5.1
• kSetup 1.5.1
Updated documents are marked by a in the Controlled document revision histories.
105
Modules are arranged by alpha-numeric order of their titles
DST/T/076 kDiscover 1.0

Date Action Reason
5 Jan. 2009 Minor change to layout on first page header; no content Consistency across product families
changed in data sheet
1 Nov. 2007 Issued first release of data sheet
DST/S/035 kFlashCardXID 1.3

Date Action Reason
3 May 2006 Issued first release of data sheet
DST/U/019 kProgram 1.6

Date Action Reason
DST/U/021 kQuicklook 2.0 .1

Date Action Reason
13 Jun. 2008 Issued first release of data sheet
DST/U/017 kSetup 1.6

Date Action Reason
DST/T/084 kTimeseed 1.2

Date Action Reason
DST/T/005 kValidate 2.0

Date Action Reason
106
DST/T/100 kWorkBench 2.0.1
Date Action Reason
28 Jul. 2008 Removed references to kConfig kConfig is no longer included with KSM-500
17 Dec. 2007 Issued first release of data sheet
DST/T/006 X-Report 2.0

Date Action Reason
DST/T/004 X-Validate 2.0

Date Action Reason
QD/HW/SPF/R/0002 Building IRIG-106 PCM frames

Date Action Reason
29 Jul. 2008 Defining a PCM frame: Updated screen shot to show kSetup
1.5
9 Jan. 2008 Defining a PCM frame: Updated screen shot to show kSetup
1.4
28 Jun. 2005 Defining a PCM frame: Updated screen shot to show kSetup
1.1
Added section explaining the menu bar.
13 Apr. 2005 Updated Frame Builder screen shots for release of KSM.
24 Jan. 2005 Issued first release of chapter
QD/HW/SPF/R/0001 Installing KSM-500

Date Action Reason
28 Jul. 2008 Updated System requirements table format.
9 Jan. 2008 Updated directory paths under the “Directory structure”

section.
8 Sep. 2005 Section 2.1.1: Removed references to Windows 98 as the

KSM-500 suite of tools does not support Windows 98.
12 Apr. 2005 Section 2.1.1: Changed screen resolution from “800 x 600” to
“1024 x 768”
2.1.2. Installing KSM: Updated “Select Features” screen shot
for new GUI.
Removed “Database Information” screen shot.
1 Apr. 2005 Added explanation of Database Information dialog to Section

2.1.2 Installing KSM.
107
7 Feb. 2005 Updated to show that the single location for EEPROM cache Documentation error.
used by kProgramXID is %root%\acra\kProgramXID\cache
and that the recommended convention is:
c:acra\tasks\MyTask.xml
QD/HW/SPF/R/0004 Introduction to KSM-500

Date Action Reason
9 Jan. 2008 Removed references to kConfig. kConfig is no longer included with KSM-500
28 Jun. 2005 Changed “KSM” to “KSM-500” throughout. Style consistency.
QD/HW/SPF/R/0003 Running batch files and interpreting

messages
Date Action Reason
9 Jan. 2008 Updated messages under the “MsgML messages common to

all tools” section. Removed references to kConfig.
25 Apr. 2006 Added new message (No. 00020)
1 Apr. 2005 Updated with new messages
108
ACRA Appendix
Abbreviations, glossary and warranty
C O N T R O L
This appendix lists the abbreviations, glossary of terms used
in this book and warranty details.
H
Hex
Abbreviations Hexadecimal
HTML
A Hypertext markup language
ASCII
American Standard Code for Information Interchange I
IRIG
B Inter-Range Instrumentation Group
Bin.
Binary file K
KSM-500 workbench
C KAM-500 System Manager workbench
CD KSM-500
Compact disk KAM-500 System manager
CmdML
a schema for defining command line option files. M
MathML
D A Markup language designed to represent mathematical
equations
DLL
MatLab
Dynamic link library
A mathematical programming language and environment,
optimized for matrix operations.
F MIL-STD
Military Standard (USA)
FAT32
MsgML
An enhancement of the File Allocation Table file system that
supports large drives with improved disk space efficiency. A schema for interpreting log files
FTIbench
FTIbench is a collection of tools aimed at the flight test
community.
P
PCM
G Pulse Code Modulation

PCMCIA
GUI
Personal Computer Memory Card International Association
Graphical user interface
R
RAM
Random Access Memory
109
T Receiving, inspection and warranties
TMATS Receiving
TeleMetry Attributes Transfer Standard Unpack the instrument and save the carton and packing
material in case the instrument must be shipped to another
site or returned to the factory for service.
U
Inspection
URI
Inspect the exterior of the instrument for any visible signs of
Uniform Resource Identifier damage that may have occurred during transit.
If damaged, contact ACRA CONTROL Customer Service
X ACRA CONTROL system warranty

Xid ACRA CONTROL warrants that each product we sell you is
eXtensible Instrumentation Definition free from defects in labor and materials and shall conform to
its product specifications as defined in the product user
XidML 2.0 documentation.
eXtensible instrumentation meta-data exchange Mark-up If the product does not function as warranted during the
Language warranty period, we will repair or replace it without charge.
XML
Warranty period
EXtensible Mark-up Language
The warranty period for hardware products is 12 months. The
Glossary of terms warranty period begins on the date of invoice.
Benchmarks: results achieved from a predefined set of Limit of warranty

tests.
Misuse, accident, modification, unsuitable physical or
Client: indicates that a tool is a consumer of another
operating environment, improper maintenance, or damage
available service, i.e. kProgram is a client of kParse and
caused by a product for which we are not responsible will
kMessageServer.
void the warranty.
CmdML: a schema for defining command line option files.
Certain components may have separate warranty periods as
Commandline: execution of a tool from a DOS box, no GUI. stated in the product user documentation.
Command file: file used to configure a tool. THIS WARRANTY REPLACES ALL OTHER WARRANTIES,
EXPRESSED OR IMPLIED, INCLUDING THE IMPLIED
Data: is the information content, i.e. instrumentation.
WARRANTIES OF THE MERCHANTABILITY AND FITNESS
GUI: execution of a tool from Windows, must have a FOR A PARTICULAR PURPOSE AND ANY OTHER
graphical user interface. OBLIGATIONS OR LIABILITIES ON THE PART OF ACRA
Instrument: an element of XidML 2.0 that describes an CONTROL WHETHER IN CONTRACT, WARRANTY,
instrument, device or equipment configuration. NEGLIGENCE OR OTHERWISE. WE SHALL NOT BE
LIABLE FOR AND DISCLAIM ALL CONSEQUENTIAL,
Log: sequential result of an operation, e.g. kParse. INCIDENTAL AND CONTINGENT DAMAGES.
Meta-data: describes the structure, form or layout of data,
including type information. Items not covered by warranty
MsgML: a schema for interpreting log files. We do not warrant uninterrupted or error-free operation of a
product.
Package: an element of XidML 2.0 that describes how data
is transported e.g. when starting kExcel we have to load the We provide certain non-ACRA CONTROL products on an “as
package (PCM format) to be loaded in SAM/DEC/007. is” basis. Non-ACRA CONTROL manufacturers or suppliers
may provide their own warranties to you.
Report: meaningful organized and well-presented document,
produced from a reporting tool such as X-Report. Separate software warranty is provided with software user
documentation.
Return code: represents the success condition of a tool, '1'
means success, '0' means failure.
ACRA CONTROL software warranty
Task: an XidML 2.0 project, assignment or load.
ACRA CONTROL warrants that the removable physical
Tool: a single public releasable executable, application or media (for example, diskette) shall be free of defects in labor
utility. and materials for a period of ninety (90) days from the invoice
XidML 2.0: standard XML schema for the interchange of data date. If the physical media is defective, ACRA CONTROL will
and meta-data. replace it without charge.
This is your sole remedy for product defects. In no event will
ACRA CONTROL’s liability exceed the price paid for the
software, regardless of the form of the claim.
110
ACRA CONTROL does not warrant that the software be 1. Redistributions of source code must retain the above
uninterrupted or error-free. copyright notice, this list of conditions and the following
disclaimer.
ACRA CONTROL MAKES NO OTHER WARRANTY,
EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THIS 2. Redistributions in binary form must reproduce the above
SOFTWARE, INCLUDING WARRANTIES OF copyright notice, this list of conditions and the following
MERCHANTABILITY OR FITNESS FOR A PARTICULAR disclaimer in the documentation and/or other materials
PURPOSE. ACRA CONTROL MAKES NO WARRANTY, provided with the distribution.
EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THE
3. The end-user documentation included with the
QUALITY OR PERFORMANCE OF THIS SOFTWARE.
redistribution, if any, must include the following
ACRA CONTROL SHALL NOT BE LIABLE FOR
acknowledgment: "This product includes software developed
CONSEQUENTIAL, INCIDENTAL OR CONTINGENT
by the Apache Software Foundation
DAMAGES.
(http://www.apache.org/)." Alternately, this acknowledgment
Some states do not allow the exclusion or limitation of implied may appear in the software itself, if and wherever such
warranties or limitation of liability for incidental or third-party acknowledgments normally appear.
consequential damages, so the above limitation or exclusion
4. The names "Xerces" and "Apache Software Foundation"
may not apply to you.
must not be used to endorse or promote products derived
from this software without prior written permission. For written
Software copyright protection permission, please contact apache@apache.org.
This software is protected by state, U.S. and international 5. Products derived from this software may not be called
copyright treaty provisions. These copyright provisions apply "Apache", nor may "Apache" appear in their name, without
to your use of this software regardless of whether or not you prior written permission of the Apache Software Foundation.
agree to the following terms. Under law, copyright infringers
may be liable for actual damages sustained by the copyright THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY
owner and for punitive damages of up to $100,000 per EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
infringement. Unauthorized copyright of computer/instrument BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
software, and attempts to do so, are also criminal violations, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
with penalties that may exceed $100,000 in fines and 10 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
years in prison. APACHE SOFTWARE FOUNDATION OR ITS
CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
1. Unless restricted by an agreement with ACRA CONTROL, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
you are permitted to: CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
a. Use this software on only one computer/instrument and by LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
one user at a time. OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND
b. Make one copy of this software, provided that: ON ANY THEORY OF LIABILITY, WHETHER IN
(i) the copy is created as an essential step in the utilization of CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
this software in conjunction with your machine and that it is NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
used in no other manner, or OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
(ii) that the copy is for archival purposes only and that all
archival copies are destroyed in the event that your continued ==============================================
possession of this software should cease to be rightful. ======================
c. Sell this software, or any archival copy, only as part of the This software consists of voluntary contributions made by
sale of all of your rights in this software, except that many individuals on behalf of the Apache Software
adaptations may be transferred only with the authorization of Foundation and was originally based on software copyright
ACRA CONTROL. (c) 1999, International Business Machines, Inc.,
http://www.ibm.com. For more information on the Apache
2. You are not permitted to:
Software Foundation, please see <http://www.apache.org/>.
a. Make copies of this software or documentation except as
described above.
b. Alter, modify or adapt this software or documentation
except as described above.
c. Distribute, lease, rent or sublicense this software or
documentation.
Apache software license information

The Apache Software License, Version 1.1 Copyright (c)
1999-2003 The Apache Software Foundation. All rights
reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
111

KSM 500databook

Uploaded by

Copyright:

Available Formats

KSM 500databook

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

KSM 500databook

Uploaded by

Copyright:

Available Formats

KSM-500 Databook

kDiscover 1.0 5 Jan. 2009 | DST/T/076

kFlashCardXID 1.3 5 Jan. 2008 | DST/S/035

kProgram 1.6 27 Nov. 2008 | DST/U/019

kQuicklook 2.0.1 5 Jan. 2009 | DST/U/021

kSetup 1.6 27 Nov. 2008 | DST/U/017

kTimeseed 1.2 5 Jan. 2009 | DST/T/084

kValidate 2.0 5 Jan. 2009 | DST/T/005

kWorkbench 2.0.1 5 Jan. 2009 | DST/T/100

X-Report 2.0 5 Jan. 2009 | DST/T/006

X-Validate 2.0 5 Jan. 2009 | DST/T/004

KSM-500 Databook chapters

Installing KSM-500 QD/HW/SPF/R/0001 | 28 Jul. 2008

Building IRIG-106 QD/HW/SPF/R/0002 | 29 Jul. 2008

Running batch files QD/HW/SPF/R/0003 | 9 Jan. 2008

Introduction to QD/HW/SPF/R/0004 | 9 Jan. 2008

See “Revision histories” on page 105 for details of revisions

Suggested Reading Paths

Introduction A modular approach

QD/HW/SPF/R/0004 | 9 Jan. 2008 1

X-Report is a freeware software utility which

From proprietary XID and XML-based

2 QD/HW/SPF/R/0004 | 9 Jan. 2008

Operating system Windows® 2000 or XP

Processor 1GHz Intel® Pentium® 4

Input device Keyboard; mouse (if using GUIs)

Screen 1024 x 768 (if using GUIs)

Operating system Windows 2000 or XP

Processor 2.8GHz Intel Pentium 4

Input device Keyboard; mouse (if using GUIs)

Screen 1024 x 768 (if using GUIs)

QD/HW/SPF/R/0001 | 28 Jul. 2008 3

Installing Adobe Acrobat®

%root%\acra\<tool>.exe Location of executable tool

%root%\acra\<tool> Location of binaries for tool

%root%\acra\database Location of KSM v2 database

%root%\acra\kProgram\cache Single location for EEPROM cache used by

%root%\acra\kProgram\log Location of legacy log files: kc.log,

%root%\acra\tasks\<task> Location of task directories

%root%\acra\<tool>\MsgML\<tool>_msgml.xml Last log for tool

4 QD/HW/SPF/R/0001 | 28 Jul. 2008

%root%\acra\<tool>\MsgML\Archive\<tool>_msgml_<date_time>.xml Archived logs for tool

%root%\acra\<tool>\CmdML\<tool>_cmdml.xml Last CmdML file for tool

Output Location Comment

EEPROM \%root%\acra\cache\... The files in this directory are used by kProgram.

QD/HW/SPF/R/0001 | 28 Jul. 2008 5

This section contains data sheets for all tools in KSM-500.

• “kFlashCardXID 1.3” on page 17

• “kProgram 1.6” on page 25

• “kQuicklook 2.0.1” on page 31

• “kSetup 1.6” on page 39

• “kTimeseed 1.2” on page 49

• “kValidate 2.0” on page 55

• “kWorkbench 2.0.1” on page 61

• “X-Report 2.0” on page 67

• “X-Validate 2.0” on page 73

5 Jan. 2009 | DST/T/076 9

kDiscover 1.0 First release Recommended for new programs

DOC/MAN/018 KSM-500 Databook