-
Notifications
You must be signed in to change notification settings - Fork 47
[APP-9296] Move dial logic into RobotClient
class
#619
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
Merged
micheal-parks
merged 4 commits into
viamrobotics:main
from
micheal-parks:refactor-robot-client
Aug 26, 2025
Merged
[APP-9296] Move dial logic into RobotClient
class
#619
micheal-parks
merged 4 commits into
viamrobotics:main
from
micheal-parks:refactor-robot-client
Aug 26, 2025
Conversation
This file contains hidden or 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
Setting as a draft to get a viz team review first. update: I think this is ready. |
mattmacf98
reviewed
Aug 25, 2025
mattmacf98
reviewed
Aug 25, 2025
mattmacf98
reviewed
Aug 25, 2025
DTCurrie
approved these changes
Aug 25, 2025
njooma
reviewed
Aug 26, 2025
RobotClient
classRobotClient
class
njooma
approved these changes
Aug 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Currently the only way to connect to a robot with good backoff logic and alternating dial methods is by calling
createRobotClient
. This function is async, and in its body both creates aRobotClient
class and attempts connection (hence the async part) before returning the client.This is problematic for the following reasons:
Solution
This PR moves all of the dial logic into the RobotClient class. This is not a breaking change, the behavior of
createRobotClient
andRobotClient
is the same. However, it is now possible to instantiate a robotClient before dialing, making disconnection much easier:Additionally, since the dial logic is now within the RobotClient class, we can emit events that can be piped to a UI or console to provide users more understanding of what's currently happening: