irobot::create::Create Class Reference

List of all members.

Public Member Functions

def __del__
def __getattr__
def __init__
def brake
def clear
def clearAngle
def clearDistance
def demo
def forwardTurn
def leds
def left
def playSong
def reset
def right
def send
def start
def stop
def storeSong
def tank
def turn

Public Attributes


Private Member Functions

def __addAngle
def __addDistance
def __convert
def __highLow
def __read
def __sendAll
def __sendNow
def __twos

Private Attributes


Detailed Description

Wrapper class for the iRobot Create

Definition at line 125 of file

Member Function Documentation

def irobot::create::Create::__addAngle (   self,
) [private]

Definition at line 240 of file

def irobot::create::Create::__addDistance (   self,
) [private]

Definition at line 233 of file

def irobot::create::Create::__convert (   self,
) [private]

Definition at line 179 of file

def irobot::create::Create::__del__ (   self  ) 

Definition at line 261 of file

def irobot::create::Create::__getattr__ (   self,

Definition at line 227 of file

def irobot::create::Create::__highLow (   self,
) [private]

Definition at line 182 of file

def irobot::create::Create::__init__ (   self,
  tty = "/dev/ttyUSB0" 
constructor for the Create, takes in a single argument: the serial port

Definition at line 128 of file

def irobot::create::Create::__read (   self,
  block = False 
) [private]

Definition at line 217 of file

def irobot::create::Create::__sendAll (   self  )  [private]

Definition at line 207 of file

def irobot::create::Create::__sendNow (   self,
) [private]

Definition at line 200 of file

def irobot::create::Create::__twos (   self,
  bits = 16 
) [private]

Definition at line 185 of file

def irobot::create::Create::brake (   self  ) 
Stops the iCreate, takes no parameters

Definition at line 264 of file

def irobot::create::Create::clear (   self  ) 

Definition at line 257 of file

def irobot::create::Create::clearAngle (   self  ) 

Definition at line 252 of file

def irobot::create::Create::clearDistance (   self  ) 

Definition at line 247 of file

def irobot::create::Create::demo (   self,
Takes a single parameter, the number of the demo to begin. "Running" demo -1 will stop the demo. After using this function the iCreate must be reset.

Definition at line 268 of file

def irobot::create::Create::forwardTurn (   self,
Takes two parameters: speed and radius. Drives the iCreate at speed with enough of an angle that the iCreate will carve a circle with the given radius. Speed is in mm/s and can vary between -500 and 500. The radius can vary between -2000 and 2000 mm (with negative mm turning left).

Definition at line 311 of file

def irobot::create::Create::leds (   self,
Controls the LEDs. Parameters are play: boolean (play on/off), advance: boolean (advance on/off), color: 0-255 (how much red in the power light), and intensity: 0-255 (how bright should the power light be.

Definition at line 277 of file

def irobot::create::Create::left (   self,
Takes in a parameter: speed and turns counter-clockwise in place at speed mm/s.

Definition at line 339 of file

def irobot::create::Create::playSong (   self,
Plays a song. Takes one parameter, the song number.

Definition at line 296 of file

def irobot::create::Create::reset (   self  ) 
Reset the iCreate.

Definition at line 166 of file

def irobot::create::Create::right (   self,
Takes in a parameter: speed and turns clockwise in place at speed mm/s.

Definition at line 335 of file

def irobot::create::Create::send (   self,

Definition at line 190 of file

def irobot::create::Create::start (   self  ) 
Start the iCreate after initialization or reset.

Definition at line 146 of file

def irobot::create::Create::stop (   self  ) 
Stop the iCreate. Must be called before deletion of the iCreate object.

Definition at line 157 of file

def irobot::create::Create::storeSong (   self,
Store a song. First parameter is the song number, the remaming arguments are taken to be of the form: note, duration, note, duration, etc. See page 12 of the iRobot Create Open Interface Manual for numerical note definitions. Duration is interpreted as duration*1/64th of a second.

Definition at line 290 of file

def irobot::create::Create::tank (   self,
Drive the iCreate like a tank (i.e. left throttle, right throttle). Takes two parameters: left and right throttle. Each can be between -500 and 500 representing mm/s.  If either are outside of this range, both throttles will be linearly scaled to fit inside the range

Definition at line 301 of file

def irobot::create::Create::turn (   self,

Definition at line 332 of file

Member Data Documentation

Definition at line 140 of file

Definition at line 138 of file

Definition at line 139 of file

Definition at line 137 of file

Definition at line 134 of file

Definition at line 132 of file

Definition at line 141 of file

Definition at line 142 of file

Definition at line 136 of file

Definition at line 135 of file

Definition at line 133 of file

Definition at line 131 of file

Definition at line 143 of file

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs

Author(s): Graylin Trevor Jay, Brian Thomas
autogenerated on Fri Jan 11 09:52:14 2013