From 6a6e158c18862b1f9346ec0f490c7a60f8b2cb39 Mon Sep 17 00:00:00 2001 From: Carlos Pereira Atencio Date: Fri, 25 Mar 2022 19:02:17 +0000 Subject: [PATCH] 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. --- docs/radio.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/radio.rst b/docs/radio.rst index 6f8b37ad6..b0163c398 100644 --- a/docs/radio.rst +++ b/docs/radio.rst @@ -28,17 +28,20 @@ We assume you have done this for the examples below. Constants ========= -.. py:attribute:: RATE_250KBIT - - Constant used to indicate a throughput of 256 Kbit a second. - .. py:attribute:: RATE_1MBIT - Constant used to indicate a throughput of 1 MBit a second. + Constant used to indicate a throughput of 1 Mbit a second. .. py:attribute:: RATE_2MBIT - Constant used to indicate a throughput of 2 MBit a second. + Constant used to indicate a throughput of 2 Mbit a second. + +.. note:: + + A lower data rate of 250 kbit/sec is possible with micro:bit V1 via + the ``RATE_250KBIT`` constant (or using its value ``2`` directly). However + as this rate is not guaranteed to work on V2 it has been deprecated for + compatibility reasons. Functions @@ -90,8 +93,7 @@ Functions The ``data_rate`` (default=radio.RATE_1MBIT) indicates the speed at which data throughput takes place. Can be one of the following contants defined - in the ``radio`` module : ``RATE_250KBIT``, ``RATE_1MBIT`` or - ``RATE_2MBIT``. + in the ``radio`` module : ``RATE_1MBIT`` or ``RATE_2MBIT``. If ``config`` is not called then the defaults described above are assumed.