v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
pid-calibration

Cancel PID Controller Calibration

Cancels an active PID controller calibration process for the active hold position feature. This endpoint immediately terminates any ongoing calibration routine and returns the system to normal operational mode.

The cancellation stops the automated tuning sequence and preserves any previously configured PID parameters. Use this endpoint if the calibration process needs to be interrupted due to operational requirements or safety concerns. The system will safely halt all calibration movements and restore normal motor control functionality.

Cancellation requires the same system prerequisites as starting calibration, including an installed motor position encoder and enabled active hold position feature. After cancellation, the system returns to its previous PID configuration state without applying any partially completed calibration results.

post/api/v1/reel/pid-calibration/cancel

Response

Successful Response

actionstring required

The action that was requested or performed by the endpoint

errorboolean required

Indicates whether the operation encountered an error

error_msgsstring[]

List of error messages if the operation failed

Example response

{
  "error_msgs": [],
  "result": {
    "calibrating": true
  }
}