HIL Read Encoder (Scalar)

Parent Polymorphic VI: HIL Read

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

Description

Reads from an encoder input channel of a HIL board.

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.

encoder channel is a channel number indicating the encoder input channel to be read. The value read will appear at the encoder counts output.

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

board out is a copy of the HIL Board instance passed to the board in input.

encoder count is the encoder count value read from the specified encoder channel.

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 only reads one encoder input. When reading from mixed signal types, it is more efficient to use the HIL Read 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