position2d
[Interface specifications]
Collaboration diagram for position2d:
|
Detailed Description
Planar mobile robot.
The position2d interface is used to control mobile robot bases in 2D.
Define Documentation
| #define PLAYER_POSITION2D_CMD_CAR 3 |
Command: carlike (PLAYER_POSITION2D_CMD_CAR).
The position interface accepts carlike translational velocity + constant turn commands (speed and turning angle) for the robot's motors (only supported by some drivers).
Definition at line 4721 of file player_interfaces.h.
Referenced by Erratic::HandleCommand(), and ER::ProcessMessage().
| #define PLAYER_POSITION2D_CMD_POS 2 |
Command: position (PLAYER_POSITION2D_CMD_POS).
The position interface accepts new positions for the robot's motors (drivers may support position control, speed control, or both).
Definition at line 4715 of file player_interfaces.h.
Referenced by GarciaDriver::ProcessMessage().
| #define PLAYER_POSITION2D_CMD_VEL 1 |
Command: velocity (PLAYER_POSITION2D_CMD_VEL).
The position interface accepts new velocities for the robot's motors (drivers may support position control, speed control, or both).
Definition at line 4708 of file player_interfaces.h.
Referenced by wbr914::HandleCommand(), P2OS::HandleCommand(), Erratic::HandleCommand(), SegwayRMP::ProcessMessage(), RFLEX::ProcessMessage(), P2OS::ProcessMessage(), Khepera::ProcessMessage(), GarciaDriver::ProcessMessage(), ER::ProcessMessage(), and ClodBuster::ProcessMessage().
| #define PLAYER_POSITION2D_CMD_VEL_HEAD 4 |
Command: vel/head (PLAYER_POSITION2D_CMD_VEL_HEAD).
The position interface accepts translational velocity + absolute heading commands (speed and angular position) for the robot's motors (only supported by some drivers).
Definition at line 4726 of file player_interfaces.h.
Referenced by Erratic::HandleCommand().
| #define PLAYER_POSITION2D_DATA_GEOM 2 |
Data: geometry.
This messages is published by drivers which can change their geometry at run time
Definition at line 4701 of file player_interfaces.h.
| #define PLAYER_POSITION2D_DATA_STATE 1 |
Data: state (PLAYER_POSITION2D_DATA_STATE).
The position interface returns data regarding the odometric pose and velocity of the robot, as well as motor stall information.
Definition at line 4695 of file player_interfaces.h.
Referenced by P2OS::GyroPutData(), SegwayRMP::Main(), RFLEX::Main(), ER::Main(), ClodBuster::Main(), AMCLOdom::ProcessMessage(), wbr914::PublishData(), Erratic::PublishPosition2D(), AdaptiveMCL::PutDataPosition(), GarciaDriver::RefreshData(), Khepera::ResetOdometry(), P2OS::StandardSIPPutData(), and Khepera::UpdateData().
| #define PLAYER_POSITION2D_REQ_GET_GEOM 1 |
Request/reply: geometry.
To request robot geometry, send a null PLAYER_POSITION2D_REQ_GET_GEOM request.
Definition at line 4610 of file player_interfaces.h.
Referenced by wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), SegwayRMP::HandlePositionConfig(), AdaptiveMCL::ProcessGeom(), RFLEX::ProcessMessage(), Khepera::ProcessMessage(), GarciaDriver::ProcessMessage(), ER::ProcessMessage(), ClodBuster::ProcessMessage(), AdaptiveMCL::ProcessMessage(), and GarciaDriver::ProcessPos2dGeomReq().
| #define PLAYER_POSITION2D_REQ_MOTOR_POWER 2 |
Request/reply: Motor power.
On some robots, the motor power can be turned on and off from software. To do so, send a PLAYER_POSITION2D_REQ_MOTOR_POWER request with the format given below, and with the appropriate state (zero for motors off and non-zero for motors on). Null response.
Be VERY careful with this command! You are very likely to start the robot running across the room at high speed with the battery charger still attached.
Definition at line 4623 of file player_interfaces.h.
Referenced by wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), SegwayRMP::HandlePositionConfig(), RFLEX::ProcessMessage(), REB::ProcessMessage(), Khepera::ProcessMessage(), ER::ProcessMessage(), and ClodBuster::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_POSITION_MODE 4 |
Request/reply: Change control mode.
To change control mode, send a PLAYER_POSITION2D_REQ_POSITION_MODE request. Null response.
Definition at line 4656 of file player_interfaces.h.
Referenced by REB::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_POSITION_PID 8 |
Request/reply: Set position PID parameters.
To set position PID parameters, send a PLAYER_POSITION2D_REQ_POSITION_PID request. Null response.
Definition at line 4683 of file player_interfaces.h.
Referenced by REB::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_RESET_ODOM 6 |
Request/reply: Reset odometry.
To reset the robot's odometry to 
, send a PLAYER_POSITION2D_REQ_RESET_ODOM request. Null response.
Definition at line 4668 of file player_interfaces.h.
Referenced by wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), SegwayRMP::HandlePositionConfig(), RFLEX::ProcessMessage(), REB::ProcessMessage(), Khepera::ProcessMessage(), ER::ProcessMessage(), and ClodBuster::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_SET_ODOM 5 |
Request/reply: Set odometry.
To set the robot's odometry to a particular state, send a PLAYER_POSITION2D_REQ_SET_ODOM request. Null response.
Definition at line 4662 of file player_interfaces.h.
Referenced by wbr914::HandleConfig(), P2OS::HandleConfig(), Erratic::HandleConfig(), RFLEX::ProcessMessage(), REB::ProcessMessage(), Khepera::ProcessMessage(), ER::ProcessMessage(), and ClodBuster::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_SPEED_PID 7 |
Request/reply: Set velocity PID parameters.
To set velocity PID parameters, send a PLAYER_POSITION2D_REQ_SPEED_PID request. Null response.
Definition at line 4675 of file player_interfaces.h.
Referenced by REB::ProcessMessage(), and ClodBuster::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_SPEED_PROF 9 |
Request/reply: Set linear speed profile parameters.
To set linear speed profile parameters, send a PLAYER_POSITION2D_REQ_SPEED_PROF request. Null response.
Definition at line 4689 of file player_interfaces.h.
Referenced by REB::ProcessMessage().
| #define PLAYER_POSITION2D_REQ_VELOCITY_MODE 3 |
Request/reply: Change velocity control.
Some robots offer different velocity control modes. It can be changed by sending a PLAYER_POSITION2D_REQ_VELOCITY_MODE request with the format given below, including the appropriate mode. No matter which mode is used, the external client interface to the position device remains the same. Null response.
The p2os driver offers two modes of velocity control: separate translational and rotational control and direct wheel control. When in the separate mode, the robot's microcontroller internally computes left and right wheel velocities based on the currently commanded translational and rotational velocities and then attenuates these values to match a nice predefined acceleration profile. When in the direct mode, the microcontroller simply passes on the current left and right wheel velocities. Essentially, the separate mode offers smoother but slower (lower acceleration) control, and the direct mode offers faster but jerkier (higher acceleration) control. Player's default is to use the direct mode. Set mode to zero for direct control and non-zero for separate control.
For the reb driver, 0 is direct velocity control, 1 is for velocity-based heading PD controller.
Definition at line 4649 of file player_interfaces.h.
Referenced by P2OS::HandleConfig(), Erratic::HandleConfig(), RFLEX::ProcessMessage(), REB::ProcessMessage(), Khepera::ProcessMessage(), and ClodBuster::ProcessMessage().