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

Any documentation on ROS specific feature, e.g widgets? #20

Open
pitosalas opened this issue Jun 26, 2019 · 5 comments
Open

Any documentation on ROS specific feature, e.g widgets? #20

pitosalas opened this issue Jun 26, 2019 · 5 comments

Comments

@pitosalas
Copy link

No description provided.

@pitosalas
Copy link
Author

pitosalas commented Jun 26, 2019

Other than the two screenshots in the readme, is there any documentation for the capabilities of this wonderful package?

@pitosalas pitosalas changed the title Any documentation on ROS specific feature, Any documentation on ROS specific feature, e.g widgets? Jun 26, 2019
@wolfv
Copy link
Member

wolfv commented Jun 27, 2019

Hi,

indeed documentation is currently quite lacking. Best way is to look at the notebooks and read the source code (for the moment).

We'll need to work on that!

@pitosalas
Copy link
Author

pitosalas commented Jun 27, 2019 via email

@wolfv
Copy link
Member

wolfv commented Jun 27, 2019

there are three classical widget functions: jr.subscribe, jr.publish and jr.bag_player and jr.live_plot

and then there is the ros3d suite with all the widgets you find in this file (mirroring roswebtools.js capabilities):

https://github.com/RoboStack/jupyter-ros/blob/master/jupyros/ros3d.py

The usage across widgets is pretty much always the same, so you can extrapolate from the examples (add objects to a view model).

However, some important fixes are coming in with #17, so just to let you know :)

@pitosalas
Copy link
Author

Thanks... There are multiple things called sidecar. How do I install it so that I can run the 3d widgets? Also the comment in the laser notebook says "Make sure that the websocket rosbridge is running on your host computer, and that you publish a laser scan on the /scan topic." I am not sure what that means. What if I have a similated gazebo robot publishing on /scan, won't that be the same? Thanks!

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

No branches or pull requests

2 participants