This section describes the required keys, the optional keys, the development keys, and the obsoleted keys that are found within the master.txt file. Refer to the relevant tables later in this section for more information about each of the keys listed in Table 1.
Keys that must be included in the master configuration file | |
Key | Description |
$ Display Type | Specifies the display type. Not used on a G610 display module. |
$ File Config File 0 | Specifies the relative file name from the working directory to the file configuration file |
$ Machine Config File 0 | Specifies the relative file name from the working directory to the machine configuration file |
$ Menu Command Log Size | Specifies how many items to keep in the list of button presses in the diagnostic file (default = 40) |
$ Send Dr Watson Log | Specifies whether the onboard software transmits Dr Watson log files to the office via FTP |
$ Working Directory | Specifies the full path to the current working directory for the onboard software |
Optional keys that can be included in the master configuration file | |
Key | Description |
$ CGC TTT | Specific to v5.1 only and is used by the onboard software at start-up to define the machine as using blade control features |
$ GPS Over CAN | Disables the onboard software system from using the CAN bus for GNSS communication |
$ Navigator With Unique Network Name | Informs the onboard software that the name of the D3:C4 Nav 10.4 Display has been changed |
$ Position Broadcast | This key enables machine position to be broadcast. Any machine configured to listen to the broadcast can show other machine positions on the plan. |
$ No GPS Time Set | Specifies the D3:C4 Nav 10.4 clock time instead of GPS time |
$ Site Elevation Extents | Defines the maximum and minimum extent of elevations found on the site |
$ SN In Registry | Used on displays that do not have an EPROM and that read the display Serial Number from the windows registry |
Keys that may be included in the master configuration file for software development purposes only | |
Key | Description |
$ Calibration Menu | Specifies the display of the "Calibration" menu item in the main menu in the onboard software |
$ Development Menu | If this key is present, the Configuration Menu item appears in the main menu. |
$ Exit Menu | Displays an "Exit" menu item that will cause the onboard software to terminate |
$ File Delay | When replaying a position data file, this number defines the time delay in milliseconds that is desired between the processing of each position in the file. |
$ Files to Delete | Defines a list of files to be deleted when the onboard software starts up |
$ Gps Input | Defines the file name of the position data file to be replayed in the onboard software |
$ Gps Type | Specifies the position system input type |
$ No Restart Config File | If this key is present, the file configuration file will not be written out by the onboard software when the onboard software exits. |
$ Power Control | Determines whether the onboard software will shut down the Microsoft Windows Operating System when the onboard software exits |
$ Test Menu | If this key is present, the Test Menu item appears in the main menu. |
$ Title Bar | If this key is present, then the main window will have a title bar and border. |
The following keys are obsolete in v4.5. If included in the master configuration file, the keys will be ignored.
- $ Internal Units
- $ Master Data Files Src Dir
- $ Mets Directory
- $ No GPS Time Set
- $ Process Snip
- $ Record Ore Loads
- $ SN in Registry
The following keys are obsolete in v6.0. If included in the master configuration file, the keys will be ignored.
- $ Diag Directory
- $ Config Directory
- $ Data Directory
- $ Executable Directory
- $ Ftp Directory
- $ MineStar Directory
- $ Playback File Time Length
- $ Playback File Path
- $ Sensor Log Playback File
- $ Snip Directory
- $ Temp Directory
Required Master Configuration File Keys
The following keys must be included in the master configuration file:
$ Config Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard configuration files. | ||||
Syntax: | $ Config Directory =<directory> | ||||
Example: | $ Config Directory =config\
$ Working Directory =c:\caes\ In this example, the data files for the onboard software would be stored in the directory c:\caes\config\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Data Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard software data files. | ||||
Syntax: | $ Data Directory =<directory> | ||||
Example: | $ Data Directory =data\
$ Working Directory =c:\caes\ In this example, the data files for the onboard software would be stored in the directory c:\caes\data\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Display Type | |||||
---|---|---|---|---|---|
Description: | This key specifies the display type on which the onboard software is running.
Note: Do not alter this key for the G610 display module. Note: This key has been removed from the Terrain mobile software. |
||||
Syntax: | $ Display Type =<Display Name> | ||||
Example: | $ Display Type =D3:C4 Nav 10.4 | ||||
Parameter | Description | Possible Values | Default | Data Type | Units |
Name | Display Type on which the onboard software is running. | D3:C4 Nav 10.4 | String | NA |
$ Executable Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard software application files (EXE files) and DLLs. | ||||
Syntax: | $ Executable Directory =<directory> | ||||
Example: | $ Executable Directory =exe\
$ Working Directory =c:\caes\ In this example, the EXE and DLL files for the onboard software would be stored in the directory c:\caes\exe\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ File Config File 0 | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative file name from the working directory to the file configuration file. This file is created and managed by the onboard software. On exit, the onboard software uses this file to store the list of DTs. DTs are parameters that describe the state of the machine and display configuration modes at the time the onboard software exits. | ||||
Syntax: | $ File Config File 0 =<path> | ||||
Example: | $ File Config File 0 =config\file_cfg.txt
$ Working Directory =c:\caes\ The file configuration file would be stored in the file c:\caes\config\file_cfg.txt |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
path | The relative file name from the working directory. | A file name up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Ftp Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that will be used to store files temporarily that are being transmitted via FTP. | ||||
Syntax: | $ Ftp Directory =<directory> | ||||
Example: | $ Ftp Directory =ftp\
$ Working Directory =d:\caes\ In this example, the files that the onboard software is transmitting via FTP are temporarily stored in the directory d:\caes\ftp\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long. | None | String | NA |
$ Machine Config File 0 | ||||
Description: | This key specifies the relative file name from the CAES working directory to the machine configuration file. | |||
Syntax: | $ Machine Config File 0 =<path> | |||
Example: | $ Machine Config File 0 =config\mach_cfg.txt
$ Working Directory =[drive name]: \caes\ The CAES machine configuration file would be stored in the file [drive name]: \caes\config\file_cfg.txt |
|||
Parameter | Description | Possible Values | Default | Data Type |
Path | The relative file name from the working directory. | A file name up to 255 chars long for the onboard software.
CAES is restricted to 8.3 file names and paths |
None | String |
$ Menu Command Log Size | ||||
Description: | This key sets the number of on-display button presses included in the diagnostic file. | |||
Syntax: | $ Menu Command Log Size =<number of presses> | |||
Example: | $ Menu Command Log Size =40
In this example, the diagnostic file will show the latest 40 buttons pressed by the operator on the display. |
|||
Parameter | Description | Possible Values | Default | Data Type |
number of presses | Number of on-display button presses | Any Integer | 40 | Integer |
$ Minestar Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that will be used to store MineStar files. | ||||
Syntax: | $ Minestar Directory =<directory> | ||||
Example: | $ Minestar Directory =minestar\
$ Working Directory =d:\caes\ In this example, the MineStar files that the onboard software uses are stored in the directory d:\caes\minestar\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long. | None | String | NA |
$ Send Dr Watson Log | |||||
---|---|---|---|---|---|
Description: | This key determines whether the onboard software transmits Dr Watson log files to the office via FTP. Dr Watson logs are generated when the onboard software crashes. Logs are sent to the office diagnostics directory of the machine. | ||||
Syntax: | $ Send Dr Watson Log =<flag> | ||||
Example: | $ Send Dr Watson Log =1
The onboard software will send Dr Watson logs. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
flag | A Boolean flag to determine whether to send Dr Watson logs via FTP. | 0 = Do not send Dr Watson logs
1 = Send Dr Watson logs |
None | Integer | NA |
$ Snip Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard software snippet files. | ||||
Syntax: | $ Snip Directory =<directory> | ||||
Example: | $ Snip Directory =snip\
$ Working Directory =c:\caes\ In this example, the snippet files for the onboard software would be stored in the directory c:\caes\snip\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Temp Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard software temporary files. | ||||
Syntax: | $ Temp Directory =<directory> | ||||
Example: | $ Data Directory =temp\
$ Working Directory =c:\caes\ In this example, the data files for the onboard software would be stored in the directory c:\caes\temp\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Working Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the full path to the current working directory. The working directory is the root directory that contains the onboard software folders (for example, config, data, snip, temp). | ||||
Syntax: | $ Working Directory =<directory> | ||||
Example: | |||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The full path to a directory. Path must end with a \ character. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths.
c:\caes (CAES) or d:\caes |
$ Working Directory =c:\caes\ | In this example, the working directory for the onboard software is set to c:\caes\. | NA |
Optional Master Configuration File Keys
The following six keys may be included in the Master Configuration file, however the keys are not required.
$ CGC TTT | |||||
---|---|---|---|---|---|
Description: | This key, which was introduced in v5.1, is used by the onboard software at start-up to define the machine as using blade control features.
The Terrain onboard software checks for the presence of the key. |
||||
Syntax: | $ CGC TTT | ||||
Example: | $ CGC TTT key is present
The onboard software starts the relevant DLL files and checks the presence of the Implement Electronic Control Module (ECM). The MCU checks to see if the machine type = "Track-type Tractor" and Antenna count = "2" . If so, then the onboard software defines security keys as unnecessary. |
||||
Description | Possible Values | Default | |||
Use blade control features | Key is present or not present | Not present |
$ Diag Directory | |||||
---|---|---|---|---|---|
Description: | This key specifies the relative path from the working directory to the directory that contains the onboard software diagnostic files. | ||||
Syntax: | $ Diag Directory =<directory> | ||||
Example: | $ Data Directory =diag\
$ Working Directory =c:\caes\ In this example, the data files for the onboard software would be stored in the directory c:\caes\diag\. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
directory | The relative path to a directory. Path must end with a \ character. | A directory path up to 255 characters long. | None | String | NA |
$ GPS Over CAN | |||||
Description: | Disables the onboard software system from using the CAN bus for satellite communication | ||||
Syntax: | $ GPS Over CAN =<flag> | ||||
Example | $ GPS Over CAN =0
in master.txt file, MS Controller is forced to use the serial port to communicate with the satellite receiver. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
flag | Determine if use CAN or serial port | Key is notpresent = communicate using CAN
0 = communicate using serial port 1 = communicate using CAN |
1 | Integer | NA |
$ Navigator With Unique Network Name | |||||
---|---|---|---|---|---|
Description: | This key is used to inform the onboard software that the name of the D3:C4 Nav 10.4 has been changed.
Reference: Refer to Systems Operation, M0102735, "D3:C4 Nav 10.4 Display Ethernet Port Activation" for information on how to change the name of the display. |
||||
Syntax: | $ Navigator With Unique Network Name =<new D3:C4 Nav 10.4 Display name> | ||||
Example: | $ Navigator With Unique Network Name =Dozer20 | ||||
Parameter | Description | Possible Values | Default | Data Type | Units |
NA | NA. | Text and numbers | NA | NA | NA |
$ No GPS Time Set | |||||
---|---|---|---|---|---|
Description: | The system time is set from the D3:C4 Nav 10.4 Display clock instead of from the GPS time.
If this key is not enabled, then GPS time is used to set system time. |
||||
Syntax: | $ No GPS Time Set |
$ Position Broadcast | |||||
---|---|---|---|---|---|
Description: | This key enables machine position to be broadcast. Any machine configured to listen to the broadcast can show other machine positions on the plan. When using a TC900 radio and multicasting, make sure that the Ethernet port is disabled. Disabling the Ethernet port forces the multicast to use the RAS connection.
Reference: Refer to Systems Operation, M0102735, "D3:C4 Nav 10.4 Display Ethernet Port Activation" for information on how to change the name of the display. |
||||
Syntax: | $ Position Broadcast <number> =<address> <port> <time interval> | ||||
Example: | $ Position Broadcast 0 =224.0.252.1 13000 2000
Positions are broadcast every 2 seconds to IP address 224.0.252.1 on port 13000 |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
number | Sequence number
Consecutive starting at 0 |
0, 1, 2, 3, ... | None | Integer | NA |
address | Broadcast IP address | Any valid address
224.0.0.### |
None | String | NA |
port | UDP port number | Any valid port | None | Integer | NA |
time interval | Broadcast interval | Any positive integer | None | Integer | Milliseconds |
$ Site Elevation Extents | |||||
Description: | Defines the maximum and minimum extent of elevations found on the site.
Note: Do not set these limits too close to the actual operating elevations. The log files created by transgressions beyond these limits by the machines will result in large log files being created and transmitted to the office. (i) If the key is not present, the onboard software will default to -1000 m and 10000 m as the minimum and maximum values. (ii) If the $ Site Elevation Extents key is configured incorrectly, an error message is written to the DiagMsgLog file. If the minimum value is higher than the maximum value, the $ Site Elevation Extents key is configured with the default values. (iii) If an elevation spikes beyond the extents of this key, an entry is written to the ElevationExtentErrors.log which can be found in the \temp directory. The log file is appended to the Diagnostic File and sent to the office when the onboard software starts up or when a Diagnostic File is requested. The log file is then cleared and started again with the configured extents. |
||||
Syntax: | $ Site Elevation Extents =<min elevation> <max elevation> | ||||
Example: | $ Site Elevation Extents =-200 1150
The minimum elevation that should be expected on site is -200 m. The maximum elevation expected on site is 1150 m. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
Minimum elevation | Minimum elevation on site | Anything less than the maximum | -1000 | Real number | Meters |
Maximum elevation | Maximum elevation on site | Anything greater than the minimum | 10000 |
$ SN in Registry | ||
Description: | The $ SN In Registry key must now be configured in the master.txt file
Enable or disable SN in registry. $ SN In Registry is used on displays that do not have an EPROM and that read the display Serial Number from the windows registry. Note: Tick to enable this setting. Clear to disable. |
|
Syntax: | $ SN In Registry =<flag> | |
Example: | Yes
The display Serial Number is in the windows registry. |
|
Possible Values | Default | Data Type |
Yes
No |
Yes | N/A |
Development Master Configuration File Keys
The following keys may be included in the master configuration file, however the keys are to be included for software development purposes only.
$ Exit Menu | |||||
---|---|---|---|---|---|
Description: | For the onboard software, this key displays an "Exit" menu item on the "System" menu
For the onboard software, displays an exit menu item on the Diagnostics > Service menu that will cause the onboard software to terminate This key should be used for demonstration purposes only. |
||||
Syntax: | $ Exit Menu =<flag> | ||||
Example: | $ Exit Menu =1
Displays the exit menu item. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
flag | Boolean flag to determine whether the Exit menu item is displayed.
For the onboard software, the presence of the key will display the menu item regardless of the value of the flag. |
0 = No Exit menu item.
1 = Exit menu item is displayed. |
0 | Integer | NA |
$ File Delay | |||||
---|---|---|---|---|---|
Description: | When replaying a position data file, this key defines the time delay in milliseconds that is desired between the processing of each position in the file. | ||||
Syntax: | $ File Delay =<delay time> | ||||
Example: | $ File Delay =200
Since positions are received five times per second, normal time playback can be approximated with a delay value of 200 milliseconds. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
delay time | Amount of time to delay between GPS positions. | 0 - 65535 | Integer | millisecond |
$ Files to Delete | |||||
---|---|---|---|---|---|
Description: | This key defines a list of the files that are to be deleted when the onboard software starts up.
NOTE: "to" is not capitalized. |
||||
Syntax: | $ Files to Delete # =<filename> | ||||
Example: | $ Files to Delete 0 =temp\test1.txt
$ Files to Delete 1 =temp\test2.txt Upon start-up, the onboard software will delete the files "test1.txt" and"test2.txt" in the temp directory. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
# | The first occurrence must be numbered 0 (zero). Each additional occurrence of this item must be numbered consecutively from the first occurrence. | 0 - 65535 | NA | Integer | NA |
filename | The name of the file to be deleted at system start-up.The name can be either a relative file name to the working directory or can be a full path name to a specific file. | A file name up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | NA | String | NA |
$ Gps Input | |||||
---|---|---|---|---|---|
Description: | This key defines the file name of the position data file that is to be replayed in the onboard software. | ||||
Syntax: | $ Gps Input =<filename> | ||||
Example: | $ Gps Input =c:\caes\temp\gps_data.gsf
This key will cause the onboard software to input position data from the file "gps_data.gsf" that is located in the c:\caes\temp directory. This data will be used in lieu of actual data from the satellite receiver. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
filename | The full path file name to the GNSS position data file. | A directory path up to 255 characters long for the onboard software. CAES is restricted to 8.3 file names and paths. | None | String | NA |
$ Gps Type | |||||
---|---|---|---|---|---|
Description: | This key specifies the internal format of the Position Input. | ||||
Syntax: | $ Gps Type =<number> | ||||
Example: | $ Gps Type =1
$ Gps Input =c:\caes\temp\gpsdata.dat The onboard software expects the satellite data to be in a Trimble GSOF format. Type 5 supports playback and real-time position input. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
number | Specifies the internal format of the Position Input File | 0 = Test Use Only (VPG)
1 = Caterpillar formatted ASCII data 5 = Trimble GSOF format real time and Playback 6 = Trimble GSOF Playback 7 = Novariant XPS or NMEA GGA, WGS-84 input |
5 | Integer | NA |
$ No Restart Config File | |||||
---|---|---|---|---|---|
Description: | If this key is present, then the file configuration file will not be written out by the onboard software when the onboard software exits.
If this key is not present, the onboard software defaults to writing out the file at exit. |
||||
Syntax: | $ No Restart Config File =<flag> | ||||
Example: | $ No Restart Config File =0
No file configuration file will be written when the system shuts down. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
flag | If this key is present, then the file configuration file will not be written regardless of the value of the flag | 0 - 65535 | None | Integer | NA |
$ Power Control | |||||
---|---|---|---|---|---|
Description: | This key is used to determine whether the onboard software will shut down the Microsoft Windows Operating System when the onboard software exits. | ||||
Syntax: | $ Power Control =<number> | ||||
Example: | $ Power Control =2
This setting will cause the onboard software not to exit MS Windows when the onboard software shuts down. This setting should be used when running system demos on a desktop PC. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
number | Value to define whether MS Windows will exit. | 0 = Exit Windows
1 = No longer used 2 = Do not exit Windows |
None | Integer | NA |
$ Title Bar | |||||
---|---|---|---|---|---|
Description: | If this key is present, then the main window will have a title bar and border. | ||||
Syntax: | $ Title Bar =<flag> | ||||
Example: | $ Title Bar =0
Even though the flag value is 0, a title bar will be displayed at the top of the main window. |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
flag | Regardless of the value of this flag, if this key is present then the onboard software will be displayed with an MS Windows Title bar. | 0 - 65535 | None | Integer | NA |
$ Calibration Menu | |||||
---|---|---|---|---|---|
Description: | This key specifies the display of the "Calibration" menu item in the onboard software main menu. The "Calibration" menu contains options that are used to either view calibrations or else to complete calibrations for dual satellite receiver excavator and front shovel systems. The "Calibration" menu item is displayed until a current machine calibration is available. This is true regardless of the specified calibration key configuration. | ||||
Syntax: | $ Calibration Menu =<flag> | ||||
Example: | $ Calibration Menu =1.
In this example the "Calibration" menu may be opened from the onboard software main menu |
||||
Parameter | Description | Possible Values | Default | Data Type | Units |
Flag | A Boolean flag to indicate whether to display the additional <label>Calibration</label> menu | 0 = Do not display the <label>Calibration</label> menu
1 = Display the <label>Calibration</label> menu |
0 | Integer | NA |