HIL Task Start

Owning Palette: HIL/Core/Watchdog

Requirements: Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer

Description

Starts the HIL Task. The task runs at the sampling frequency specified and processes the number of samples specified.

Required Inputs All required inputs must be wired. They appear in bold text in the context help window for the VI.

task in is a reference to a HIL Task instance that represents the created HIL task. This input must be wired to a valid HIL Task signal, as generated by a HIL Task Create Reader VI.

Recommended Inputs Recommended inputs need not be wired. They appear as simple text in the context help window for the VI.

clock indicates which hardware timer on the HIL board is to be used as the timer for the task. For most application, the default clock of zero is appropriate. Refer to the documentation for a specific HIL board for more details on the clocks available on that board.

frequency indicates the frequency in Hertz at which to process samples. For example, if frequency is set to 1000, then the task will process one sample every millisecond.

num samples indicates the number of samples to process. Each "sample" consists of all the input channels specified when the task was created using HIL Task Create Reader VI. For example, if frequency is set to 1000 and num samples is set to 5000, then the task will run for 5 seconds, processing 5000 samples. If the is set to INFINITE then the task runs until HIL Close VI is called.

error in describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster in error out.

status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.

code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.

source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Outputs

task out is a copy of the HIL Task instance passed to the task in input.

error out contains error information. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI.

	status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.
	code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.
	source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Feedthrough Behaviour

All input/output pairs of this function have direct feedthrough behaviour.

Examples

There are currently no examples

Targets

Target	Supported	Comments
RCP Windows (64-bit) Target	Yes	Fully supported.

navigation bar

	HIL Task Create Reader	Create a task for reading from analog, digital, encoder and/or other channels of a HIL board. The task allows other operations to be performed while the inputs are being read "in the background". The data is read into an internal circular "task buffer" from which it can be read at any time using the HIL Task Read VI. The size of this task buffer is determined by the sample in buffer input.
	HIL Task Read	Reads from analog, digital, encoder and/or other channels of a HIL Task.