hardware: add new versions to the supported hardware list

- Added support to the following new hardware:
  - 0x4E: XBee 3 Cellular LTE-M/NB-IoT (Telit)
  - 0x50: XB3-DMLR
  - 0x51: XB3-DMLR868
  - 0x52: XBee 3 Reduced RAM
  - 0x53: S2C P5
- Adapted firmware update and file system features to the new hardware.

https://onedigi.atlassian.net/browse/XBJAPI-535

Signed-off-by: Diego Escalona <diego.escalona@digi.com>
Signed-off-by: Tatiana Leon <Tatiana.Leon@digi.com>

Author: diescalo

CHANGELOG.rst

@@ -4,6 +4,13 @@ Changelog
 v1.4.1 - XX/XX/2021
 -------------------
 
+* Support for new hardware variants:
+
+  * XBee 3 Cellular LTE-M/NB-IoT (Telit)
+  * XBee 3 Reduced RAM
+  * S2C P5
+  * XB3-DMLR
+  * XB3-DMLR868
 * OTA firmware update:
 
   * Implementation of considerations for versions 1009, 300A, 200A or prior

digi/xbee/filesystem.py

@@ -82,9 +82,11 @@
 
 _SECURE_ELEMENT_SUFFIX = "#"
 
-SUPPORTED_HW_VERSIONS = (HardwareVersion.XBEE3.code,
-                         HardwareVersion.XBEE3_SMT.code,
-                         HardwareVersion.XBEE3_TH.code)
+REMOTE_SUPPORTED_HW_VERSIONS = (HardwareVersion.XBEE3.code,
+                                HardwareVersion.XBEE3_SMT.code,
+                                HardwareVersion.XBEE3_TH.code)
+LOCAL_SUPPORTED_HW_VERSIONS = REMOTE_SUPPORTED_HW_VERSIONS \
+                              + (HardwareVersion.XBEE3_RR.code,)
 
 # Update this value when File System API frames are supported
 XB3_MIN_FW_VERSION_FS_API_SUPPORT = {
@@ -3355,7 +3357,10 @@ def check_fs_support(xbee, min_fw_vers=None, max_fw_vers=None):
                 "filesystem support: %s", str(exc))
 
     # Check compatibility
-    if hw_version and hw_version.code not in SUPPORTED_HW_VERSIONS:
+    supported_hw_versions = LOCAL_SUPPORTED_HW_VERSIONS
+    if xbee.is_remote():
+        supported_hw_versions = REMOTE_SUPPORTED_HW_VERSIONS
+    if hw_version and hw_version.code not in supported_hw_versions:
         return False
 
     if not fw_version:

digi/xbee/firmware.py

@@ -77,9 +77,15 @@
 _PATTERN_GECKO_BOOTLOADER_COMPATIBILITY_FULL = \
     "^.*Gecko Bootloader.*\\(([0-9a-fA-F]{4})-([0-9a-fA-F]{2})(.*)\\).*$"
 _PATTERN_GECKO_BOOTLOADER_VERSION = \
-    "^.*Gecko Bootloader v([0-9a-fA-F]{1}\\.[0-9a-fA-F]{1}\\.[0-9a-fA-F]{1}).*$"
+    "^.*Gecko Bootloader v([0-9a-fA-F]{1,}\\.[0-9a-fA-F]{1,}\\.[0-9a-fA-F]{1,}).*$"
 
-_XBEE3_BOOTLOADER_FILE_PREFIX = "xb3-boot-rf_"
+_XBEE3_BL_DEF_PREFIX = "xb3-boot-rf_"
+_XBEE3_BOOTLOADER_FILE_PREFIX = {
+    HardwareVersion.XBEE3.code: _XBEE3_BL_DEF_PREFIX,
+    HardwareVersion.XBEE3_SMT.code: _XBEE3_BL_DEF_PREFIX,
+    HardwareVersion.XBEE3_TH.code: _XBEE3_BL_DEF_PREFIX,
+    HardwareVersion.XBEE3_RR.code: "xb3-boot-rr_"
+}
 
 _GEN3_BOOTLOADER_ERROR_CHECKSUM = 0x12
 _GEN3_BOOTLOADER_ERROR_VERIFY = 0x13
