Difference between revisions of "Robotics-2010"

From Earlham CS Department
Jump to navigation Jump to search
Line 14: Line 14:
 
** <code>close()</code> - Close connection to brick.
 
** <code>close()</code> - Close connection to brick.
 
** <code>host</code> - Returns the address of the brick.  
 
** <code>host</code> - Returns the address of the brick.  
** generator object <code>find_bricks()</code>, the object returned by <code>find_bricks()</code>.
+
** generator object <code>find_bricks()</code>
 
*** <code>next()</code> - Find the next brick in the sequence, returns the same thing as <code>find_one_brick()</code>.  
 
*** <code>next()</code> - Find the next brick in the sequence, returns the same thing as <code>find_one_brick()</code>.  
** <code>find_one_brick(host=None, name=None)</code>
+
** <code>find_one_brick()</code>
 
** <code>find_bricks(host=None, name=None)</code> - Find all the bricks in the area, returns a generator object <code>find_bricks</code>.  
 
** <code>find_bricks(host=None, name=None)</code> - Find all the bricks in the area, returns a generator object <code>find_bricks</code>.  
  

Revision as of 23:22, 14 February 2010

NXT-Python Documentation

Largely a work in-progress, please add/edit as you learn the details. Note that this page is documenting the NXT-Python release (URL here), not the NXT_Python release (hyphen vs underscore).

nxt.locator

The function of this module is to locate NXT brick(s). Returns an nxt.bluesock.BlueSock object for robots connected by Bluetooth and a nxt.usbsock.USBSock object for robot connected by USB, and throws nxt.locator.BrickNotFoundError if none can be found.

  • Status: incomplete as of 2010-02-14
  • Objects
    • nxt.bluesock.BlueSock - The object returned by find_one_brick() when a brick is found on a Bluetooth connection.
  • Methods
    • connect() - Try to connect to the brick.
    • close() - Close connection to brick.
    • host - Returns the address of the brick.
    • generator object find_bricks()
      • next() - Find the next brick in the sequence, returns the same thing as find_one_brick().
    • find_one_brick()
    • find_bricks(host=None, name=None) - Find all the bricks in the area, returns a generator object find_bricks.
  • Example
import nxt.locator 
sock = nxt.locator.find_one_brick() 
brick = sock.connect() 
print brick.host 
brick.close()

nxt.motor

  • Status: incomplete as of 2010-02-14

nxt.sensor

  • Status: incomplete as of 2010-02-14