Robotics-2010: Difference between revisions

From Earlham CS Department
Jump to navigation Jump to search
← Older editNewer edit →
Charliep (talk | contribs)
Bureaucrats, nsAppliedGroupsD, nsAppliedGroupsR, nsAppliedGroups_, nsCS382DEL, nsCS382RW, nsCS382_TalkDEL, nsCS382_TalkRW, nsDepartmentDEL, nsDepartmentRW, nsDepartment_Tal, nsFundingDEL, nsFundingRW, nsFunding_TalkDE, nsFunding_TalkRW, nsGradingDEL, nsGradingRW, nsGrading_TalkDE, nsGrading_TalkRW, Administrators
1,991 edits
No edit summary
Charliep (talk | contribs)
Bureaucrats, nsAppliedGroupsD, nsAppliedGroupsR, nsAppliedGroups_, nsCS382DEL, nsCS382RW, nsCS382_TalkDEL, nsCS382_TalkRW, nsDepartmentDEL, nsDepartmentRW, nsDepartment_Tal, nsFundingDEL, nsFundingRW, nsFunding_TalkDE, nsFunding_TalkRW, nsGradingDEL, nsGradingRW, nsGrading_TalkDE, nsGrading_TalkRW, Administrators
1,991 edits
No edit summary
Line 1: Line 1:
== NXT-Python Documentation ==
= NXT-Python Documentation =
Largely a work in-progress, please add/edit as you learn the details.
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 ===  
=== nxt.locator ===  
The function of this module is to locate NXT brick(s).  Returns an <code>nxt.bluesock.BlueSock</code> object for robots connected by Bluetooth and a <code>nxt.usbsock.USBSock</code> object for robot connected by USB, and throws <code>nxt.locator.BrickNotFoundError</code> if none can be found.  
The function of this module is to locate NXT brick(s).  Returns an <code>nxt.bluesock.BlueSock</code> object for robots connected by Bluetooth and a <code>nxt.usbsock.USBSock</code> object for robot connected by USB, and throws <code>nxt.locator.BrickNotFoundError</code> if none can be found.  
* Status: incomplete as of 2010-02-14


* Objects
* Objects
Line 12: 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>.
*** <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_bricks(host=None, name=None)</code> - Find all the bricks in the area, returns a generator object <code>find_bricks</code>.


    generator object find_bricks
* Example
 
import nxt.locator
        The object returned by find_bricks(). Methods (incomplete):
sock = nxt.locator.find_one_brick()  
 
brick = sock.connect()  
            next()
print brick.host  
 
brick.close()
                Find the next brick in the sequence. Returns the same thing as find_one_brick().
 
Methods: (incomplete)
 
    find_one_brick(host=None, name=None) (incomplete)
 
 
    find_bricks(host=None, name=None)


        Use to find all the bricks in the area. Returns a generator object find_bricks.  
=== nxt.motor ===


Example: import nxt.locator sock = nxt.locator.find_one_brick() brick = sock.connect() print brick.host brick.close()
* Status: incomplete as of 2010-02-14


== nxt.motor ==
=== nxt.sensor ===


== nxt.sensor ==
* Status: incomplete as of 2010-02-14

Revision as of 03:20, 15 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(), the object returned by find_bricks().
      • next() - Find the next brick in the sequence, returns the same thing as find_one_brick().
    • find_one_brick(host=None, name=None)
    • 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
Retrieved from "https://wiki.cs.earlham.edu/index.php?title=Robotics-2010&oldid=10707"