ODIS Config.xml

From OKOS Wiki
Jump to navigation Jump to search

Obsolescence

As of ODIS-IC 3.19.98, this file is obsolete and the settings below are integrated into the <appSettings> sections of ODIS-3.exe.config. ODIS-NDT is in the process of conversion.

Description

The ODIS_Config.xml file stores system-wide configuration options that are not often changed. As of this writing, the file is located in the same directory as the ODIS application itself.

Note: depending on where ODIS was installed, you may need Administrative privileges to edit the file.

All entries in ODIS_Config.xml are stored in key/value pairs , e.g.:

 <add key="TLimit" value="false"></add>
   

There are five major sub-sections within the file whose tags are described here. The overall format of the file is:

 <Configuration>		
   <ODIS_MDI>	
     <key-value pairs>
   </ODIS_MDI>	
   <Motors>	
    <key-value pairs>
   </Motors>	
   <ScanManager>
     <key-value pairs>
   </ScanManager>
   <FormImage>	
     <key-value pairs>
   </FormImage>	
   <Pulsers>
     <key-value pairs>
   </Pulsers>
 </Configuration>		

Keys are listed in alphabetical order. Deprecated (obsolete) keys are noted as such.

<ODIS_MDI>

This contains major configuration settings for hardware and location of data files.

Analysis_Only

  • Deprecated: use “Mode” key instead.

True or False. If True, ODIS will start without A/D, P/R, or Motion support.

 <add key="Anaylsis_Only" value="false"></add>

DataAcquisitionOnly

  • Deprecated: use “Mode” key instead.

True or False. If True, ODIS will start without Motion support, but will use the A/D and P/R configuration. The Scan Manager window will not be displayed.

 <add key="DataAcquisitionOnly" value="false"></add>

DatumOnStart

True or False. If True, the user will be prompted to Initialize motors on startup. The user has a choice to cancel this prompt.

 <add key="DatumOnStart" value="true"></add>

Dir_Working

Sets the Working directory for ODIS. This is the location where Scan data is stored.
Note: This directory can be overridden by the "Set Working Directory" menu option. See Main Menu.

 <add key="Dir_Working" value="C:\OKOS\ODIS_DATA\Scans"></add>

Dir_Parameters

Sets the Parameters directory for ODIS. This is the location where parameter files are stored.

 <add key="Dir_Parameters" value="C:\OKOS\ODIS_DATA\Scans"></add>

Dir_Temp

Sets the Temporary directory for ODIS. This is the location where temporary files are created. Any files left behind in this directory can be deleted once ODIS exits.

 <add key="Dir_Temp" value="C:\OKOS\ODIS_DATA\Temp"></add>

Dir_Palette

Sets the directory where Palette files are stored.

 <add key="Dir_Palette" value="C:\OKOS\ODIS_DATA\Palettes"></add>

Dir_ScanMath

Sets the directory where ScanMath code is stored. All code in this directory must be compilable by the C# runtime, otherwise errors may occur when using the Scan Math features of ODIS.

 <add key="Dir_ScanMath" value="C:\OKOS\ODIS_DATA\ScanMath"></add>

Dir_Transducers

Sets the directory where Transducer information is stored. This information is edited in the Transducers menu item.

Dir_Reports

Sets the directory where report stylesheets are stored. This includes both Cascading Style Sheets (CSS) and XML transforms (XSLT).

 <add key="Dir_Reports" value="C:\OKOS\ODIS_DATA\Reports"></add>

Display_FFT_On_Start

True or False. If True, a Magnitude spectrum plot of the A/D board signal will be shown on startup.

 <add key="Display_FFT_On_Start" value="false"></add>

Init_Motors_With_Limits

True or False. If true, the user will have the option to initialize motors, assuming limits are present on all axes.

 <add key="Init_Motors_With_Limits" value="true"></add>


Init_Motors_Without_Limits

True or False. If true, the user will have the option to initialize motors without limits present.
IMPORTANT NOTE: This requires the presence of hard stops and encoder feedback on all axes. Otherwise, damage to your system may result.

 <add key="Init_Motors_Without_Limits" value="false"></add>

Mode

Sets the default run state of the program. Depending on the mode, ODIS will hide or show different features. If the user has logged in with and id that already defines the run mode, this tag will be overridden.

Defined types are as follows:

basic
Runs ODIS in a simplified mode (3-axis support only, limited A/D and P/R, limited gate settings)
normal
Runs ODIS with all current configuration settings (this is the default setting)
acquisition
Runs in Data Acquisition Mode. No Motion support, but A/D and P/R configurations are used.
analysis
Runs ODIS without A/D, P/R or Motion support. Images can be loaded and analyzed.
production
Runs ODIS in Production mode
 <add key="Mode" value="basic"></add>

