- Caterpillar Products
- All
Introduction
This Special Instruction describes the technical specifications and output file formats of the Cat® VIMS Converter functionality.
Important Safety Information
Do not perform any procedure in this Special Instruction until you have read this Special Instruction and you understand this information. Use only proper tools and observe all precautions that pertain to the use of those tools. Failure to follow these procedures can result in personal injury. The following procedures should be observed.
Work safely. Most accidents that involve product operation, maintenance, and repair are caused by failure to observe basic safety rules or precautions. An accident can often be avoided by recognizing potentially hazardous situations before an accident occurs.
A person must be alert to potential hazards. This person should also have the necessary training, skills, and tools to perform these functions properly.
Safety precautions and warnings are provided in this instruction and on the product. If these hazard warnings are not heeded, bodily injury or death could occur to you or to other persons. Caterpillar cannot anticipate every possible circumstance that might involve a potential hazard.
Therefore, the warnings in this publication and the warnings that are on the product are not all inclusive. Ensure that any tool, procedure, work method, or operating technique you use that is not recommended by Caterpillar is safe.
Cat® VIMS Converter
The Cat® VIMS Converter parses binary VIMS files and creates a comma-separated value output files representing the input file.
The converter supports the following VIMS file types:
- Truck payload (.PA_ and .PA3)
- Continuous loggers1 (.CL_ and .CL3)
- Events (.EC_ and .EC3)
- Data loggers (.DL_ and .DL3)
- Trends (.TR_ and .TR3)
The converter supports the following machine platforms:
- Cat VIMS 68K with health interface module
- Cat VIMS ABL with health interface module
- Cat VIMS 3G
Illustration 1 | g06152474 |
Example of the acquisition and conversion process (1) VIMS 3G"" (2) File Server (3) Cat VIMS File Decoder (4) Cat VIMS CSV File Creator (5) Creates CSVs (6) File Server |
An example of the acquisition and conversion process is shown in Illustration 1.
Note: In order for continuous logger files to be processed by the Cat® MineStar system, the associate cl_cnf created by the onboard also needs to be provided to the system.
Performance Considerations
The StandardJobExecutor service hosts the conversion process. The StandardJobExecutor service supports multi-threading of scheduled jobs, and to increase throughput the converter will process files concurrently with the following constraints:
- 5 threads will be used to process small files
- Large files will use between one and ten threads depending on the maximum memory assigned to the JVM
A large file is considered a file with a size more than 16384 bytes.
Configuring the JVM with a maximum memory (-xmx) value of 4096M is recommended. This memory setting will use 9 threads for processing of large files.
Output File Naming
The output file will be named in the following format:
<original input file name>.csvFor example:
Input File Name | Output File Name |
---|---|
SSP00760151211072746.CL3 | SSP00760151211072746.CL3.csv |
File Upload to Caterpillar
The mechanism used to transfer the binary VIMS files to Caterpillar is standard SFTP, that is, SSH File Transfer Protocol running on the standard SSH port of TCP 22.
Caterpillar will configure the system with a set of credentials used to upload these files to Caterpillars corporate data warehouse.
The system will attempt to upload the source binary VIMS files each time the conversion process is run. If the upload should fail, a maximum of 1500 files will be queued for upload. Once this queue limit is reached, the conversion process will stop until the backlog is successfully uploaded to the Caterpillar gateway.
Define The Customer Code and Dealer Code
- Run MineStar Supervisor.
- Click Options > System Options.
Show/hide table
Illustration 2 g06153945 - On the General tab, enter the Customer Code and Dealer Code for your site.
Customer Code - XXXX
Dealer Code - 0589
- Click "Apply" to save the changes.
- Stop all M* Services.
- Navigate to mstarFiles\systems\main\shortcuts\ServerDesktop.
- Right-click Stop Services.
- Select Run as administrator.
- Start all M* Services.
- Navigate to mstarFiles\systems\main\shortcuts\ServerDesktop.
- Right-click Start Services.
- Select Run as administrator.
The files sent out of the tool shall have the following naming after the change:
Missing Channel Information
Any channel that is recorded into the VIMS binary file with a failure mode indicator (that is, a code indicating that a value was not valid or available) will be included in the exported csv file with an empty value.
Continuous Data Logger Considerations
For historical reasons there are some considerations that must be taken in to account when analyzing continuous logger files.
These considerations include:
- Incorrect Timestamps
- A continuous data logger file always contains the machine data over the last one operating hour. The timestamp associated with the data is only applied once retroactively when the download is triggered. Therefore, if the machine was powered off in the preceding 1 hour, the data recorded before the power off will be tagged with incorrect timestamps.
- Possible Data Duplication in Logger Files
- If a continuous data logger file is downloaded more often than every 1 hour, some of the files content will be duplicated into other data logger files. For example, by downloading files every 20 minutes, only 20 minutes out of the 60 recorded minutes will be new content. The first 40 minutes of data will be duplicated from the files downloaded previously.
Data Type Definitions
All units referenced in files are base International System of Units (SI) units unless otherwise mentioned.
Data types described below are in general and are to assist with the development of import routines, and are not detailed descriptions of data types (that is, columns are not described in platform-specific data types such as int, float, double, and string).
String
Number
Integer
GPS
[Latitude, Longitude, Height] in degrees (decimal)
Date/Time
As per ISO 8601
<Date>T<Time_UTC> where
Component | Format |
---|---|
<Date> | YYYY-MM-DD |
<Time_UTC> | hh:mm:ss |
Note: The Date/Time information is provided by the real-time clock of the machine onboard ECM creating the VIMS binary file. Make sure that the on-board ECMs clocks are set accurately, within the time zone of interest.
Output File Format Definitions
All CSV files outputting contain a header row with the following column header values.
Data & Continuous Loggers
Note: Parameter units are typically SI base units and are described in the parameter unit field.
Column Number | Value | Data Type |
---|---|---|
1 | Serial Number | String |
2 | Date/Time | Date/Time |
3 | SMH | Number |
4 | Parameter Name | String |
5 | Parameter Value | Number |
6 | Parameter Unit | String |
7 | Display Code | Integer |
Display codes apply only to parameters representing operational states (example: ON, OFF, engaged, active and so on). The code refers to a table ID that provides the mapping between the Parameter Value and the operational state.
Events
Column Number | Value | Data Type |
---|---|---|
1 | Serial Number | String |
2 | Date/Time | Date/Time |
3 | SMH | Number |
4 | Event Name | String |
5 | Event Severity | Integer |
6 | Event Failure Mode | Integer |
7 | Event Status | String |
8 | Occurrence Count | Integer |
9 | Duration | Integer |
10 | Source | String |
11 | Trigger Value | Number |
12 | Worst Value | Number |
13 | GPS Position | GPS |
Trend
Note: Parameter units are typically SI base units and are described in the trend unit field.
Column Number | Value | Data Type |
---|---|---|
1 | Serial Number | String |
2 | Date/Time | Date/Time |
3 | SMH | Number |
4 | Trend Parameter Name | String |
5 | Trend Value | Number |
6 | Trend Unit | String |
7 | Trend Condition | String |
8 | Trend Type | String |
Truck Payload
Column Number | Value | Data Type | Unit |
---|---|---|---|
1 | Serial Number | String | |
2 | Date/Time | Date/Time | |
3 | SMH | Number | |
4 | Payload Weight | Number | |
5 | Payload Unit | String | |
6 | Load Cycle Time (Loading) | Number | Second |
7 | Load Cycle Time (Stopped Empty) | Number | Second |
8 | Load Cycle Time (Traveling Empty) | Number | Second |
9 | Load Cycle Distance (Traveling Empty) | Number | Kilometer |
10 | Load Cycle Time (Stopped Loaded) | Number | Second |
11 | Load Cycle Time (Traveling Loaded) | Number | Second |
12 | Load Cycle Distance (Traveling Loaded) | Number | Kilometer |
13 | Load Cycle Pass Count | Integer | |
14 | Number of Transmission Shifts in Payload Cycle | Integer | |
15 | Fuel Used in Payload Cycle | Number | Liter |
16 | Operator ID | Integer | |
17 | Event Mask | Integer | |
18 | Second Gear Reweigh Flag | Integer | |
19 | Truck Payload Carryback | Number | |
20 | GPS Position (Loading) | GPS | |
21 | GPS Signal Status (Loading) | Number | |
22 | GPS Position (Dumping) | GPS | |
23 | GPS Signal Status (Dumping) | Number |