Interpan#

API and Callbacks for the Interpan Component.

A component used to handle sending and receiving inter-PAN messages, which are messages that are sent by unjoined devices 1-hop away.

Modules#

Interpan

Enumerations#

enum
EInterpanFragmentationStatus {
IPMF_SUCCESS = 0
IPMF_TX_TIMEOUT
IPMF_RX_TIMEOUT
IPMF_TX_BAD_RESPONSE
IPMF_RX_BAD_RESPONSE
}

Macros#

#define
STUB_NWK_SIZE 2
#define
MAX_STUB_APS_SIZE (INTERPAN_APS_MULTICAST_SIZE)
#define
MIN_STUB_APS_SIZE (INTERPAN_APS_UNICAST_SIZE)
#define
INTERPAN_UNICAST_HEADER_SIZE (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + INTERPAN_APS_UNICAST_SIZE)
#define
INTERPAN_MULTICAST_HEADER_SIZE (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + INTERPAN_APS_MULTICAST_SIZE)
#define
MAX_INTER_PAN_HEADER_SIZE (INTERPAN_MULTICAST_HEADER_SIZE)
#define
INTERPAN_APS_FRAME_CONTROL_NO_DELIVERY_MODE (INTERPAN_APS_FRAME_TYPE)
#define
EMBER_APS_INTERPAN_FRAGMENT_MIN_LEN EMBER_APS_INTERPAN_FRAGMENTATION_RESPONSE_LEN
#define
EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_BUFFER_SIZE (EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_PAYLOAD_SIZE + INTERPAN_UNICAST_HEADER_SIZE)

Enumeration Documentation#

EInterpanFragmentationStatus#

EInterpanFragmentationStatus
Enumerator
IPMF_SUCCESS
IPMF_TX_TIMEOUT
IPMF_RX_TIMEOUT
IPMF_TX_BAD_RESPONSE
IPMF_RX_BAD_RESPONSE

Definition at line 231 of file app/framework/plugin/interpan/interpan.h

Macro Definition Documentation#

MAX_INTER_PAN_MAC_SIZE#

#define MAX_INTER_PAN_MAC_SIZE
Value:
23

Definition at line 69 of file app/framework/plugin/interpan/interpan.h

STUB_NWK_SIZE#

#define STUB_NWK_SIZE
Value:
2

Definition at line 72 of file app/framework/plugin/interpan/interpan.h

STUB_NWK_FRAME_CONTROL#

#define STUB_NWK_FRAME_CONTROL
Value:
0x000B

Definition at line 73 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_UNICAST_SIZE#

#define INTERPAN_APS_UNICAST_SIZE
Value:
5

Definition at line 79 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_BROADCAST_SIZE#

#define INTERPAN_APS_BROADCAST_SIZE
Value:
5

Definition at line 82 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_MULTICAST_SIZE#

#define INTERPAN_APS_MULTICAST_SIZE
Value:
7

Definition at line 89 of file app/framework/plugin/interpan/interpan.h

MAX_STUB_APS_SIZE#

#define MAX_STUB_APS_SIZE
Value:
(INTERPAN_APS_MULTICAST_SIZE)

Definition at line 91 of file app/framework/plugin/interpan/interpan.h

MIN_STUB_APS_SIZE#

#define MIN_STUB_APS_SIZE
Value:
(INTERPAN_APS_UNICAST_SIZE)

Definition at line 92 of file app/framework/plugin/interpan/interpan.h

INTERPAN_UNICAST_HEADER_SIZE#

#define INTERPAN_UNICAST_HEADER_SIZE
Value:
  (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + INTERPAN_APS_UNICAST_SIZE)

Definition at line 94 of file app/framework/plugin/interpan/interpan.h

INTERPAN_MULTICAST_HEADER_SIZE#

#define INTERPAN_MULTICAST_HEADER_SIZE
Value:
  (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + INTERPAN_APS_MULTICAST_SIZE)

Definition at line 97 of file app/framework/plugin/interpan/interpan.h

MAX_INTER_PAN_HEADER_SIZE#

#define MAX_INTER_PAN_HEADER_SIZE
Value:
(INTERPAN_MULTICAST_HEADER_SIZE)

Definition at line 100 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_FRAME_TYPE#

#define INTERPAN_APS_FRAME_TYPE
Value:
0x03

Definition at line 102 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_FRAME_TYPE_MASK#

