search

ros-industrial / staubli_val3_driver

ROS-Industrial (simple message) driver for Stäubli CS8 and CS9 robot controllers (VAL 3 application)
Apache License 2.0
26 stars 21 forks source link

val3_driver: create ROS wiki page #6

Closed gavanderhoorn closed 4 years ago

gavanderhoorn commented 8 years ago

The README already contains quite some information, but is not the first place most users would look to for instructions on installation and usage.

It would be good to expand the ROS wiki page for staubli_val3_driver to include things such as minimum version of VAL3 supported, compatible controllers, information on compatible manipulators, etc.

See fanuc_driver for an example of such a page.

gavanderhoorn commented 8 years ago

Alternatively, we might want to invest in writing Sphinx-based documentation for the staubli packages.

That would have a nr of advantages over the ROS wiki (versioning with source, easier on resources, target multiple output formats with a single source, responsive layout, etc). A disadvantage is less integration (and visibility?) with the ROS wiki.

See also ros-industrial/fanuc#148.

gavanderhoorn commented 6 years ago

@nilsmelchert: is this perhaps something you would be interested in?

The current page is wiki/staubli_val3_driver.

You could take a look at the fanuc_driver one mentioned in the OP (see also the installation tutorial) and the Motoman installation tutorial.

If you've run into any issues while setting up staubli_val3_driver, it might be nice to document those on a Troubleshooting page similar to the ones for fanuc_driver (here) and motoman_driver (here).

nilsmelchert commented 6 years ago

Sure. I totally forgot about this Issue. I will take care of it.

Edit:Besides, I figured that the tx60 series are not listed on the main wiki page of this repository yet: http://wiki.ros.org/staubli_experimental.

gavanderhoorn commented 4 years ago

I'm going to close this one, as I believe we (as in: the ROS community) are slowly migrating away from the wiki. It will not be used with ROS 2 fi, and keeping documentation near code is a good way to increase the chances it'll be kept up-to-date.

8 improves the readme already. We could see whether more extensive documentation would be required/desirable. If so, please post new issue(s) to track this.