Knowledgebase
Knowledgebase: Support
What are User Defined Parameters and how to I use them?
What are User Defined Parameters?
If you have information on parameters (Switches, Scalars, and/or Tables) that we do not have defined currently in VCM Editor, you can now add them yourself and edit them right in VCM Editor immediately. All you need to do is define the parameters using TunerPro, save the TunerPro definition, and import the TunerPro definition right into the User Defined Parameters feature in VCM Editor. If you would like parameters added to VCM Editor permanently, you can still email support requesting they be added. Please Note: Not all controllers supported by VCM Suite support User Defined Parameters, please email Support for more information.

How do I get to use the User Defined Parameters feature?
The User Defined Parameters feature can be purchased by logging into your customer page and purchasing the one-time feature unlock for $169.99. After you purchase, you will be provided with a new application key. Once you receive the application key, simply enter it into VCM Suite and User Defined Parameters will be available for you to use.

How do I define my own parameters for VCM Editor?
If you have the necessary information on a parameter that you would like to define yourself, you can define and import your own parameters by doing the following:
  1. Define the Parameter(s) using TunerPro
  2. Save your .XDF file with the parameters you wish to import
  3. Open your .HPT file in VCM Editor
  4. Go to Edit -> User Defined Parameters
  5. Open the XDF File and your parameters will be imported into VCM Editor for editing.

Please see the example TunerPro .XDF file posted below for an example of each parameter type:

What are the "Allowed Addresses" in the User Defined Parameters window?
The allowed addresses are address ranges that you are allowed to define parameters in. If you try to define a parameter outside these ranges, they will not import and you will not allowed to edit them.


How do I define a Parameter?
If you have the proper information to be able to define a parameter, please see the following 3 examples for defining a switch, scalar, and table in TunerPro.

To define a switch, insert a new Switch/Flag into your TunerPro definition and fill out the following fields with the appropriate information:
  • Name
  • Description (optional)
  • Address
  • Src Data Size
  • Bit Number

Visibility Level and Categories will be ignored.

Click image for larger version. 

Name:	TunerProSwitch.PNG 
Views:	232 
Size:	13.5 KB 
ID:	67478


To define a scalar, insert a new Scalar into your TunerPro definition and fill out the following fields with the appropriate information:
  • Name
  • Description (optional)
  • Address
  • Size
  • Signed, Floating Point, LSB flags
  • Stock Units
  • Low & High Ranges
  • Conversion Equation

Visibility Level and Categories will be ignored.

Click image for larger version. 

Name:	TunerProScalar.PNG 
Views:	158 
Size:	17.6 KB 
ID:	67479 Click image for larger version. 

Name:	TunerProScalarEquation.PNG 
Views:	126 
Size:	10.6 KB 
ID:	67480


To define a table, insert a new Table into your TunerPro definition and enter the appropriate information for the table, it's row axis, and it's column axis.
Table Information:
  • Name
  • Description (optional)
  • Address
  • Size
  • Signed, Floating Point, LSB flags
  • Cell Units (optional)
  • Low & High Ranges
  • Conversion Equation

Visibility Level and Categories will be ignored.

Click image for larger version. 

Name:	TunerProTable.PNG 
Views:	132 
Size:	18.9 KB 
ID:	67481 Click image for larger version. 

Name:	TunerProTableConversion.PNG 
Views:	103 
Size:	13.5 KB 
ID:	67482

Row Axis Information:
  • Number of Rows
  • Stock Units
  • Label Source1
  • Address
  • Data Size
  • Address step
  • Signed, Floating Point, LSB flags
  • Conversion Equation


Click image for larger version. 

Name:	TunerProTableRow.PNG 
Views:	86 
Size:	18.8 KB 
ID:	67483 Click image for larger version. 

Name:	TunerProTableRowConversion.PNG 
Views:	67 
Size:	12.4 KB 
ID:	67484

Column Axis Information:
  • Number of Rows
  • Stock Units
  • Label Source1
  • Address
  • Data Size
  • Address step
  • Signed, Floating Point, LSB flags
  • Conversion Equation


Click image for larger version. 

Name:	TunerProTableColumn.PNG 
Views:	80 
Size:	17.4 KB 
ID:	67485 Click image for larger version. 

Name:	TunerProTableColumnConversion.PNG 
Views:	59 
Size:	12.4 KB 
ID:	67486

1 Only "External(Manual)", "Internal, Pure", and "Linked, Scale" are supported axis types at this time. "Linked, Normalized" axis types are not supported. Example images above are of type "Internal, Pure".

What if my definition requires a base offset?
Some controllers require a base offset for all parameters. For example, if you define the parameter at address: 0x1ABCDE, however the location of the parameter is actually at 0x801ABCDE. This would require an offset of +0x80000000.

To add a base offset to your entire definition
  1. Open your XDF in TunerPro
  2. Go to XDF -> View/Edit XDF Header Info
  3. Set your bin size2
  4. Set your base offset
  5. Click OK

2When defining a TunerPro base offset to be used in VCM Editor, the bin size doesn't need to be the actual size of the binary. It just needs to be a larger value than the base offset value. The bin size will be ignored when imported into VCM Editor

Click image for larger version. 

Name:	TunerProOffset.PNG 
Views:	58 
Size:	13.9 KB 
ID:	69679

NOTE: For TunerPro V5.00.8944 or older, if you must define a base offset of 0x80000000 or higher you must edit the base offset manually in a text editor.(Notepad/Notepad++) To manually adjust the offset in a text editor:
  1. Open your .XDF file in the text editor
  2. Find the <baseoffset> field in the XDFHEADER (always near/at the top)
  3. Enter your new offset value in DECIMAL, not hexadecimal (Example for an offset of 0x80000000, enter 2147483648 into the baseoffset field)
  4. If the offset is negative, add a "-" before the offset (Example: -2147483648)
  5. Save your XDF


What units do I enter for tables?
In the instances where there is no drop down selection for units (main table cells), you will need to enter a valid unit into the "Cell Units" text box.

To find valid units for import:
  1. Open VCM Scanner
  2. Go to Tools -> Quantities & Units
  3. Copy the Symbol OR Name into the "Cell Units" box in TunerPro


Click image for larger version. 

Name:	VCMScannerUnits.PNG 
Views:	100 
Size:	20.6 KB 
ID:	67497Click image for larger version. 

Name:	TunerProCellUnits.png 
Views:	143 
Size:	15.7 KB 
ID:	67498


For all other parameter types (Scalars, Axis') that have an available "Stock Units" drop-down, please select your unit from the drop-down.


(0 vote(s))
Helpful
Not helpful