MotoHawk:Blocks:Fixed Point Calibration

From MotoHawk
Jump to navigationJump to search

Fixed-Point Calibration (16-Bit)

This MotoHawk™ block provides a connection to MotoTune, and allows run-time modification of calibration values with the MotoTune tool.

Block ID

Fixed Point Calibration

Library

MotoHawk_lib/Fixed Point Blocks

Description

Fixed Point Calibration.PNG

This block behaves in simulation like a Constant block, and accepts any Matlab value as its Default Value, including data-typing casts. Engineering Value = (Raw Module Value*Gain)^Exp)+Offset. For more information, see [../MotoHawk_topics/BScaleFixed.html Fixed Point Values and B Numbers].

Block Parameters

Parameter Field Values Comments/Description
Name Alpha-numeric text, single-quote enclosed Name as displayed in block, MotoTune, for block. No special characters, such as spaces, dashes, commas (underscore allowed).
Default Value Numeric Numeric entry or Matlab expression.
Output B Scale Numeric Supply applicable numeric value for "B" - larger B values increase value range and reduce resolution.
Behavior Define type of block behavior.
Calibration Use block for calibration in MotoTune (saved in .cal file).
Display Use block for displaying value in MotoTune (not available for saving in .cal file).
Calibration NV Use block for calibration in MotoTune (saved in .cal file). Saved in non-volatile (EEPROM) memory; allows online calibration in development and also in production modules.
Display NV Use block for displaying value in MotoTune (not available for saving in .cal file). Saved in non-volatile (EEPROM) memory; allows online calibration in development and also in production modules.
Name Source Use Parameter / Output Wire Name Select method for Name - use either the "Name" field or take the name from Output used.
Read Access Level 1-4 Sets security level 1 lowest, 4 highest, for user access to read value.
Write Access Level 1-4 Sets security level 1 lowest, 4 highest, for user access to write value.
Use uploaded calibration values from MotoTune Checkbox enable Enable/disable to use or ignore uploaded values from MotoTune.
View Value as Drop-down list
Sets "Default Value" data type
Number Numeric value
Enumeration Enables enumeration - maps to the indicated term in the Enumeration text-entry field.
Text Text string
Enumeration (Cell String, or Struct) Alpha-numeric text, single-quote enclosed Field enabled when Enumeration is selected under "View Value as." Enter term of defined entity to be mapped. Cell String: A cell array of strings such as {'Off', 'On'} may be used to define the names of enumerated values. In this case, the values start with 0 and increment by one. This is especially useful for defining names for Boolean flags like 'On' and 'Off'. Struct: A Matlab struct array containing a 'name' field, and optionally a 'value' field may be used to define the names and explicitly define the values of an enumerated type. For example: struct('name', {'Off', 'On'}, 'value', {0,1}). If the 'value' field is missing, then the values start with 0 and increment by one, just like with the Cell String format.
Show Vectors As Wide Row/Tall Column Set viewing format for values displayed.
Help Text Alpha-numeric text, single-quote enclosed Enter text to describe block usage per needs.
Units Alpha-numeric text, single-quote enclosed Enter text to describe or label units or data for clarification in MotoTune, as appropriate per application.
Row Header Enumeration (Cell String, or Struct) Alpha-numeric text, single-quote enclosed Use to identify / locate probe value (see Enumeration) - row header
Column Header Enumeration (Cell String, or Struct) Alpha-numeric text, single-quote enclosed Use to identify / locate probe value (see Enumeration) - column header
Minimum Value Numeric Value Sets lower end of allowable range for value. This can be used to prevent a user from entering an out of range number when calibrating.
Maximum Value Numeric Value Sets higher end of allowable range for value. This can be used to prevent a user from entering an out of bounds range when calibrating.
Precision Numeric value, single-quote enclosed Set the precision of the variable as displayed in MotoTune, by entering a value '1.x' where "x" is the number of decimal places requested. Default is two decimal places.
MotoTune Group String Alpha-numeric text, single-quote enclosed Determines Folder name and hierarchy as displayed in MotoTune. Use "|" character between folder names to delineate subfolder structure.