@@ -280,15 +286,17 @@
                    HardwareVersion.XB24C.code,
                    HardwareVersion.XBP24C_S2C_SMT.code,
                    HardwareVersion.XBP24C_TH_DIP.code,
-                   HardwareVersion.XB24C_TH_DIP.code)
+                   HardwareVersion.XB24C_TH_DIP.code,
+                   HardwareVersion.S2C_P5.code)
 
 SX_HW_VERSIONS = (HardwareVersion.SX.code,
                   HardwareVersion.SX_PRO.code,
                   HardwareVersion.XB8X.code)
 
 XBEE3_HW_VERSIONS = (HardwareVersion.XBEE3.code,
                      HardwareVersion.XBEE3_SMT.code,
-                     HardwareVersion.XBEE3_TH.code)
+                     HardwareVersion.XBEE3_TH.code,
+                     HardwareVersion.XBEE3_RR.code)
 
 LOCAL_SUPPORTED_HW_VERSIONS = SX_HW_VERSIONS + XBEE3_HW_VERSIONS
 REMOTE_SUPPORTED_HW_VERSIONS = SX_HW_VERSIONS + XBEE3_HW_VERSIONS + S2C_HW_VERSIONS
@@ -521,7 +529,7 @@ def parse_file(self):
                 self._image_type = utils.bytes_to_int(
                     _reverse_bytearray(file.read(_BUFFER_SIZE_SHORT)))
                 _log.debug(" - Image type: %s (%d)",
-                           "Firmware" if not self._image_type else "File system", self._image_type)
+                           "Firmware" if self._image_type in (0, 1) else "File system", self._image_type)
                 f_version = _reverse_bytearray(file.read(_BUFFER_SIZE_INT))
                 self._file_version = utils.bytes_to_int(f_version)
                 _log.debug(" - File version: %s (%d)",
@@ -652,8 +660,8 @@ def manufacturer_code(self):
     @property
     def image_type(self):
         """
-        Returns the OTA file image type: 0x0000 for firmware,
-        0x0100 for file system.
+        Returns the OTA file image type: 0x0000 for XBee 3 firmware,
+        0x0001 for XBee 3 RR firmware, 0x0100 for file system.
 
         Returns:
             Integer: OTA file image type.
@@ -3720,7 +3728,8 @@ def _check_bootloader_binary_file(self):
         if self._bootloader_fw_file is None:
             path = Path(self._xml_fw_file)
             self._bootloader_fw_file = str(Path(path.parent).joinpath(
-                _XBEE3_BOOTLOADER_FILE_PREFIX + str(self._xml_bootloader_version[0])
+                _XBEE3_BOOTLOADER_FILE_PREFIX[self._target_hw_version]
+                + str(self._xml_bootloader_version[0])
                 + _BOOTLOADER_VERSION_SEPARATOR + str(self._xml_bootloader_version[1])
                 + _BOOTLOADER_VERSION_SEPARATOR + str(self._xml_bootloader_version[2])
                 + EXTENSION_GBL))
@@ -4932,8 +4941,9 @@ def _check_img_data(self, payload):
         if man_code != self._ota_file.manufacturer_code:
             server_status = _XBee3OTAStatus.NO_IMAGE_AVAILABLE
         # Check image type:
-        #    0x0000: firmware upgrade
-        #    0x0100: file system upgrade
+        #    0x0000: XBee 3 firmware upgrade
+        #    0x0001: XBee 3 RR firmware upgrade
+        #    0x0100: XBee 3 file system upgrade
         elif img_type != self._ota_file.image_type:
             server_status = _XBee3OTAStatus.NO_IMAGE_AVAILABLE
         # Check compatibility number

digi/xbee/models/hw.py

@@ -93,6 +93,11 @@ class HardwareVersion(Enum):
     CELLULAR_3_LTE_M_VERIZON = (0x4A, "XBee Cellular 3 LTE-M Verizon")
     CELLULAR_3_LTE_M_ATT = (0x4B, "XBee Cellular 3 LTE-M AT&T")
     CELLULAR_3_CAT1_LTE_VERIZON = (0x4D, "XBee Cellular 3 Cat 1 LTE Verizon")
+    CELLULAR_3_LTE_M_TELIT = (0x4E, "XBee 3 Cellular LTE-M/NB-IoT (Telit)")
+    XBEE3_DM_LR = (0x50, "XB3-DMLR")
+    XBEE3_DM_LR_868 = (0x51, "XB3-DMLR868")
+    XBEE3_RR = (0x52, "XBee 3 Reduced RAM")
+    S2C_P5 = (0x53, "S2C P5")
 
     def __init__(self, code, description):
         self.__code = code

digi/xbee/models/protocol.py

@@ -256,15 +256,17 @@ def determine_protocol(hw_version, fw_version, br_value=None):
                           HardwareVersion.CELLULAR_3_CAT1_LTE_ATT.code,
                           HardwareVersion.CELLULAR_3_LTE_M_VERIZON.code,
                           HardwareVersion.CELLULAR_3_LTE_M_ATT.code,
-                          HardwareVersion.CELLULAR_3_CAT1_LTE_VERIZON.code):
+                          HardwareVersion.CELLULAR_3_CAT1_LTE_VERIZON.code,
+                          HardwareVersion.CELLULAR_3_LTE_M_TELIT.code):
             return XBeeProtocol.CELLULAR
 
         if hw_version == HardwareVersion.CELLULAR_NBIOT_EUROPE.code:
             return XBeeProtocol.CELLULAR_NBIOT
 
         if hw_version in (HardwareVersion.XBEE3.code,
                           HardwareVersion.XBEE3_SMT.code,
-                          HardwareVersion.XBEE3_TH.code):
+                          HardwareVersion.XBEE3_TH.code,
+                          HardwareVersion.XBEE3_RR.code):
             if fw_version.startswith("2"):
                 return XBeeProtocol.RAW_802_15_4
             if fw_version.startswith("3"):
@@ -275,6 +277,17 @@ def determine_protocol(hw_version, fw_version, br_value=None):
             return (XBeeProtocol.DIGI_MESH
                     if br_value != 0 else XBeeProtocol.DIGI_POINT)
 
+        if hw_version in (HardwareVersion.XBEE3_DM_LR.code,
+                          HardwareVersion.XBEE3_DM_LR_868.code):
+            return XBeeProtocol.DIGI_MESH
+
+        if hw_version == HardwareVersion.S2C_P5.code:
+            if fw_version.startswith("C"):
+                return XBeeProtocol.RAW_802_15_4
+            if fw_version.startswith("B"):
+                return XBeeProtocol.DIGI_MESH
+            return XBeeProtocol.ZIGBEE
+
         return XBeeProtocol.ZIGBEE
 
 

digi/xbee/recovery.py

@@ -1,4 +1,4 @@
-# Copyright 2019, 2020, Digi International Inc.
+# Copyright 2019-2021, Digi International Inc.
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -30,7 +30,8 @@
 
 SUPPORTED_HARDWARE_VERSIONS = (HardwareVersion.XBEE3.code,
                                HardwareVersion.XBEE3_SMT.code,
-                               HardwareVersion.XBEE3_TH.code)
+                               HardwareVersion.XBEE3_TH.code,
+                               HardwareVersion.XBEE3_RR.code)
 
 _BAUDRATE_KEY = "baudrate"
 _PARITY_KEY = "parity"