Skip to content

Commit 17e624a

Browse files
docs: Remove radio.RATE_250KBIT as it has been dropped from V2. (bbcmicrobit#731)
The constant is still present in the micro:bit V1 MicroPython port, but it is not in the V2 MicroPython port. The value from the constant (`2`) can be used as an argument in the V2 MicroPython `radio.config(data_rate=2)`, but because it is not officially supported in the V2 nRF52833 microcontroller we cannot guarantee it will always work, so the constant is deprecated in V1 and removed in V2.
1 parent 42bb525 commit 17e624a

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/radio.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,19 @@ We assume you have done this for the examples below.
2828
Constants
2929
=========
3030

31-
.. py:attribute:: RATE_250KBIT
32-
33-
Constant used to indicate a throughput of 256 Kbit a second.
34-
3531
.. py:attribute:: RATE_1MBIT
3632
37-
Constant used to indicate a throughput of 1 MBit a second.
33+
Constant used to indicate a throughput of 1 Mbit a second.
3834

3935
.. py:attribute:: RATE_2MBIT
4036
41-
Constant used to indicate a throughput of 2 MBit a second.
37+
Constant used to indicate a throughput of 2 Mbit a second.
38+
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.
4244

4345

4446
Functions
@@ -90,8 +92,7 @@ Functions
9092

9193
The ``data_rate`` (default=radio.RATE_1MBIT) indicates the speed at which
9294
data throughput takes place. Can be one of the following contants defined
93-
in the ``radio`` module : ``RATE_250KBIT``, ``RATE_1MBIT`` or
94-
``RATE_2MBIT``.
95+
in the ``radio`` module : ``RATE_1MBIT`` or ``RATE_2MBIT``.
9596

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

0 commit comments

Comments
 (0)