digi.xbee.models.options module¶

class digi.xbee.models.options.ReceiveOptions(value)[source]¶

Bases: enum.Enum

This class lists all the possible options that have been set while receiving an XBee packet.

The receive options are usually set as a bitfield meaning that the options can be combined using the ‘|’ operand.

Values:

ReceiveOptions.NONE = 0
ReceiveOptions.PACKET_ACKNOWLEDGED = 1
ReceiveOptions.BROADCAST_PACKET = 2
ReceiveOptions.APS_ENCRYPTED = 32
ReceiveOptions.SENT_FROM_END_DEVICE = 64

NONE = 0¶: No special receive options.

PACKET_ACKNOWLEDGED = 1¶

Packet was acknowledged.

Not valid for WiFi protocol.

BROADCAST_PACKET = 2¶

Packet was a broadcast packet.

Not valid for WiFi protocol.

APS_ENCRYPTED = 32¶

Packet encrypted with APS encryption.

Only valid for ZigBee XBee protocol.

SENT_FROM_END_DEVICE = 64¶

Packet was sent from an end device (if known).

Only valid for ZigBee XBee protocol.

class digi.xbee.models.options.TransmitOptions(value)[source]¶

Bases: enum.Enum

This class lists all the possible options that can be set while transmitting an XBee packet.

The transmit options are usually set as a bitfield meaning that the options can be combined using the ‘|’ operand.

Not all options are available for all cases, that’s why there are different names with same values. In each moment, you must be sure that the option your are going to use, is a valid option in your context.

Values:

TransmitOptions.NONE = 0
TransmitOptions.DISABLE_ACK = 1
TransmitOptions.DONT_ATTEMPT_RD = 2
TransmitOptions.USE_BROADCAST_PAN_ID = 4
TransmitOptions.ENABLE_MULTICAST = 8
TransmitOptions.ENABLE_APS_ENCRYPTION = 32
TransmitOptions.USE_EXTENDED_TIMEOUT = 64
TransmitOptions.REPEATER_MODE = 128
TransmitOptions.DIGIMESH_MODE = 192

NONE = 0¶: No special transmit options.

DISABLE_ACK = 1¶

Disables acknowledgments on all unicasts .

Only valid for DigiMesh, 802.15.4 and Point-to-multipoint protocols.

DISABLE_RETRIES_AND_REPAIR = 1¶

Disables the retries and router repair in the frame .

Only valid for ZigBee protocol.

DONT_ATTEMPT_RD = 2¶

Doesn’t attempt Route Discovery .

Disables Route Discovery on all DigiMesh unicasts.

Only valid for DigiMesh protocol.

USE_BROADCAST_PAN_ID = 4¶

Sends packet with broadcast {@code PAN ID}. Packet will be sent to all devices in the same channel ignoring the {@code PAN ID}.

It cannot be combined with other options.

Only valid for 802.15.4 XBee protocol.

ENABLE_UNICAST_NACK = 4¶

Enables unicast NACK messages .

NACK message is enabled on the packet.

Only valid for DigiMesh 868/900 protocol.

ENABLE_UNICAST_TRACE_ROUTE = 4¶

Enables unicast trace route messages .

Trace route is enabled on the packets.

Only valid for DigiMesh 868/900 protocol.

ENABLE_MULTICAST = 8¶

Enables multicast transmission request.

Only valid for ZigBee XBee protocol.

ENABLE_APS_ENCRYPTION = 32¶

Enables APS encryption, only if {@code EE=1} .

Enabling APS encryption decreases the maximum number of RF payload bytes by 4 (below the value reported by {@code NP}).

Only valid for ZigBee XBee protocol.

USE_EXTENDED_TIMEOUT = 64¶

Uses the extended transmission timeout .

Setting the extended timeout bit causes the stack to set the extended transmission timeout for the destination address.

Only valid for ZigBee XBee protocol.

POINT_MULTIPOINT_MODE = 64¶

Transmission is performed using point-to-Multipoint mode.

Only valid for DigiMesh 868/900 and Point-to-Multipoint 868/900 protocols.

REPEATER_MODE = 128¶

Transmission is performed using repeater mode .

Only valid for DigiMesh 868/900 and Point-to-Multipoint 868/900 protocols.

DIGIMESH_MODE = 192¶

Transmission is performed using DigiMesh mode .

Only valid for DigiMesh 868/900 and Point-to-Multipoint 868/900 protocols.

class digi.xbee.models.options.RemoteATCmdOptions(value)[source]¶

Bases: enum.Enum

This class lists all the possible options that can be set while transmitting a remote AT Command.

These options are usually set as a bitfield meaning that the options can be combined using the ‘|’ operand.

Values:

RemoteATCmdOptions.NONE = 0
RemoteATCmdOptions.DISABLE_ACK = 1
RemoteATCmdOptions.APPLY_CHANGES = 2
RemoteATCmdOptions.EXTENDED_TIMEOUT = 64

NONE = 0¶: No special transmit options

DISABLE_ACK = 1¶: Disables ACK

APPLY_CHANGES = 2¶

Applies changes in the remote device.

If this option is not set, AC command must be sent before changes will take effect.

EXTENDED_TIMEOUT = 64¶

Uses the extended transmission timeout

Setting the extended timeout bit causes the stack to set the extended transmission timeout for the destination address.

Only valid for ZigBee XBee protocol.

