Files
pybricks-api/doc/api/pupdevices.rst
T
Laurens Valk fe39782b5a config: rename _instances
Now that the instance hack has been dropped, all that remains is the simplified motor docs, so rename file accordingly.
2020-01-14 17:58:10 +01:00

106 lines
2.6 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._simplemotor.Motor
:noindex:
:no-members:
.. automethod:: pybricks._simplemotor.Motor.angle
:noindex:
.. automethod:: pybricks._simplemotor.Motor.reset_angle
:noindex:
.. automethod:: pybricks._simplemotor.Motor.speed
:noindex:
.. automethod:: pybricks._simplemotor.Motor.stop
:noindex:
.. automethod:: pybricks._simplemotor.Motor.run
:noindex:
.. automethod:: pybricks._simplemotor.Motor.run_time
:noindex:
.. automethod:: pybricks._simplemotor.Motor.run_angle
:noindex:
.. automethod:: pybricks._simplemotor.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.pupdevices::ColorDistanceSensor.light.on
.. automethod:: pybricks.pupdevices::ColorDistanceSensor.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.pupdevices::RemoteControl.light.on
.. automethod:: pybricks.pupdevices::RemoteControl.light.off
.. automethod:: pybricks.pupdevices::RemoteControl.buttons.pressed