digi.xbee.packets.aft module

class digi.xbee.packets.aft.ApiFrameType(value)

Bases: enum.Enum

This enumeration lists all the available frame types used in any XBee protocol.

Inherited properties:

name (String): the name (id) of this ApiFrameType.

value (String): the value of this ApiFrameType.

Values:

ApiFrameType.TX_64 = (0, ‘TX (Transmit) Request 64-bit address’)

ApiFrameType.TX_16 = (1, ‘TX (Transmit) Request 16-bit address’)

ApiFrameType.REMOTE_AT_COMMAND_REQUEST_WIFI = (7, ‘Remote AT Command Request (Wi-Fi)’)

ApiFrameType.AT_COMMAND = (8, ‘AT Command’)

ApiFrameType.AT_COMMAND_QUEUE = (9, ‘AT Command Queue’)

ApiFrameType.TRANSMIT_REQUEST = (16, ‘Transmit Request’)

ApiFrameType.EXPLICIT_ADDRESSING = (17, ‘Explicit Addressing Command Frame’)

ApiFrameType.REMOTE_AT_COMMAND_REQUEST = (23, ‘Remote AT Command Request’)

ApiFrameType.TX_SMS = (31, ‘TX SMS’)

ApiFrameType.TX_IPV4 = (32, ‘TX IPv4’)

ApiFrameType.CREATE_SOURCE_ROUTE = (33, ‘Create Source Route’)

ApiFrameType.REGISTER_JOINING_DEVICE = (36, ‘Register Joining Device’)

ApiFrameType.SEND_DATA_REQUEST = (40, ‘Send Data Request’)

ApiFrameType.DEVICE_RESPONSE = (42, ‘Device Response’)

ApiFrameType.USER_DATA_RELAY_REQUEST = (45, ‘User Data Relay Request’)

ApiFrameType.FILE_SYSTEM_REQUEST = (59, ‘File System Request’)

ApiFrameType.REMOTE_FILE_SYSTEM_REQUEST = (60, ‘Remote File System Request’)

ApiFrameType.SOCKET_CREATE = (64, ‘Socket Create’)

ApiFrameType.SOCKET_OPTION_REQUEST = (65, ‘Socket Option Request’)

ApiFrameType.SOCKET_CONNECT = (66, ‘Socket Connect’)

ApiFrameType.SOCKET_CLOSE = (67, ‘Socket Close’)

ApiFrameType.SOCKET_SEND = (68, ‘Socket Send (Transmit)’)

ApiFrameType.SOCKET_SENDTO = (69, ‘Socket SendTo (Transmit Explicit Data): IPv4’)

ApiFrameType.SOCKET_BIND = (70, ‘Socket Bind/Listen’)

ApiFrameType.RX_64 = (128, ‘RX (Receive) Packet 64-bit Address’)

ApiFrameType.RX_16 = (129, ‘RX (Receive) Packet 16-bit Address’)

ApiFrameType.RX_IO_64 = (130, ‘IO Data Sample RX 64-bit Address Indicator’)

ApiFrameType.RX_IO_16 = (131, ‘IO Data Sample RX 16-bit Address Indicator’)

ApiFrameType.REMOTE_AT_COMMAND_RESPONSE_WIFI = (135, ‘Remote AT Command Response (Wi-Fi)’)

ApiFrameType.AT_COMMAND_RESPONSE = (136, ‘AT Command Response’)

ApiFrameType.TX_STATUS = (137, ‘TX (Transmit) Status’)

ApiFrameType.MODEM_STATUS = (138, ‘Modem Status’)

ApiFrameType.TRANSMIT_STATUS = (139, ‘Transmit Status’)

ApiFrameType.DIGIMESH_ROUTE_INFORMATION = (141, ‘Route Information’)

ApiFrameType.IO_DATA_SAMPLE_RX_INDICATOR_WIFI = (143, ‘IO Data Sample RX Indicator (Wi-Fi)’)

ApiFrameType.RECEIVE_PACKET = (144, ‘Receive Packet’)

ApiFrameType.EXPLICIT_RX_INDICATOR = (145, ‘Explicit RX Indicator’)

ApiFrameType.IO_DATA_SAMPLE_RX_INDICATOR = (146, ‘IO Data Sample RX Indicator’)

ApiFrameType.REMOTE_AT_COMMAND_RESPONSE = (151, ‘Remote Command Response’)

ApiFrameType.RX_SMS = (159, ‘RX SMS’)

ApiFrameType.OTA_FIRMWARE_UPDATE_STATUS = (160, ‘OTA Firmware Update Status’)

ApiFrameType.ROUTE_RECORD_INDICATOR = (161, ‘Route Record Indicator’)

ApiFrameType.REGISTER_JOINING_DEVICE_STATUS = (164, ‘Register Joining Device Status’)

ApiFrameType.USER_DATA_RELAY_OUTPUT = (173, ‘User Data Relay Output’)

ApiFrameType.RX_IPV4 = (176, ‘RX IPv4’)

ApiFrameType.SEND_DATA_RESPONSE = (184, ‘Send Data Response’)

ApiFrameType.DEVICE_REQUEST = (185, ‘Device Request’)

ApiFrameType.DEVICE_RESPONSE_STATUS = (186, ‘Device Response Status’)

ApiFrameType.FILE_SYSTEM_RESPONSE = (187, ‘File System Response’)

ApiFrameType.REMOTE_FILE_SYSTEM_RESPONSE = (188, ‘Remote File System Response’)

ApiFrameType.SOCKET_CREATE_RESPONSE = (192, ‘Socket Create Response’)

ApiFrameType.SOCKET_OPTION_RESPONSE = (193, ‘Socket Option Response’)

ApiFrameType.SOCKET_CONNECT_RESPONSE = (194, ‘Socket Connect Response’)

ApiFrameType.SOCKET_CLOSE_RESPONSE = (195, ‘Socket Close Response’)

ApiFrameType.SOCKET_LISTEN_RESPONSE = (198, ‘Socket Listen Response’)

ApiFrameType.SOCKET_NEW_IPV4_CLIENT = (204, ‘Socket New IPv4 Client’)

ApiFrameType.SOCKET_RECEIVE = (205, ‘Socket Receive’)

ApiFrameType.SOCKET_RECEIVE_FROM = (206, ‘Socket Receive From’)

ApiFrameType.SOCKET_STATE = (207, ‘Socket State’)

ApiFrameType.FRAME_ERROR = (254, ‘Frame Error’)

ApiFrameType.GENERIC = (255, ‘Generic’)

ApiFrameType.UNKNOWN = (-1, ‘Unknown Packet’)

property code

Returns the code of the ApiFrameType element.

Returns

the code of the ApiFrameType element.

Return type

Integer

property description

Returns the description of the ApiFrameType element.

Returns

the description of the ApiFrameType element.

Return type

Integer

classmethod get(code)

Retrieves the api frame type associated to the given ID.

Parameters

code (Integer) – the code of the API frame type to get.

Returns

the API frame type associated to the given

code or UNKNOWN if not found.

Return type

ApiFrameType