MotoHawk:Blocks:Probe
From MotoHawk
Jump to navigationJump to searchProbe
This MotoHawkâ„¢ block provides a connection to MotoTune, and allows run-time observation of probed values with the MotoTune tool.
Block ID
motohawk_probe
Library
MotoHawk_lib/Calibration and Probing
Description
The Name Source field allows the name to be entered as a Literal, evaluated as a Matlab expression, or it may be inherited from the name of the input wire. If no name is supplied, (Undefined Name) will be displayed on the block.
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) |
Name Source | Select source for Name parameter. | |
Use Parameter | Use Name field text. | |
Input Wire Name | Take name from input wire name. | |
Output Wire Name | Take name from output wire name. | |
Read Access Level | 1-4 | Sets security level 1 lowest, 4 highest, for user access to read value |
View Value as | Sets probe 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. 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 in calibration tools to set the minimum allowed value for the probed signal. |
Maximum Value | Numeric Value | Sets higher end of allowable range for value. This can be used in calibration tools to set the maximum allowed value for the probed signal. |
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. |
Gain* | Numeric Value | Multiplier applied (Default is 1) to the raw value used in calculation of the engineering value as observed in MotoTune. |
Offset* | Numeric Value | Constant added (Default is 0) to the raw value calculations to result in the engineering value as observed in MotoTune. |
Exponent* | Numeric Value | Exponent applied (Default is 1) to the (raw value*gain) product used in calculating the engineering value as observed in MotoTune. |
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. |
*NOTE: Engineering Value = (Raw Module Value*Gain)^Exp)+Offset.