digi.xbee.models.protocol module¶
-
class
digi.xbee.models.protocol.
XBeeProtocol
(code, description)[source]¶ Bases:
enum.Enum
Enumerates the available XBee protocols. The XBee protocol is determined by the combination of hardware and firmware of an XBee device.
Inherited properties:name (String): the name (id) of this XBeeProtocol.value (String): the value of this XBeeProtocol.Values:XBeeProtocol.ZIGBEE = (0, ‘Zigbee’)XBeeProtocol.RAW_802_15_4 = (1, ‘802.15.4’)XBeeProtocol.XBEE_WIFI = (2, ‘Wi-Fi’)XBeeProtocol.DIGI_MESH = (3, ‘DigiMesh’)XBeeProtocol.XCITE = (4, ‘XCite’)XBeeProtocol.XTEND = (5, ‘XTend (Legacy)’)XBeeProtocol.XTEND_DM = (6, ‘XTend (DigiMesh)’)XBeeProtocol.SMART_ENERGY = (7, ‘Smart Energy’)XBeeProtocol.DIGI_POINT = (8, ‘Point-to-multipoint’)XBeeProtocol.ZNET = (9, ‘ZNet 2.5’)XBeeProtocol.XC = (10, ‘XSC’)XBeeProtocol.XLR = (11, ‘XLR’)XBeeProtocol.XLR_DM = (12, ‘XLR’)XBeeProtocol.SX = (13, ‘XBee SX’)XBeeProtocol.XLR_MODULE = (14, ‘XLR Module’)XBeeProtocol.CELLULAR = (15, ‘Cellular’)XBeeProtocol.CELLULAR_NBIOT = (16, ‘Cellular NB-IoT’)XBeeProtocol.UNKNOWN = (99, ‘Unknown’)-
code
¶ Returns the code of the XBeeProtocol element.
Returns: the code of the XBeeProtocol element. Return type: Integer
-
description
¶ Returns the description of the XBeeProtocol element.
Returns: the description of the XBeeProtocol element. Return type: String
-
-
class
digi.xbee.models.protocol.
IPProtocol
(code, description)[source]¶ Bases:
enum.Enum
Enumerates the available network protocols.
Inherited properties:name (String): the name (id) of this IPProtocol.value (String): the value of this IPProtocol.Values:IPProtocol.UDP = (0, ‘UDP’)IPProtocol.TCP = (1, ‘TCP’)IPProtocol.TCP_SSL = (4, ‘TLS’)-
code
¶ Returns the code of the IP protocol.
Returns: code of the IP protocol. Return type: Integer
-
description
¶ Returns the description of the IP protocol.
Returns: description of the IP protocol. Return type: String
-
-
class
digi.xbee.models.protocol.
Role
(identifier, description)[source]¶ Bases:
enum.Enum
Enumerates the available roles for an XBee.
Inherited properties:name (String): the name (id) of this Role.value (String): the value of this Role.Values:Role.COORDINATOR = (0, ‘Coordinator’)Role.ROUTER = (1, ‘Router’)Role.END_DEVICE = (2, ‘End device’)Role.UNKNOWN = (3, ‘Unknown’)-
id
¶ Gets the identifier of the role.
Returns: the role identifier. Return type: Integer
-
description
¶ Gets the description of the role.
Returns: the role description. Return type: String
-