Files
pybricks-api/doc/main/pupdevices/remote.rst
T
2026-08-25 12:03:03 +02:00

92 lines
2.3 KiB
ReStructuredText

.. pybricks-requirements:: pupdevices
Remote Control
^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: ../../main/cad/output/pupdevice-remote.png
:width: 60 %
.. blockimg:: pybricks_variables_set_remote_connect_any
.. blockimg:: pybricks_variables_set_remote_connect_name
.. autoclass:: pybricks.pupdevices.Remote
:no-members:
.. automethod:: pybricks.pupdevices::Remote.connect
.. automethod:: pybricks.pupdevices::Remote.name
.. blockimg:: pybricks_blockLightOnColor_remote_on
.. automethod:: pybricks.pupdevices::Remote.light.on
.. blockimg:: pybricks_blockLightOnColor_remote_on
.. automethod:: pybricks.pupdevices::Remote.light.off
.. blockimg:: pybricks_blockButtonIsPressed_Remote
.. automethod:: pybricks.pupdevices::Remote.buttons.pressed
.. automethod:: pybricks.pupdevices::Remote.disconnect
Examples
-------------------
Checking which buttons are pressed
**********************************
.. literalinclude::
../../../examples/pup/remote/basics.py
Changing the remote light color
**********************************
.. literalinclude::
../../../examples/pup/remote/set_color_basic.py
Changing the light color using the buttons
*******************************************
.. literalinclude::
../../../examples/pup/remote/set_color.py
Using the timeout setting
**********************************
You can use the ``timeout`` argument to change for how long the hub searches
for the remote. If you choose ``None``, it will search forever.
.. literalinclude::
../../../examples/pup/remote/timeout_none.py
If the remote was not found within the specified ``timeout``,
an :ref:`OSError <OSError>` is raised. You can catch this exception to run
other code if the remote is not available.
.. literalinclude::
../../../examples/pup/remote/timeout_exception.py
Changing the name of the remote
*******************************
You can change the Bluetooth name of the remote. The factory default name is
``Handset``.
.. blockimg:: pybricks_variables_set_remote_connect_rename
.. literalinclude::
../../../examples/pup/remote/set_name.py
You can specify this name when connecting to the remote.
This lets you pick the right one if multiple remotes are nearby.
.. blockimg:: pybricks_variables_set_remote_connect_name
.. literalinclude::
../../../examples/pup/remote/use_name.py