Skip to content

Commit

Permalink
and again...
Browse files Browse the repository at this point in the history
  • Loading branch information
pkerspe committed Aug 15, 2021
1 parent 7e1aa30 commit 0afbfc4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ The following is an excerpt of the endpoints being provided:
| METHOD | PATH | DESCRIPTION |
|---|---|---|
|GET |`/api/status`|get the current stepper server status report including the following information: version string of the server, wifi information (wifi mode, IP address), spiffs information (total space and free space)|
|POST |`/api/steppers/returnhome`|endpoint to trigger homing of the stepper motor. This is a non blocking call, meaning the API will directly return even though the stepper motor is still performing the homing movement.<br /><br />_IMPORTANT:_ this function should only be called if you previously configured a homing / limit switch for this stepper motor, otherwise the stepper will start jogging for a long time (a default limit of 2000000000 steps is configured, but can be overwritten with a POST parameter) before coming to a halt.<br/><br />_Required post parameters:_<br />- id (id of the stepper motor to pefrom the homing command for)<br /> - speed: the speed in steps per second to perform the homing command with<br />_Optional POST parameters:_<br />- switchId: the id of the configured switch to use as limit switch, if parameter is omited the position switch from the configurtration of the stepper motor will be used, if none is configured, operation will fail)<br /> - accel: the acceleration for the homing procedure in steps/sec^2, if ommitted the previously defined acceleration in the flexy stepper instance will be used<br />- maxSteps: this parameter defines the maximum number of steps to perform before cancelling the homing procedure. This is kind of a safeguard to prevent endless spinning of the stepper motor. Defaults to 2000000000 steps|
|POST |`/api/steppers/returnhome`|endpoint to trigger homing of the stepper motor. This is a non blocking call, meaning the API will directly return even though the stepper motor is still performing the homing movement.<br /><br />_IMPORTANT:_ this function should only be called if you previously configured a homing / limit switch for this stepper motor, otherwise the stepper will start jogging for a long time (a default limit of 2000000000 steps is configured, but can be overwritten with a POST parameter) before coming to a halt.<br/><br />_Required post parameters:_<br />- id (id of the stepper motor to pefrom the homing command for)<br /> - speed: the speed in steps per second to perform the homing command with<br />_Optional POST parameters:_<br />- accel: the acceleration for the homing procedure in steps/sec^2, if ommitted the previously defined acceleration in the flexy stepper instance will be used<br />- maxSteps: this parameter defines the maximum number of steps to perform before cancelling the homing procedure. This is kind of a safeguard to prevent endless spinning of the stepper motor. Defaults to 2000000000 steps|
|POST|`/api/steppers/moveby`|endpoint to set a new RELATIVE target position for the stepper motor in either mm, revs or steps. Required post parameters: id, unit, value. Optional post parameters: speed, acel, decel|
|POST |`/api/steppers/position`|endpoint to set a new absolute target position for the stepper motor in either mm, revs or steps. Required post parameters: id, unit, value. Optional post parameters: speed, acel, decel|
| GET |`/api/steppers` or `/api/steppers?id=<id>`|endpoint to list all configured steppers or a specific one if "id" query parameter is given
Expand Down

0 comments on commit 0afbfc4

Please sign in to comment.