AILSystem_ConfigureEncoder


Configures the encoder.

Syntax

C++
Python
 
def AILSystem_ConfigureEncoder(
	state: AILSystem_State,
	/,
	*,
	inDeviceID: AILSystemAndDeviceIdentifier | None = None,
	inEncoder: int = 1,
	inBit0Source: int = 1,
	inBit1Source: int = 2,
	inOutputMode: AILEncoderOutputMode = AILEncoderOutputMode.Default,
	inPositionTrigger: int = 0,
	inResetSource: AILEncoderResetSource = AILEncoderResetSource.Null,
	inResetCounter: bool = False,
	inEnable: bool = True
)
-> None

Parameters

Name Type Range Default Description
Input will be modified ioState AILSystem_State
Input value inDeviceID AILSystemAndDeviceIdentifier | None None Device identification.
Input value inEncoder int 1 - 2 1 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 AILEncoderOutputMode AILEncoderOutputMode.Default Circumstances in which the rotary decoder should output a pulse.
Input value inPositionTrigger int 0 Rotary decoder's counter value upon which a trigger is generated.
Input value inResetSource AILEncoderResetSource AILEncoderResetSource.Null Signal source to use to reset the rotary decoder's counter to 0.
Input value inResetCounter bool False Reset the encoder counter value to 0 at the end of configuration.
Input value inEnable bool True Enable or disable the encoder.