#define INTERPAN_APS_FRAME_TYPE_MASK
Value:
0x03

Definition at line 103 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_FRAME_CONTROL_NO_DELIVERY_MODE#

#define INTERPAN_APS_FRAME_CONTROL_NO_DELIVERY_MODE
Value:
(INTERPAN_APS_FRAME_TYPE)

Definition at line 106 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_FRAME_DELIVERY_MODE_MASK#

#define INTERPAN_APS_FRAME_DELIVERY_MODE_MASK
Value:
0x0C

Definition at line 108 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_FRAME_SECURITY#

#define INTERPAN_APS_FRAME_SECURITY
Value:
0x20

Definition at line 109 of file app/framework/plugin/interpan/interpan.h

INTERPAN_APS_ENCRYPTION_OVERHEAD#

#define INTERPAN_APS_ENCRYPTION_OVERHEAD
Value:
(5 + 4)

Definition at line 112 of file app/framework/plugin/interpan/interpan.h

EMBER_APS_INTERPAN_FRAGMENTATION_OVERHEAD#

#define EMBER_APS_INTERPAN_FRAGMENTATION_OVERHEAD
Value:
4

Definition at line 115 of file app/framework/plugin/interpan/interpan.h

EMBER_APS_INTERPAN_FRAGMENTATION_RESPONSE_LEN#

#define EMBER_APS_INTERPAN_FRAGMENTATION_RESPONSE_LEN
Value:
3

Definition at line 117 of file app/framework/plugin/interpan/interpan.h

EMBER_APS_INTERPAN_FRAGMENT_MIN_LEN#

#define EMBER_APS_INTERPAN_FRAGMENT_MIN_LEN
Value:
EMBER_APS_INTERPAN_FRAGMENTATION_RESPONSE_LEN

Definition at line 118 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_INDEX#

#define INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_INDEX
Value:
0

Definition at line 121 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_INDEX_IPMF_INDEX#

#define INTERPAN_FRAGMENTATION_APS_INDEX_IPMF_INDEX
Value:
1

Definition at line 122 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_IPMF_RESPONSE_INDEX#

#define INTERPAN_FRAGMENTATION_APS_IPMF_RESPONSE_INDEX
Value:
2

Definition at line 123 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_LEN_IPMF_INDEX#

#define INTERPAN_FRAGMENTATION_APS_LEN_IPMF_INDEX
Value:
3

Definition at line 124 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_IPMF_VAL#

#define INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_IPMF_VAL
Value:
0x00

Definition at line 125 of file app/framework/plugin/interpan/interpan.h

INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_IPMF_RESPONSE_VAL#

#define INTERPAN_FRAGMENTATION_APS_CONTROL_BYTE_IPMF_RESPONSE_VAL
Value:
0x80

Definition at line 126 of file app/framework/plugin/interpan/interpan.h

INTERPAN_IPMF_RESPONSE_SUCCESS#

#define INTERPAN_IPMF_RESPONSE_SUCCESS
Value:
0x00

Definition at line 128 of file app/framework/plugin/interpan/interpan.h

INTERPAN_IPMF_RESPONSE_FAILURE#

#define INTERPAN_IPMF_RESPONSE_FAILURE
Value:
0x01

Definition at line 129 of file app/framework/plugin/interpan/interpan.h

EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_PAYLOAD_SIZE#

#define EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_PAYLOAD_SIZE
Value:
1500

Definition at line 131 of file app/framework/plugin/interpan/interpan.h

EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_INCOMING_PACKETS#

#define EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_INCOMING_PACKETS
Value:
1

Definition at line 137 of file app/framework/plugin/interpan/interpan.h

EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_OUTGOING_PACKETS#

#define EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_OUTGOING_PACKETS
Value:
1

Definition at line 138 of file app/framework/plugin/interpan/interpan.h

EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_BUFFER_SIZE#

#define EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_BUFFER_SIZE
Value:
  (EMBER_AF_PLUGIN_INTERPAN_FRAGMENTATION_MAX_PAYLOAD_SIZE + INTERPAN_UNICAST_HEADER_SIZE)

Definition at line 139 of file app/framework/plugin/interpan/interpan.h

EMBER_AF_PLUGIN_INTERPAN_FILTER_LIST#

#define EMBER_AF_PLUGIN_INTERPAN_FILTER_LIST

Definition at line 142 of file app/framework/plugin/interpan/interpan.h