MotoHawk Toolkit Integration DAB Function Definition

This block defines a ToolKit Data-Access Based (DAB) Function which is executable on the target.

Block ID

Toolkit Integration DAB Function Definition

Library

MotoHawk_Protocols_lib

Description

This block defines a ToolKit DAB Function.

A "DAB Function" is a way to trigger execution of a subsystem in the application based upon read/write access to a parameter defined by the application. Toolkit will write the parameter to a non-zero value. At this point the DAB Function Trigger will cause a routine to be executed, and the routine should provide its results via the DAB Function Response block. A zero value indicates success, and any negative value indicates failure.

The Send Command Access Level determines the minimum security level which must be attained in order to cause execution of the DAB Function by Toolkit. In addition, any function parameters should be defined to be accessible at this level or lower.

The Permissive Parameter can be used to link to a boolean parameter, defined elsewhere in the application, which represents whether or not this DAB Function is enabled for execution. If a runtime check of the permissive parameter's value indicates fales, then ToolKit will display the "Disabled Message" text.

The Enabler DAB Function parameter is the name of another DAB Function Definition, defined elsewhere in the application, which ToolKit may use to attempt to enable this function. I.e. calling the Enabler DAB Function would cause the Permissive Parameter to transition from the "false" to "true" state.

Block Parameters

Parameter Field	Values	Comments/Description
Function Name	String	Name of the parameter ToolKit will write and the reference for the other DAB Function blocks.
Display Text	String	The text which will be placed in the Toolkit dialog to indicate the controller's associated functionality.
Send Command Access Level	Dropdown	Security access level required for initiating this DAB Function.
Confirmation Message	String	A message that will be displayed to the Toolkit user to confirm initiation of the DAB Function was desired.
Permissive Parameter	String	Name of a parameter which reflects if this DAB Function is permitted to be called.
Disabled Message	String	A message which ToolKit will display upon discovering the Permissive Parameter is set to false.
Enabler DAB Function	String	The name of another DAB Function which may be called to enable this function.
Instrumentation Group	String	The location in the parameter tree for the DAB Function.