/README.md

https://gitlab.com/F34140r/meta-ros · Markdown · 170 lines · 114 code · 56 blank · 0 comment · 0 complexity · d587e3534f748f06d20fd56a73463dac MD5 · raw file

  1. This is a layer to provide ROS Hydromedusa in an OpenEmbedded Linux system.
  2. It provides a stable cross-compilation build system for many common ROS packages.
  3. Currently, this layer is still under continuous development.
  4. ## IMPORTANT RESOURCES ##
  5. * Source Code Repository: https://github.com/bmwcarit/meta-ros.git
  6. * Issue Tracker: https://github.com/bmwcarit/meta-ros/issues
  7. * Mailing List: https://groups.google.com/forum/#!forum/meta-ros
  8. * Installation Guide: http://wiki.ros.org/hydro/Installation/OpenEmbedded
  9. * Development Guides:
  10. * https://github.com/bmwcarit/meta-ros/wiki/Guidelines-for-ROS-recipes
  11. * https://github.com/bmwcarit/meta-ros/wiki/Developer-Guidelines
  12. ## MAINTAINERS ##
  13. * Lukas Bulwahn, BMW Car IT GmbH <lukas.bulwahn@oss.bmw-carit.de>
  14. * Stefan Herbrechtsmeier, Bielefeld University <stefan@herbrechtsmeier.net>
  15. * Kristof Robot <krirobo@gmail.com>
  16. ## CONTRIBUTORS ##
  17. * Lukas Bulwahn, BMW Car IT GmbH <lukas.bulwahn@oss.bmw-carit.de>
  18. * Stefan Herbrechtsmeier, Bielefeld University <stefan@herbrechtsmeier.net>
  19. * Tobias Weigl, BMW Car IT GmbH <tobias.weigl@bmw-carit.de>
  20. * Kartik Mohta <kartikmohta@gmail.com>
  21. * Koen Kooi <koen@dominion.thruhere.net>
  22. * Victor Mayoral Vilches <v.mayoralv@gmail.com>
  23. * Sergey 'Jin' Bostandzhyan <jin@dev.digitalstrom.org>
  24. * Andreas Hildisch, BMW Car IT GmbH <andreas.hildisch@bmw-carit.de>
  25. * William <william@friedcircuits.us>
  26. * Kristof Robot <krirobo@gmail.com>
  27. * Khem Raj <raj.khem@gmail.com>
  28. * Esteve Fernandez <esteve@apache.org>
  29. * Jonas Sticha <jonas.sticha@bmw-carit.de>
  30. ## HOW TO CONTRIBUTE ##
  31. We are still working on this development and are interested in other use cases.
  32. If you are interested in this project, please contact us via email.
  33. The more people are interested, the more we will be pushing this project.
  34. If you want to contribute, please contact us and we can discuss open issues
  35. and how to join forces.
  36. ## DEPENDENCIES ##
  37. This layer depends on:
  38. URI: git://git.openembedded.org/openembedded-core
  39. branch: master
  40. revision: HEAD
  41. URI: git://git.openembedded.org/meta-openembedded
  42. layers: meta-oe
  43. branch: master
  44. revision: HEAD
  45. bitbake > 1.20
  46. ## DEPENDENCIES ON RECENT COMMITS ##
  47. Here, we list which parts of this layer depend on recent commits in the
  48. bitbake, openembedded-core and meta-openembedded repositories. Using
  49. `git blame` on the lines below, you can find the commits in meta-ros that
  50. rely on the remote commits. In case of porting to other versions, you must
  51. possibly revert some of those commits.
  52. cv-bridge and dependent recipes, e.g., the image-transport recipes, depend on
  53. 7568bfdd114597956a1da68746f207ec7f93a48d@openembedded-core.
  54. Some recipes that need the Eigen library, e.g., the pcl-ros recipe, depend on
  55. 424e3c1b930c0103c2cedfd4df1671e84a5256d5@meta-openembedded.
  56. Using wildcards in bbappend versions part in name depends on
  57. 31bc9af9cd56e7b318924869970e850993fafc5f@bitbake and
  58. 991cbeedbde8bd25ce08c669b1bfac8b99e33149@bitbake.
  59. octomap-ros and collada-urdf depend on
  60. 43073569cb67d98c11aa71211d77b566b64f9145@openembedded-core and
  61. 783fb88f476c94d5d4f4b954f7053464d9a6dff5@openembedded-core.
  62. ## INSTALLATION ##
  63. The repository contains a layer for ROS that builds on top of the
  64. OpenEmbedded Core layer and the meta-oe layer.
  65. We try our best to keep up with the development of the current HEAD
  66. of the layers mentioned above. If you notice any problems with the
  67. current HEAD, please report this in our issue tracker.
  68. You can use this layer with earlier versions of the layers mentioned above
  69. and their release branches, dora and daisy, with a few minor adjustments.
  70. The section "dependencies on recent commits" in this file provides a few
  71. pointers to adjust this layer for other versions.
  72. ## USAGE ##
  73. Currently, you can cross-compile the ROS packages with the commands:
  74. source oe-init-build-env
  75. bitbake <package-name>
  76. Look at the meta-ros test reports for the description of the current state.
  77. The recipe core-image-ros-roscore provides a minimal Linux system that runs
  78. roscore.
  79. You can compile the minimal Linux system with
  80. bitbake core-image-ros-roscore
  81. Then for example, you start this system in the qemu virtual machine with
  82. runqemu <MACHINE> core-image-ros-roscore
  83. On the Linux system, ensure that the own host's name in resolved by adding
  84. 127.0.0.1 <HOSTNAME>.localdomain <HOSTNAME>
  85. to the /etc/hosts file, and set up the environment with
  86. export ROS_ROOT=/usr
  87. export ROS_MASTER_URI=http://localhost:11311
  88. export CMAKE_PREFIX_PATH=/usr
  89. touch /usr/.catkin
  90. Finally, you can start roscore with
  91. roscore
  92. ## LICENSE ##
  93. All metadata is MIT licensed unless otherwise stated. Source code included
  94. in tree for individual recipes is under the LICENSE stated in each recipe
  95. (.bb file) unless otherwise stated.
  96. The descriptions in the recipes of ROS packages have been extracted from
  97. the ROS wiki (http://www.ros.org/wiki/) and are licensed under
  98. Creative Commons Attribution 3.0 (http://creativecommons.org/licenses/by/3.0/)
  99. unless otherwise noted.
  100. This README document is Copyright (C) 2012 BMW Car IT GmbH.
  101. ## REDISTRIBUTIONS ##
  102. The log4cxx recipe originated from the recipe in the OpenEmbedded (Classic) Development
  103. (cf. http://cgit.openembedded.org/openembedded/tree/recipes/log4cxx)
  104. licensed with the MIT License.
  105. The yaml-cpp recipe originated from the recipe in Kartik Mohta's OpenEmbedded layer
  106. (cf. https://github.com/kartikmohta/meta-km/blob/master/recipes-devtools/yaml-cpp/yaml-cpp_0.3.0.bb)
  107. licensed with the MIT License.
  108. The libpoco recipe originated from the recipe in digitalSTROM's OpenEmbedded layer
  109. (cf. https://gitorious.digitalstrom.org/dss-oe/dss-oe/blobs/master/dS/meta-dss11-production/recipes-support/poco/poco_1.3.6p2.bb)
  110. licensed with the MIT License.
  111. The core-image-ros-* recipes originated from the core-image-minimal recipe in OpenEmbedded Core
  112. (cf. http://cgit.openembedded.org/openembedded-core/tree/meta/recipes-core/images/core-image-minimal.bb)
  113. licensed with the MIT License.
  114. The original or modified files are redistributed here under the same MIT License.