Skip to content

Commit bdf72b1

Browse files
committed
doc: add XBee RR and XBee 3 BLU firmware update feature
Related to commits: * 'hardware: add new versions to the supported hardware list' (9c08721) * 'xmodem: Handle first-chunk delay when sending firmware into XR bootloader' (f95e0fa) * 'Add support for the new XBee BLU device/product.' (187afbf) Signed-off-by: Tatiana Leon <Tatiana.Leon@digi.com>
1 parent 1212cce commit bdf72b1

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

doc/user_doc/update_the_xbee.rst

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,22 @@ profiles:
1616
* Local and remote firmware updates
1717
* Local and remote file system updates
1818
* Local and remote profile updates
19+
* **XBee 3 BLU**:
20+
* Local firmware updates
21+
* Local file system updates
22+
* Local profile updates
23+
* **XBee RR**
24+
* Local and remote firmware updates
25+
* Local and remote profile updates
26+
* **XBee XR 868/900**
27+
* Local and remote firmware updates
28+
* Local and remote profile updates
1929
* **XBee SX 868/900 MHz**
2030
* Local and remote firmware updates
2131
* Local and remote profile updates
2232
* **XBee S2C**
2333
* Remote firmware updates
2434
* Remote profile updates
25-
* **XBee XR 868/900**
26-
* Local and remote firmware updates
27-
* Local and remote profile updates
2835

2936

3037
.. _updateFirmware:
@@ -45,9 +52,11 @@ and remote devices:
4552
.. warning::
4653
At the moment, firmware update is only supported in:
4754
* **XBee 3**: Local and remote firmware updates
55+
* **XBee 3 BLU**: Local firmware updates
56+
* **XBee RR**: Local and remote firmware updates
57+
* **XBee XR 868/900**: Local and remote firmware updates
4858
* **XBee SX 868/900 MHz**: Local and remote firmware updates
4959
* **XBee S2C**: Remote firmware updates
50-
* **XBee XR 868/900**: Local and remote firmware updates
5160

5261

5362
.. _updateFirmwareLocal:
@@ -71,7 +80,8 @@ connection. For this operation, you need the following components:
7180

7281
.. warning::
7382
At the moment, local firmware update is only supported in **XBee 3**,
74-
**XBee SX 868/900 MHz** and **XBee XR 868/900** devices.
83+
**XBee 3 BLU**, **XBee RR**, **XBee XR 868/900**, and **XBee SX 868/900 MHz**
84+
devices.
7585

7686

7787
+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -225,7 +235,8 @@ components:
225235

226236
.. warning::
227237
At the moment, remote firmware update is only supported in **XBee 3**,
228-
**XBee SX 868/900 MHz**, **XBee S2C**, and **XBee XR 868/900** devices.
238+
**XBee RR**, **XBee XR 868/900**, **XBee SX 868/900 MHz**,
239+
and **XBee S2C** devices.
229240

230241
To perform the remote firmware update, call the ``update_firmware()`` method of
231242
the ``RemoteXBeeDevice`` class providing the required parameters:
@@ -303,16 +314,16 @@ The ``update_firmware()`` method may fail for the following reasons:
303314
Update the XBee file system
304315
---------------------------
305316

306-
XBee 3 devices feature file system capabilities, meaning that they are able to
307-
persistently store files and folders in flash. The XBee Python Library provides
308-
classes and methods to manage these files.
317+
XBee 3 and XBee RR devices feature file system capabilities, meaning that they
318+
are able to persistently store files and folders in flash. The XBee Python
319+
Library provides classes and methods to manage these files.
309320

310321
* :ref:`filesystemManager`
311322
* :ref:`filesystemOperations`
312323

313324
.. warning::
314-
At the moment file system capabilities are only supported in **XBee 3**
315-
devices.
325+
At the moment file system capabilities are only supported in **XBee 3** and
326+
**XBee RR** devices.
316327

317328

318329
.. _filesystemManager:
@@ -491,9 +502,11 @@ To configure individual settings see :ref:`configureXBee`.
491502
.. warning::
492503
At the moment, firmware update is only supported in:
493504
* **XBee 3**: Local and remote profile updates
505+
* **XBee 3 BLU**: Local profile updates
506+
* **XBee RR**: Local and remote profile updates
507+
* **XBee XR 868/900**: Local and remote profile updates
494508
* **XBee SX 868/900 MHz**: Local and remote profile updates
495509
* **XBee S2C**: Remote profile updates
496-
* **XBee XR 868/900**: Local and remote profile updates
497510

498511

499512
.. _readXBeeProfile:
@@ -647,7 +660,8 @@ Applying a profile to a local XBee requires the following components:
647660

648661
.. warning::
649662
At the moment, local profile update is only supported in **XBee 3**,
650-
**XBee SX 868/900 MHz**, and **XBee XR 868/900** devices.
663+
**XBee 3 BLU**, **XBee RR**, **XBee XR 868/900**, and **XBee SX 868/900 MHz**
664+
devices.
651665

652666
To apply the XBee profile to a local XBee, call the ``apply_profile()`` method
653667
of the ``XBeeDevice`` class providing the required parameters:
@@ -721,7 +735,8 @@ Applying a profile to a remote XBee requires the following components:
721735

722736
.. warning::
723737
At the moment, remote profile update is only supported in **XBee 3**,
724-
**XBee SX 868/900 MHz**, **XBee S2C**, and **XBee XR 868/900** devices.
738+
**XBee RR**, **XBee XR 868/900**, **XBee SX 868/900 MHz** and
739+
**XBee S2C** devices.
725740

726741
To apply the XBee profile to a remote XBee, call the ``apply_profile()`` method
727742
of the ``RemoteXBeeDevice`` class providing the required parameters:

0 commit comments

Comments
 (0)