ros-industrial / ros_canopen

CANopen driver framework for ROS (http://wiki.ros.org/ros_canopen)
GNU Lesser General Public License v3.0
336 stars 271 forks source link

documentation and instruction how to use socketcan_bridge code #354

Open duongvuhyperx opened 4 years ago

duongvuhyperx commented 4 years ago

Hi, Thank you for making a the great plug in, great job and well done!

I wondering is there any document on how to use the code, like wiki, or the comment of what suppose to go into each line. This will greatly help new developer.

Similiar wiki: python-can.readthedocs.io/en/master/

Thanks

mathias-luedtke commented 4 years ago

There is not much documentation for developers for socketcan_bridge (ros_canopen) in general. However, the code base of socketcan_bridge is fairly small..

The API can be seen here, but without any explanations.

It would be highly appreciated if you would provide comments (doxygen) or explanations in the wiki as soon as git familiar with the code.

iwanders commented 4 years ago

When I originally wrote the socketcan_bridge I wrote documentation for users (not developers) on the ros wiki. See the socketcan_bridge page there. The code itself is straightforward and easily readable.

There are some more pages on the wiki like the one on ros_canopen and socketcan_interface, they provide some overview of how the pieces fit together.