Files
pybricks-api/doc/api/pupdevices.rst
T
Laurens Valk ada319f88d doc/pupdevices: drop gears example
This is reserved for the detailed Motor page.
2019-11-11 13:30:08 +01:00

105 lines
2.5 KiB
ReStructuredText

:mod:`pupdevices` -- Powered Up Devices
===========================================================
.. automodule:: pybricks.pupdevices
:no-members:
Motor
^^^^^^^^^^^^
.. autoclass:: pybricks._instances.Motor
:noindex:
:no-members:
Example::
# Initialize a motor.
example_motor = Motor(Port.A)
# Initialize a motor with positive speed as counterclockwise
right_motor = Motor(Port.B, Direction.COUNTERCLOCKWISE)
.. rubric:: Methods for motors with rotation sensors
.. automethod:: pybricks.pupdevices.Motor.angle
.. automethod:: pybricks.pupdevices.Motor.reset_angle
.. automethod:: pybricks.pupdevices.Motor.speed
.. automethod:: pybricks.pupdevices.Motor.stop
.. automethod:: pybricks.pupdevices.Motor.run
.. automethod:: pybricks.pupdevices.Motor.run_time
.. automethod:: pybricks.pupdevices.Motor.run_angle
.. automethod:: pybricks.pupdevices.Motor.run_target
.. rubric:: Methods for all motors
.. automethod:: pybricks.pupdevices.Motor.dc
Example::
# Set the motor duty cycle to 75%.
example_motor.duty(75)
.. automethod:: pybricks.pupdevices.Motor.stop
Color and Distance Sensor
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.pupdevices.ColorDistanceSensor
:no-members:
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.color
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.ambient
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.reflection
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.rgb
.. automethod:: pybricks.pupdevices.ColorDistanceSensor.distance
.. rubric:: Built-in light
This sensor has a built-in light. You can make it red, green, blue, or turn
it off. If you use the sensor to measure something afterwards, the light
automatically turns back on at the default color for that sensing method.
.. automethod:: pybricks._instances.light.on
.. automethod:: pybricks._instances.light.off
Tilt Sensor
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.pupdevices.TiltSensor
:no-members:
.. automethod:: neutral
.. automethod:: acceleration
.. automethod:: tilt
.. automethod:: up
Remote Control
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: pybricks.pupdevices.RemoteControl
:no-members:
.. automethod:: pybricks._instances.light.on
.. automethod:: pybricks._instances.light.off
.. automethod:: pybricks._instances.buttons.pressed