Source code for digi.xbee.models.hw

# Copyright 2017-2022, 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
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

from enum import Enum, unique
from digi.xbee.util import utils


[docs]@unique class HardwareVersion(Enum): """ This class lists all hardware versions. | Inherited properties: | **name** (String): The name of this HardwareVersion. | **value** (Integer): The ID of this HardwareVersion. """ X09_009 = (0x01, "X09-009") X09_019 = (0x02, "X09-019") XH9_009 = (0x03, "XH9-009") XH9_019 = (0x04, "XH9-019") X24_009 = (0x05, "X24-009") X24_019 = (0x06, "X24-019") X09_001 = (0x07, "X09-001") XH9_001 = (0x08, "XH9-001") X08_004 = (0x09, "X08-004") XC09_009 = (0x0A, "XC09-009") XC09_038 = (0x0B, "XC09-038") X24_038 = (0x0C, "X24-038") X09_009_TX = (0x0D, "X09-009-TX") X09_019_TX = (0x0E, "X09-019-TX") XH9_009_TX = (0x0F, "XH9-009-TX") XH9_019_TX = (0x10, "XH9-019-TX") X09_001_TX = (0x11, "X09-001-TX") XH9_001_TX = (0x12, "XH9-001-TX") XT09B_XXX = (0x13, "XT09B-xxx (Attenuator version)") XT09_XXX = (0x14, "XT09-xxx") XC08_009 = (0x15, "XC08-009") XC08_038 = (0x16, "XC08-038") XB24_AXX_XX = (0x17, "XB24-Axx-xx") XBP24_AXX_XX = (0x18, "XBP24-Axx-xx") XB24_BXIX_XXX = (0x19, "XB24-BxIx-xxx and XB24-Z7xx-xxx") XBP24_BXIX_XXX = (0x1A, "XBP24-BxIx-xxx and XBP24-Z7xx-xxx") XBP09_DXIX_XXX = (0x1B, "XBP09-DxIx-xxx Digi Mesh") XBP09_XCXX_XXX = (0x1C, "XBP09-XCxx-xxx: S3 XSC Compatibility") XBP08_DXXX_XXX = (0x1D, "XBP08-Dxx-xxx 868MHz") XBP24B = (0x1E, "XBP24B: Low cost ZB PRO and PLUS S2B") XB24_WF = (0x1F, "XB24-WF: XBee 802.11 (Redpine module)") AMBER_MBUS = (0x20, "??????: M-Bus module made by Amber") XBP24C = (0x21, "XBP24C: XBee PRO SMT Ember 357 S2C PRO") XB24C = (0x22, "XB24C: XBee SMT Ember 357 S2C") XSC_GEN3 = (0x23, "XSC_GEN3: XBP9 XSC 24 dBm") SRD_868_GEN3 = (0x24, "SDR_868_GEN3: XB8 12 dBm") ABANDONATED = (0x25, "Abandonated") SMT_900LP = (0x26, "900LP (SMT): 900LP on 'S8 HW'") WIFI_ATHEROS = (0x27, "WiFi Atheros (TH-DIP) XB2S-WF") SMT_WIFI_ATHEROS = (0x28, "WiFi Atheros (SMT) XB2B-WF") SMT_475LP = (0x29, "475LP (SMT): Beta 475MHz") XBEE_CELL_TH = (0x2A, "XBee-Cell (TH): XBee Cellular") XLR_MODULE = (0x2B, "XLR Module") XB900HP_NZ = (0x2C, "XB900HP (New Zealand): XB9 NZ HW/SW") XBP24C_TH_DIP = (0x2D, "XBP24C (TH-DIP): XBee PRO DIP") XB24C_TH_DIP = (0x2E, "XB24C (TH-DIP): XBee DIP") XLR_BASEBOARD = (0x2F, "XLR Baseboard") XBP24C_S2C_SMT = (0x30, "XBee PRO SMT") SX_PRO = (0x31, "SX Pro") S2D_SMT_PRO = (0x32, "XBP24D: S2D SMT PRO") S2D_SMT_REG = (0x33, "XB24D: S2D SMT Reg") S2D_TH_PRO = (0x34, "XBP24D: S2D TH PRO") S2D_TH_REG = (0x35, "XB24D: S2D TH Reg") SX = (0x3E, "SX") XTR = (0x3F, "XTR") CELLULAR_CAT1_LTE_VERIZON = (0x40, "XBee Cellular Cat 1 LTE Verizon") XBEE3_SMT = (0x41, "XBee 3 Micro and SMT") XBEE3_TH = (0x42, "XBee 3 TH") XBEE3 = (0x43, "XBee 3 Reserved") CELLULAR_3G = (0x44, "XBee Cellular 3G") XB8X = (0x45, "XB8X") CELLULAR_LTE_VERIZON = (0x46, "XBee Cellular LTE-M Verizon") CELLULAR_LTE_ATT = (0x47, "XBee Cellular LTE-M AT&T") CELLULAR_NBIOT_EUROPE = (0x48, "XBee Cellular NBIoT Europe") CELLULAR_3_CAT1_LTE_ATT = (0x49, "XBee Cellular 3 Cat 1 LTE AT&T") 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") CELLULAR_3_GLOBAL_LTE_CAT1 = (0x54, "XBee 3 Cellular Global LTE Cat 1") CELLULAR_3_NA_LTE_CAT1 = (0x55, "XBee 3 Cellular North America LTE Cat 1") def __init__(self, code, description): self.__code = code self.__desc = description @property def code(self): """ Returns the code of the HardwareVersion element. Returns: Integer: the code of the HardwareVersion element. """ return self.__code @property def description(self): """ Returns the description of the HardwareVersion element. Returns: String: the description of the HardwareVersion element. """ return self.__desc @classmethod def get(cls, code): """ Returns the HardwareVersion for the given code. Args: code (Integer): the code of the hardware version to get. Returns: :class:`HardwareVersion`: the HardwareVersion with the given code, `None` if not found. """ for version in cls: if version.code == code: return version return None
[docs]class LegacyHardwareVersion(Enum): """ This class lists all legacy hardware versions. | Inherited properties: | **name** (String): The name of this LegacyHardwareVersion. | **value** (Integer): The ID of this LegacyHardwareVersion. """ A = (0x01, "A") B = (0x02, "B") C = (0x03, "C") D = (0x04, "D") E = (0x05, "E") F = (0x06, "F") G = (0x07, "G") H = (0x08, "H") I = (0x09, "I") J = (0x0A, "J") K = (0x0B, "K") L = (0x0C, "L") M = (0x0D, "M") N = (0x0E, "N") O = (0x0F, "O") P = (0x10, "P") Q = (0x11, "Q") R = (0x12, "R") S = (0x13, "S") T = (0x14, "T") U = (0x15, "U") V = (0x16, "V") W = (0x17, "W") X = (0x18, "X") Y = (0x19, "Y") Z = (0x1A, "Z") def __init__(self, code, letter): self.__code = code self.__letter = letter @property def code(self): """ Returns the code of the LegacyHardwareVersion element. Returns: Integer: the code of the LegacyHardwareVersion element. """ return self.__code @property def letter(self): """ Returns the letter of the LegacyHardwareVersion element. Returns: String: the letter of the LegacyHardwareVersion element. """ return self.__letter @classmethod def get_by_letter(cls, letter): """ Returns the LegacyHardwareVersion for the given letter. Args: letter (String): the letter of the legacy hardware version to get. Returns: :class:`LegacyHardwareVersion`: the LegacyHardwareVersion with the given letter, `None` if not found. """ for version in cls: if version.letter == letter: return version return None
HardwareVersion.__doc__ += utils.doc_enum(HardwareVersion) LegacyHardwareVersion.__doc__ += utils.doc_enum(LegacyHardwareVersion)