gripper
Interface specifications

Gripper interface. More...

#define | PLAYER_GRIPPER_DATA_STATE 1
| Data subtype: state.
#define | PLAYER_GRIPPER_REQ_GET_GEOM 1
| Request subtype: get geometry.
#define | PLAYER_GRIPPER_CMD_OPEN 1
| Command: Open (PLAYER_GRIPPER_CMD_OPEN) More...
#define | PLAYER_GRIPPER_CMD_CLOSE 2
| Command: Close (PLAYER_GRIPPER_CMD_CLOSE) More...
#define | PLAYER_GRIPPER_CMD_STOP 3
| Command: Stop (PLAYER_GRIPPER_CMD_STOP) More...
#define | PLAYER_GRIPPER_CMD_STORE 4
| Command: Store (PLAYER_GRIPPER_CMD_STORE) More...
#define | PLAYER_GRIPPER_CMD_RETRIEVE 5
| Command: Retrieve (PLAYER_GRIPPER_CMD_RETRIEVE) More...
#define | PLAYER_GRIPPER_STATE_OPEN 1
| Gripper state: open.
#define | PLAYER_GRIPPER_STATE_CLOSED 2
| Gripper state: closed.
#define | PLAYER_GRIPPER_STATE_MOVING 3
| Gripper state: moving.
#define | PLAYER_GRIPPER_STATE_ERROR 4
| Gripper state: error.
typedef struct player_gripper_data | player_gripper_data_t
| Data: state (PLAYER_GRIPPER_DATA_STATE) More...
typedef struct player_gripper_geom | player_gripper_geom_t
| Request/reply: get geometry. More...

## Detailed Description

Gripper interface.

The `gripper` interface provides access to a robotic gripper. A gripper is a device capable of closing around and carrying an object of suitable size and shape. On a mobile robot, a gripper is typically mounted near the floor on the front, or on the end of a robotic limb. Grippers typically have two "fingers" that close around an object. Some grippers can detect whether an objcet is within the gripper (using, for example, light beams). Some grippers also have the ability to move the a carried object into a storage system, freeing the gripper to pick up a new object, and move objects from the storage system back into the gripper.

## Macro Definition Documentation

#define PLAYER_GRIPPER_CMD_CLOSE 2

Command: Close (PLAYER_GRIPPER_CMD_CLOSE)

Tells the gripper to close.

Referenced by P2OS::ProcessMessage().

#define PLAYER_GRIPPER_CMD_OPEN 1

Command: Open (PLAYER_GRIPPER_CMD_OPEN)

Tells the gripper to open.

Referenced by P2OS::ProcessMessage().

#define PLAYER_GRIPPER_CMD_RETRIEVE 5

Command: Retrieve (PLAYER_GRIPPER_CMD_RETRIEVE)

Tells the gripper to retrieve a stored object (so that it can be put back into the world). The opposite of store.

#define PLAYER_GRIPPER_CMD_STOP 3

Command: Stop (PLAYER_GRIPPER_CMD_STOP)

Tells the gripper to stop.

Referenced by P2OS::ProcessMessage().

#define PLAYER_GRIPPER_CMD_STORE 4

Command: Store (PLAYER_GRIPPER_CMD_STORE)

Tells the gripper to store whatever it is holding.

## Typedef Documentation

typedef struct player_gripper_data player_gripper_data_t

Data: state (PLAYER_GRIPPER_DATA_STATE)

The `gripper` interface returns the current state of the gripper and information on a potential object in the gripper. state may be PLAYER_GRIPPER_STATE_OPEN, PLAYER_GRIPPER_STATE_CLOSED, PLAYER_GRIPPER_STAGE_MOVING or PLAYER_GRIPPER_STATE_ERROR. beams provides information on how far into the gripper an object is. For most grippers, this will be a bit mask, with each bit representing whether a beam has been interrupted or not.

typedef struct player_gripper_geom player_gripper_geom_t

Request/reply: get geometry.

The geometry (pose, outer size and inner size) of the gripper device can be queried by sending a null PLAYER_GRIPPER_REQ_GET_GEOM request.

Last updated 12 September 2005 21:38:45