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.

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

Jump to bottom

DOCS-2603: Clarify sdk code running on LAN #3145

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DOCS-2603: Clarify sdk code running on LAN #3145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46e2db3
DOCS-2603: Clarify sdk code running on LAN
npentrel Jul 19, 2024
8c7bbb1
Update docs/build/program/run.md
npentrel Jul 21, 2024
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
7 changes: 4 additions & 3 deletions docs/build/program/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,10 @@ Running everything on one machine is also convenient if you have a machine (for

{{<imgproc src="/build/program/on-robot.png" resize="900x" declaredimensions=true alt="A client running on a machine">}}

The script you run on-machine is the same as the script you [run remotely](#run-code-remotely) or on a local network.
When the connection code from the [**CONNECT** tab's **Code sample** page](/build/program/#hello-world-the-connect-tab) executes, it creates a [client session](/appendix/apis/sessions/) connected to your machine using the [most efficient route](/build/program/connectivity/).
Because the code is running on the same machine as `viam-server`, the favored route for commands is automatically over localhost.
To run SDK code on a local nework, you need to change the connection code, that you obtained from the [**CONNECT** tab's **Code sample** page](/build/program/#hello-world-the-connect-tab).
The default machine address (URI) from the **CONNECT** tab is of the form `mymachine-main.0a1bcdefgi.viam.cloud`.
To connect directly to the local machine, change the end of the URI from `.viam.cloud` to `.local.viam.cloud`.
For the example that results in `mymachine-main.0a1bcdefgi.local.viam.cloud`.

Install the appropriate programming language and [Viam SDK](/sdks/) on your machine and run a command to execute the program in the terminal of that machine instead of from a separate computer:

Expand Down
Loading