Skip to content

docs: Add note about possible 250kbit/sec radio rate in V2. #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2022
Merged

docs: Add note about possible 250kbit/sec radio rate in V2. #744

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/radio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,6 @@ Constants

Constant used to indicate a throughput of 2 Mbit a second.

.. py:attribute:: RATE_250KBIT

**Deprecated**.
This rate is possible with micro:bit V1, but it is not guaranteed to work
on V2, so it has been deprecated for compatibility reasons.


Functions
=========
Expand Down Expand Up @@ -94,6 +88,13 @@ Functions
data throughput takes place. Can be one of the following contants defined
in the ``radio`` module : ``RATE_1MBIT`` or ``RATE_2MBIT``.

.. note::

A lower data rate of of 250kbit/sec is supported in micro:bit V1, and
may be possible with micro:bit V2, but it is not guaranteed to work on
all devices. To access this hidden feature for compatibility with V1
pass ``2`` to the ``data_rate`` argument.

If ``config`` is not called then the defaults described above are assumed.

.. py:function:: reset()
Expand Down