Skip to content

Commit

Permalink
DOCS-1024: Add gantry control card view (#2083)
Browse files Browse the repository at this point in the history
  • Loading branch information
sguequierre authored Oct 23, 2023
1 parent ca211f0 commit 298d41d
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/components/gantry/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ Enter a name for your gantry and click **Create**.

No attributes are available for fake gantries.
See [GitHub](https://github.com/viamrobotics/rdk/blob/main/components/gantry/fake/gantry.go) for API call return specifications.

{{< readfile "/static/include/components/test-control/gantry-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/gantry/multi-axis.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,5 @@ The following attributes are available for `multi-axis` gantries:
| --------- | ---- | --------- | ----------- |
| `subaxes_list` | array | **Required** | An array of the `name` of each of the sub-axes, the [`single-axis`](/components/gantry/single-axis/) gantries that make up the `multi-axis` gantry. |
| `move_simultaneously` | boolean | Optional | A boolean indicating if the sub-axes should move together, or one at a time when `MoveToPosition` is called. <br> Default: `false` |

{{< readfile "/static/include/components/test-control/gantry-control.md" >}}
2 changes: 2 additions & 0 deletions docs/components/gantry/single-axis.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,5 @@ The following attributes are available for `single-axis` gantries:
| `limit_pin_enabled_high` | boolean | Optional | Whether the limit pins are enabled. <br> Default: `false` |
| `mm_per_rev` | int | **Required** | How far the gantry moves (linear, distance in mm) per one revolution of the motor’s output shaft. This typically corresponds to Distance = PulleyDiameter * pi, or the pitch of a linear screw. |
| `gantry_mm_per_sec` | int | Optional | The speed at which the gantry moves in millimeters per second. Used to calculate the gantry `motor`'s revolutions per minute (RPM). <br> Default: `100` RPM |

{{< readfile "/static/include/components/test-control/gantry-control.md" >}}
9 changes: 9 additions & 0 deletions static/include/components/test-control/gantry-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Test the gantry

Once your gantry is configured and connected, go to the [**Control** tab](/manage/fleet/robots/#control) and click on the gantry's drop-down panel.

Use the panel to adjust the position of the actuator on the axis and check whether it moves as expected.

{{<imgproc src="/components/gantry/gantry-control-tab.png" resize="450x" declaredimensions=true alt="Gantry control panel.">}}

If the gantry does not appear on the **Control** tab, or if you notice unexpected behavior, check your robot's [**Logs** tab](/manage/fleet/robots/#logs) for errors, and review the configuration.

0 comments on commit 298d41d

Please sign in to comment.