mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 09:37:25 +00:00
David Lechner
31a639f55b
This enables the sphinx doc nitpicky option to detect broken references. Also fix all of the broken references.
106 lines
2.5 KiB
ReStructuredText
106 lines
2.5 KiB
ReStructuredText
:mod:`pupdevices <pybricks.pupdevices>` -- Powered Up Devices
|
|
=============================================================
|
|
|
|
.. automodule:: pybricks.pupdevices
|
|
:no-members:
|
|
|
|
Motors without Rotation Sensors
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: pybricks.builtins.DCMotor
|
|
:noindex:
|
|
:no-members:
|
|
|
|
.. automethod:: pybricks.builtins.DCMotor.dc
|
|
:noindex:
|
|
|
|
Motors with Rotation Sensors
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: pybricks._instances.Motor
|
|
:noindex:
|
|
:no-members:
|
|
|
|
.. automethod:: pybricks._instances.Motor.angle
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.reset_angle
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.speed
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.stop
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.run
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.run_time
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.run_angle
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks._instances.Motor.run_target
|
|
:noindex:
|
|
|
|
.. automethod:: pybricks.builtins.Motor.dc
|
|
:noindex:
|
|
|
|
This method lets you use a motor as if it is a simple DC motor.
|
|
|
|
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
|