The Configuration File
The configuration file is an "INI" format file. A configuration file is composed of configuration sections where each section defines a device or functional component. Each section is composed of key / value pairs that define the relevant properties of that section. In many cases if a key / value pair is not defined then a default value is used.
Configuration files must contain a section for every device and functional component used by the system.
A configuration section is comprised of the following parts:
The section name or component alias |
[Port1FCM] |
An optional descriptive comment |
;The IP address of the FCM |
A list of Key = value pairs |
IpAddress = 10.10.1.2 |
- Section Name/Alias (as shown in Red)
The section name identifies component being configured. When programming if a function requires a name or alias parameter this is the name used. Section names are enclosed in square brackets[]. In the example above "Port1FCM" is the device alias.
- Comment (as shown in Green)
Comments are lines that have the ";" as their first character. They are used to describe some part in the file and are placed above the part that they are describing. Blank lines are treated as comments.
- Key (as shown in Maroon) / Value Pair (as shown in Blue)
The key value pair is the configuration item being specified that is associated with the component. In the example above the item key "IpAddress" has the value "10.10.1.2".
Different sections may have the same key, however, a single section cannot have two identical keys.
A key may also have a non existent value, i.e.
IpAddress =
This is equivalent to not including the key in the section at all.
Every Configuration must define the key "ConfigType" the allowed types are enumerated by EConfigType and are as follows:
- AmbSplit
- Calibration
- Dcm
- Fcm
- MultiSwitch
- Path
- Pna
- PowerBridge
- Sequence
- Scm
- ShortOpenLoad
- Switch
- UserDevice
Here is an example section with key pair values:
;*******************************************************************************
; This is a section header comment
;*******************************************************************************
[Configuration_Name_Or_Alias]
; This is a key/value comment
ConfigType = Calibration
CalAcquireTimeoutSec = 60