Back to Aurora Vision Library website

You are here: Start » Function Reference » Hardware Support » Z4Sight » Z4Sight_ConfigureEncoder

Z4Sight_ConfigureEncoder


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Configures the encoder.

Syntax

void avl::Z4Sight_ConfigureEncoder
(
	Z4Sight_State& ioState,
	atl::Optional<const avl::Z4SightSystemAndDeviceIdentifier&> inDeviceID,
	int inEncoder,
	int inBit0Source,
	int inBit1Source,
	avl::Z4SightEncoderOutputMode::Type inOutputMode,
	int inPositionTrigger,
	avl::Z4SightEncoderResetSource::Type inResetSource,
	bool inResetCounter,
	bool inEnable
)

Parameters

Name Type Range Default Description
Input will be modified ioState Z4Sight_State& Object used to maintain state of the function.
Input value inDeviceID Optional<const Z4SightSystemAndDeviceIdentifier&> NIL Device identification.
Input value inEncoder int 1 - 2 Encoder.
Input value inBit0Source int 0 - 63 1 Auxiliary input signal on which to receive bit 0 of the 2-bit Gray code.
Input value inBit1Source int 0 - 63 2 Auxiliary input signal on which to receive bit 1 of the 2-bit Gray code.
Input value inOutputMode Z4SightEncoderOutputMode::Type Circumstances in which the rotary decoder should output a pulse.
Input value inPositionTrigger int Rotary decoder's counter value upon which a trigger is generated.
Input value inResetSource Z4SightEncoderResetSource::Type Signal source to use to reset the rotary decoder's counter to 0.
Input value inResetCounter bool Reset the encoder counter value to 0 at the end of configuration.
Input value inEnable bool True Enable or disable the encoder.

Remarks

I/O device driver software

This filter is intended to cooperate with a Zebra 4Sight device using its vendor SDK. To be able to connect to the device, it is required to install Matrox MIL X SDK. Zebra 4Sight industrial PCs usually come with a preinstalled runtime license.

Add DLL path to system environment variable may be required.

Recommended Matrox MIL X SDK version for Aurora Vision Studio usage is V22H1 (10.60.0776).

Device identification

Device field can be used to specify the number (rank) of the target board of the specified system type. Device can be set to:

  • DEFAULT - Specifies the default board. The default board is set in the MILConfig utility.
  • DEVn - Specifies the device number (rank) of the board (where 0 <= n <=15).

System field can be used to specify the system type. System can be set to:

  • HOST - Specifies the default build-in system like IO in industrial PC.
  • CONCORD - Specifies the IO system from Concord framegrabber.

This filter allows to configure one of the built-in quadrature decoders.

See Also