Add examples

Author: schodet

MANIFEST.in

@@ -5,3 +5,4 @@ include docs/Makefile
 include docs/conf.py
 include docs/favicon.ico
 recursive-include docs *.rst
+recursive-include examples *.py

examples/motcont.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+"""NXT-Python example to use Linus Atorf's MotorControl.
+
+You need to have MotorControl22 program installed on the brick, you can find it here:
+
+https://github.com/schodet/MotorControl
+
+Build it and install it with nxc.
+"""
+import time
+
+import nxt.locator
+import nxt.motcont
+import nxt.motor
+
+with nxt.locator.find() as b:
+    mc = nxt.motcont.MotCont(b)
+
+    def wait():
+        while not mc.is_ready(nxt.motor.Port.A) or not mc.is_ready(nxt.motor.Port.B):
+            time.sleep(0.5)
+
+    mc.start()
+
+    mc.cmd((nxt.motor.Port.A, nxt.motor.Port.B), 50, 360)
+    wait()
+
+    mc.cmd((nxt.motor.Port.A, nxt.motor.Port.B), -50, 360)
+    wait()
+
+    mc.stop()

examples/sensors.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+"""NXT-Python example to use sensors."""
+import time
+
+import nxt.locator
+import nxt.sensor
+import nxt.sensor.generic
+
+with nxt.locator.find() as b:
+    touch = b.get_sensor(nxt.sensor.Port.S1, nxt.sensor.generic.Touch)
+    sound = b.get_sensor(nxt.sensor.Port.S2, nxt.sensor.generic.Sound)
+    light = b.get_sensor(nxt.sensor.Port.S3, nxt.sensor.generic.Light, False)
+    us = b.get_sensor(nxt.sensor.Port.S4)
+    sensors = [touch, sound, light, us]
+
+    while True:
+        samples = [s.get_sample() for s in sensors]
+        print(samples)
+        time.sleep(0.5)

examples/tutorial/debug.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python3
+"""NXT-Python tutorial: increase log level."""
+import logging
+
+import nxt.locator
+
+# Increase the log level, must be done before using any NXT-Python function. See logging
+# documentation for details.
+logging.basicConfig(level=logging.DEBUG)
+
+with nxt.locator.find() as b:
+    b.play_tone(440, 250)

examples/tutorial/find.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python3
+"""NXT-Python tutorial: find the brick."""
+import nxt.locator
+
+# Find a brick.
+with nxt.locator.find() as b:
+    # Once found, print its name.
+    print("Found brick:", b.get_device_info()[0])
+    # And play a recognizable note.
+    b.play_tone(440, 250)

examples/tutorial/motor.py

@@ -0,0 +1,12 @@
+#!/usr/bin/python3
+"""NXT-Python tutorial: turn a motor."""
+import nxt.locator
+import nxt.motor
+
+with nxt.locator.find() as b:
+    # Get the motor connected to the port A.
+    mymotor = b.get_motor(nxt.motor.Port.A)
+    # Full circle in one direction.
+    mymotor.turn(25, 360)
+    # Full circle in the opposite direction.
+    mymotor.turn(-25, 360)

examples/tutorial/sensor_touch.py

@@ -0,0 +1,18 @@
+#!/usr/bin/python3
+"""NXT-Python tutorial: use touch sensor."""
+import time
+
+import nxt.locator
+import nxt.sensor
+import nxt.sensor.generic
+
+with nxt.locator.find() as b:
+    # Get the sensor connected to port 1, not a digital sensor, must give the sensor
+    # class.
+    mysensor = b.get_sensor(nxt.sensor.Port.S1, nxt.sensor.generic.Touch)
+    # Read the sensor in a loop (until interrupted).
+    print("Use Ctrl-C to interrupt")
+    while True:
+        value = mysensor.get_sample()
+        print(value)
+        time.sleep(0.5)

examples/tutorial/sensor_us.py

@@ -0,0 +1,19 @@
+#!/usr/bin/python3
+"""NXT-Python tutorial: use ultra-sonic sensor."""
+import time
+
+import nxt.locator
+import nxt.sensor
+
+# Need to import generic sensors for auto-detection to work.
+import nxt.sensor.generic
+
+with nxt.locator.find() as b:
+    # Find the sensor connected to port 4.
+    mysensor = b.get_sensor(nxt.sensor.Port.S4)
+    # Read the sensor in a loop (until interrupted).
+    print("Use Ctrl-C to interrupt")
+    while True:
+        distance_cm = mysensor.get_sample()
+        print(distance_cm)
+        time.sleep(0.5)