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.

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

Developer Tutorial #99

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Developer Tutorial #99

wants to merge 4 commits into from

Conversation

hello-binit
Copy link
Collaborator

Description

This PR adds a tutorial that shows the organization of code in this repo and how to new development. It covers how to plumb data, service calls, etc. from the ROS world through WebRTC and up to the web interface, where a React component (i.e. a piece of UI that the user can interact with) can display data, trigger services, etc. It takes the example of homing the robot, which involves showing a button that calls the /home_the_robot ROS2 service.

Before opening a pull request

From the top-level of this repository, run:

  • pre-commit run --all-files

To merge

  • Squash & Merge

This tutorial covers how to plumb data, service calls, etc. from
the ROS world through WebRTC and up to the web interface, where
a React component (i.e. a piece of UI that the user can interact
with) can display data, trigger services, etc. It takes the
example of homing the robot, which involves showing a button
that calls the /home_the_robot ROS2 service, showing a loading
spinner while the robot is doing the homing sequence (as reported
by the driver on the /mode ROS2 topic), and disappearing once
the robot is done (as reported on the /is_homed topic).
There are three component folders:

- `layout_components/`: for components that will be displayed as part of the interface's layout. These are typically top-level components.
- `static_components/`: TODO - what is the difference between a static component and a basic component??
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hello-vinitha Would you mind clearing up the difference between static and basic components for me?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hello-vinitha, quick ping, in case you didn't see this

@hello-binit
Copy link
Collaborator Author

@hello-vinitha friendly ping

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant