Skip to content

Commit 6a6e158

Browse files
docs: Remove radio.RATE_250KBIT as it has been dropped from V2.
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. To keep the documentation simple it might be better to remove the mention of radio.RATE_250KBIT, rather than adding more content to a fairly long function description.
1 parent 8da0e1d commit 6a6e158

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/radio.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,20 @@ 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+
.. note::
40+
41+
A lower data rate of 250 kbit/sec is possible with micro:bit V1 via
42+
the ``RATE_250KBIT`` constant (or using its value ``2`` directly). However
43+
as this rate is not guaranteed to work on V2 it has been deprecated for
44+
compatibility reasons.
4245

4346

4447
Functions
@@ -90,8 +93,7 @@ Functions
9093

9194
The ``data_rate`` (default=radio.RATE_1MBIT) indicates the speed at which
9295
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``.
96+
in the ``radio`` module : ``RATE_1MBIT`` or ``RATE_2MBIT``.
9597

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

0 commit comments

Comments
 (0)