class digi.xbee.models.options.SendDataRequestOptions(value)[source]¶

Bases: enum.Enum

Enumerates the different options for the SendDataRequestPacket.

Values:

SendDataRequestOptions.OVERWRITE = (0, ‘Overwrite’)
SendDataRequestOptions.ARCHIVE = (1, ‘Archive’)
SendDataRequestOptions.APPEND = (2, ‘Append’)
SendDataRequestOptions.TRANSIENT = (3, ‘Transient data (do not store)’)

classmethod get(code)[source]¶

Returns the send data request option for the given code.

Parameters

code (Integer) – the code of the send data request option to get.

Returns

the SendDataRequestOptions with the given code, None if there is not: any send data request option with the provided code.

Return type

FrameError

property code¶: Integer. The send data request option code.

property description¶: String. The send data request option description.

class digi.xbee.models.options.DiscoveryOptions(value)[source]¶

Bases: enum.Enum

Enumerates the different options used in the discovery process.

Values:

DiscoveryOptions.APPEND_DD = (1, ‘Append device type identifier (DD)’)
DiscoveryOptions.DISCOVER_MYSELF = (2, ‘Local device sends response frame’)
DiscoveryOptions.APPEND_RSSI = (4, ‘Append RSSI (of the last hop)’)

APPEND_DD = (1, 'Append device type identifier (DD)')¶

Append device type identifier (DD) to the discovery response.

Valid for the following protocols:

DigiMesh
Point-to-multipoint (Digi Point)
ZigBee

DISCOVER_MYSELF = (2, 'Local device sends response frame')¶

Local device sends response frame when discovery is issued.

Valid for the following protocols:

DigiMesh
Point-to-multipoint (Digi Point)
ZigBee
802.15.4

APPEND_RSSI = (4, 'Append RSSI (of the last hop)')¶

Append RSSI of the last hop to the discovery response.

Valid for the following protocols:

DigiMesh
Point-to-multipoint (Digi Point)

classmethod get(code)[source]¶

Returns the DiscoveryOptions for the given code.

Parameters

code (Integer) – the code of the DiscoveryOptions to get.

Returns

the DiscoveryOptions with the given code, None if there is not: any discovery option with the provided code.

Return type

FrameError

static calculate_discovery_value(protocol, options)[source]¶

Calculates the total value of a combination of several options for the given protocol.

Parameters

protocol (XBeeProtocol) – the XBeeProtocol to calculate the value of all the given discovery options.
options – collection of options to get the final value.

Returns

The value to be configured in the module depending on the given: collection of options and the protocol.

Return type

Integer

property code¶: Integer. The discovery option code.

property description¶: String. The discovery option description.

class digi.xbee.models.options.XBeeLocalInterface(value)[source]¶

Bases: enum.Enum

Enumerates the different interfaces for the UserDataRelayPacket and UserDataRelayOutputPacket.

Inherited properties:

name (String): the name (id) of the XBee local interface.

value (String): the value of the XBee local interface.

Values:

XBeeLocalInterface.SERIAL = (0, ‘Serial port (UART when in API mode, or SPI interface)’)
XBeeLocalInterface.BLUETOOTH = (1, ‘BLE API interface (on XBee devices which support BLE)’)
XBeeLocalInterface.MICROPYTHON = (2, ‘MicroPython’)
XBeeLocalInterface.UNKNOWN = (255, ‘Unknown interface’)

classmethod get(code)[source]¶

Returns the XBee local interface option for the given code.

Parameters

code (Integer) – the code of the XBee local interface to get.

Returns

the XBeeLocalInterface with the given code,: UNKNOWN if there is not any XBeeLocalInterface with the provided code.

Return type

XBeeLocalInterface

property code¶: Integer. The XBee local interface code.

property description¶: String. The XBee local interface description.

class digi.xbee.models.options.RegisterKeyOptions(value)[source]¶

Bases: enum.Enum

This class lists all the possible options that have been set while receiving an XBee packet.

The receive options are usually set as a bitfield meaning that the options can be combined using the ‘|’ operand.

Values:

RegisterKeyOptions.LINK_KEY = (0, ‘Key is a Link Key (KY on joining node)’)
RegisterKeyOptions.INSTALL_CODE = (1, ‘Key is an Install Code (I? on joining node, DC must be set to 1 on joiner)’)
RegisterKeyOptions.UNKNOWN = (255, ‘Unknown key option’)

classmethod get(code)[source]¶

Returns the register key option for the given code.

Parameters

code (Integer) – the code of the register key option to get.

Returns

the RegisterKeyOptions with the given code,: UNKNOWN if there is not any RegisterKeyOptions with the provided code.

Return type

RegisterKeyOptions

property code¶: Integer. The register key option code.

property description¶: String. The register key option description.

class digi.xbee.models.options.SocketOption(value)[source]¶

Bases: enum.Enum

Enumerates the different Socket Options.

Values:

SocketOption.TLS_PROFILE = (0, ‘TLS Profile’)
SocketOption.UNKNOWN = (255, ‘Unknown’)

classmethod get(code)[source]¶

Returns the Socket Option for the given code.

Parameters

code (Integer) – the code of the Socket Option to get.

Returns

the SocketOption with the given code,: SocketOption.UNKNOWN if there is not any option with the provided code.

Return type

SocketOption

property code¶: Integer. The Socket Option code.

property description¶: String. The Socket Option description.