Back to FabImage Library website

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

Z4Sight_ConfigureEncoder_Deprecated


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Configures the encoder.

Syntax

void fil::Z4Sight_ConfigureEncoder_Deprecated
(
	Z4Sight_State& ioState,
	ftl::Optional<const fil::Z4SightDeviceID::Type&> inDeviceID,
	int inEncoder,
	int inBit0Source,
	int inBit1Source,
	fil::Z4SightEncoderOutputMode::Type inOutputMode,
	int inPositionTrigger,
	fil::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 Z4SightDeviceID::Type&> NIL Device identification number.
Input value inEncoder int 1 - 2 Encoder.
Input value inBit0Source int 1 - 8 1 Auxiliary input signal on which to receive bit 0 of the 2-bit Gray code.
Input value inBit1Source int 1 - 8 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.