summaryrefslogtreecommitdiff
path: root/python/nxt-python/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/nxt-python/README')
-rw-r--r--python/nxt-python/README23
1 files changed, 16 insertions, 7 deletions
diff --git a/python/nxt-python/README b/python/nxt-python/README
index 19157be329..bd05e263c6 100644
--- a/python/nxt-python/README
+++ b/python/nxt-python/README
@@ -1,26 +1,35 @@
-nxt-python is a python 2.x driver/interface for the Lego Mindstorms NXT robot.
+nxt-python (python module to control Lego NXT)
+
+nxt-python is a python 2.x driver/interface for the Lego Mindstorms
+NXT robot.
Setup
------
-In order to use nxt-python with an NXT kit, you should add a 'lego' group to your system, and add yourself to that group:
+In order to use nxt-python with an NXT kit, you should add a 'lego'
+group to your system, and add yourself to that group:
# groupadd lego
# usermod -a -G lego YourUserName
-You will also want to set up a udev rule to identify NXT hardware and grant the 'lego' group permission to use it.
+You will also want to set up a udev rule to identify NXT hardware and
+grant the 'lego' group permission to use it.
-A sample rule is included for you in /usr/share/nxt-python, but you may want to verify the vendor code of the NXT unit.
+A sample rule is included for you in /usr/share/nxt-python, but you may
+want to verify the vendor code of the NXT unit.
-To verify the vendor code, connect the NXT hardware to your computer and then run:
+To verify the vendor code, connect the NXT hardware to your computer
+and then run:
lsusb
-Look at the ID for the Lego device; it will probably be 0694, but if not, then change the value in the sample udev rule to match.
+Look at the ID for the Lego device; it will probably be 0694, but if not,
+then change the value in the sample udev rule to match.
Save the sample udev rule (70-lego.rules) to /etc/udev/rules.d/
-Log out and log back in, and you should now have full control, via Python, over your NXT hardware.
+Log out and log back in, and you should now have full control, via Python,
+over your NXT hardware.
Requires at least one of these
-------------------------------