Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1825: Document teleop page as how-to #3675

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/how-tos/teleop/blank-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/how-tos/teleop/configured-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/how-tos/teleop/four-panes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/how-tos/teleop/full-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/how-tos/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,12 @@ The guides on this page provide solutions for common tasks and workflows. Browse
{{< /cards >}}
{{< /how-to-expand >}}

{{< how-to-expand "Work with sensor data" "3" "INTERMEDIATE" >}}
{{< how-to-expand "Work with sensor data" "4" "INTERMEDIATE" >}}
{{< cards >}}
{{% card link="/how-tos/collect-sensor-data/" noimage="true" %}}
{{% card link="/how-tos/sensor-data-visualize/" noimage="true" %}}
{{% card link="/how-tos/sensor-data-query-with-third-party-tools/" noimage="true" %}}
{{% card link="/how-tos/configure-teleop-workspace/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}

Expand Down
93 changes: 93 additions & 0 deletions docs/how-tos/configure-teleop-workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Configure a teleop workspace"
linkTitle: "Configure a teleop workspace"
weight: 10
type: "docs"
description: "Create and configure a teleop workspace with widgets."
images: ["/how-tos/teleop/full-workspace.png"]
icon: true
tags: ["teleop", "configuration"]
languages: []
viamresources: ["sensor", "camera", "movement sensor"]
platformarea: ["viz", "data"]
level: "Intermediate"
date: "2024-11-13"
# updated: "2024-08-26" # When the tutorial was last entirely checked
cost: "0"
---

You can use teleop to create a custom workspace where you can visualize and aggregate data from a machine.
You can currently visualize data from a camera, a sensor, or a movement sensor.

{{% alert title="In this page" color="info" %}}

- [Configure a workspace](#configure-a-workspace)

{{% /alert %}}

## Prerequisites

{{% expand "A configured machine with teleoperable components" %}}

Make sure your machine has at least one of the following:

- A camera, movement sensor, sensor, base, arm, board, gantry, gripper, motor or servo
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated this for actuation-- I figure not updating the screenshots to also include an actuation widget is fine for this demo as its pretty self explanatory but if anyone thinks differently I can update/retake the screenshots


See [configure a machine](/how-tos/configure/) for more information.
sguequierre marked this conversation as resolved.
Show resolved Hide resolved

{{% /expand%}}

## Configure a workspace

{{< table >}}
{{% tablestep %}}
**1. Create a workspace in the Viam app**

Log in to the [Viam app](https://app.viam.com/).

Navigate to the **FLEET** page's **TELEOP** tab.
Create a workspace by clicking **+ Create workspace**.
Give it a name.

{{<imgproc src="/how-tos/teleop/blank-workspace.png" resize="800x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Blank teleop page.">}}

{{% /tablestep %}}
{{% tablestep %}}
**2. Add widgets**

Click **Add widget** and select the appropriate widget for your machine.
Repeat as many times as necessary.

Now your workspace setup is complete:

{{<imgproc src="/how-tos/teleop/configured-workspace.png" resize="700x" style="width: 500px" class="fill aligncenter" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets.">}}

{{% /tablestep %}}
{{% tablestep %}}
**3. Select a machine**

Now, select a machine with which to make your teleop workspace come to life.
Select **Monitor** in the top right corner to leave editing mode.
Click **Select machine** and select your configured machine.

Your dashboard now shows the configured widgets for the data from your machine:

{{<imgproc src="/how-tos/teleop/full-workspace.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode.">}}

You can go back to **Edit** mode and drag and drop the widgets' panes around to edit their appearance.
For example:

{{<imgproc src="/how-tos/teleop/four-panes.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode with four panes.">}}

{{% /tablestep %}}
{{< /table >}}

## Next steps

Follow more of our how-to guides to do more with the Viam platform:

{{< cards >}}
{{% card link="/how-tos/detect-people/" %}}
{{% card link="/how-tos/drive-rover/" %}}
{{% card link="/how-tos/train-deploy-ml/" %}}
{{< /cards >}}
1 change: 1 addition & 0 deletions layouts/docs/howto.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ <h4 class="alert-heading">Javascript</h4>
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/collect-sensor-data/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/sensor-data-query-with-third-party-tools/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/sensor-data-visualize/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/configure-teleop-workspace/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/create-module/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/sensor-module/") }}
{{ partial "tutorialcard-no-js.html" (dict "link" "/how-tos/upload-module/") }}
Expand Down
Loading