@@ -14,7 +14,7 @@ Requirements:
1414 * USB communications:
1515 PyUSB (http://sourceforge.net/projects/pyusb/)
1616
17- Installation (if using source package) :
17+ Installation:
1818
1919 * Untar/unzip source package
2020 * In package directory, run "python setup.py install" (as root), or if
@@ -27,12 +27,15 @@ Installation (if using source package):
2727
2828Getting Started:
2929
30- Take a look at the examples directory (this is, unfortunately, not included
31- in the windows installer packages...you will find it in a corresponding source
32- package or SVN checkout). Feel free to copy that code into your scripts and
33- don't be afraid to experiment! If you are having trouble with something, you may
34- find the solution in the docstrings (ex. help('nxt.sensor.Ultrasonic')) or even
35- in the source code (especially for digital sensors).
30+ Take a look at the examples directory. This shows by example how to do most
31+ things in nxt-python. Feel free to copy that code into your scripts and don't be
32+ afraid to experiment! If you are having trouble with something, you may find the
33+ solution in the docstrings (ex. help('nxt.sensor.Ultrasonic')) or even in the
34+ source code (especially for digital sensors). Note that in PyPI packages, this
35+ directory is omitted; if you are developing for NXT-Python, you should get one
36+ of the packages from the googlecode site at nxt-python.googlecode.com. You can
37+ also find documentation, tutorials, FAQs, a link to the mailing list, and a neat
38+ web interface to the SVN there.
3639
3740Notes/FAQ:
3841 (I have tried to put the most important stuff first, but it would be a good
@@ -53,21 +56,15 @@ longer a nxt.server module. I removed it due to it being a prime example of
5356feature creep, the code being of low quality, and the connection protocol very
5457badly designed. I would recommend that anyone wanting to use a brick over a
5558network connection design and write their own protocol and code to best fit
56- their specific application.
59+ their specific application. Some good example network code may be found at
60+ http://wiki.python.org/moin/TcpCommunication
5761 -=-=-Problems and Their Solutions-=-=-
58- For some reason, digital sensor operations have a tendency to throw random
59- I2C communication errors. I have been unable to find the source of this problem
60- (it seems to be inside the nxt firmware itself) or a good workaround. If some
61- python master out there comes up with a fix, I would be very, very happy to get
62- it. Thanks!
62+ Support for a number of sensors has not been tested at all, due to lack of
63+ hardware. If you have a problem with a digital sensor, see the troubleshooting
64+ guide below and don't forget to report your trouble!
6365 The Synchronized Motor support has not been extensively tested for accuracy.
6466It seems to mostly work well but the accuracy of the braking function and the
6567closeness of the two motors to each other have not been assesed.
66- Support for a number of sensors has not been tested at all, due to lack of
67- hardware. I have started a project to test this code, but the going is slow
68- and I have decided to go ahead and release rather than waiting several more
69- months. If you have a problem with a digital sensor, see the troubleshooting
70- guide below and don't forget to report your trouble!
7168 NXT-Python has not been tested and may not work with custom nxt firmware
7269versions (if you don't know what that means, you don't need to worry about it).
7370However, if the firmware uses the standard USB/BT communications protocol,
@@ -99,9 +96,9 @@ Specific Stability Status:
9996 this stage and has not been extensively tested.
10097 nxt.sensor:
10198 Code not specific to a particular sensor is well tested and working
102- well. About half of the sensor classes were last reported working; the
103- rest have not to my knowlege been tested and were written blindly from
104- the manuacturers' specifications.
99+ well. More than half of the sensor classes were last reported working;
100+ the rest have not to my knowlege been tested and were written blindly
101+ from the manuacturers' specifications.
105102 nxt.error:
106103 If there's a problem with this one, I'm gonna cry.
107104
0 commit comments