Skip to content

Commit

Permalink
docs: Add note about possible 250kbit/sec radio rate in V2. (#744)
Browse files Browse the repository at this point in the history
  • Loading branch information
microbit-carlos committed Apr 29, 2022
1 parent c2ca9f5 commit 70bd815
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/radio.rst
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

0 comments on commit 70bd815

Please sign in to comment.