MotionType

This tells ODIS which type of Motor Controller to look for. Current values are:

  • Galil (Galil Motor controllers, PCI or Ethernet)
  • Melec (Melec 870 and 872 PCI Motor Controllers)
  • Copley (For direct control of motion using Copleys CANBus interface)
  • Shell (Creates a dummy Motor Controller shell for simulation modes)
  • Arcus (For Arcus 4-axis Motor Controllers)
 <add key="MotionType" value="Galil"></add>

Production_Mode

  • Deprecated: use “Mode” key instead.

True or False.

 <add key="Production_Mode" value="false"></add>

PRType

This tells ODIS which type of Pulser/Reciever to look for. Most digital P/Rs also require an ODIS_Config section describing the ports used for communication (see Pulser Configuration Settings). Current recognized types are:

Tag Description
DPR500 JSR DPR500
DPR300 JSR DPR300, all configurations
PR5800 Panametrics 5800
PR5900 Panametrics 5900
DPR002 JSR DPR002, uses special serial control
DPR35 JSR DPR35, uses special serial control
DPR35G JSR DPR35G
PureView PureView USB P/R
Shell Creates a dummy Pulser/Receiver shell for simulation modes
Multi Used in systems with multiple Pulser/Receivers
NoneNo Pulser/Receiver window will be displayed

Use “None” or “Shell” if using a Pulser/Receiver that is not controlled digitially.

 <add key="PRType" value="Shell"></add>

<Motors>

This section is used to set defaults for the selected Motor controller More detailed configuration is listed in Motors.xml.

Note that in this file, “X”, “Y”, “Z”, etc. refer to specific axes in the motor controller:

  • X = axis 1
  • Y = axis 2
  • Z = axis 3
  • T = axis 4
  • G = axis 5
  • S = axis 6

Any references to axes indexes are 0-based (e.g. X = 0, Y = 1, etc.)


AccX/Y/Z/T/G/S

Sets Jog Accelerations for the first six axes. Units are in the defined OperatingUnits (see “ScanManager” section), or degrees for rotational axes.

 <add key="AccX" value="300"></add>

DatumOrder

Sets Initialization order for the first three axes. Axis indices are 0-based.

 <add key="DatumOrder" value="012"></add>

FocusAxis

Sets the default focus axis. Value is an index into the available motor axes. Indexes are 0-based.

 <add key="FocusAxis" value="2"></add>

GoHomeOrder

Sets Homing order for the first three axes. Axis indices are 0-based.

 <add key="GoHomeOrder" value="102"></add>

HomeX/HomeY/HomeZ

Sets the default Home position on the first three axes. Units are in OperatingUnits.

 <add key="HomeZ" value="20"></add>

IPAddress

Sets the ip address to use when searching for Ethernet-based Motor Controllers.

 <add key="IPAddress" value="127.0.0.1"></add>

JogSlowX/Y/Z/T/G/S

  • Deprecated: use System Configuration to set Jog Slow Speeds.

Sets the Slow speed to use when jogging any of the first six axes.

 <add key="JogSlowX" value="10"></add>

JogFastX/Y/Z/T/G/S

Sets the Fast speed to use when jogging any of the first six axes.

 <add key="JogFastX" value="50"></add>

X/Y/Z/T/G/SLimit

Sets whether or not limits are present on the first six axes.

 <add key="XLimit" value="true"></add>

NumAxes

Sets the number of axes to use in the system. This may not be the number of axes available (e.g. using 3 axes on a 4-axis motor controller) and does not include special axes (e.g. using axes 4 and 5 to do Motor Triggering on a Galil Motor controller).

 <add key="NumAxes" value="3"></add>

ScanAxis

Sets the default scan axis. Value is an index into the available motor axes. Indexes are 0-based.

 <add key="ScanAxis" value="0"></add>


StepAxis

Sets the default step axis. Value is an index into the available motor axes. Indexes are 0-based.

 <add key="StepAxis" value="1"></add>

<ScanManager>

This section is used to set defaults for the Scan Manager.

DMADownloadSize

  • Deprecated: use System Configuration to set Download Size.

Sets the number of acquisitions to make before attempting to download the data from the board. Max is 255. This also sets how many acquisitions to make between digital oscilloscope updates.

 <add key="DMADownloadSize" value="200"></add>

DoStep

  • Deprecated: use System Configuration to set the diagnostic settings.

True or False. If false, scan collections will not move the step axis, causing the collection to repeat the same scanline over and over. Useful for diagnosing motor drift issues.

 <add key="DoStep" value="true"></add>

EncoderResolution

  • Deprecated: use System Configuration to set the Encoder resolution

Sets the number of encoder counts per OperatingUnit, as used on the A/D board. For linear axes, this is counts per mm or inch, depending on the Operating Units. For Rotational axes, this is specified in counts per degree.

 <add key="EncoderResolution" value="800.0"></add>

