-
Notifications
You must be signed in to change notification settings - Fork 42
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
sguequierre
merged 8 commits into
viamrobotics:main
from
sguequierre:DOCS-1825/document-teleop-page
Nov 26, 2024
+96
−1
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
bc8ed87
document teleop as how-to
sguequierre 499a0f8
edits
sguequierre 4de897a
Merge branch 'main' into DOCS-1825/document-teleop-page
sguequierre 754f3c6
Apply suggestions from code review
sguequierre 8c90e8d
Apply suggestions from code review
sguequierre 9f066de
Apply suggestions from code review
sguequierre d5397e2
Update configure-teleop-workspace.md
sguequierre 92d1e1f
Update configure-teleop-workspace.md
sguequierre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
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 >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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