Skip to content

davidmball/ros_examples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ROS Examples

A collection of examples for the Online ROS site where everyone can view, edit, compile and run ROS code.

See instructions here: https://github.com/davidmball/online_ros

Contributions

Pull requests with new examples are very welcome. Please keep the example focussed on one particular aspect of ROS.

Please follow the ROS style guide (http://wiki.ros.org/CppStyleGuide and http://wiki.ros.org/PyStyleGuide) with the following exception(s):

  • C++11/14 is encouraged.

The xml file has the following elements

<example>Surround the entire xml will this tag.
  <title>This title will be displayed in the index list, top of the example page, and in the google search result.</titl>
  <description> This description will be displayed in the index list, at the top of the example page, and suggested to google for the snippet in its search results</description>
  <ros_version>Which ROS build does this support. At the moment there is only a kinetic container. ROS2 support is planned</ros_version>
  <time_limit>This is the amount of time that compilation and execution of the example will last</time_limit>
  <tag>A number of tags that describe this example. These are shown on the index page listing.</tag>

  <language>One of these for each code language that is supported.
    <name>cpp or py supported at the moment</name>
    <run_cmd>This is the cmd that will be run in the docker container after compilation</run_cmd>
    <start_file>This is the file that is shown by default to the end user on page load</start_file>
  </language>

  <feedback>Two parent feeback sections must be included. These configure the interactive parts for the user
    <tab>Which of the tabs should be displayed in teh feedback panel by default. At the moment can be "topics", "nodes", "params", "service", "viz"</tab>
    <topic>(optional) Some tabs require the topic to work with. Eg the "topics" needs to know the default topic.</topic>
    <msg_type>Describe the msg type for the topic. Hopefully in the future. this can be depricated and gotten from the server.</msg_type>
  </feedback>
</example>

License

The code is released under the BSD license. Except where otherwise noted, the web pages and documentation are licensed under Creative Commons Attribution 3.0.

About

ROS examples for online code editing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published