Adjust accessor velocity

Edit online

Adjusts the maximum speed at which an accessor can move. This should be used only to debug issues with the accessor.

Request syntax

PATCH /v1/accessors/<location> {"velocityScalingXY": <value>, "velocityScalingPivot": <value>}
Adjusts the maximum speed at which an accessor can move.

Path parameters

location (string)

The unique location of the accessor.

Request body parameters

velocityScalingXY (number, optional)

A percentage scaling of the maximum velocity of the accessor in the X and Y directions. A value of 100 is default and means no scaling. If the value entered is below the minimum value of 20, the command is rejected.

velocityScalingPivot (number, optional)

A percentage scaling of the maximum accessor pivot speed. A value of 100 is default and means no scaling. If the value entered is not an increment of 10 or is below the minimum value of 20, the command is rejected.

Example

> PATCH /v1/accessors/accessor_Ab {"velocityScalingXY": 80}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

  • Returns 501 Not Implemented if this is a Diamondback library and velocityScalingPivot is modified.
  • Returns 401 Bad Request if the value entered for velocityScalingXY is below the minimum value of 20.
  • Returns 401 Bad Request if the value entered for velocityScalingPivot is not an increment of 10 or is below the minimum value of 20.