@@ -38,53 +38,27 @@ It is expected that most tools and applications written for a
38
38
TurtleBot should run on a Level 1 compatible robot.
39
39
40
40
.. figure:: rep-0119/turtlebot_lg.png
41
+ :width: 260px
41
42
:alt: An image of a TurtleBot
42
43
43
44
A TurtleBot
44
45
45
46
46
- There are a lot of tools and applications written for the TurtleBot
47
+ There are many tools and applications written for the TurtleBot
47
48
which can be useful for other similar robots. Level 2 compatible
48
49
robots are a subset of these robots for which a significant subset
49
- will work. There are already a number of robots which are close such
50
- as Mini Max [#minimax]_ and Pi Robot [#pirobot]_ .
50
+ will work. There are already a number of robots which are TurtleBot
51
+ compatible such as Mini Max [#minimax]_ and Pi Robot [#pirobot]_ .
51
52
52
53
53
54
54
55
.. figure:: rep-0119/mini_max.png
56
+ :width: 260px
55
57
:alt: An image of Mini Max
56
58
57
59
Mini Max the robot.
58
60
59
- Simulation
60
- ==========
61
-
62
- And there is a package which provides the necessary Gazebo model for
63
- Level 1 compliant robots. See the turtlebot_simulator stack
64
- [#turtlebot_simulator]_ for more information.
65
-
66
- It is recommended for Level 2 compliant robots to release a stack with
67
- the gazebo model(s) which allows them to be simulated as well, to ease
68
- development for developers who do not always have access to hardware.
69
-
70
- .. figure:: rep-0119/turtlebot_sim.png
71
- :alt: A screenshot of the TurtleBot in the Gazebo Simulator
72
-
73
- The TurtleBot simulated in Gazebo
74
-
75
- Existing REP Compliance
76
- =======================
77
-
78
- This REP is built upon previous REPs and ROS best practices. All implementations should do the same. Specifically relevant ones are listed below.
79
61
80
- REP 103 [#REP-103]_ Standard Units of Measure and Coordinate Conventions
81
- All units will follow REP 103 and all cooridnate frames will follow the conventions in REP 103.
82
-
83
- REP 105 [#REP-105]_ Coordinate Frames for Mobile Platforms
84
- The coordinate frames for the mobile base will follow REP 105.
85
-
86
- REP 107 [#REP-107]_ Diagnostic System for Robots Running ROS
87
- All hardware drivers should provide diagnostic information via the diagnostic_msgs interface of REP 107.
88
62
89
63
Compatibility Specification
90
64
===========================
@@ -116,10 +90,16 @@ ensure accessory compatibility between TurtleBot compatible robots.
116
90
* The top mounting surface of the robot must provide a hole grid pattern
117
91
centered around the z-axis of the robot base_link that is identical to
118
92
the 68-04541_TurtleBot_Plate_2 part found in the TurtleBot hardware
119
- documentation. #### TODO DESCRIBE IN THIS DOCUMENT
93
+ documentation and shown in the figure below.
120
94
* The top mounting surface of the robot must be 0.2032m (8 inches)
121
95
from rgbd camera mounting surface.
122
96
* The base footprint is circular with diameter ######
97
+
98
+ .. figure:: rep-0119/68-04541-RD_Turtlebot_Plate_2.png
99
+ :width: 100%
100
+ :alt: An image of the top mounting surface
101
+
102
+ TurtleBot Mounting Surface.
123
103
124
104
Software Requirements
125
105
'''''''''''''''''''''
@@ -137,8 +117,6 @@ TurtleBot:
137
117
* If the RGBD sensor requires a breaker to turn on it will use "Breaker 0"
138
118
* If an attached arm requires a breaker to turn on it will use "Breaker 1" TODO Better define
139
119
140
-
141
-
142
120
Level 2
143
121
-------
144
122
@@ -168,32 +146,68 @@ distributors should use the following guidelines and conventions:
168
146
169
147
Sensor Naming Convetions
170
148
''''''''''''''''''''''''
149
+ Whenever possible it is prefered to use the following convention
150
+ naming for sensor topics/namespaces LOCATION_TYPE. For example:
151
+
152
+ * base_scan
153
+ * head_camera
154
+ * forearm_camera
155
+
156
+ Link, Joint, and Frame Naming Conventions
157
+ '''''''''''''''''''''''''''''''''''''''''
158
+ Whenever possible it is prefered to use the following convention
159
+ naming for links and connecting joints LOCATION_DESCRIPTOR_TYPE. For example:
171
160
172
- *
161
+ * arm_shoulder_pan_link, arm_shoulder_pan_joint
162
+ * head_tilt_link, head_tilt_joint
173
163
174
- Link and Joint Naming Conventions
175
- '''''''''''''''''''''''''''''''''
164
+ Whenever possible it is prefered to use the following convention
165
+ naming for links and sensors LOCATION_SENSOR_TYPE. For example:
176
166
177
- The naming conventions for link names are designed to
167
+ * head_camera_rgb_link, head_camera_rgb_optical_frame
178
168
179
169
URDF
180
170
''''
171
+ Additionally a URDF snippet should be provided for the hardware
172
+ extension or modification.
173
+
174
+ Simulation
175
+ ==========
176
+
177
+ There is a package which provides the necessary Gazebo model for
178
+ Level 1 compliant robots. See the turtlebot_simulator stack
179
+ [#turtlebot_simulator]_ for more information.
180
+
181
+ It is recommended for Level 2 compliant robots to release a stack with
182
+ the gazebo model(s) which allows them to be simulated as well, to ease
183
+ development for developers who do not always have access to hardware.
184
+
185
+ .. figure:: rep-0119/turtlebot_sim.png
186
+ :alt: A screenshot of the TurtleBot in the Gazebo Simulator
187
+
188
+ The TurtleBot simulated in Gazebo
181
189
182
190
183
191
Exceptions
184
- ----------
192
+ ==========
185
193
186
194
The scope of potential robotics software is too broad to require all
187
195
ROS software to follow the guidelines of this REP. However, choosing
188
196
different conventions should be well justified and well documented.
189
197
198
+ Existing REP Compliance
199
+ =======================
190
200
201
+ This REP is built upon previous REPs and ROS best practices. All implementations should do the same. Specifically relevant ones are listed below.
191
202
192
- Compliance
193
- ==========
203
+ REP 103 [#REP-103]_ Standard Units of Measure and Coordinate Conventions
204
+ All units will follow REP 103 and all cooridnate frames will follow the conventions in REP 103.
194
205
195
- This REP depends on and is compliant with REP 103 [#REP-103]_ , REP 105 [#REP-105]_,
196
- and REP 107 [#REP-107]_.
206
+ REP 105 [#REP-105]_ Coordinate Frames for Mobile Platforms
207
+ The coordinate frames for the mobile base will follow REP 105.
208
+
209
+ REP 107 [#REP-107]_ Diagnostic System for Robots Running ROS
210
+ All hardware drivers should provide diagnostic information via the diagnostic_msgs interface of REP 107.
197
211
198
212
References
199
213
==========
0 commit comments