HIL Task Create Reader Encoder (Scalar)

Parent Polymorphic VI: HIL Task Create Reader

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

Description

Create a task for reading from an encoder input channel.

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

board in is a reference to a HIL Board instance that represents the open HIL board. This input must be wired to a valid HIL Board signal, as generated by a HIL Initialize VI.

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

sample in buffer indicates the number of samples in the task buffer. The created task cannot read more samples than this in a single call. If the task buffer overflows because HIL Task Read VI has not been called in time to remove the data from the task buffer then the next call to HIL Task Read VI will return an HIL_BUFFER_OVERFLOW error.

encoder channel is a channel number indicating the encoder input channel to be read. The value read will appear at the encoder counts output of the HIL Task Read VI.

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 HIL Task instance that can be passed to other VIs that require a HIL Task instance.

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.

Details

This VI creates a task for reading from one encoder input. When reading from mixed signal types, it is more efficient to use the HIL Task Create Reader Mixed than to include multiple VIs specific to each type of channel.

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