Interface specifications
[libplayercore]

Collaboration diagram for Interface specifications:

Detailed Description

All Player communication occurs through interfaces, which specify the syntax and semantics for a set of messages.

See the tutorial Interfaces, drivers, and devices for a discussion of what an interface is.

Below are the details. For each interface, the following is given:

It can be the case that a given message can be sent as data or in response to a request. A common example is geometry. For many devices geometry is fixed and so need only be requested once. For others geometry may change dynamically and so the device will publish it periodically.

Todo:
  • Normalize subtype names (PLAYER_PTZ_REQ_GEOM vs PLAYER_POSITION2D_REQ_GET_GEOM)


Modules

 dio
 Digital I/O.
 ranger
 A range sensor.
 blinkenlight
 An indicator light.
 blackboard
 Access properties stored in a central repository.
 wifi
 WiFi signal information.
 planner
 A planar path-planner.
 log
 Log read / write control.
 mcom
 Client - client communication.
 speech
 Speech synthesis.
 ir
 Array of infrared rangers.
 position3d
 A robot that moves in 3-D.
 actarray
 An array of actuators.
 opaque
 A generic interface for user-defined messages.
 vectormap
 Access and update geometric features in a map.
 joystick
 Joystick control.
 aio
 Analog I/O.
 gripper
 Gripper interface.
 limb
 A multi-jointed limb.
 camera
 Camera imagery.
 laser
 Laser range-finder.
 health
 Statgrab - System Infos.
 fiducial
 Fiducial (marker) detection.
 rfid
 RFID reader.
 ptz
 Pan-tilt-zoom unit.
 graphics3d
 Three-dimensional graphics interface.
 position1d
 A 1-D linear actuator.
 graphics2d
 Two-dimensional graphics interface.
 imu
 Inertial Measurement Unit.
 gps
 Global positioning system.
 blobfinder
 A visual blob-detection system.
 power
 Power system.
 position2d
 Planar mobile robot.
 localize
 Multi-hypothesis planar localization system.
 player
 Player: the meta-device.
 wsn
 Wireless Sensor Networks.
 pointcloud3d
 A 3-D point cloud.
 simulation
 A robot simulator.
 sonar
 Array of ultrasonic rangers.
 map
 Access maps.
 audio
 Interface to an audio system.
 speech_recognition
 Speech recognition.
 bumper
 An array of bumpers.

Last updated 12 September 2005 21:38:45