Skip to content

Update Control tab docs for TypeScript code sandbox #5313

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.

Sign up for GitHub

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

Merged
Jeremy Rose (jeremyrose-viam) merged 1 commit into from
Sep 14, 2026
Merged

Update Control tab docs for TypeScript code sandbox #5313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions docs/monitor/default-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,25 @@ Each configured component and service appears as a card. What you can do depends

You can switch between machine parts directly from the CONTROL tab using the part selector at the top.

### Code sandbox

The CONTROL tab includes a TypeScript code sandbox.
Click **Sandbox** in the sidebar under **Code** to open it.

The sandbox editor is pre-filled with a starter program based on the machine's configured resources.
You can edit the code, run it, and see output in the console below the editor.
The sandbox runs against your live machine using the page's existing connection, so you do not need to supply an API key or address.

Use the sandbox to:

- Test SDK calls interactively before writing a full application
- Experiment with component and service methods on a live machine
- Prototype a sequence of commands without setting up a local development environment

Programs are not persisted.
Navigating away from the sandbox discards your code.
Use the download button to save your program as a file before leaving.

## Viam mobile app

The Viam mobile app provides similar access from your phone:
Expand Down
2 changes: 1 addition & 1 deletion docs/monitor/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ See [Set up alerts](/monitor/alert/).

You can remotely control and test any configured machine without writing code.

The **default control interface** is the CONTROL tab on your machine's page in the Viam app. It provides a control card for every configured component and service: move bases, actuate arms and grippers, read sensors, view camera feeds, and test vision services. The Viam mobile app provides similar access from your phone.
The **default control interface** is the CONTROL tab on your machine's page in the Viam app. It provides a control card for every configured component and service: move bases, actuate arms and grippers, read sensors, view camera feeds, and test vision services. A built-in code sandbox lets you write and run TypeScript against the live machine directly from the browser. The Viam mobile app provides similar access from your phone.

**Teleop workspaces** let you build custom operator interfaces with only the widgets you need for a specific task. You choose the widgets (camera feeds, sensor readouts, actuation controls, GPS maps) and arrange them into a focused view. This is useful when the full CONTROL tab shows more than the operator needs.

Expand Down
Loading