Probe

This MotoHawk™ block allows run-time observation of a signal with a suitable Instrumentation 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 assigned to the probe. Should be unique and C-legal (no special characters such as spaces, dashes or 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	0-8	Sets security level 1 lowest, 8 highest, for user access to read value. A setting of zero indicates unsecured access is allowed.
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)	Alphanumeric Cell String, Struct or Script	Field enabled when Enumeration is selected under "View Value as." Enter term of defined entity to be  mapped. Valid entries are: 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. Script: A number of MotoHawk blocks have output ports of an enum type. The block's help typically lists the name of a script that defines the enumeration fields. When a probe is connected to the blocks enum output, then the script name can be placed in the probe's enumeration string field, Eg: motohawk_fault_status_enum
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 the Instrumentation Tool, 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 the lower end of the expected range for the probe. The specified value is in engineering units (see Engineering Values versus Native Values).
Maximum Value	Numeric Value	Sets the higher end of the expected range for the probe. The specified value is in engineering units (see Engineering Values versus Native Values).
Precision	Numeric value, single-quote enclosed	Set the precision of the variable as displayed in the Instrumentation Tool by entering a value '1.x' where "x" is the number of decimal places requested. Default is two decimal places.
Gain*	Numeric Value	Multiplier component of the conversion equation that converts a native value into an engineering units value (see Engineering Values versus Native Values).
Offset*	Numeric Value	Offset component of the conversion equation that converts a native value into an engineering units value (see Engineering Values versus Native Values).
Exponent*	Numeric Value	Exponent component of the conversion equation that converts a native value into an engineering units value (see Engineering Values versus Native Values).
Instrumentation Group	Alpha-numeric text, single-quote enclosed	Determines Folder name and hierarchy to be used by an Instrumentation Tool. Use "|" character between folder names to delineate subfolder structure.

*NOTE: Engineering Value = ((Native Value * Gain)^Exponent) + Offset
See the Engineering Values versus Native Values help topic for further information.