Skip to content

Commit ec326a9

Browse files
docs: Add note about possible 250kbit/sec radio rate in V2. (#744)
1 parent 78c4c3b commit ec326a9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/radio.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ Constants
3636
3737
Constant used to indicate a throughput of 2 Mbit a second.
3838

39-
.. py:attribute:: RATE_250KBIT
40-
41-
**Deprecated**.
42-
This rate is possible with micro:bit V1, but it is not guaranteed to work
43-
on V2, so it has been deprecated for compatibility reasons.
44-
4539

4640
Functions
4741
=========
@@ -94,6 +88,13 @@ Functions
9488
data throughput takes place. Can be one of the following contants defined
9589
in the ``radio`` module : ``RATE_1MBIT`` or ``RATE_2MBIT``.
9690

91+
.. note::
92+
93+
A lower data rate of of 250kbit/sec is supported in micro:bit V1, and
94+
may be possible with micro:bit V2, but it is not guaranteed to work on
95+
all devices. To access this hidden feature for compatibility with V1
96+
pass ``2`` to the ``data_rate`` argument.
97+
9798
If ``config`` is not called then the defaults described above are assumed.
9899

99100
.. py:function:: reset()

0 commit comments

Comments
 (0)