Redler Technologies Inc.

MotionComTryCalibrate Method

Tries to calibrate the driver with the specified calibration type

Definition

Namespace: Redler.Motion.Communication.MotionCom
Assembly: Redler.Motion.Communication (in Redler.Motion.Communication.dll) Version: 0.0.0.0
C#
public Task<bool> TryCalibrate(
	MotionPacketHelperCalibrationHelperCalibrationTypes calibType,
	IReadOnlyDictionary<int, (MotionPacketHelperCalibrationHelperCalibModes , string )> calibrationStatusMapping,
	CancellationToken cs,
	IProgress<(MotionPacketHelperCalibrationHelperCalibModes , string message)>? progress = null,
	int numOfRetries = 200
)

Parameters

calibType  MotionPacketHelperCalibrationHelperCalibrationTypes
The type of calibration the user tries to perform
calibrationStatusMapping  IReadOnlyDictionaryInt32, ValueTupleMotionPacketHelperCalibrationHelperCalibModes, String
Mapping of every status available
cs  CancellationToken
The cancellation token in order to abort the calibration
progress  IProgressValueTupleMotionPacketHelperCalibrationHelperCalibModes, String  (Optional)
The progress of the calibration process
numOfRetries  Int32  (Optional)
Maximum number of retries to get the status of the calibration

Return Value

TaskBoolean
True if the calibration finished successfully

See Also