jupyter-ros icon indicating copy to clipboard operation
jupyter-ros copied to clipboard

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

Open pitosalas opened this issue 6 years ago • 5 comments

pitosalas avatar Jun 26 '19 13:06 pitosalas

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

pitosalas avatar Jun 26 '19 13:06 pitosalas

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!

wolfv avatar Jun 27 '19 12:06 wolfv

Are the examples in the repo representative of all widgets/features, or are there other samples?

Sent from my iPad

On Jun 27, 2019, at 8:20 AM, Wolf Vollprecht [email protected] wrote:

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!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

pitosalas avatar Jun 27 '19 12:06 pitosalas

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 :)

wolfv avatar Jun 27 '19 12:06 wolfv

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!

pitosalas avatar Jun 28 '19 00:06 pitosalas