From ec326a98fda85b2380c0de2a9841ad7ac0ca2577 Mon Sep 17 00:00:00 2001 From: Carlos Pereira Atencio Date: Fri, 29 Apr 2022 11:52:02 +0200 Subject: [PATCH] docs: Add note about possible 250kbit/sec radio rate in V2. (#744) --- docs/radio.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/radio.rst b/docs/radio.rst index 5ef7d26e7..ecbd6aa39 100644 --- a/docs/radio.rst +++ b/docs/radio.rst @@ -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 ========= @@ -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()