turtleAPI
index
/home/turtle/turtleAPI/turtleAPI.py

 
Classes
       
robot

 
class robot
    robot encapsulates all of the needed nodes to make the functions interface
with the ros hardware.
 
Specific functions will only work if those nodes have been started (for
example, .turn() will only work if the robot's "legs" have been turned on)
 
  Methods defined here:
__init__(self)
This constructor connects to the robot and starts the communication with
the robot and the kinect.
drive(self, angSpeed=0, linSpeed=0)
Uses the continuous_driver package to start the robot driving at the given
speed.  Will return immediately, and the robot will keep moving at that
speed until told otherwise.
getAngle(self)
:return: a Tuple with roll, pitch, and yaw (presumably the first two are 0
for this robot, unless things have gone quite wrong)
getBumpStatus(self)
getBumpStatus returns the bumper states to the User
getDepth(self)
Returns a depth image, where the each pixel is a single float containing the distance from the camera of that pixel.  "I don't know"s are nans.
getImage(self)
:return: the most recent image taken by the camera
getMCLTup(self)
:return: robot's location from in the map frame from MCL as an (x,y,yaw) tuple
getMap(self)
:return: the map from Cartographer
getPosition(self)
:return: robot's entire odom data
getPositionTup(self)
:return: (x,y,yaw) tuple from the odometer
light(self)
Flashes the light on the robot (useful for checking connection or for raves)
printMap(self)
printMap prints out all of the occupancy grid information gleemed from
google cartographer
shutdown(self)
stop(self)
Uses drive() to stop the robot.