MotoHawk:Blocks:Fixed Point Probe
From MotoHawk
Jump to navigationJump to searchFixed-Point Probe
This MotoHawk™ block provides a connection to MotoTune, and allows run-time observation of probed values with the MotoTune tool.
Block ID
Fixed Point Probe
Library
MotoHawk_lib/Fixed Point Blocks
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. 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) |
Input B Scale | Numeric (B value) | Supply applicable value for "B" - larger B values increase value range and reduce resolution of output values. |
Number of Bits | Drop down | Selects 16 or 32 bits |
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 | Number Enumeration Text |
Sets "Default Value" data type Numeric value Enables enumeration - maps to the indicated term in the Enumeration text-entry field 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 namesand 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 |
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 |