api/nxtdevices: add Touch Sensor

This commit is contained in:
Laurens Valk
2020-01-14 20:12:27 +01:00
parent ad12d13355
commit 19e4d3d36f
2 changed files with 43 additions and 0 deletions
+22
View File
@@ -8,3 +8,25 @@ NXT Motor
^^^^^^^^^^^^^^^^
This motor works just like a LEGO MINDSTORMS EV3 Large Motor. You can use it in
your programs using the :mod:`Motor <.ev3devices>` class.
NXT Touch Sensor
^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.nxtdevices.TouchSensor
:no-members:
.. automethod:: pybricks.nxtdevices.TouchSensor.pressed
.. toggle-header::
:header: **Using older NXT Touch Sensors**
**Example: Using a first-generation NXT Touch Sensor.**
Normally, the EV3 brick always verifies that a sensor is attached
before you can use it. This means that your program stops if a sensor
that you selected was not found. The very first generation of NXT Touch
Sensors did not support this functionality.
To use these sensors, set ``verify_type=False`` as follows::
from pybricks.nxtdevices import TouchSensor
from pybricks.parameters import Port
my_sensor = TouchSensor(Port.S1, verify_type=False)
+21
View File
@@ -1,2 +1,23 @@
"""Use LEGO® MINDSTORMS® NXT motors and sensors with the EV3 brick."""
class TouchSensor():
"""LEGO® MINDSTORMS® NXT Touch Sensor."""
def __init__(self, port):
"""
Arguments:
port (Port): Port to which the sensor is connected.
"""
pass
def pressed(self):
"""Check if the sensor is pressed.
Returns:
bool: ``True`` if the sensor is pressed, ``False`` if it is
not pressed.
"""
pass