Skip to content

Commit 268f681

Browse files
author
marcusw
committed
Added a specific stability section to the README.
1 parent 20ba584 commit 268f681

1 file changed

Lines changed: 29 additions & 6 deletions

File tree

README

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,16 @@ Requirements:
1414
* USB communications:
1515
PyUSB (http://sourceforge.net/projects/pyusb/)
1616

17-
Installation:
17+
Installation (if using source package):
1818

1919
* Untar/unzip source package
2020
* In package directory, run "python setup.py install" (as root), or if
2121
under windows, double-click install.bat.
2222
* To use USB on Linux as non-superuser, at a root terminal type:
2323
groupadd lego
2424
usermod -a -G lego [username]
25-
echo 'BUS=="usb", SYSFS{idVendor}=="0694", GROUP="lego", MODE="0660"' >
26-
\
27-
/etc/udev/rules.d/70-lego.rules
25+
echo 'BUS=="usb", SYSFS{idVendor}=="0694", GROUP="lego", MODE="0660"' \
26+
> /etc/udev/rules.d/70-lego.rules
2827

2928
Getting Started:
3029

@@ -37,7 +36,7 @@ in the source code (especially for digital sensors).
3736

3837
Notes/FAQ:
3938
(I have tried to put the most important stuff first, but it would be a good
40-
idea to read the whole thing. In any case, read it all the way through
39+
idea to read the whole section. In any case, read it all the way through
4140
before asking for help. Thanks!)
4241

4342
-=-=-About v2-=-=-
@@ -53,7 +52,7 @@ welcome to ask for help.
5352
longer a nxt.server module. I removed it due to it being a prime example of
5453
feature creep, the code being of low quality, and the connection protocol very
5554
badly designed. I would recommend that anyone wanting to use a brick over a
56-
network connection to design and write their own protocol and code to best fit
55+
network connection design and write their own protocol and code to best fit
5756
their specific application.
5857
-=-=-Problems and Their Solutions-=-=-
5958
For some reason, digital sensor operations have a tendency to throw random
@@ -82,6 +81,30 @@ intended for developers and advanced users who are looking to experiment with
8281
sensors and the digital sensor framework and classes. See Arduino/README for
8382
more info and usage instructions.
8483

84+
Specific Stability Status:
85+
nxt.brick, nxt.telegram, nxt.direct, and nxt.system:
86+
Hardly changed since NXT_Python; very, very stable.
87+
USB Communication System (nxt.usbsock)
88+
On Linux: Very stable and extensively tested.
89+
On Windows: Somewhat tested; seems to work pretty well.
90+
On Mac: Should be working, though I have not heard either way.
91+
BlueTooth Communication System (nxt.bluesock, nxt.lightblueglue)
92+
On Linux: Stable; well tested.
93+
On Windows: Stable; working last I checked.
94+
On Mac: Reported working.
95+
nxt.locator:
96+
Stable, well tested.
97+
nxt.motor:
98+
Stable except for Synchronized Motor support, which is experimental at
99+
this stage and has not been extensively tested.
100+
nxt.sensor:
101+
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.
105+
nxt.error:
106+
If there's a problem with this one, I'm gonna cry.
107+
85108
Contact:
86109

87110
NXT-Python's Head Developer:

0 commit comments

Comments
 (0)