next up previous contents
Next: 2 Developer Guide Up: 1 User Guide Previous: 5. Non-model Reference   Contents

Subsections


6. Model Reference

Gazebo currently supports the following models.

AvatarHeli


6.1 AvatarHeli

Authors

Srikanth Saripalli srik(at)usc.edu

6.1.1 Overview

The AvatarHeli model simulates the USC AVATAR helicopter, a Bergen Industrial Twin RC helicopter (http://www.bergenrc.com/IndustrialTwin.asp).

6.1.2 libgazebo Interfaces

AvatarHeli currently does not support any interfaces.

6.1.3 Player Drivers

No player drivers are available.

6.1.4 World File Attributes

AvatarHeli models can be instantiated using the <model:AvatarHeli> tag. The following attributes are supported.

<model:AvatarHeli>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.1.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

Blimp


6.2 Blimp

Authors

Pranav Srivastava pranav(at)seas.upenn.edu

6.2.1 Overview

The Blimp model simulates a UPenn Blimp.

6.2.2 libgazebo Interfaces

Blimp supports the libgazebo position and position3d interface.

6.2.3 Player Drivers

Basic motor control and odometry information is available through the gz_position or gz_position3d driver.

6.2.4 World File Attributes

Blimp models can be instantiated using the <model:Blimp> tag. The following attributes are supported.

<model:Blimp>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<is3d> true/false false Does this use the position3d interface?

6.2.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

ClodBuster


6.3 ClodBuster

Authors

Pranav Srivastava pranav(at)seas.upenn.edu

6.3.1 Overview

The ClodBuster model simulates the UPenn ClodBuster robot (4 wheel drive robot with Ackerman steering).

6.3.2 libgazebo Interfaces

ClodBuster supports the libgazebo position interface.

6.3.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver.

6.3.4 World File Attributes

ClodBuster models can be instantiated using the <model:ClodBuster> tag. The following attributes are supported.

<model:ClodBuster>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<raw_encoder_position> true/false false Flag indicating return of raw wheel encoder values.

6.3.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

Factory


6.4 Factory

Authors

Chris Jones cvjones(at)usc.edu, Nathan Koenig nkoenig(at)usc.edu

6.4.1 Overview

The Factory model maintains no physical characteristics, but instead allows the user to dynamically create models at runtime. A model is instantiated by passing an XML character string to a Factory model. The character string use the same model format as the .world files. Note that the string should only contain the model description, and no other tags. The XML string is passed into Gazebo through the gz_factory interface which has the same interface as the Player speech device.

6.4.2 libgazebo Interfaces

Factory supports the libgazebo factory interface.

6.4.3 Player Drivers

A new model is created using the gz_factory driver.

6.4.4 World File Attributes

Factory models can be instantiated using the <model:Factory> tag. The following attributes are supported.

<model:Factory>
Attribute Type Default Description
<id> string NULL Model ID string

6.4.5 Body Attributes

This model does not have a physical representation.

GarminGPS


6.5 GarminGPS

Authors

Pranav Srivastava pranav(at)seas.upenn.edu

6.5.1 Overview

The model simulates GPS information by using the flat-world approximation. It doesn't account for GPS occlusion or loss of signal, etc.

6.5.2 libgazebo Interfaces

supports the libgazebo gps interfaces.

6.5.3 Player Drivers

The GPS position are available through the gz_gps driver.

6.5.4 World File Attributes

models can be instantiated using the <model:GarminGPS> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<origin> 3-vector (0,0,0) coordinates of the origin in lat-long-alt

6.5.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

GroundPlane


6.6 GroundPlane

Authors

Nathan Koenig nkoenig(at)usc.edu

6.6.1 Overview

The model simulates a flat infinite plane.

6.6.2 libgazebo Interfaces

has no libgazebo interface.

6.6.3 Player Drivers

There are no player drivers.

6.6.4 World File Attributes

models can be instantiated using the <model:GroundPlane> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<normal> 3-vector (0,0,1) Direction of the normal vector
<height> double 0 Distance along the z-axis to place the plane
<color> 3-vector (0,0,0) RGB color
<texture2D> string NULL Texture image filename
<cfm> double 0.01 Constraint Force Mixing parameter

6.6.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

LightSource


6.7 LightSource

Authors

Andrew Howard ahoward(at)usc.edu, Nathan Koenig nkoenig(at)usc.edu

6.7.1 Overview

The LightSource model simulates a single point light.

6.7.2 libgazebo Interfaces

LightSource has no libgazebo interface.

6.7.3 Player Drivers

There are no player drivers.

6.7.4 World File Attributes

LightSource models can be instantiated using the <model:LightSource> tag. The following attributes are supported.

<model:LightSource>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<ambientColor> 4-vector (0.2 0.2 0.2 1.0) Ambient color
<diffuseColor> 4-vector (0.8 0.8 0.8 1.0) Diffuse color
<specularColor> 4-vector (0.2 0.2 0.2 1.0) Specular color
<attenuation> 3-vector (1.0 0.0 0.0) Constant, Linear, Quadratic attenuation

6.7.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

MapExtruder


6.8 MapExtruder

Authors

Nathan Koenig nkoenig(at)usc.edu

6.8.1 Overview

The MapExtruder model extrudes a 2D image into 3D geometry. This is useful for generating simple maps. The bottom left point in the image is mapped to the position specified by the pos tag.

6.8.2 libgazebo Interfaces

MapExtruder currently has no libgazebo interface.

6.8.3 Player Drivers

There are no player drivers.

6.8.4 World File Attributes

MapExtruder models can be instantiated using the <model:MapExtruder> tag. The following attributes are supported.

<model:MapExtruder>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<imageFile> string NULL PPM image file to extrude
<negative> true/false false Use the inverse color values
<threshold> integer 200 Value over which a pixel is considered filled space
<width> float 0.1 Width of the geometries
<height> float 1 Height of the geometries, along z-axis
<scale> float 0.1 Scale the map up or down
<color> 3-vector (0,0,0) RGB color
<errBound> float 5 Allowable error in the geometries
<halign> left/center left Horizontal alignment
<valign> bottom/center bottom Vertical alignment

6.8.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

ObserverCam


6.9 ObserverCam

Authors

Nathan Koenig nkoenig(at)usc.edu, Andrew Howard ahoward(at)usc.edu

6.9.1 Overview

The model provides a interactive viewport through which users can view the simulation (think of it as a fly god's eye).

6.9.2 World File Attributes

models can be instantiated using the <model:ObserverCam> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<updatePeriod> float 0.1 Seconds between refresh
<displayRays> true/false false Display laser rays
<saveFrames> string NULL Directory to store image frames
<shadeModel> flat/smooth flat OpenGL shading model
<polygonMode> point/line/fill fill OpenGL polygon mode
<lens> Camera lens attributes
    <hfov> degrees 60 Horizontal field of view
    <nearClip> meters 0.20 Distance to near clip plane
    <farClip> meters 1000.0 Distance to far clip plane

6.9.3 Windows

The following are definitions for the ObserverWindow. The window attribute block must be a child of <model:>.

<window:X11GLWindow>
Attribute Type Default Description
<id> string NULL Window ID string
<title> string NULL Window title string
<size> 2-vector (100,100) Initial size of the window
<moveScale> float 0.1 Mouse movement scale factor

Mouse Commands
Button Vertical Move Horizontal Move
Left Rotate along X axis Rotate along Z axis
Middle Translate along Z axis Translate along X axis
Right Translate along Y axis Translate along X axis

6.9.4 Body Attributes

This model does not have a physical representation.

Pioneer2AT


6.10 Pioneer2AT

Authors

Andrew Howard ahoward(at)usc.edu, Nathan Koenig nkoenig(at)usc.edu

6.10.1 Overview

The model simulates the ActivMedia Pioneer2AT (``all terrain'') robot with 4 wheels and skid steering. Currently, it does not simulate the robot's sonar ring.

6.10.2 libgazebo Interfaces

supports the libgazebo position interface.

6.10.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver.

6.10.4 World File Attributes

models can be instantiated using the <model:Pioneer2AT> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.10.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

Pioneer2DX


6.11 Pioneer2DX

Authors

Andrew Howard ahoward(at)usc.edu

6.11.1 Overview

The model simulates the ActivMedia Pioneer2DX (indoor) robot with 2 drive wheels and a castor. Currently, it does not simulate the robot's sonar ring.

6.11.2 libgazebo Interfaces

supports the libgazebo position interface.

6.11.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver.

6.11.4 World File Attributes

models can be instantiated using the <model:Pioneer2DX> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.11.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

Pioneer2Gripper


6.12 Pioneer2Gripper

Authors

Carle Cote Carle.Cote(at)USherbrooke.ca

6.12.1 Overview

The model simulates the ActivMedia Pioneer2 Gripper. Every object in the world that can be picked up by a gripper must set the <canBeGrip> to true.

6.12.2 libgazebo Interfaces

supports the libgazebo gripper interface.

6.12.3 Player Drivers

Control of the gripper position is available through the gz_gripper driver.

6.12.4 World File Attributes

models can be instantiated using the <model:Pioneer2Gripper> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.12.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.
baseBarBody single
Stationary support bar leftGripperBody single
Left gripper rightGripperBody single
Right gripper

Pioneer2Sonars


6.13 Pioneer2Sonars

Authors

Carle Cote Carle.Cote(at)USherbrooke.ca

6.13.1 Overview

The model simulates the ActivMedia Pioneer2 Sonar Ring. The sonar ring consists of 15 ray proximity sensors, each of which simulates a single sonar.

6.13.2 libgazebo Interfaces

supports the libgazebo sonar interface.

6.13.3 Player Drivers

Control of the sonars is available through the gz_sonars driver.

6.13.4 World File Attributes

models can be instantiated using the <model:Pioneer2Sonars> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0,0,0) Position of the ray
<dir> 3-vector (0,0,0) Direction of the ray
<range> meters 0 Initial sensor range

6.13.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

PointSet


6.14 PointSet

Authors

Andrew Howard ahoward(at)usc.edu

6.14.1 Overview

The model visualizes a, usually dense, point cloud.

6.14.2 libgazebo Interfaces

has no libgazebo interface.

6.14.3 Player Drivers

There are no player drivers.

6.14.4 World File Attributes

models can be instantiated using the <model:PointSet> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<pointFile> string NULL Point cloud data file

6.14.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

SegwayRMP


6.15 SegwayRMP

Authors

Andrew Howard ahoward(at)usc.edu

6.15.1 Overview

The model simulates RMP modification of the Segway HT.

Those of you that already have one of these will know what this is; for everyone else: the Segway RMP (Robotic Mobility Platform) is a two-wheeled, dynamically stabilized robot made from a modified Segway HT (Human Transporter). This is an interesting beast: it is large, fast and heavy, and will fall down alarmingly if you turn the power off.

The model includes a PID inverted pendulum controller written by Marin Kobilarov mkobilar(at)usc.edu. The dynamics are roughly similar to those of the real robot, but users should not expect a close correlation.

6.15.2 libgazebo Interfaces

supports the libgazebo position interface. IMU data is not yet available.

6.15.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver. IMU data is not yet available.

6.15.4 World File Attributes

models can be instantiated using the <model:SegwayRMP> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.15.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.
topPlate Top plate

Shrimp


6.16 Shrimp

Authors

Stijn Opheide stijn.opheide(at)kotnet.org, Jef Marien jef.marien(at)student.kuleuven.ac.be, Koen Jans koen.jans(at)student.kuleuven.ac.be

6.16.1 Overview

The model simulates the BlueBotics Shrimp robot. This model is currently under development.

6.16.2 libgazebo Interfaces

supports the libgazebo position interface.

6.16.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver.

6.16.4 World File Attributes

models can be instantiated using the <model:Shrimp> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.16.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

SickLMS200


6.17 SickLMS200

Authors

Andrew Howard ahoward(at)usc.edu, Nathan Koenig nkoenig(at)usc.edu

6.17.1 Overview

The model simulates the ubiquitous SICK scanning laser range-finder.

6.17.2 libgazebo Interfaces

supports the libgazebo laser and fiducial interfaces.

6.17.3 Player Drivers

Range and intensity data is available through the gz_laser driver. Fiducial information (ID, range, bearing and orientation) is available through the gz_fiducial driver. Note that, at present, only SimpleSolid models can be fiducials.

6.17.4 World File Attributes

SickLMS200 models can be instantiated using the <model:SickLMS200> tag. The following attributes are supported.

<model:SickLMS200>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<rangeCount> int 361 The number of range readings to generate.
<rayCount> int 91 The number of actual rays to generate.
<maxRange> float 8.192 Maximum laser range (m).
<minRange> float 0.20 Minimum laser range (m).
<scanPeriod> float 0.200 The interval between successive scans (s).

Note that when the number of rays is less than the number of range readings, the ``missing'' range readings will be interpolated. Reducing the number of rays is a good way to save CPU cycles (at the expense of simulation fidelity).

6.17.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

SimpleSolid


6.18 SimpleSolid

Authors

Andrew Howard ahoward(at)usc.edu

6.18.1 Overview

The model creates simple solid objects, such as spheres and boxes. The solids have mass, and will interact with other objects.

6.18.2 libgazebo Interfaces

does not support any interfaces.

6.18.3 Player Drivers

There are no Player drivers for .

6.18.4 World File Attributes

models can be instantiated using the <model:SimpleSolid> tag. The following attributes are supported.

<model:SimpleSolid>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<shape> string NULL Shape description. Can be any of: sphere, box, cylinder.
<size> float 1.0 Sphere diameter.
<size> tuple (0.1, 1.0) Cylinder diameter and height.
<size> tuple (1.0, 1.0, 1.0) Box width, length and height.
<mass> float 1.0 Mass of the object (kg).
<color> tuple (0, 0, 0, 1) Color of the object (including alpha, if transparency is enabled.
<retro> float 0 Retro-reflectivity level (0 = not a retro-reflector, 1 = perfect retro-reflector).
<fiducial> integer -1 Fiducial ID (-1 = not a fiducial).
<transparent> true/false false Sets transparency.
<texture2D> string NULL Texture image filename
<cfm> double 0.01 Constraint Force Mixing parameter

6.18.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

SonyVID30


6.19 SonyVID30

Authors

Nathan Koenig nkoenig(at)usc.edu, Andrew Howard ahoward(at)usc.edu, Pranav Srivastava pranav(at)seas.upenn.edu

6.19.1 Overview

The model simulates the Sony VID 30 pan-tilt-zoom camera. This model will probably be merged with the MonoCam model in future releases.

6.19.2 libgazebo Interfaces

supports the libgazebo ptz interface.

6.19.3 Player Drivers

The camera position (pan and tilt) can be controlled by setting pan/tilt using the gz_ptz driver.

6.19.4 World File Attributes

models can be instantiated using the <model:SonyVID30> tag. The following attributes are supported.

<model:SonyVID30>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<gain> double 1.0 Motion gain
<zoomLimits> tuple (10.0, 60.0) Zoom limits
<imageSize> tuple (320, 240) Size of the image in pixels
<updatePeriod> float 0.1 Seconds between refresh
<displayRays> true/false false Display laser rays
<saveFrames> string NULL Directory to store image frames
<shadeModel> flat/smooth flat OpenGL shading model
<polygonMode> point/line/fill fill OpenGL polygon mode
<lens> Camera lens attributes
    <hfov> degrees 60 Horizontal field of view
    <nearClip> meters 0.20 Distance to near clip plane
    <farClip> meters 1000.0 Distance to far clip plane

6.19.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.
head The camera head (the bit that moves.)

6.19.6 Windows

The following are definitions for the windows. The window attribute block must be a child of <model:>.

<window:X11GLWindow>
Attribute Type Default Description
<id> string NULL Window ID string
<title> string NULL Window title string

Terrain


6.20 Terrain

Authors

Nathan Koenig nkoenig(at)usc.edu

6.20.1 Overview

The model generates a triangle mesh from a 2D image or other data file, such as a DEM. The generated mesh has a variable triangle density corresponding to a user defined error bound. A high error bound allows for more error in the terrain representation, resulting in fewer triangles.

6.20.2 libgazebo Interfaces

has no libgazebo interface.

6.20.3 Player Drivers

There are no player drivers.

6.20.4 World File Attributes

models can be instantiated using the <model:Terrain> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<vertexSpacing> double 1.0 Meters between the vertices of the mesh.
<elevationScale> double 1.0 Elevation scale factor in meters.
<color> 3-vector (0,0,0) RGB color
<texture2D> string NULL Texture image filename
<textureRepeat> tuple (1.0 1.0) Texture repetition in X and Y directions.
<cfm> double 0.01 Constraint Force Mixing parameter

6.20.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

TotemPole


6.21 TotemPole

Authors

Andrew Howard ahoward(at)usc.edu

6.21.1 Overview

The model generates a stack of simple solids to create a visual fiducial.

6.21.2 libgazebo Interfaces

has no libgazebo interface.

6.21.3 Player Drivers

There are no player drivers.

6.21.4 World File Attributes

models can be instantiated using the <model:TotemPole> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation
<shape> box/cylinder cylinder Simple Sold shape.
<diameter> double 0.10 Diameter of the totem pole in meters.
<steps> integer 1 Number of shapes used in the pole.
<step_##_height> double 0.02 Height of the ##th shape.
<step_##_barcode> binary string NULL Barcode of ##th shape.

6.21.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.

TruthWidget


6.22 TruthWidget

Authors

Chris Jones cvjones(at)usc.edu

6.22.1 Overview

The is a magical device for querying and modifying the true pose of objects in the simulator. It has no simulated body, but can be attached to other models to learn or change their pose.

6.22.2 libgazebo Interfaces

supports the libgazebo truth interface.

6.22.3 Player Drivers

As of Player 1.4rc2, this model has no Player support.

6.22.4 World File Attributes

models can be instantiated using the <model:TruthWidget> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.22.5 Body Attributes

This model does not have a physical representation.

WheelChair


6.23 WheelChair

Authors

Pranav Srivastava pranav(at)seas.upenn.edu

6.23.1 Overview

The model simulates a robotic wheelchair.

6.23.2 libgazebo Interfaces

supports the libgazebo position interface.

6.23.3 Player Drivers

Basic motor control and odometry information is available through the gz_position driver.

6.23.4 World File Attributes

models can be instantiated using the <model:WheelChair> tag. The following attributes are supported.

<model:>
Attribute Type Default Description
<id> string NULL Model ID string
<xyz> 3-vector (0, 0, 0) Model position
<rpy> Euler angles (0, 0, 0) Model orientation

6.23.5 Body Attributes

The following bodies are used by this model.

Name Description
canonical The canonical (default) body.


next up previous contents
Next: 2 Developer Guide Up: 1 User Guide Previous: 5. Non-model Reference   Contents
2004-05-31