FireNewData

 <add key="FireNewData" value="true"></add>

GoStartOrder

  • Deprecated: use System Configuration to set Start Order.

Sets the order in which axes return to scan start.

 <add key="GoStartOrder" value="201"></add>

OverScan

  • Deprecated: use System Configuration to set Overscan.

Sets the amount of overscan to user per scanline. Units are in OperatingUnits.

 <add key="OverScan" value="1"></add>

OperatingUnits

Sets the default operating units for the system, either “mm” (millimeters) or “in” (inches). Must use the same units (“mm” or “in”) as used in Motors.xml.

 <add key="OperatingUnits" value="mm"></add>

RestartFreeRunning

True or False. If True, after a scan is complete, the scope is started back up in freerunning mode (e.g., collects a sample continuously). If not, the scope will remain off until the user turns it back on.

 <add key="RestartFreeRunning" value="true"></add>

ScanTimeout

Sets the minimum timeout (in milliseconds) for the system to wait while a scan line is in progress. If a scanline is calculated to take longer than the minimum timeout (based on scan velocity and acceleration settings), the calculated value is used instead. Example:

 <add key="ScanTimeout" value="15.0"></add>

<FormImage>

This section has settings related to image display and export.

RasterViewPerspective

  • Deprecated: no longer used. Use System Configuration to set default orientation.

Sets the Image orientation to display.

 <add key="RasterViewPerspective" value="TopLeft"></add>

RotateExcelExport

 <add key="RotateExcelExport" value="false"></add>

ExcelExportDecimation

In nm (nanometers).

 <add key="ExcelExportDecimation" value="6350"></add>


MaxDisplayPixels

  • Deprecated: use System Configuration to set maximum Display Pixels.

Sets the maximum number of display pixels to use when scanning. If the image size is greater than the Maximum display pixels, the image will be decimated before being displayed.

 <add key="MaxDisplayPixels" value="1000"></add>

<Pulsers>

This section is used to set the Port used to communicate with the device is set. Older versions of ODIS_Config used individual configurations for each type of Pulser/Receiver.

IOHW

Sets the type of I/O used to communicate with the P/R. Applies to DPR002 and DPR35 only. Ignored for other pulser types. Current values are:

ETH32
Winford ETH32
IO24
Elexol I/O Controller

Other types will be added as supported.

 <add key="IOHW" value="ETH32"></add>

IPAddress

IP Address with which to communicate with the P/R, or the hardware used to talk to the P/R. The IP address should be in standard format “XXX.XXX.XXX.XXX”, where “XXX” is from 0 to 255.

 <add key="IPAddress" value="192.168.1.1"></add>

MultiType

When using multiple P/Rs, this describes the type of P/Rs present. Current values are:

JSR
JSR P/Rs with Daisy chain support (e.g. DPR300, DPR500, and DPR35G)
Shell
dummy Shell P/Rs (used in testing)
 <add key="MultiType" value="JSR"></add>

NumPulsers

If using multiple P/Rs, this lists the number of pulsers expected. If not present, the number of pulsers is assumed to be one.

 <add key="NumPulsers" value="3"></add>

Port

Sets the communication (COM) port used to control the digital P/R, for pulser types that use a Serial port. Ignored if using a “Shell” pulser. Current values are:

COMx
Sets the COM port to use, where "x" is the assigned serial port (e.g. "COM3")
Simulate
tells the system to create the control for the pulser but will only simulate hardware communications. If simulation is active the NumPulsers key will be used to determine how many pulsers to simulate, and the PRType key will determine the type of pulser.
 <add key="Port" value="COM1" />

Obsolete ODIS_Config sections for Pulsers

The following sections are deprecated and should be replaced by the <Pulsers> section.

 <FormUTex>
 <FormDPR500>
 <FormDPR300>
 <FormDPR5900>

<LightPole>

This section defines the IP address for the LightPole attachment (if any).

IPAddress

IP Address with which to communicate with the Lightpole, or the hardware used to talk to the Lightpole. The IP address should be in standard format “XXX.XXX.XXX.XXX”, where “XXX” is from 0 to 255.

 <add key="IPAddress" value="192.168.1.1"></add>


<Communications>

This section defines the IP and hardware for I/O Communications (if any). When enabled, an IOConfig file should also be present.

CommDevice

Type of Communications Deviced used to send I/O. Current possible values are "ETH32".

  <add key="CommDevice" value="ETH32"/>

IPAddress

IP Address with which to communicate with the I/O hardware. The IP address should be in standard format “XXX.XXX.XXX.XXX”, where “XXX” is from 0 to 255.

 <add key="IPAddress" value="192.168.1.1"></add>