-
Notifications
You must be signed in to change notification settings - Fork 43
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
Update connectivity.md #1870
Update connectivity.md #1870
Conversation
Overall readability score: 55.73 (🔴 -0.04)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
@dannenberg - could you read through the changes to the connectivity page and ensure that that answers all remaining questions and @cheukt - apologies - could you confirm this is all still correct? @sguequierre - please read over it for correctness as well |
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.
looks accurate
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.
the only question i'm not seeing an answer to here is "can a client establish a connection to the viam-server over LAN without an internet connection?" and possibly implicit in that "if we were connected via a route using the internet, but that gets severed, will the client be able to reconnect over their shared LAN?" (could this happen. that is, would webrtc ever choose a route out of LAN when LAN is available?)
otherwise this is looking great. thank you for your efforts
docs/program/connectivity.md
Outdated
|
||
When a robot loses its connection over LAN or WAN, it can no longer communicate with clients through [the Viam app](https://app.viam.com). | ||
When no heartbeat has been received over a timeout period, `viam-server` will end any current client [*sessions*](/program/apis/sessions/) on this robot. | ||
- Client sessions connected through the internet will timeout and end. |
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.
(opt) For clarity I would suggest moving this down and specifying "different LAN or WAN" or "through the cloud" vs just "through the internet", but idk I think this is technically correct anyways?
@cheukt please confirm the answers:
I assume yes and you'd do that the same way as https://docs-test.viam.dev/d4b541ef8633aa931fd9723fc58b82f3d0fd8915/public/program/run/#run-code-on-robot ?
I believe it would automatially figure out there's a better connection and use LAN, so no reconnection needed? |
for 1, yes, and at this point you should be able to connect just using the code sample for all the supported SDKs |
for clarity, the steps naomi linked in #1 are no longer necessary. correct cheuk? |
yes, it should definitely work with go and python sdk. possibly not for the typescript sdk |
59ac856
to
16c1723
Compare
07fa6c9
to
926405f
Compare
926405f
to
9260e27
Compare
@dannenberg and @cheukt could you please review the changes in the last commit ("Address feedback") to ensure the changes based on your comments are factually accurate and cover what we want to cover? We will need to understand the Typescript limitations as well but we can do that separately. |
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/39fc5ee56de4407039031aa93adcaa790735dd02/public |
No description provided.